From 9a9657dd5339c293395002e8d3a6d6efa7a4df74 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Sun, 25 Feb 2024 00:30:13 +1300 Subject: [PATCH] Release candidate for 1.5.x --- .travis.yml | 32 +++++++++ README.md | 6 +- ...e2f-a-challenge.md => create-challenge.md} | 2 +- docs/examples/account/create-email-token.md | 2 +- .../account/create-magic-u-r-l-token.md | 2 +- .../examples/account/create-o-auth2session.md | 1 - docs/examples/account/create-o-auth2token.md | 15 ++++ docs/examples/account/create-phone-token.md | 2 +- docs/examples/account/create-push-target.md | 6 +- docs/examples/account/create-session.md | 4 +- docs/examples/account/create.md | 4 +- docs/examples/account/delete-authenticator.md | 2 +- docs/examples/account/delete-identity.md | 2 +- docs/examples/account/delete-push-target.md | 2 +- docs/examples/account/delete-session.md | 2 +- docs/examples/account/get-session.md | 2 +- docs/examples/account/update-challenge.md | 4 +- .../account/update-magic-u-r-l-session.md | 4 +- docs/examples/account/update-name.md | 2 +- .../account/update-phone-verification.md | 4 +- docs/examples/account/update-push-target.md | 4 +- docs/examples/account/update-recovery.md | 4 +- docs/examples/account/update-session.md | 2 +- docs/examples/account/update-verification.md | 4 +- docs/examples/account/verify-authenticator.md | 2 +- docs/examples/assistant/chat.md | 2 +- docs/examples/avatars/get-initials.md | 2 +- docs/examples/avatars/get-q-r.md | 2 +- .../databases/create-boolean-attribute.md | 4 +- docs/examples/databases/create-collection.md | 6 +- .../databases/create-datetime-attribute.md | 4 +- docs/examples/databases/create-document.md | 6 +- .../databases/create-email-attribute.md | 4 +- .../databases/create-enum-attribute.md | 6 +- .../databases/create-float-attribute.md | 4 +- docs/examples/databases/create-index.md | 4 +- .../databases/create-integer-attribute.md | 4 +- .../examples/databases/create-ip-attribute.md | 4 +- .../create-relationship-attribute.md | 6 +- .../databases/create-string-attribute.md | 6 +- .../databases/create-url-attribute.md | 4 +- docs/examples/databases/create.md | 4 +- docs/examples/databases/delete-attribute.md | 4 +- docs/examples/databases/delete-collection.md | 4 +- docs/examples/databases/delete-document.md | 6 +- docs/examples/databases/delete-index.md | 4 +- docs/examples/databases/delete.md | 2 +- docs/examples/databases/get-attribute.md | 4 +- .../databases/get-collection-usage.md | 4 +- docs/examples/databases/get-collection.md | 4 +- docs/examples/databases/get-database-usage.md | 2 +- docs/examples/databases/get-document.md | 6 +- docs/examples/databases/get-index.md | 4 +- docs/examples/databases/get.md | 2 +- docs/examples/databases/list-attributes.md | 4 +- .../databases/list-collection-logs.md | 4 +- docs/examples/databases/list-collections.md | 4 +- docs/examples/databases/list-document-logs.md | 6 +- docs/examples/databases/list-documents.md | 4 +- docs/examples/databases/list-indexes.md | 4 +- docs/examples/databases/list-logs.md | 2 +- docs/examples/databases/list.md | 2 +- .../databases/update-boolean-attribute.md | 4 +- docs/examples/databases/update-collection.md | 6 +- .../databases/update-datetime-attribute.md | 4 +- docs/examples/databases/update-document.md | 6 +- .../databases/update-email-attribute.md | 4 +- .../databases/update-enum-attribute.md | 6 +- .../databases/update-float-attribute.md | 4 +- .../databases/update-integer-attribute.md | 4 +- .../examples/databases/update-ip-attribute.md | 4 +- .../update-relationship-attribute.md | 4 +- .../databases/update-string-attribute.md | 6 +- .../databases/update-url-attribute.md | 4 +- docs/examples/databases/update.md | 4 +- docs/examples/functions/create-build.md | 6 +- docs/examples/functions/create-deployment.md | 6 +- docs/examples/functions/create-execution.md | 6 +- docs/examples/functions/create-variable.md | 6 +- docs/examples/functions/create.md | 24 +++---- docs/examples/functions/delete-deployment.md | 4 +- docs/examples/functions/delete-variable.md | 4 +- docs/examples/functions/delete.md | 2 +- .../examples/functions/download-deployment.md | 4 +- docs/examples/functions/get-deployment.md | 4 +- docs/examples/functions/get-execution.md | 4 +- docs/examples/functions/get-function-usage.md | 2 +- docs/examples/functions/get-variable.md | 4 +- docs/examples/functions/get.md | 2 +- docs/examples/functions/list-deployments.md | 4 +- docs/examples/functions/list-executions.md | 4 +- docs/examples/functions/list-variables.md | 2 +- docs/examples/functions/list.md | 2 +- docs/examples/functions/update-deployment.md | 4 +- docs/examples/functions/update-variable.md | 8 +-- docs/examples/functions/update.md | 16 ++--- docs/examples/health/get-queue-databases.md | 2 +- .../messaging/create-apns-provider.md | 13 ++-- docs/examples/messaging/create-email.md | 6 +- .../examples/messaging/create-fcm-provider.md | 4 +- .../messaging/create-mailgun-provider.md | 12 ++-- .../messaging/create-msg91provider.md | 8 +-- docs/examples/messaging/create-push.md | 18 ++--- .../messaging/create-sendgrid-provider.md | 10 +-- docs/examples/messaging/create-sms.md | 4 +- .../messaging/create-smtp-provider.md | 20 +++--- docs/examples/messaging/create-subscriber.md | 6 +- .../messaging/create-telesign-provider.md | 8 +-- .../messaging/create-textmagic-provider.md | 8 +-- docs/examples/messaging/create-topic.md | 4 +- .../messaging/create-twilio-provider.md | 8 +-- .../messaging/create-vonage-provider.md | 8 +-- docs/examples/messaging/delete-provider.md | 2 +- docs/examples/messaging/delete-subscriber.md | 4 +- docs/examples/messaging/delete-topic.md | 2 +- docs/examples/messaging/delete.md | 2 +- docs/examples/messaging/get-message.md | 2 +- docs/examples/messaging/get-provider.md | 2 +- docs/examples/messaging/get-subscriber.md | 4 +- docs/examples/messaging/get-topic.md | 2 +- docs/examples/messaging/list-message-logs.md | 2 +- docs/examples/messaging/list-messages.md | 2 +- docs/examples/messaging/list-provider-logs.md | 2 +- docs/examples/messaging/list-providers.md | 2 +- .../messaging/list-subscriber-logs.md | 2 +- docs/examples/messaging/list-subscribers.md | 4 +- docs/examples/messaging/list-targets.md | 2 +- docs/examples/messaging/list-topic-logs.md | 2 +- docs/examples/messaging/list-topics.md | 2 +- .../messaging/update-a-p-n-s-provider.md | 19 ----- .../messaging/update-apns-provider.md | 20 ++++++ docs/examples/messaging/update-email.md | 6 +- ...c-m-provider.md => update-fcm-provider.md} | 6 +- .../messaging/update-mailgun-provider.md | 14 ++-- .../messaging/update-msg91provider.md | 10 +-- docs/examples/messaging/update-push.md | 16 ++--- .../messaging/update-sendgrid-provider.md | 12 ++-- docs/examples/messaging/update-sms.md | 4 +- .../messaging/update-smtp-provider.md | 22 +++--- .../messaging/update-telesign-provider.md | 10 +-- .../messaging/update-textmagic-provider.md | 10 +-- docs/examples/messaging/update-topic.md | 5 +- .../messaging/update-twilio-provider.md | 10 +-- .../messaging/update-vonage-provider.md | 10 +-- .../migrations/create-appwrite-migration.md | 4 +- .../migrations/create-firebase-migration.md | 2 +- .../create-firebase-o-auth-migration.md | 2 +- .../migrations/create-n-host-migration.md | 12 ++-- .../migrations/create-supabase-migration.md | 8 +-- docs/examples/migrations/delete.md | 2 +- .../migrations/get-appwrite-report.md | 4 +- .../migrations/get-firebase-report-o-auth.md | 2 +- .../migrations/get-firebase-report.md | 2 +- docs/examples/migrations/get-n-host-report.md | 12 ++-- .../migrations/get-supabase-report.md | 8 +-- docs/examples/migrations/get.md | 2 +- docs/examples/migrations/list.md | 2 +- docs/examples/migrations/retry.md | 2 +- docs/examples/project/create-variable.md | 4 +- docs/examples/project/delete-variable.md | 2 +- docs/examples/project/get-variable.md | 2 +- docs/examples/project/update-variable.md | 6 +- docs/examples/projects/create-key.md | 4 +- docs/examples/projects/create-platform.md | 8 +-- docs/examples/projects/create-smtp-test.md | 8 +-- docs/examples/projects/create-webhook.md | 8 +-- docs/examples/projects/create.md | 20 +++--- .../projects/delete-email-template.md | 2 +- docs/examples/projects/delete-key.md | 4 +- docs/examples/projects/delete-platform.md | 4 +- docs/examples/projects/delete-sms-template.md | 2 +- docs/examples/projects/delete-webhook.md | 4 +- docs/examples/projects/delete.md | 2 +- docs/examples/projects/get-email-template.md | 2 +- docs/examples/projects/get-key.md | 4 +- docs/examples/projects/get-platform.md | 4 +- docs/examples/projects/get-sms-template.md | 2 +- docs/examples/projects/get-webhook.md | 4 +- docs/examples/projects/get.md | 2 +- docs/examples/projects/list-keys.md | 2 +- docs/examples/projects/list-platforms.md | 2 +- docs/examples/projects/list-webhooks.md | 2 +- docs/examples/projects/list.md | 2 +- .../examples/projects/update-auth-duration.md | 2 +- docs/examples/projects/update-auth-limit.md | 2 +- .../update-auth-password-dictionary.md | 2 +- .../projects/update-auth-password-history.md | 2 +- .../projects/update-auth-sessions-limit.md | 2 +- docs/examples/projects/update-auth-status.md | 2 +- .../projects/update-email-template.md | 8 +-- docs/examples/projects/update-key.md | 6 +- docs/examples/projects/update-o-auth2.md | 6 +- .../projects/update-personal-data-check.md | 2 +- docs/examples/projects/update-platform.md | 10 +-- .../projects/update-service-status-all.md | 2 +- .../projects/update-service-status.md | 2 +- docs/examples/projects/update-sms-template.md | 4 +- docs/examples/projects/update-smtp.md | 8 +-- docs/examples/projects/update-team.md | 4 +- .../projects/update-webhook-signature.md | 4 +- docs/examples/projects/update-webhook.md | 10 +-- docs/examples/projects/update.md | 20 +++--- docs/examples/proxy/create-rule.md | 2 +- docs/examples/proxy/delete-rule.md | 2 +- docs/examples/proxy/get-rule.md | 2 +- docs/examples/proxy/list-rules.md | 2 +- .../proxy/update-rule-verification.md | 2 +- docs/examples/storage/create-bucket.md | 4 +- docs/examples/storage/create-file.md | 4 +- docs/examples/storage/delete-bucket.md | 2 +- docs/examples/storage/delete-file.md | 4 +- docs/examples/storage/get-bucket-usage.md | 2 +- docs/examples/storage/get-bucket.md | 2 +- docs/examples/storage/get-file-download.md | 4 +- docs/examples/storage/get-file-preview.md | 4 +- docs/examples/storage/get-file-view.md | 4 +- docs/examples/storage/get-file.md | 4 +- docs/examples/storage/list-buckets.md | 2 +- docs/examples/storage/list-files.md | 4 +- docs/examples/storage/update-bucket.md | 4 +- docs/examples/storage/update-file.md | 6 +- docs/examples/teams/create-membership.md | 6 +- docs/examples/teams/create.md | 4 +- docs/examples/teams/delete-membership.md | 4 +- docs/examples/teams/delete.md | 2 +- docs/examples/teams/get-membership.md | 4 +- docs/examples/teams/get-prefs.md | 2 +- docs/examples/teams/get.md | 2 +- docs/examples/teams/list-logs.md | 2 +- docs/examples/teams/list-memberships.md | 4 +- docs/examples/teams/list.md | 2 +- .../teams/update-membership-status.md | 8 +-- docs/examples/teams/update-membership.md | 4 +- docs/examples/teams/update-name.md | 4 +- docs/examples/teams/update-prefs.md | 2 +- docs/examples/users/create-argon2user.md | 4 +- docs/examples/users/create-bcrypt-user.md | 4 +- docs/examples/users/create-m-d5user.md | 4 +- docs/examples/users/create-p-h-pass-user.md | 4 +- docs/examples/users/create-s-h-a-user.md | 4 +- .../users/create-scrypt-modified-user.md | 10 +-- docs/examples/users/create-scrypt-user.md | 6 +- docs/examples/users/create-session.md | 2 +- docs/examples/users/create-target.md | 10 +-- docs/examples/users/create-token.md | 2 +- docs/examples/users/create.md | 4 +- docs/examples/users/delete-authenticator.md | 4 +- docs/examples/users/delete-identity.md | 2 +- docs/examples/users/delete-session.md | 4 +- docs/examples/users/delete-sessions.md | 2 +- docs/examples/users/delete-target.md | 4 +- docs/examples/users/delete.md | 2 +- docs/examples/users/get-prefs.md | 2 +- docs/examples/users/get-target.md | 4 +- docs/examples/users/get.md | 2 +- docs/examples/users/list-factors.md | 2 +- docs/examples/users/list-identities.md | 2 +- docs/examples/users/list-logs.md | 2 +- docs/examples/users/list-memberships.md | 2 +- docs/examples/users/list-sessions.md | 2 +- docs/examples/users/list-targets.md | 2 +- docs/examples/users/list.md | 2 +- .../users/update-email-verification.md | 2 +- docs/examples/users/update-email.md | 2 +- docs/examples/users/update-labels.md | 2 +- docs/examples/users/update-mfa.md | 2 +- docs/examples/users/update-name.md | 4 +- docs/examples/users/update-password.md | 2 +- .../users/update-phone-verification.md | 2 +- docs/examples/users/update-phone.md | 2 +- docs/examples/users/update-prefs.md | 2 +- docs/examples/users/update-status.md | 2 +- docs/examples/users/update-target.md | 10 +-- .../vcs/create-repository-detection.md | 6 +- docs/examples/vcs/create-repository.md | 4 +- docs/examples/vcs/delete-installation.md | 2 +- docs/examples/vcs/get-installation.md | 2 +- docs/examples/vcs/get-repository.md | 4 +- docs/examples/vcs/list-installations.md | 2 +- docs/examples/vcs/list-repositories.md | 4 +- docs/examples/vcs/list-repository-branches.md | 4 +- .../vcs/update-external-deployments.md | 6 +- package.json | 2 +- src/client.ts | 2 +- src/enums/email-template-type.ts | 1 + src/enums/sms-template-type.ts | 1 + .../{encryption.ts => smtp-encryption.ts} | 2 +- src/index.ts | 2 +- src/service.ts | 3 - src/services/account.ts | 69 ++++++++++++++++--- src/services/assistant.ts | 1 - src/services/avatars.ts | 1 - src/services/console.ts | 1 - src/services/databases.ts | 1 - src/services/functions.ts | 1 - src/services/graphql.ts | 1 - src/services/health.ts | 1 - src/services/locale.ts | 1 - src/services/messaging.ts | 34 ++++++--- src/services/migrations.ts | 1 - src/services/project.ts | 1 - src/services/projects.ts | 1 - src/services/proxy.ts | 1 - src/services/storage.ts | 1 - src/services/teams.ts | 1 - src/services/users.ts | 1 - src/services/vcs.ts | 1 - 307 files changed, 782 insertions(+), 683 deletions(-) create mode 100644 .travis.yml rename docs/examples/account/{create2f-a-challenge.md => create-challenge.md} (87%) create mode 100644 docs/examples/account/create-o-auth2token.md delete mode 100644 docs/examples/messaging/update-a-p-n-s-provider.md create mode 100644 docs/examples/messaging/update-apns-provider.md rename docs/examples/messaging/{update-f-c-m-provider.md => update-fcm-provider.md} (74%) rename src/enums/{encryption.ts => smtp-encryption.ts} (65%) diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..aae2399 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,32 @@ +language: node_js +node_js: + - "14.16" + +jobs: + include: + - stage: NPM RC Release + if: tag == *-rc* + node_js: "14.16" + script: + - npm install + - npm run build + - echo "Deploying RC to NPM..." + deploy: + provider: npm + email: $NPM_EMAIL + api_key: $NPM_API_KEY + tag: next + - stage: NPM Release + if: tag != *-rc* + node_js: "14.16" + script: + - npm install + - npm run build + - echo "Deploying to NPM..." + deploy: + provider: npm + email: $NPM_EMAIL + api_key: $NPM_API_KEY + skip_cleanup: true + on: + tags: true \ No newline at end of file diff --git a/README.md b/README.md index cea81f3..bdebf1b 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ import { Client, Account } from "@appwrite.io/console"; To install with a CDN (content delivery network) add the following scripts to the bottom of your tag, but before you use any Appwrite services: ```html - + ``` @@ -64,7 +64,7 @@ Once your SDK object is set, access any of the Appwrite services and choose any const account = new Account(client); // Register User -account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe') +account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien") .then(function (response) { console.log(response); }, function (error) { @@ -86,7 +86,7 @@ client const account = new Account(client); // Register User -account.create(ID.unique(), 'me@example.com', 'password', 'Jane Doe') +account.create(ID.unique(), "email@example.com", "password", "Walter O'Brien") .then(function (response) { console.log(response); }, function (error) { diff --git a/docs/examples/account/create2f-a-challenge.md b/docs/examples/account/create-challenge.md similarity index 87% rename from docs/examples/account/create2f-a-challenge.md rename to docs/examples/account/create-challenge.md index a10dded..2a2bd70 100644 --- a/docs/examples/account/create2f-a-challenge.md +++ b/docs/examples/account/create-challenge.md @@ -6,7 +6,7 @@ const client = new Client() const account = new Account(client); -const result = await account.create2FAChallenge( +const result = await account.createChallenge( AuthenticationFactor.Totp // factor ); diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md index 276d5c3..9536329 100644 --- a/docs/examples/account/create-email-token.md +++ b/docs/examples/account/create-email-token.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.createEmailToken( - '[USER_ID]', // userId + '', // userId 'email@example.com', // email false // phrase (optional) ); diff --git a/docs/examples/account/create-magic-u-r-l-token.md b/docs/examples/account/create-magic-u-r-l-token.md index 62d631b..dcdef26 100644 --- a/docs/examples/account/create-magic-u-r-l-token.md +++ b/docs/examples/account/create-magic-u-r-l-token.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.createMagicURLToken( - '[USER_ID]', // userId + '', // userId 'email@example.com', // email 'https://example.com', // url (optional) false // phrase (optional) diff --git a/docs/examples/account/create-o-auth2session.md b/docs/examples/account/create-o-auth2session.md index fca1a3d..35ef6f8 100644 --- a/docs/examples/account/create-o-auth2session.md +++ b/docs/examples/account/create-o-auth2session.md @@ -10,7 +10,6 @@ account.createOAuth2Session( OAuthProvider.Amazon, // provider 'https://example.com', // success (optional) 'https://example.com', // failure (optional) - false, // token (optional) [] // scopes (optional) ); diff --git a/docs/examples/account/create-o-auth2token.md b/docs/examples/account/create-o-auth2token.md new file mode 100644 index 0000000..a35bb38 --- /dev/null +++ b/docs/examples/account/create-o-auth2token.md @@ -0,0 +1,15 @@ +import { Client, Account, OAuthProvider } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('5df5acd0d48c2'); // Your project ID + +const account = new Account(client); + +account.createOAuth2Token( + OAuthProvider.Amazon, // provider + 'https://example.com', // success (optional) + 'https://example.com', // failure (optional) + [] // scopes (optional) +); + diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md index 0d0c6ad..5d7c160 100644 --- a/docs/examples/account/create-phone-token.md +++ b/docs/examples/account/create-phone-token.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.createPhoneToken( - '[USER_ID]', // userId + '', // userId '+12065550100' // phone ); diff --git a/docs/examples/account/create-push-target.md b/docs/examples/account/create-push-target.md index eb76f83..093abcc 100644 --- a/docs/examples/account/create-push-target.md +++ b/docs/examples/account/create-push-target.md @@ -7,9 +7,9 @@ const client = new Client() const account = new Account(client); const result = await account.createPushTarget( - '[TARGET_ID]', // targetId - '[IDENTIFIER]', // identifier - '[PROVIDER_ID]' // providerId (optional) + '', // targetId + '', // identifier + '' // providerId (optional) ); console.log(response); diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md index c410f05..be5a2a3 100644 --- a/docs/examples/account/create-session.md +++ b/docs/examples/account/create-session.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.createSession( - '[USER_ID]', // userId - '[SECRET]' // secret + '', // userId + '' // secret ); console.log(response); diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md index 4598db5..9c0d035 100644 --- a/docs/examples/account/create.md +++ b/docs/examples/account/create.md @@ -7,10 +7,10 @@ const client = new Client() const account = new Account(client); const result = await account.create( - '[USER_ID]', // userId + '', // userId 'email@example.com', // email '', // password - '[NAME]' // name (optional) + '' // name (optional) ); console.log(response); diff --git a/docs/examples/account/delete-authenticator.md b/docs/examples/account/delete-authenticator.md index 7a3e2f9..af72aae 100644 --- a/docs/examples/account/delete-authenticator.md +++ b/docs/examples/account/delete-authenticator.md @@ -8,7 +8,7 @@ const account = new Account(client); const result = await account.deleteAuthenticator( AuthenticatorType.Totp, // type - '[OTP]' // otp + '' // otp ); console.log(response); diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md index 5f3735f..ed23adf 100644 --- a/docs/examples/account/delete-identity.md +++ b/docs/examples/account/delete-identity.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.deleteIdentity( - '[IDENTITY_ID]' // identityId + '' // identityId ); console.log(response); diff --git a/docs/examples/account/delete-push-target.md b/docs/examples/account/delete-push-target.md index dca74a5..630ebfe 100644 --- a/docs/examples/account/delete-push-target.md +++ b/docs/examples/account/delete-push-target.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.deletePushTarget( - '[TARGET_ID]' // targetId + '' // targetId ); console.log(response); diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md index 99c010d..4908800 100644 --- a/docs/examples/account/delete-session.md +++ b/docs/examples/account/delete-session.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.deleteSession( - '[SESSION_ID]' // sessionId + '' // sessionId ); console.log(response); diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md index f044ea0..6707c51 100644 --- a/docs/examples/account/get-session.md +++ b/docs/examples/account/get-session.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.getSession( - '[SESSION_ID]' // sessionId + '' // sessionId ); console.log(response); diff --git a/docs/examples/account/update-challenge.md b/docs/examples/account/update-challenge.md index 8be9cf2..2c5c34e 100644 --- a/docs/examples/account/update-challenge.md +++ b/docs/examples/account/update-challenge.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updateChallenge( - '[CHALLENGE_ID]', // challengeId - '[OTP]' // otp + '', // challengeId + '' // otp ); console.log(response); diff --git a/docs/examples/account/update-magic-u-r-l-session.md b/docs/examples/account/update-magic-u-r-l-session.md index 5f39688..d82c7c2 100644 --- a/docs/examples/account/update-magic-u-r-l-session.md +++ b/docs/examples/account/update-magic-u-r-l-session.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updateMagicURLSession( - '[USER_ID]', // userId - '[SECRET]' // secret + '', // userId + '' // secret ); console.log(response); diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md index 06aa720..d3c0d89 100644 --- a/docs/examples/account/update-name.md +++ b/docs/examples/account/update-name.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.updateName( - '[NAME]' // name + '' // name ); console.log(response); diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md index 90c6c15..5417e11 100644 --- a/docs/examples/account/update-phone-verification.md +++ b/docs/examples/account/update-phone-verification.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updatePhoneVerification( - '[USER_ID]', // userId - '[SECRET]' // secret + '', // userId + '' // secret ); console.log(response); diff --git a/docs/examples/account/update-push-target.md b/docs/examples/account/update-push-target.md index 3e031d7..6125151 100644 --- a/docs/examples/account/update-push-target.md +++ b/docs/examples/account/update-push-target.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updatePushTarget( - '[TARGET_ID]', // targetId - '[IDENTIFIER]' // identifier + '', // targetId + '' // identifier ); console.log(response); diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md index 9fc912d..4034ad5 100644 --- a/docs/examples/account/update-recovery.md +++ b/docs/examples/account/update-recovery.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updateRecovery( - '[USER_ID]', // userId - '[SECRET]', // secret + '', // userId + '', // secret '' // password ); diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md index 6619d74..a55c078 100644 --- a/docs/examples/account/update-session.md +++ b/docs/examples/account/update-session.md @@ -7,7 +7,7 @@ const client = new Client() const account = new Account(client); const result = await account.updateSession( - '[SESSION_ID]' // sessionId + '' // sessionId ); console.log(response); diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md index b53b553..d221ebf 100644 --- a/docs/examples/account/update-verification.md +++ b/docs/examples/account/update-verification.md @@ -7,8 +7,8 @@ const client = new Client() const account = new Account(client); const result = await account.updateVerification( - '[USER_ID]', // userId - '[SECRET]' // secret + '', // userId + '' // secret ); console.log(response); diff --git a/docs/examples/account/verify-authenticator.md b/docs/examples/account/verify-authenticator.md index f38ac6a..0ccb9de 100644 --- a/docs/examples/account/verify-authenticator.md +++ b/docs/examples/account/verify-authenticator.md @@ -8,7 +8,7 @@ const account = new Account(client); const result = await account.verifyAuthenticator( AuthenticatorType.Totp, // type - '[OTP]' // otp + '' // otp ); console.log(response); diff --git a/docs/examples/assistant/chat.md b/docs/examples/assistant/chat.md index 581c8d8..76a461f 100644 --- a/docs/examples/assistant/chat.md +++ b/docs/examples/assistant/chat.md @@ -7,7 +7,7 @@ const client = new Client() const assistant = new Assistant(client); const result = await assistant.chat( - '[PROMPT]' // prompt + '' // prompt ); console.log(response); diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md index f723ce6..384f635 100644 --- a/docs/examples/avatars/get-initials.md +++ b/docs/examples/avatars/get-initials.md @@ -7,7 +7,7 @@ const client = new Client() const avatars = new Avatars(client); const result = avatars.getInitials( - '[NAME]', // name (optional) + '', // name (optional) 0, // width (optional) 0, // height (optional) '' // background (optional) diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md index edd6d1c..4bafd30 100644 --- a/docs/examples/avatars/get-q-r.md +++ b/docs/examples/avatars/get-q-r.md @@ -7,7 +7,7 @@ const client = new Client() const avatars = new Avatars(client); const result = avatars.getQR( - '[TEXT]', // text + '', // text 1, // size (optional) 0, // margin (optional) false // download (optional) diff --git a/docs/examples/databases/create-boolean-attribute.md b/docs/examples/databases/create-boolean-attribute.md index 286bb08..c1c8c86 100644 --- a/docs/examples/databases/create-boolean-attribute.md +++ b/docs/examples/databases/create-boolean-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createBooleanAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required false, // default (optional) diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md index 090d7fe..d8d2bc3 100644 --- a/docs/examples/databases/create-collection.md +++ b/docs/examples/databases/create-collection.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createCollection( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[NAME]', // name + '', // databaseId + '', // collectionId + '', // name ["read("any")"], // permissions (optional) false, // documentSecurity (optional) false // enabled (optional) diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md index 5b6f435..1b0a082 100644 --- a/docs/examples/databases/create-datetime-attribute.md +++ b/docs/examples/databases/create-datetime-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createDatetimeAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required '', // default (optional) diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index 1099fec..85114bd 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createDocument( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[DOCUMENT_ID]', // documentId + '', // databaseId + '', // collectionId + '', // documentId {}, // data ["read("any")"] // permissions (optional) ); diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md index 994647d..867f9ed 100644 --- a/docs/examples/databases/create-email-attribute.md +++ b/docs/examples/databases/create-email-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createEmailAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required 'email@example.com', // default (optional) diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md index bb997ca..fb8ed88 100644 --- a/docs/examples/databases/create-enum-attribute.md +++ b/docs/examples/databases/create-enum-attribute.md @@ -7,12 +7,12 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createEnumAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key [], // elements false, // required - '[DEFAULT]', // default (optional) + '', // default (optional) false // array (optional) ); diff --git a/docs/examples/databases/create-float-attribute.md b/docs/examples/databases/create-float-attribute.md index 4b0762c..51c4f23 100644 --- a/docs/examples/databases/create-float-attribute.md +++ b/docs/examples/databases/create-float-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createFloatAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required null, // min (optional) diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index 9a3ebb9..dd21231 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createIndex( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key IndexType.Key, // type [], // attributes diff --git a/docs/examples/databases/create-integer-attribute.md b/docs/examples/databases/create-integer-attribute.md index 368cb2e..d73139c 100644 --- a/docs/examples/databases/create-integer-attribute.md +++ b/docs/examples/databases/create-integer-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createIntegerAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required null, // min (optional) diff --git a/docs/examples/databases/create-ip-attribute.md b/docs/examples/databases/create-ip-attribute.md index cd1f951..1609c87 100644 --- a/docs/examples/databases/create-ip-attribute.md +++ b/docs/examples/databases/create-ip-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createIpAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required '', // default (optional) diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md index 6c8b57a..f212ac4 100644 --- a/docs/examples/databases/create-relationship-attribute.md +++ b/docs/examples/databases/create-relationship-attribute.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createRelationshipAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[RELATED_COLLECTION_ID]', // relatedCollectionId + '', // databaseId + '', // collectionId + '', // relatedCollectionId RelationshipType.OneToOne, // type false, // twoWay (optional) '', // key (optional) diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md index d80d2dd..0d04eee 100644 --- a/docs/examples/databases/create-string-attribute.md +++ b/docs/examples/databases/create-string-attribute.md @@ -7,12 +7,12 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createStringAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key 1, // size false, // required - '[DEFAULT]', // default (optional) + '', // default (optional) false, // array (optional) false // encrypt (optional) ); diff --git a/docs/examples/databases/create-url-attribute.md b/docs/examples/databases/create-url-attribute.md index 4369a56..72e06b5 100644 --- a/docs/examples/databases/create-url-attribute.md +++ b/docs/examples/databases/create-url-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.createUrlAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required 'https://example.com', // default (optional) diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md index a0d448e..b443c87 100644 --- a/docs/examples/databases/create.md +++ b/docs/examples/databases/create.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.create( - '[DATABASE_ID]', // databaseId - '[NAME]', // name + '', // databaseId + '', // name false // enabled (optional) ); diff --git a/docs/examples/databases/delete-attribute.md b/docs/examples/databases/delete-attribute.md index ae35ad6..8d21126 100644 --- a/docs/examples/databases/delete-attribute.md +++ b/docs/examples/databases/delete-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.deleteAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '' // key ); diff --git a/docs/examples/databases/delete-collection.md b/docs/examples/databases/delete-collection.md index 06e5c2c..0f3b98d 100644 --- a/docs/examples/databases/delete-collection.md +++ b/docs/examples/databases/delete-collection.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.deleteCollection( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]' // collectionId + '', // databaseId + '' // collectionId ); console.log(response); diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md index e67ac3a..d2d986f 100644 --- a/docs/examples/databases/delete-document.md +++ b/docs/examples/databases/delete-document.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.deleteDocument( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[DOCUMENT_ID]' // documentId + '', // databaseId + '', // collectionId + '' // documentId ); console.log(response); diff --git a/docs/examples/databases/delete-index.md b/docs/examples/databases/delete-index.md index 16d5f55..3ecb1f1 100644 --- a/docs/examples/databases/delete-index.md +++ b/docs/examples/databases/delete-index.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.deleteIndex( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '' // key ); diff --git a/docs/examples/databases/delete.md b/docs/examples/databases/delete.md index ec5955a..4391302 100644 --- a/docs/examples/databases/delete.md +++ b/docs/examples/databases/delete.md @@ -7,7 +7,7 @@ const client = new Client() const databases = new Databases(client); const result = await databases.delete( - '[DATABASE_ID]' // databaseId + '' // databaseId ); console.log(response); diff --git a/docs/examples/databases/get-attribute.md b/docs/examples/databases/get-attribute.md index 7936aaf..20ce69c 100644 --- a/docs/examples/databases/get-attribute.md +++ b/docs/examples/databases/get-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '' // key ); diff --git a/docs/examples/databases/get-collection-usage.md b/docs/examples/databases/get-collection-usage.md index 614112e..d7cfc42 100644 --- a/docs/examples/databases/get-collection-usage.md +++ b/docs/examples/databases/get-collection-usage.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getCollectionUsage( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId DatabaseUsageRange.TwentyFourHours // range (optional) ); diff --git a/docs/examples/databases/get-collection.md b/docs/examples/databases/get-collection.md index 314cbf0..b7d6429 100644 --- a/docs/examples/databases/get-collection.md +++ b/docs/examples/databases/get-collection.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getCollection( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]' // collectionId + '', // databaseId + '' // collectionId ); console.log(response); diff --git a/docs/examples/databases/get-database-usage.md b/docs/examples/databases/get-database-usage.md index c1f5902..9ad346f 100644 --- a/docs/examples/databases/get-database-usage.md +++ b/docs/examples/databases/get-database-usage.md @@ -7,7 +7,7 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getDatabaseUsage( - '[DATABASE_ID]', // databaseId + '', // databaseId DatabaseUsageRange.TwentyFourHours // range (optional) ); diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md index 8c64be3..f961727 100644 --- a/docs/examples/databases/get-document.md +++ b/docs/examples/databases/get-document.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getDocument( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[DOCUMENT_ID]', // documentId + '', // databaseId + '', // collectionId + '', // documentId [] // queries (optional) ); diff --git a/docs/examples/databases/get-index.md b/docs/examples/databases/get-index.md index 29b8770..340414c 100644 --- a/docs/examples/databases/get-index.md +++ b/docs/examples/databases/get-index.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.getIndex( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '' // key ); diff --git a/docs/examples/databases/get.md b/docs/examples/databases/get.md index 3a53bbb..86af972 100644 --- a/docs/examples/databases/get.md +++ b/docs/examples/databases/get.md @@ -7,7 +7,7 @@ const client = new Client() const databases = new Databases(client); const result = await databases.get( - '[DATABASE_ID]' // databaseId + '' // databaseId ); console.log(response); diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md index f4a49d8..a4d5477 100644 --- a/docs/examples/databases/list-attributes.md +++ b/docs/examples/databases/list-attributes.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listAttributes( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId [] // queries (optional) ); diff --git a/docs/examples/databases/list-collection-logs.md b/docs/examples/databases/list-collection-logs.md index 1ba52af..f2119e7 100644 --- a/docs/examples/databases/list-collection-logs.md +++ b/docs/examples/databases/list-collection-logs.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listCollectionLogs( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId [] // queries (optional) ); diff --git a/docs/examples/databases/list-collections.md b/docs/examples/databases/list-collections.md index 24f33f9..b1aa270 100644 --- a/docs/examples/databases/list-collections.md +++ b/docs/examples/databases/list-collections.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listCollections( - '[DATABASE_ID]', // databaseId + '', // databaseId [], // queries (optional) - '[SEARCH]' // search (optional) + '' // search (optional) ); console.log(response); diff --git a/docs/examples/databases/list-document-logs.md b/docs/examples/databases/list-document-logs.md index 46d9ca6..94bb129 100644 --- a/docs/examples/databases/list-document-logs.md +++ b/docs/examples/databases/list-document-logs.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listDocumentLogs( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[DOCUMENT_ID]', // documentId + '', // databaseId + '', // collectionId + '', // documentId [] // queries (optional) ); diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md index ca0ab26..d704eda 100644 --- a/docs/examples/databases/list-documents.md +++ b/docs/examples/databases/list-documents.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listDocuments( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId [] // queries (optional) ); diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md index f2b3cd8..c1818ad 100644 --- a/docs/examples/databases/list-indexes.md +++ b/docs/examples/databases/list-indexes.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listIndexes( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId [] // queries (optional) ); diff --git a/docs/examples/databases/list-logs.md b/docs/examples/databases/list-logs.md index 4521ddd..d889ec7 100644 --- a/docs/examples/databases/list-logs.md +++ b/docs/examples/databases/list-logs.md @@ -7,7 +7,7 @@ const client = new Client() const databases = new Databases(client); const result = await databases.listLogs( - '[DATABASE_ID]', // databaseId + '', // databaseId [] // queries (optional) ); diff --git a/docs/examples/databases/list.md b/docs/examples/databases/list.md index e3a50f1..f5742ff 100644 --- a/docs/examples/databases/list.md +++ b/docs/examples/databases/list.md @@ -8,7 +8,7 @@ const databases = new Databases(client); const result = await databases.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '' // search (optional) ); console.log(response); diff --git a/docs/examples/databases/update-boolean-attribute.md b/docs/examples/databases/update-boolean-attribute.md index 4197724..4963701 100644 --- a/docs/examples/databases/update-boolean-attribute.md +++ b/docs/examples/databases/update-boolean-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateBooleanAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required false // default diff --git a/docs/examples/databases/update-collection.md b/docs/examples/databases/update-collection.md index d5a5c9a..7a94d88 100644 --- a/docs/examples/databases/update-collection.md +++ b/docs/examples/databases/update-collection.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateCollection( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[NAME]', // name + '', // databaseId + '', // collectionId + '', // name ["read("any")"], // permissions (optional) false, // documentSecurity (optional) false // enabled (optional) diff --git a/docs/examples/databases/update-datetime-attribute.md b/docs/examples/databases/update-datetime-attribute.md index 3ea1d91..ce12ecf 100644 --- a/docs/examples/databases/update-datetime-attribute.md +++ b/docs/examples/databases/update-datetime-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateDatetimeAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required '' // default diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md index f633d2e..82307c7 100644 --- a/docs/examples/databases/update-document.md +++ b/docs/examples/databases/update-document.md @@ -7,9 +7,9 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateDocument( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId - '[DOCUMENT_ID]', // documentId + '', // databaseId + '', // collectionId + '', // documentId {}, // data (optional) ["read("any")"] // permissions (optional) ); diff --git a/docs/examples/databases/update-email-attribute.md b/docs/examples/databases/update-email-attribute.md index db5a323..eaf1167 100644 --- a/docs/examples/databases/update-email-attribute.md +++ b/docs/examples/databases/update-email-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateEmailAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required 'email@example.com' // default diff --git a/docs/examples/databases/update-enum-attribute.md b/docs/examples/databases/update-enum-attribute.md index 70e36ef..4dba524 100644 --- a/docs/examples/databases/update-enum-attribute.md +++ b/docs/examples/databases/update-enum-attribute.md @@ -7,12 +7,12 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateEnumAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key [], // elements false, // required - '[DEFAULT]' // default + '' // default ); console.log(response); diff --git a/docs/examples/databases/update-float-attribute.md b/docs/examples/databases/update-float-attribute.md index c9a4b8f..c8c73e1 100644 --- a/docs/examples/databases/update-float-attribute.md +++ b/docs/examples/databases/update-float-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateFloatAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required null, // min diff --git a/docs/examples/databases/update-integer-attribute.md b/docs/examples/databases/update-integer-attribute.md index dbcfb30..c113213 100644 --- a/docs/examples/databases/update-integer-attribute.md +++ b/docs/examples/databases/update-integer-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateIntegerAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required null, // min diff --git a/docs/examples/databases/update-ip-attribute.md b/docs/examples/databases/update-ip-attribute.md index c3cdf1d..81c47d4 100644 --- a/docs/examples/databases/update-ip-attribute.md +++ b/docs/examples/databases/update-ip-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateIpAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required '' // default diff --git a/docs/examples/databases/update-relationship-attribute.md b/docs/examples/databases/update-relationship-attribute.md index e5b1177..649cae1 100644 --- a/docs/examples/databases/update-relationship-attribute.md +++ b/docs/examples/databases/update-relationship-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateRelationshipAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key RelationMutate.Cascade // onDelete (optional) ); diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md index d4ec38a..54d7875 100644 --- a/docs/examples/databases/update-string-attribute.md +++ b/docs/examples/databases/update-string-attribute.md @@ -7,11 +7,11 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateStringAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required - '[DEFAULT]' // default + '' // default ); console.log(response); diff --git a/docs/examples/databases/update-url-attribute.md b/docs/examples/databases/update-url-attribute.md index 7ea466e..3d02628 100644 --- a/docs/examples/databases/update-url-attribute.md +++ b/docs/examples/databases/update-url-attribute.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.updateUrlAttribute( - '[DATABASE_ID]', // databaseId - '[COLLECTION_ID]', // collectionId + '', // databaseId + '', // collectionId '', // key false, // required 'https://example.com' // default diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md index ddaec96..41529ed 100644 --- a/docs/examples/databases/update.md +++ b/docs/examples/databases/update.md @@ -7,8 +7,8 @@ const client = new Client() const databases = new Databases(client); const result = await databases.update( - '[DATABASE_ID]', // databaseId - '[NAME]', // name + '', // databaseId + '', // name false // enabled (optional) ); diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-build.md index fccaae3..034ea7e 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-build.md @@ -7,9 +7,9 @@ const client = new Client() const functions = new Functions(client); const result = await functions.createBuild( - '[FUNCTION_ID]', // functionId - '[DEPLOYMENT_ID]', // deploymentId - '[BUILD_ID]' // buildId + '', // functionId + '', // deploymentId + '' // buildId ); console.log(response); diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md index 3f2c20b..d3086ce 100644 --- a/docs/examples/functions/create-deployment.md +++ b/docs/examples/functions/create-deployment.md @@ -7,11 +7,11 @@ const client = new Client() const functions = new Functions(client); const result = await functions.createDeployment( - '[FUNCTION_ID]', // functionId + '', // functionId document.getElementById('uploader').files[0], // code false, // activate - '[ENTRYPOINT]', // entrypoint (optional) - '[COMMANDS]' // commands (optional) + '', // entrypoint (optional) + '' // commands (optional) ); console.log(response); diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md index 63ca0e5..d8ff507 100644 --- a/docs/examples/functions/create-execution.md +++ b/docs/examples/functions/create-execution.md @@ -7,10 +7,10 @@ const client = new Client() const functions = new Functions(client); const result = await functions.createExecution( - '[FUNCTION_ID]', // functionId - '[BODY]', // body (optional) + '', // functionId + '', // body (optional) false, // async (optional) - '[PATH]', // path (optional) + '', // path (optional) ExecutionMethod.GET, // method (optional) {} // headers (optional) ); diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index 37ac9ae..3b8f6d3 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -7,9 +7,9 @@ const client = new Client() const functions = new Functions(client); const result = await functions.createVariable( - '[FUNCTION_ID]', // functionId - '[KEY]', // key - '[VALUE]' // value + '', // functionId + '', // key + '' // value ); console.log(response); diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index e36c912..f726c57 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.create( - '[FUNCTION_ID]', // functionId - '[NAME]', // name + '', // functionId + '', // name .Node145, // runtime ["any"], // execute (optional) [], // events (optional) @@ -16,17 +16,17 @@ const result = await functions.create( 1, // timeout (optional) false, // enabled (optional) false, // logging (optional) - '[ENTRYPOINT]', // entrypoint (optional) - '[COMMANDS]', // commands (optional) - '[INSTALLATION_ID]', // installationId (optional) - '[PROVIDER_REPOSITORY_ID]', // providerRepositoryId (optional) - '[PROVIDER_BRANCH]', // providerBranch (optional) + '', // entrypoint (optional) + '', // commands (optional) + '', // installationId (optional) + '', // providerRepositoryId (optional) + '', // providerBranch (optional) false, // providerSilentMode (optional) - '[PROVIDER_ROOT_DIRECTORY]', // providerRootDirectory (optional) - '[TEMPLATE_REPOSITORY]', // templateRepository (optional) - '[TEMPLATE_OWNER]', // templateOwner (optional) - '[TEMPLATE_ROOT_DIRECTORY]', // templateRootDirectory (optional) - '[TEMPLATE_BRANCH]' // templateBranch (optional) + '', // providerRootDirectory (optional) + '', // templateRepository (optional) + '', // templateOwner (optional) + '', // templateRootDirectory (optional) + '' // templateBranch (optional) ); console.log(response); diff --git a/docs/examples/functions/delete-deployment.md b/docs/examples/functions/delete-deployment.md index feaaf2a..fac4afe 100644 --- a/docs/examples/functions/delete-deployment.md +++ b/docs/examples/functions/delete-deployment.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.deleteDeployment( - '[FUNCTION_ID]', // functionId - '[DEPLOYMENT_ID]' // deploymentId + '', // functionId + '' // deploymentId ); console.log(response); diff --git a/docs/examples/functions/delete-variable.md b/docs/examples/functions/delete-variable.md index 2918f45..d6f7f92 100644 --- a/docs/examples/functions/delete-variable.md +++ b/docs/examples/functions/delete-variable.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.deleteVariable( - '[FUNCTION_ID]', // functionId - '[VARIABLE_ID]' // variableId + '', // functionId + '' // variableId ); console.log(response); diff --git a/docs/examples/functions/delete.md b/docs/examples/functions/delete.md index 010b0cb..5cb2ee4 100644 --- a/docs/examples/functions/delete.md +++ b/docs/examples/functions/delete.md @@ -7,7 +7,7 @@ const client = new Client() const functions = new Functions(client); const result = await functions.delete( - '[FUNCTION_ID]' // functionId + '' // functionId ); console.log(response); diff --git a/docs/examples/functions/download-deployment.md b/docs/examples/functions/download-deployment.md index bfb206a..cea9970 100644 --- a/docs/examples/functions/download-deployment.md +++ b/docs/examples/functions/download-deployment.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = functions.downloadDeployment( - '[FUNCTION_ID]', // functionId - '[DEPLOYMENT_ID]' // deploymentId + '', // functionId + '' // deploymentId ); console.log(result); diff --git a/docs/examples/functions/get-deployment.md b/docs/examples/functions/get-deployment.md index 2838cc9..372697a 100644 --- a/docs/examples/functions/get-deployment.md +++ b/docs/examples/functions/get-deployment.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.getDeployment( - '[FUNCTION_ID]', // functionId - '[DEPLOYMENT_ID]' // deploymentId + '', // functionId + '' // deploymentId ); console.log(response); diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md index e127a53..7dbb050 100644 --- a/docs/examples/functions/get-execution.md +++ b/docs/examples/functions/get-execution.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.getExecution( - '[FUNCTION_ID]', // functionId - '[EXECUTION_ID]' // executionId + '', // functionId + '' // executionId ); console.log(response); diff --git a/docs/examples/functions/get-function-usage.md b/docs/examples/functions/get-function-usage.md index 5969317..e465afc 100644 --- a/docs/examples/functions/get-function-usage.md +++ b/docs/examples/functions/get-function-usage.md @@ -7,7 +7,7 @@ const client = new Client() const functions = new Functions(client); const result = await functions.getFunctionUsage( - '[FUNCTION_ID]', // functionId + '', // functionId FunctionUsageRange.TwentyFourHours // range (optional) ); diff --git a/docs/examples/functions/get-variable.md b/docs/examples/functions/get-variable.md index ec24ed4..3507968 100644 --- a/docs/examples/functions/get-variable.md +++ b/docs/examples/functions/get-variable.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.getVariable( - '[FUNCTION_ID]', // functionId - '[VARIABLE_ID]' // variableId + '', // functionId + '' // variableId ); console.log(response); diff --git a/docs/examples/functions/get.md b/docs/examples/functions/get.md index 311417b..51c8190 100644 --- a/docs/examples/functions/get.md +++ b/docs/examples/functions/get.md @@ -7,7 +7,7 @@ const client = new Client() const functions = new Functions(client); const result = await functions.get( - '[FUNCTION_ID]' // functionId + '' // functionId ); console.log(response); diff --git a/docs/examples/functions/list-deployments.md b/docs/examples/functions/list-deployments.md index 9afe3b8..30ae40f 100644 --- a/docs/examples/functions/list-deployments.md +++ b/docs/examples/functions/list-deployments.md @@ -7,9 +7,9 @@ const client = new Client() const functions = new Functions(client); const result = await functions.listDeployments( - '[FUNCTION_ID]', // functionId + '', // functionId [], // queries (optional) - '[SEARCH]' // search (optional) + '' // search (optional) ); console.log(response); diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index 7d941c2..5236bf6 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -7,9 +7,9 @@ const client = new Client() const functions = new Functions(client); const result = await functions.listExecutions( - '[FUNCTION_ID]', // functionId + '', // functionId [], // queries (optional) - '[SEARCH]' // search (optional) + '' // search (optional) ); console.log(response); diff --git a/docs/examples/functions/list-variables.md b/docs/examples/functions/list-variables.md index 0b257f0..ca43b90 100644 --- a/docs/examples/functions/list-variables.md +++ b/docs/examples/functions/list-variables.md @@ -7,7 +7,7 @@ const client = new Client() const functions = new Functions(client); const result = await functions.listVariables( - '[FUNCTION_ID]' // functionId + '' // functionId ); console.log(response); diff --git a/docs/examples/functions/list.md b/docs/examples/functions/list.md index 1a7787c..586e51d 100644 --- a/docs/examples/functions/list.md +++ b/docs/examples/functions/list.md @@ -8,7 +8,7 @@ const functions = new Functions(client); const result = await functions.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '' // search (optional) ); console.log(response); diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-deployment.md index 1bf9909..373c9a4 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-deployment.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.updateDeployment( - '[FUNCTION_ID]', // functionId - '[DEPLOYMENT_ID]' // deploymentId + '', // functionId + '' // deploymentId ); console.log(response); diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index c8ab9ba..bd6b0b2 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -7,10 +7,10 @@ const client = new Client() const functions = new Functions(client); const result = await functions.updateVariable( - '[FUNCTION_ID]', // functionId - '[VARIABLE_ID]', // variableId - '[KEY]', // key - '[VALUE]' // value (optional) + '', // functionId + '', // variableId + '', // key + '' // value (optional) ); console.log(response); diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md index 9a5eb77..3bb85ee 100644 --- a/docs/examples/functions/update.md +++ b/docs/examples/functions/update.md @@ -7,8 +7,8 @@ const client = new Client() const functions = new Functions(client); const result = await functions.update( - '[FUNCTION_ID]', // functionId - '[NAME]', // name + '', // functionId + '', // name .Node145, // runtime (optional) ["any"], // execute (optional) [], // events (optional) @@ -16,13 +16,13 @@ const result = await functions.update( 1, // timeout (optional) false, // enabled (optional) false, // logging (optional) - '[ENTRYPOINT]', // entrypoint (optional) - '[COMMANDS]', // commands (optional) - '[INSTALLATION_ID]', // installationId (optional) - '[PROVIDER_REPOSITORY_ID]', // providerRepositoryId (optional) - '[PROVIDER_BRANCH]', // providerBranch (optional) + '', // entrypoint (optional) + '', // commands (optional) + '', // installationId (optional) + '', // providerRepositoryId (optional) + '', // providerBranch (optional) false, // providerSilentMode (optional) - '[PROVIDER_ROOT_DIRECTORY]' // providerRootDirectory (optional) + '' // providerRootDirectory (optional) ); console.log(response); diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md index 797be48..9ea4d8c 100644 --- a/docs/examples/health/get-queue-databases.md +++ b/docs/examples/health/get-queue-databases.md @@ -7,7 +7,7 @@ const client = new Client() const health = new Health(client); const result = await health.getQueueDatabases( - '[NAME]', // name (optional) + '', // name (optional) null // threshold (optional) ); diff --git a/docs/examples/messaging/create-apns-provider.md b/docs/examples/messaging/create-apns-provider.md index ef586bb..2313716 100644 --- a/docs/examples/messaging/create-apns-provider.md +++ b/docs/examples/messaging/create-apns-provider.md @@ -7,12 +7,13 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createApnsProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name - '[AUTH_KEY]', // authKey (optional) - '[AUTH_KEY_ID]', // authKeyId (optional) - '[TEAM_ID]', // teamId (optional) - '[BUNDLE_ID]', // bundleId (optional) + '', // providerId + '', // name + '', // authKey (optional) + '', // authKeyId (optional) + '', // teamId (optional) + '', // bundleId (optional) + false, // sandbox (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-email.md b/docs/examples/messaging/create-email.md index 536fdb2..af79ef6 100644 --- a/docs/examples/messaging/create-email.md +++ b/docs/examples/messaging/create-email.md @@ -7,9 +7,9 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createEmail( - '[MESSAGE_ID]', // messageId - '[SUBJECT]', // subject - '[CONTENT]', // content + '', // messageId + '', // subject + '', // content [], // topics (optional) [], // users (optional) [], // targets (optional) diff --git a/docs/examples/messaging/create-fcm-provider.md b/docs/examples/messaging/create-fcm-provider.md index 5a59ac7..6409186 100644 --- a/docs/examples/messaging/create-fcm-provider.md +++ b/docs/examples/messaging/create-fcm-provider.md @@ -7,8 +7,8 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createFcmProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '', // providerId + '', // name {}, // serviceAccountJSON (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-mailgun-provider.md b/docs/examples/messaging/create-mailgun-provider.md index d81fbc9..70e6059 100644 --- a/docs/examples/messaging/create-mailgun-provider.md +++ b/docs/examples/messaging/create-mailgun-provider.md @@ -7,14 +7,14 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createMailgunProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name - '[API_KEY]', // apiKey (optional) - '[DOMAIN]', // domain (optional) + '', // providerId + '', // name + '', // apiKey (optional) + '', // domain (optional) false, // isEuRegion (optional) - '[FROM_NAME]', // fromName (optional) + '', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) + '', // replyToName (optional) 'email@example.com', // replyToEmail (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-msg91provider.md b/docs/examples/messaging/create-msg91provider.md index 5be2510..dac0516 100644 --- a/docs/examples/messaging/create-msg91provider.md +++ b/docs/examples/messaging/create-msg91provider.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createMsg91Provider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '', // providerId + '', // name '+12065550100', // from (optional) - '[SENDER_ID]', // senderId (optional) - '[AUTH_KEY]', // authKey (optional) + '', // senderId (optional) + '', // authKey (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md index e5de584..8de70d9 100644 --- a/docs/examples/messaging/create-push.md +++ b/docs/examples/messaging/create-push.md @@ -7,20 +7,20 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createPush( - '[MESSAGE_ID]', // messageId - '[TITLE]', // title - '[BODY]', // body + '', // messageId + '', // title + '<BODY>', // body [], // topics (optional) [], // users (optional) [], // targets (optional) {}, // data (optional) - '[ACTION]', // action (optional) + '<ACTION>', // action (optional) '[ID1:ID2]', // image (optional) - '[ICON]', // icon (optional) - '[SOUND]', // sound (optional) - '[COLOR]', // color (optional) - '[TAG]', // tag (optional) - '[BADGE]', // badge (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) + '<BADGE>', // badge (optional) MessageStatus.Draft, // status (optional) '' // scheduledAt (optional) ); diff --git a/docs/examples/messaging/create-sendgrid-provider.md b/docs/examples/messaging/create-sendgrid-provider.md index 7f9acef..10c1987 100644 --- a/docs/examples/messaging/create-sendgrid-provider.md +++ b/docs/examples/messaging/create-sendgrid-provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createSendgridProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name - '[API_KEY]', // apiKey (optional) - '[FROM_NAME]', // fromName (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) + '<REPLY_TO_NAME>', // replyToName (optional) 'email@example.com', // replyToEmail (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-sms.md b/docs/examples/messaging/create-sms.md index d3a06a3..3eba217 100644 --- a/docs/examples/messaging/create-sms.md +++ b/docs/examples/messaging/create-sms.md @@ -7,8 +7,8 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createSms( - '[MESSAGE_ID]', // messageId - '[CONTENT]', // content + '<MESSAGE_ID>', // messageId + '<CONTENT>', // content [], // topics (optional) [], // users (optional) [], // targets (optional) diff --git a/docs/examples/messaging/create-smtp-provider.md b/docs/examples/messaging/create-smtp-provider.md index 64e2cb6..fd8aa44 100644 --- a/docs/examples/messaging/create-smtp-provider.md +++ b/docs/examples/messaging/create-smtp-provider.md @@ -1,4 +1,4 @@ -import { Client, Messaging, } from "@appwrite.io/console"; +import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint @@ -7,18 +7,18 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createSmtpProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name - '[HOST]', // host + '<PROVIDER_ID>', // providerId + '<NAME>', // name + '<HOST>', // host 1, // port (optional) - '[USERNAME]', // username (optional) - '[PASSWORD]', // password (optional) - .None, // encryption (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) false, // autoTLS (optional) - '[MAILER]', // mailer (optional) - '[FROM_NAME]', // fromName (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) + '<REPLY_TO_NAME>', // replyToName (optional) 'email@example.com', // replyToEmail (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-subscriber.md b/docs/examples/messaging/create-subscriber.md index 7ad2feb..71e2e04 100644 --- a/docs/examples/messaging/create-subscriber.md +++ b/docs/examples/messaging/create-subscriber.md @@ -7,9 +7,9 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createSubscriber( - '[TOPIC_ID]', // topicId - '[SUBSCRIBER_ID]', // subscriberId - '[TARGET_ID]' // targetId + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>', // subscriberId + '<TARGET_ID>' // targetId ); console.log(response); diff --git a/docs/examples/messaging/create-telesign-provider.md b/docs/examples/messaging/create-telesign-provider.md index 8ef4bc4..d0105ff 100644 --- a/docs/examples/messaging/create-telesign-provider.md +++ b/docs/examples/messaging/create-telesign-provider.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createTelesignProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '<PROVIDER_ID>', // providerId + '<NAME>', // name '+12065550100', // from (optional) - '[CUSTOMER_ID]', // customerId (optional) - '[API_KEY]', // apiKey (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-textmagic-provider.md b/docs/examples/messaging/create-textmagic-provider.md index b2e6c48..9eccf33 100644 --- a/docs/examples/messaging/create-textmagic-provider.md +++ b/docs/examples/messaging/create-textmagic-provider.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createTextmagicProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '<PROVIDER_ID>', // providerId + '<NAME>', // name '+12065550100', // from (optional) - '[USERNAME]', // username (optional) - '[API_KEY]', // apiKey (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-topic.md b/docs/examples/messaging/create-topic.md index 0f284d8..ce49f9d 100644 --- a/docs/examples/messaging/create-topic.md +++ b/docs/examples/messaging/create-topic.md @@ -7,8 +7,8 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createTopic( - '[TOPIC_ID]', // topicId - '[NAME]', // name + '<TOPIC_ID>', // topicId + '<NAME>', // name ["any"] // subscribe (optional) ); diff --git a/docs/examples/messaging/create-twilio-provider.md b/docs/examples/messaging/create-twilio-provider.md index 91d51f4..37e6851 100644 --- a/docs/examples/messaging/create-twilio-provider.md +++ b/docs/examples/messaging/create-twilio-provider.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createTwilioProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '<PROVIDER_ID>', // providerId + '<NAME>', // name '+12065550100', // from (optional) - '[ACCOUNT_SID]', // accountSid (optional) - '[AUTH_TOKEN]', // authToken (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/create-vonage-provider.md b/docs/examples/messaging/create-vonage-provider.md index 5f7e1c9..81b3d16 100644 --- a/docs/examples/messaging/create-vonage-provider.md +++ b/docs/examples/messaging/create-vonage-provider.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.createVonageProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name + '<PROVIDER_ID>', // providerId + '<NAME>', // name '+12065550100', // from (optional) - '[API_KEY]', // apiKey (optional) - '[API_SECRET]', // apiSecret (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/delete-provider.md b/docs/examples/messaging/delete-provider.md index 469ab0d..dbdc076 100644 --- a/docs/examples/messaging/delete-provider.md +++ b/docs/examples/messaging/delete-provider.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.deleteProvider( - '[PROVIDER_ID]' // providerId + '<PROVIDER_ID>' // providerId ); console.log(response); diff --git a/docs/examples/messaging/delete-subscriber.md b/docs/examples/messaging/delete-subscriber.md index d35bfc6..c88a0a5 100644 --- a/docs/examples/messaging/delete-subscriber.md +++ b/docs/examples/messaging/delete-subscriber.md @@ -7,8 +7,8 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.deleteSubscriber( - '[TOPIC_ID]', // topicId - '[SUBSCRIBER_ID]' // subscriberId + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId ); console.log(response); diff --git a/docs/examples/messaging/delete-topic.md b/docs/examples/messaging/delete-topic.md index 6a897f4..1adaa6a 100644 --- a/docs/examples/messaging/delete-topic.md +++ b/docs/examples/messaging/delete-topic.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.deleteTopic( - '[TOPIC_ID]' // topicId + '<TOPIC_ID>' // topicId ); console.log(response); diff --git a/docs/examples/messaging/delete.md b/docs/examples/messaging/delete.md index c3ab377..5adcdda 100644 --- a/docs/examples/messaging/delete.md +++ b/docs/examples/messaging/delete.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.delete( - '[MESSAGE_ID]' // messageId + '<MESSAGE_ID>' // messageId ); console.log(response); diff --git a/docs/examples/messaging/get-message.md b/docs/examples/messaging/get-message.md index 9210a9c..d296919 100644 --- a/docs/examples/messaging/get-message.md +++ b/docs/examples/messaging/get-message.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.getMessage( - '[MESSAGE_ID]' // messageId + '<MESSAGE_ID>' // messageId ); console.log(response); diff --git a/docs/examples/messaging/get-provider.md b/docs/examples/messaging/get-provider.md index 4cfbc8b..ec576d2 100644 --- a/docs/examples/messaging/get-provider.md +++ b/docs/examples/messaging/get-provider.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.getProvider( - '[PROVIDER_ID]' // providerId + '<PROVIDER_ID>' // providerId ); console.log(response); diff --git a/docs/examples/messaging/get-subscriber.md b/docs/examples/messaging/get-subscriber.md index 7aa9676..72706a0 100644 --- a/docs/examples/messaging/get-subscriber.md +++ b/docs/examples/messaging/get-subscriber.md @@ -7,8 +7,8 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.getSubscriber( - '[TOPIC_ID]', // topicId - '[SUBSCRIBER_ID]' // subscriberId + '<TOPIC_ID>', // topicId + '<SUBSCRIBER_ID>' // subscriberId ); console.log(response); diff --git a/docs/examples/messaging/get-topic.md b/docs/examples/messaging/get-topic.md index 5dd1259..277d611 100644 --- a/docs/examples/messaging/get-topic.md +++ b/docs/examples/messaging/get-topic.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.getTopic( - '[TOPIC_ID]' // topicId + '<TOPIC_ID>' // topicId ); console.log(response); diff --git a/docs/examples/messaging/list-message-logs.md b/docs/examples/messaging/list-message-logs.md index 0cea52f..20ec0be 100644 --- a/docs/examples/messaging/list-message-logs.md +++ b/docs/examples/messaging/list-message-logs.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listMessageLogs( - '[MESSAGE_ID]', // messageId + '<MESSAGE_ID>', // messageId [] // queries (optional) ); diff --git a/docs/examples/messaging/list-messages.md b/docs/examples/messaging/list-messages.md index c61362e..e7d58f9 100644 --- a/docs/examples/messaging/list-messages.md +++ b/docs/examples/messaging/list-messages.md @@ -8,7 +8,7 @@ const messaging = new Messaging(client); const result = await messaging.listMessages( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/messaging/list-provider-logs.md b/docs/examples/messaging/list-provider-logs.md index 0fd5942..9b338e3 100644 --- a/docs/examples/messaging/list-provider-logs.md +++ b/docs/examples/messaging/list-provider-logs.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listProviderLogs( - '[PROVIDER_ID]', // providerId + '<PROVIDER_ID>', // providerId [] // queries (optional) ); diff --git a/docs/examples/messaging/list-providers.md b/docs/examples/messaging/list-providers.md index c605d92..5c3e1bd 100644 --- a/docs/examples/messaging/list-providers.md +++ b/docs/examples/messaging/list-providers.md @@ -8,7 +8,7 @@ const messaging = new Messaging(client); const result = await messaging.listProviders( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/messaging/list-subscriber-logs.md b/docs/examples/messaging/list-subscriber-logs.md index b0c04a0..2ef14d7 100644 --- a/docs/examples/messaging/list-subscriber-logs.md +++ b/docs/examples/messaging/list-subscriber-logs.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listSubscriberLogs( - '[SUBSCRIBER_ID]', // subscriberId + '<SUBSCRIBER_ID>', // subscriberId [] // queries (optional) ); diff --git a/docs/examples/messaging/list-subscribers.md b/docs/examples/messaging/list-subscribers.md index 6f13bcd..c317de9 100644 --- a/docs/examples/messaging/list-subscribers.md +++ b/docs/examples/messaging/list-subscribers.md @@ -7,9 +7,9 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listSubscribers( - '[TOPIC_ID]', // topicId + '<TOPIC_ID>', // topicId [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/messaging/list-targets.md b/docs/examples/messaging/list-targets.md index a365136..1628d1d 100644 --- a/docs/examples/messaging/list-targets.md +++ b/docs/examples/messaging/list-targets.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listTargets( - '[MESSAGE_ID]', // messageId + '<MESSAGE_ID>', // messageId [] // queries (optional) ); diff --git a/docs/examples/messaging/list-topic-logs.md b/docs/examples/messaging/list-topic-logs.md index 485a481..a367503 100644 --- a/docs/examples/messaging/list-topic-logs.md +++ b/docs/examples/messaging/list-topic-logs.md @@ -7,7 +7,7 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.listTopicLogs( - '[TOPIC_ID]', // topicId + '<TOPIC_ID>', // topicId [] // queries (optional) ); diff --git a/docs/examples/messaging/list-topics.md b/docs/examples/messaging/list-topics.md index 138ec57..d42ae79 100644 --- a/docs/examples/messaging/list-topics.md +++ b/docs/examples/messaging/list-topics.md @@ -8,7 +8,7 @@ const messaging = new Messaging(client); const result = await messaging.listTopics( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-a-p-n-s-provider.md b/docs/examples/messaging/update-a-p-n-s-provider.md deleted file mode 100644 index 24e3a59..0000000 --- a/docs/examples/messaging/update-a-p-n-s-provider.md +++ /dev/null @@ -1,19 +0,0 @@ -import { Client, Messaging } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint - .setProject('5df5acd0d48c2'); // Your project ID - -const messaging = new Messaging(client); - -const result = await messaging.updateAPNSProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) - false, // enabled (optional) - '[AUTH_KEY]', // authKey (optional) - '[AUTH_KEY_ID]', // authKeyId (optional) - '[TEAM_ID]', // teamId (optional) - '[BUNDLE_ID]' // bundleId (optional) -); - -console.log(response); diff --git a/docs/examples/messaging/update-apns-provider.md b/docs/examples/messaging/update-apns-provider.md new file mode 100644 index 0000000..adde336 --- /dev/null +++ b/docs/examples/messaging/update-apns-provider.md @@ -0,0 +1,20 @@ +import { Client, Messaging } from "@appwrite.io/console"; + +const client = new Client() + .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setProject('5df5acd0d48c2'); // Your project ID + +const messaging = new Messaging(client); + +const result = await messaging.updateApnsProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + false, // enabled (optional) + '<AUTH_KEY>', // authKey (optional) + '<AUTH_KEY_ID>', // authKeyId (optional) + '<TEAM_ID>', // teamId (optional) + '<BUNDLE_ID>', // bundleId (optional) + false // sandbox (optional) +); + +console.log(response); diff --git a/docs/examples/messaging/update-email.md b/docs/examples/messaging/update-email.md index e667b2f..be66d8d 100644 --- a/docs/examples/messaging/update-email.md +++ b/docs/examples/messaging/update-email.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateEmail( - '[MESSAGE_ID]', // messageId + '<MESSAGE_ID>', // messageId [], // topics (optional) [], // users (optional) [], // targets (optional) - '[SUBJECT]', // subject (optional) - '[CONTENT]', // content (optional) + '<SUBJECT>', // subject (optional) + '<CONTENT>', // content (optional) MessageStatus.Draft, // status (optional) false, // html (optional) [], // cc (optional) diff --git a/docs/examples/messaging/update-f-c-m-provider.md b/docs/examples/messaging/update-fcm-provider.md similarity index 74% rename from docs/examples/messaging/update-f-c-m-provider.md rename to docs/examples/messaging/update-fcm-provider.md index e734ce6..bf408da 100644 --- a/docs/examples/messaging/update-f-c-m-provider.md +++ b/docs/examples/messaging/update-fcm-provider.md @@ -6,9 +6,9 @@ const client = new Client() const messaging = new Messaging(client); -const result = await messaging.updateFCMProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) +const result = await messaging.updateFcmProvider( + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) {} // serviceAccountJSON (optional) ); diff --git a/docs/examples/messaging/update-mailgun-provider.md b/docs/examples/messaging/update-mailgun-provider.md index 2091937..8edfd8f 100644 --- a/docs/examples/messaging/update-mailgun-provider.md +++ b/docs/examples/messaging/update-mailgun-provider.md @@ -7,16 +7,16 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateMailgunProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) - '[API_KEY]', // apiKey (optional) - '[DOMAIN]', // domain (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<API_KEY>', // apiKey (optional) + '<DOMAIN>', // domain (optional) false, // isEuRegion (optional) false, // enabled (optional) - '[FROM_NAME]', // fromName (optional) + '<FROM_NAME>', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) - '[REPLY_TO_EMAIL]' // replyToEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-msg91provider.md b/docs/examples/messaging/update-msg91provider.md index 196c749..decaac5 100644 --- a/docs/examples/messaging/update-msg91provider.md +++ b/docs/examples/messaging/update-msg91provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateMsg91Provider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[SENDER_ID]', // senderId (optional) - '[AUTH_KEY]', // authKey (optional) - '[FROM]' // from (optional) + '<SENDER_ID>', // senderId (optional) + '<AUTH_KEY>', // authKey (optional) + '<FROM>' // from (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md index bcf29f2..61668ad 100644 --- a/docs/examples/messaging/update-push.md +++ b/docs/examples/messaging/update-push.md @@ -7,19 +7,19 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updatePush( - '[MESSAGE_ID]', // messageId + '<MESSAGE_ID>', // messageId [], // topics (optional) [], // users (optional) [], // targets (optional) - '[TITLE]', // title (optional) - '[BODY]', // body (optional) + '<TITLE>', // title (optional) + '<BODY>', // body (optional) {}, // data (optional) - '[ACTION]', // action (optional) + '<ACTION>', // action (optional) '[ID1:ID2]', // image (optional) - '[ICON]', // icon (optional) - '[SOUND]', // sound (optional) - '[COLOR]', // color (optional) - '[TAG]', // tag (optional) + '<ICON>', // icon (optional) + '<SOUND>', // sound (optional) + '<COLOR>', // color (optional) + '<TAG>', // tag (optional) null, // badge (optional) MessageStatus.Draft, // status (optional) '' // scheduledAt (optional) diff --git a/docs/examples/messaging/update-sendgrid-provider.md b/docs/examples/messaging/update-sendgrid-provider.md index b7df476..a815cfa 100644 --- a/docs/examples/messaging/update-sendgrid-provider.md +++ b/docs/examples/messaging/update-sendgrid-provider.md @@ -7,14 +7,14 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateSendgridProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[API_KEY]', // apiKey (optional) - '[FROM_NAME]', // fromName (optional) + '<API_KEY>', // apiKey (optional) + '<FROM_NAME>', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) - '[REPLY_TO_EMAIL]' // replyToEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>' // replyToEmail (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-sms.md b/docs/examples/messaging/update-sms.md index 8adba2f..c4deb45 100644 --- a/docs/examples/messaging/update-sms.md +++ b/docs/examples/messaging/update-sms.md @@ -7,11 +7,11 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateSms( - '[MESSAGE_ID]', // messageId + '<MESSAGE_ID>', // messageId [], // topics (optional) [], // users (optional) [], // targets (optional) - '[CONTENT]', // content (optional) + '<CONTENT>', // content (optional) MessageStatus.Draft, // status (optional) '' // scheduledAt (optional) ); diff --git a/docs/examples/messaging/update-smtp-provider.md b/docs/examples/messaging/update-smtp-provider.md index 9632f8e..a8556fe 100644 --- a/docs/examples/messaging/update-smtp-provider.md +++ b/docs/examples/messaging/update-smtp-provider.md @@ -1,4 +1,4 @@ -import { Client, Messaging, } from "@appwrite.io/console"; +import { Client, Messaging, SmtpEncryption } from "@appwrite.io/console"; const client = new Client() .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint @@ -7,19 +7,19 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateSmtpProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) - '[HOST]', // host (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) + '<HOST>', // host (optional) 1, // port (optional) - '[USERNAME]', // username (optional) - '[PASSWORD]', // password (optional) - .None, // encryption (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) + SmtpEncryption.None, // encryption (optional) false, // autoTLS (optional) - '[MAILER]', // mailer (optional) - '[FROM_NAME]', // fromName (optional) + '<MAILER>', // mailer (optional) + '<FROM_NAME>', // fromName (optional) 'email@example.com', // fromEmail (optional) - '[REPLY_TO_NAME]', // replyToName (optional) - '[REPLY_TO_EMAIL]', // replyToEmail (optional) + '<REPLY_TO_NAME>', // replyToName (optional) + '<REPLY_TO_EMAIL>', // replyToEmail (optional) false // enabled (optional) ); diff --git a/docs/examples/messaging/update-telesign-provider.md b/docs/examples/messaging/update-telesign-provider.md index d9d6d97..5ae3543 100644 --- a/docs/examples/messaging/update-telesign-provider.md +++ b/docs/examples/messaging/update-telesign-provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateTelesignProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[CUSTOMER_ID]', // customerId (optional) - '[API_KEY]', // apiKey (optional) - '[FROM]' // from (optional) + '<CUSTOMER_ID>', // customerId (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-textmagic-provider.md b/docs/examples/messaging/update-textmagic-provider.md index bcaa39f..45c19fc 100644 --- a/docs/examples/messaging/update-textmagic-provider.md +++ b/docs/examples/messaging/update-textmagic-provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateTextmagicProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[USERNAME]', // username (optional) - '[API_KEY]', // apiKey (optional) - '[FROM]' // from (optional) + '<USERNAME>', // username (optional) + '<API_KEY>', // apiKey (optional) + '<FROM>' // from (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-topic.md b/docs/examples/messaging/update-topic.md index 8f9c64a..19da6c5 100644 --- a/docs/examples/messaging/update-topic.md +++ b/docs/examples/messaging/update-topic.md @@ -7,8 +7,9 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateTopic( - '[TOPIC_ID]', // topicId - '[NAME]' // name (optional) + '<TOPIC_ID>', // topicId + '<NAME>', // name (optional) + ["any"] // subscribe (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-twilio-provider.md b/docs/examples/messaging/update-twilio-provider.md index 39ddafb..fd1b314 100644 --- a/docs/examples/messaging/update-twilio-provider.md +++ b/docs/examples/messaging/update-twilio-provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateTwilioProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[ACCOUNT_SID]', // accountSid (optional) - '[AUTH_TOKEN]', // authToken (optional) - '[FROM]' // from (optional) + '<ACCOUNT_SID>', // accountSid (optional) + '<AUTH_TOKEN>', // authToken (optional) + '<FROM>' // from (optional) ); console.log(response); diff --git a/docs/examples/messaging/update-vonage-provider.md b/docs/examples/messaging/update-vonage-provider.md index cc0c933..7fd1466 100644 --- a/docs/examples/messaging/update-vonage-provider.md +++ b/docs/examples/messaging/update-vonage-provider.md @@ -7,12 +7,12 @@ const client = new Client() const messaging = new Messaging(client); const result = await messaging.updateVonageProvider( - '[PROVIDER_ID]', // providerId - '[NAME]', // name (optional) + '<PROVIDER_ID>', // providerId + '<NAME>', // name (optional) false, // enabled (optional) - '[API_KEY]', // apiKey (optional) - '[API_SECRET]', // apiSecret (optional) - '[FROM]' // from (optional) + '<API_KEY>', // apiKey (optional) + '<API_SECRET>', // apiSecret (optional) + '<FROM>' // from (optional) ); console.log(response); diff --git a/docs/examples/migrations/create-appwrite-migration.md b/docs/examples/migrations/create-appwrite-migration.md index 196c127..91e7153 100644 --- a/docs/examples/migrations/create-appwrite-migration.md +++ b/docs/examples/migrations/create-appwrite-migration.md @@ -9,8 +9,8 @@ const migrations = new Migrations(client); const result = await migrations.createAppwriteMigration( [], // resources 'https://example.com', // endpoint - '[PROJECT_ID]', // projectId - '[API_KEY]' // apiKey + '<PROJECT_ID>', // projectId + '<API_KEY>' // apiKey ); console.log(response); diff --git a/docs/examples/migrations/create-firebase-migration.md b/docs/examples/migrations/create-firebase-migration.md index 98a8692..20e7588 100644 --- a/docs/examples/migrations/create-firebase-migration.md +++ b/docs/examples/migrations/create-firebase-migration.md @@ -8,7 +8,7 @@ const migrations = new Migrations(client); const result = await migrations.createFirebaseMigration( [], // resources - '[SERVICE_ACCOUNT]' // serviceAccount + '<SERVICE_ACCOUNT>' // serviceAccount ); console.log(response); diff --git a/docs/examples/migrations/create-firebase-o-auth-migration.md b/docs/examples/migrations/create-firebase-o-auth-migration.md index 46fba36..c35c654 100644 --- a/docs/examples/migrations/create-firebase-o-auth-migration.md +++ b/docs/examples/migrations/create-firebase-o-auth-migration.md @@ -8,7 +8,7 @@ const migrations = new Migrations(client); const result = await migrations.createFirebaseOAuthMigration( [], // resources - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/migrations/create-n-host-migration.md b/docs/examples/migrations/create-n-host-migration.md index cff794f..e87a6ef 100644 --- a/docs/examples/migrations/create-n-host-migration.md +++ b/docs/examples/migrations/create-n-host-migration.md @@ -8,12 +8,12 @@ const migrations = new Migrations(client); const result = await migrations.createNHostMigration( [], // resources - '[SUBDOMAIN]', // subdomain - '[REGION]', // region - '[ADMIN_SECRET]', // adminSecret - '[DATABASE]', // database - '[USERNAME]', // username - '[PASSWORD]', // password + '<SUBDOMAIN>', // subdomain + '<REGION>', // region + '<ADMIN_SECRET>', // adminSecret + '<DATABASE>', // database + '<USERNAME>', // username + '<PASSWORD>', // password null // port (optional) ); diff --git a/docs/examples/migrations/create-supabase-migration.md b/docs/examples/migrations/create-supabase-migration.md index a98a407..5377c6b 100644 --- a/docs/examples/migrations/create-supabase-migration.md +++ b/docs/examples/migrations/create-supabase-migration.md @@ -9,10 +9,10 @@ const migrations = new Migrations(client); const result = await migrations.createSupabaseMigration( [], // resources 'https://example.com', // endpoint - '[API_KEY]', // apiKey - '[DATABASE_HOST]', // databaseHost - '[USERNAME]', // username - '[PASSWORD]', // password + '<API_KEY>', // apiKey + '<DATABASE_HOST>', // databaseHost + '<USERNAME>', // username + '<PASSWORD>', // password null // port (optional) ); diff --git a/docs/examples/migrations/delete.md b/docs/examples/migrations/delete.md index a3f0d0f..2a0af9b 100644 --- a/docs/examples/migrations/delete.md +++ b/docs/examples/migrations/delete.md @@ -7,7 +7,7 @@ const client = new Client() const migrations = new Migrations(client); const result = await migrations.delete( - '[MIGRATION_ID]' // migrationId + '<MIGRATION_ID>' // migrationId ); console.log(response); diff --git a/docs/examples/migrations/get-appwrite-report.md b/docs/examples/migrations/get-appwrite-report.md index 8e6fa65..82313bc 100644 --- a/docs/examples/migrations/get-appwrite-report.md +++ b/docs/examples/migrations/get-appwrite-report.md @@ -9,8 +9,8 @@ const migrations = new Migrations(client); const result = await migrations.getAppwriteReport( [], // resources 'https://example.com', // endpoint - '[PROJECT_ID]', // projectID - '[KEY]' // key + '<PROJECT_ID>', // projectID + '<KEY>' // key ); console.log(response); diff --git a/docs/examples/migrations/get-firebase-report-o-auth.md b/docs/examples/migrations/get-firebase-report-o-auth.md index d1779ba..634f2f0 100644 --- a/docs/examples/migrations/get-firebase-report-o-auth.md +++ b/docs/examples/migrations/get-firebase-report-o-auth.md @@ -8,7 +8,7 @@ const migrations = new Migrations(client); const result = await migrations.getFirebaseReportOAuth( [], // resources - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/migrations/get-firebase-report.md b/docs/examples/migrations/get-firebase-report.md index ea4f7c7..1d9ebaa 100644 --- a/docs/examples/migrations/get-firebase-report.md +++ b/docs/examples/migrations/get-firebase-report.md @@ -8,7 +8,7 @@ const migrations = new Migrations(client); const result = await migrations.getFirebaseReport( [], // resources - '[SERVICE_ACCOUNT]' // serviceAccount + '<SERVICE_ACCOUNT>' // serviceAccount ); console.log(response); diff --git a/docs/examples/migrations/get-n-host-report.md b/docs/examples/migrations/get-n-host-report.md index e904950..7d66870 100644 --- a/docs/examples/migrations/get-n-host-report.md +++ b/docs/examples/migrations/get-n-host-report.md @@ -8,12 +8,12 @@ const migrations = new Migrations(client); const result = await migrations.getNHostReport( [], // resources - '[SUBDOMAIN]', // subdomain - '[REGION]', // region - '[ADMIN_SECRET]', // adminSecret - '[DATABASE]', // database - '[USERNAME]', // username - '[PASSWORD]', // password + '<SUBDOMAIN>', // subdomain + '<REGION>', // region + '<ADMIN_SECRET>', // adminSecret + '<DATABASE>', // database + '<USERNAME>', // username + '<PASSWORD>', // password null // port (optional) ); diff --git a/docs/examples/migrations/get-supabase-report.md b/docs/examples/migrations/get-supabase-report.md index c390227..4a5e1a9 100644 --- a/docs/examples/migrations/get-supabase-report.md +++ b/docs/examples/migrations/get-supabase-report.md @@ -9,10 +9,10 @@ const migrations = new Migrations(client); const result = await migrations.getSupabaseReport( [], // resources 'https://example.com', // endpoint - '[API_KEY]', // apiKey - '[DATABASE_HOST]', // databaseHost - '[USERNAME]', // username - '[PASSWORD]', // password + '<API_KEY>', // apiKey + '<DATABASE_HOST>', // databaseHost + '<USERNAME>', // username + '<PASSWORD>', // password null // port (optional) ); diff --git a/docs/examples/migrations/get.md b/docs/examples/migrations/get.md index 8cfc284..4c1f5d3 100644 --- a/docs/examples/migrations/get.md +++ b/docs/examples/migrations/get.md @@ -7,7 +7,7 @@ const client = new Client() const migrations = new Migrations(client); const result = await migrations.get( - '[MIGRATION_ID]' // migrationId + '<MIGRATION_ID>' // migrationId ); console.log(response); diff --git a/docs/examples/migrations/list.md b/docs/examples/migrations/list.md index c8cdd5b..65c2c18 100644 --- a/docs/examples/migrations/list.md +++ b/docs/examples/migrations/list.md @@ -8,7 +8,7 @@ const migrations = new Migrations(client); const result = await migrations.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/migrations/retry.md b/docs/examples/migrations/retry.md index 3c092d9..110e600 100644 --- a/docs/examples/migrations/retry.md +++ b/docs/examples/migrations/retry.md @@ -7,7 +7,7 @@ const client = new Client() const migrations = new Migrations(client); const result = await migrations.retry( - '[MIGRATION_ID]' // migrationId + '<MIGRATION_ID>' // migrationId ); console.log(response); diff --git a/docs/examples/project/create-variable.md b/docs/examples/project/create-variable.md index e56846e..d9efb5e 100644 --- a/docs/examples/project/create-variable.md +++ b/docs/examples/project/create-variable.md @@ -7,8 +7,8 @@ const client = new Client() const project = new Project(client); const result = await project.createVariable( - '[KEY]', // key - '[VALUE]' // value + '<KEY>', // key + '<VALUE>' // value ); console.log(response); diff --git a/docs/examples/project/delete-variable.md b/docs/examples/project/delete-variable.md index 82490bb..657520f 100644 --- a/docs/examples/project/delete-variable.md +++ b/docs/examples/project/delete-variable.md @@ -7,7 +7,7 @@ const client = new Client() const project = new Project(client); const result = await project.deleteVariable( - '[VARIABLE_ID]' // variableId + '<VARIABLE_ID>' // variableId ); console.log(response); diff --git a/docs/examples/project/get-variable.md b/docs/examples/project/get-variable.md index 208e0ea..f7cb802 100644 --- a/docs/examples/project/get-variable.md +++ b/docs/examples/project/get-variable.md @@ -7,7 +7,7 @@ const client = new Client() const project = new Project(client); const result = await project.getVariable( - '[VARIABLE_ID]' // variableId + '<VARIABLE_ID>' // variableId ); console.log(response); diff --git a/docs/examples/project/update-variable.md b/docs/examples/project/update-variable.md index 033efbb..532fbdc 100644 --- a/docs/examples/project/update-variable.md +++ b/docs/examples/project/update-variable.md @@ -7,9 +7,9 @@ const client = new Client() const project = new Project(client); const result = await project.updateVariable( - '[VARIABLE_ID]', // variableId - '[KEY]', // key - '[VALUE]' // value (optional) + '<VARIABLE_ID>', // variableId + '<KEY>', // key + '<VALUE>' // value (optional) ); console.log(response); diff --git a/docs/examples/projects/create-key.md b/docs/examples/projects/create-key.md index 955f9ba..29f9258 100644 --- a/docs/examples/projects/create-key.md +++ b/docs/examples/projects/create-key.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.createKey( - '[PROJECT_ID]', // projectId - '[NAME]', // name + '<PROJECT_ID>', // projectId + '<NAME>', // name [], // scopes '' // expire (optional) ); diff --git a/docs/examples/projects/create-platform.md b/docs/examples/projects/create-platform.md index f552f2f..e8ad4f8 100644 --- a/docs/examples/projects/create-platform.md +++ b/docs/examples/projects/create-platform.md @@ -7,11 +7,11 @@ const client = new Client() const projects = new Projects(client); const result = await projects.createPlatform( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId PlatformType.Web, // type - '[NAME]', // name - '[KEY]', // key (optional) - '[STORE]', // store (optional) + '<NAME>', // name + '<KEY>', // key (optional) + '<STORE>', // store (optional) '' // hostname (optional) ); diff --git a/docs/examples/projects/create-smtp-test.md b/docs/examples/projects/create-smtp-test.md index d1df8b5..dab2e5e 100644 --- a/docs/examples/projects/create-smtp-test.md +++ b/docs/examples/projects/create-smtp-test.md @@ -7,15 +7,15 @@ const client = new Client() const projects = new Projects(client); const result = await projects.createSmtpTest( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId [], // emails - '[SENDER_NAME]', // senderName + '<SENDER_NAME>', // senderName 'email@example.com', // senderEmail '', // host 'email@example.com', // replyTo (optional) null, // port (optional) - '[USERNAME]', // username (optional) - '[PASSWORD]', // password (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) SMTPSecure.Tls // secure (optional) ); diff --git a/docs/examples/projects/create-webhook.md b/docs/examples/projects/create-webhook.md index 0595300..8dec04c 100644 --- a/docs/examples/projects/create-webhook.md +++ b/docs/examples/projects/create-webhook.md @@ -7,14 +7,14 @@ const client = new Client() const projects = new Projects(client); const result = await projects.createWebhook( - '[PROJECT_ID]', // projectId - '[NAME]', // name + '<PROJECT_ID>', // projectId + '<NAME>', // name [], // events '', // url false, // security false, // enabled (optional) - '[HTTP_USER]', // httpUser (optional) - '[HTTP_PASS]' // httpPass (optional) + '<HTTP_USER>', // httpUser (optional) + '<HTTP_PASS>' // httpPass (optional) ); console.log(response); diff --git a/docs/examples/projects/create.md b/docs/examples/projects/create.md index d9b0f88..b008f9b 100644 --- a/docs/examples/projects/create.md +++ b/docs/examples/projects/create.md @@ -8,18 +8,18 @@ const projects = new Projects(client); const result = await projects.create( '', // projectId - '[NAME]', // name - '[TEAM_ID]', // teamId + '<NAME>', // name + '<TEAM_ID>', // teamId .Default, // region (optional) - '[DESCRIPTION]', // description (optional) - '[LOGO]', // logo (optional) + '<DESCRIPTION>', // description (optional) + '<LOGO>', // logo (optional) 'https://example.com', // url (optional) - '[LEGAL_NAME]', // legalName (optional) - '[LEGAL_COUNTRY]', // legalCountry (optional) - '[LEGAL_STATE]', // legalState (optional) - '[LEGAL_CITY]', // legalCity (optional) - '[LEGAL_ADDRESS]', // legalAddress (optional) - '[LEGAL_TAX_ID]' // legalTaxId (optional) + '<LEGAL_NAME>', // legalName (optional) + '<LEGAL_COUNTRY>', // legalCountry (optional) + '<LEGAL_STATE>', // legalState (optional) + '<LEGAL_CITY>', // legalCity (optional) + '<LEGAL_ADDRESS>', // legalAddress (optional) + '<LEGAL_TAX_ID>' // legalTaxId (optional) ); console.log(response); diff --git a/docs/examples/projects/delete-email-template.md b/docs/examples/projects/delete-email-template.md index 2a3cae3..13a384c 100644 --- a/docs/examples/projects/delete-email-template.md +++ b/docs/examples/projects/delete-email-template.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.deleteEmailTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId EmailTemplateType.Verification, // type EmailTemplateLocale.Af // locale ); diff --git a/docs/examples/projects/delete-key.md b/docs/examples/projects/delete-key.md index 797063a..c1ac0a7 100644 --- a/docs/examples/projects/delete-key.md +++ b/docs/examples/projects/delete-key.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.deleteKey( - '[PROJECT_ID]', // projectId - '[KEY_ID]' // keyId + '<PROJECT_ID>', // projectId + '<KEY_ID>' // keyId ); console.log(response); diff --git a/docs/examples/projects/delete-platform.md b/docs/examples/projects/delete-platform.md index 1e75a9c..28e1109 100644 --- a/docs/examples/projects/delete-platform.md +++ b/docs/examples/projects/delete-platform.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.deletePlatform( - '[PROJECT_ID]', // projectId - '[PLATFORM_ID]' // platformId + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>' // platformId ); console.log(response); diff --git a/docs/examples/projects/delete-sms-template.md b/docs/examples/projects/delete-sms-template.md index 7bf1747..281384c 100644 --- a/docs/examples/projects/delete-sms-template.md +++ b/docs/examples/projects/delete-sms-template.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.deleteSmsTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId SmsTemplateType.Verification, // type SmsTemplateLocale.Af // locale ); diff --git a/docs/examples/projects/delete-webhook.md b/docs/examples/projects/delete-webhook.md index ad29516..f61268b 100644 --- a/docs/examples/projects/delete-webhook.md +++ b/docs/examples/projects/delete-webhook.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.deleteWebhook( - '[PROJECT_ID]', // projectId - '[WEBHOOK_ID]' // webhookId + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId ); console.log(response); diff --git a/docs/examples/projects/delete.md b/docs/examples/projects/delete.md index e888c6f..abcdb64 100644 --- a/docs/examples/projects/delete.md +++ b/docs/examples/projects/delete.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.delete( - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/projects/get-email-template.md b/docs/examples/projects/get-email-template.md index 6ddb9bc..177291a 100644 --- a/docs/examples/projects/get-email-template.md +++ b/docs/examples/projects/get-email-template.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.getEmailTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId EmailTemplateType.Verification, // type EmailTemplateLocale.Af // locale ); diff --git a/docs/examples/projects/get-key.md b/docs/examples/projects/get-key.md index 84faed6..ef5c30b 100644 --- a/docs/examples/projects/get-key.md +++ b/docs/examples/projects/get-key.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.getKey( - '[PROJECT_ID]', // projectId - '[KEY_ID]' // keyId + '<PROJECT_ID>', // projectId + '<KEY_ID>' // keyId ); console.log(response); diff --git a/docs/examples/projects/get-platform.md b/docs/examples/projects/get-platform.md index 2fadafc..e79319c 100644 --- a/docs/examples/projects/get-platform.md +++ b/docs/examples/projects/get-platform.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.getPlatform( - '[PROJECT_ID]', // projectId - '[PLATFORM_ID]' // platformId + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>' // platformId ); console.log(response); diff --git a/docs/examples/projects/get-sms-template.md b/docs/examples/projects/get-sms-template.md index d0031a5..8d28308 100644 --- a/docs/examples/projects/get-sms-template.md +++ b/docs/examples/projects/get-sms-template.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.getSmsTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId SmsTemplateType.Verification, // type SmsTemplateLocale.Af // locale ); diff --git a/docs/examples/projects/get-webhook.md b/docs/examples/projects/get-webhook.md index 14be8be..70ffb98 100644 --- a/docs/examples/projects/get-webhook.md +++ b/docs/examples/projects/get-webhook.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.getWebhook( - '[PROJECT_ID]', // projectId - '[WEBHOOK_ID]' // webhookId + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId ); console.log(response); diff --git a/docs/examples/projects/get.md b/docs/examples/projects/get.md index 66d0cb5..5efff32 100644 --- a/docs/examples/projects/get.md +++ b/docs/examples/projects/get.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.get( - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/projects/list-keys.md b/docs/examples/projects/list-keys.md index 1ee961e..2a2ce19 100644 --- a/docs/examples/projects/list-keys.md +++ b/docs/examples/projects/list-keys.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.listKeys( - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/projects/list-platforms.md b/docs/examples/projects/list-platforms.md index 8984498..884a712 100644 --- a/docs/examples/projects/list-platforms.md +++ b/docs/examples/projects/list-platforms.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.listPlatforms( - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/projects/list-webhooks.md b/docs/examples/projects/list-webhooks.md index 1229540..e060f4d 100644 --- a/docs/examples/projects/list-webhooks.md +++ b/docs/examples/projects/list-webhooks.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.listWebhooks( - '[PROJECT_ID]' // projectId + '<PROJECT_ID>' // projectId ); console.log(response); diff --git a/docs/examples/projects/list.md b/docs/examples/projects/list.md index e5a8ba5..51e65ac 100644 --- a/docs/examples/projects/list.md +++ b/docs/examples/projects/list.md @@ -8,7 +8,7 @@ const projects = new Projects(client); const result = await projects.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/projects/update-auth-duration.md b/docs/examples/projects/update-auth-duration.md index 9b9cfc8..a46001a 100644 --- a/docs/examples/projects/update-auth-duration.md +++ b/docs/examples/projects/update-auth-duration.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthDuration( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId 0 // duration ); diff --git a/docs/examples/projects/update-auth-limit.md b/docs/examples/projects/update-auth-limit.md index b2c5dc3..12b444a 100644 --- a/docs/examples/projects/update-auth-limit.md +++ b/docs/examples/projects/update-auth-limit.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthLimit( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId 0 // limit ); diff --git a/docs/examples/projects/update-auth-password-dictionary.md b/docs/examples/projects/update-auth-password-dictionary.md index 8632a2a..8510cfe 100644 --- a/docs/examples/projects/update-auth-password-dictionary.md +++ b/docs/examples/projects/update-auth-password-dictionary.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthPasswordDictionary( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId false // enabled ); diff --git a/docs/examples/projects/update-auth-password-history.md b/docs/examples/projects/update-auth-password-history.md index e915215..acf2c46 100644 --- a/docs/examples/projects/update-auth-password-history.md +++ b/docs/examples/projects/update-auth-password-history.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthPasswordHistory( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId 0 // limit ); diff --git a/docs/examples/projects/update-auth-sessions-limit.md b/docs/examples/projects/update-auth-sessions-limit.md index ea810ab..a47267a 100644 --- a/docs/examples/projects/update-auth-sessions-limit.md +++ b/docs/examples/projects/update-auth-sessions-limit.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthSessionsLimit( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId 1 // limit ); diff --git a/docs/examples/projects/update-auth-status.md b/docs/examples/projects/update-auth-status.md index 69f0cf9..1f4d397 100644 --- a/docs/examples/projects/update-auth-status.md +++ b/docs/examples/projects/update-auth-status.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateAuthStatus( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId AuthMethod.EmailPassword, // method false // status ); diff --git a/docs/examples/projects/update-email-template.md b/docs/examples/projects/update-email-template.md index 92cc1f7..5b16b95 100644 --- a/docs/examples/projects/update-email-template.md +++ b/docs/examples/projects/update-email-template.md @@ -7,12 +7,12 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateEmailTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId EmailTemplateType.Verification, // type EmailTemplateLocale.Af, // locale - '[SUBJECT]', // subject - '[MESSAGE]', // message - '[SENDER_NAME]', // senderName (optional) + '<SUBJECT>', // subject + '<MESSAGE>', // message + '<SENDER_NAME>', // senderName (optional) 'email@example.com', // senderEmail (optional) 'email@example.com' // replyTo (optional) ); diff --git a/docs/examples/projects/update-key.md b/docs/examples/projects/update-key.md index f70887c..1a17ac8 100644 --- a/docs/examples/projects/update-key.md +++ b/docs/examples/projects/update-key.md @@ -7,9 +7,9 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateKey( - '[PROJECT_ID]', // projectId - '[KEY_ID]', // keyId - '[NAME]', // name + '<PROJECT_ID>', // projectId + '<KEY_ID>', // keyId + '<NAME>', // name [], // scopes '' // expire (optional) ); diff --git a/docs/examples/projects/update-o-auth2.md b/docs/examples/projects/update-o-auth2.md index 6f6364f..6e2ff1c 100644 --- a/docs/examples/projects/update-o-auth2.md +++ b/docs/examples/projects/update-o-auth2.md @@ -7,10 +7,10 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateOAuth2( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId OAuthProvider.Amazon, // provider - '[APP_ID]', // appId (optional) - '[SECRET]', // secret (optional) + '<APP_ID>', // appId (optional) + '<SECRET>', // secret (optional) false // enabled (optional) ); diff --git a/docs/examples/projects/update-personal-data-check.md b/docs/examples/projects/update-personal-data-check.md index d9a9cc1..b597bc0 100644 --- a/docs/examples/projects/update-personal-data-check.md +++ b/docs/examples/projects/update-personal-data-check.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updatePersonalDataCheck( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId false // enabled ); diff --git a/docs/examples/projects/update-platform.md b/docs/examples/projects/update-platform.md index 8908b0f..3bb24ac 100644 --- a/docs/examples/projects/update-platform.md +++ b/docs/examples/projects/update-platform.md @@ -7,11 +7,11 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updatePlatform( - '[PROJECT_ID]', // projectId - '[PLATFORM_ID]', // platformId - '[NAME]', // name - '[KEY]', // key (optional) - '[STORE]', // store (optional) + '<PROJECT_ID>', // projectId + '<PLATFORM_ID>', // platformId + '<NAME>', // name + '<KEY>', // key (optional) + '<STORE>', // store (optional) '' // hostname (optional) ); diff --git a/docs/examples/projects/update-service-status-all.md b/docs/examples/projects/update-service-status-all.md index 0cc5f35..17ac72e 100644 --- a/docs/examples/projects/update-service-status-all.md +++ b/docs/examples/projects/update-service-status-all.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateServiceStatusAll( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId false // status ); diff --git a/docs/examples/projects/update-service-status.md b/docs/examples/projects/update-service-status.md index d576142..cffa955 100644 --- a/docs/examples/projects/update-service-status.md +++ b/docs/examples/projects/update-service-status.md @@ -7,7 +7,7 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateServiceStatus( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId ApiService.Account, // service false // status ); diff --git a/docs/examples/projects/update-sms-template.md b/docs/examples/projects/update-sms-template.md index 6a01fa6..1d35691 100644 --- a/docs/examples/projects/update-sms-template.md +++ b/docs/examples/projects/update-sms-template.md @@ -7,10 +7,10 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateSmsTemplate( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId SmsTemplateType.Verification, // type SmsTemplateLocale.Af, // locale - '[MESSAGE]' // message + '<MESSAGE>' // message ); console.log(response); diff --git a/docs/examples/projects/update-smtp.md b/docs/examples/projects/update-smtp.md index b39f363..91c5d57 100644 --- a/docs/examples/projects/update-smtp.md +++ b/docs/examples/projects/update-smtp.md @@ -7,15 +7,15 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateSmtp( - '[PROJECT_ID]', // projectId + '<PROJECT_ID>', // projectId false, // enabled - '[SENDER_NAME]', // senderName (optional) + '<SENDER_NAME>', // senderName (optional) 'email@example.com', // senderEmail (optional) 'email@example.com', // replyTo (optional) '', // host (optional) null, // port (optional) - '[USERNAME]', // username (optional) - '[PASSWORD]', // password (optional) + '<USERNAME>', // username (optional) + '<PASSWORD>', // password (optional) SMTPSecure.Tls // secure (optional) ); diff --git a/docs/examples/projects/update-team.md b/docs/examples/projects/update-team.md index a8aa0bc..416ccfd 100644 --- a/docs/examples/projects/update-team.md +++ b/docs/examples/projects/update-team.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateTeam( - '[PROJECT_ID]', // projectId - '[TEAM_ID]' // teamId + '<PROJECT_ID>', // projectId + '<TEAM_ID>' // teamId ); console.log(response); diff --git a/docs/examples/projects/update-webhook-signature.md b/docs/examples/projects/update-webhook-signature.md index a0cce99..8c83e15 100644 --- a/docs/examples/projects/update-webhook-signature.md +++ b/docs/examples/projects/update-webhook-signature.md @@ -7,8 +7,8 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateWebhookSignature( - '[PROJECT_ID]', // projectId - '[WEBHOOK_ID]' // webhookId + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>' // webhookId ); console.log(response); diff --git a/docs/examples/projects/update-webhook.md b/docs/examples/projects/update-webhook.md index 81bf514..eccb7a6 100644 --- a/docs/examples/projects/update-webhook.md +++ b/docs/examples/projects/update-webhook.md @@ -7,15 +7,15 @@ const client = new Client() const projects = new Projects(client); const result = await projects.updateWebhook( - '[PROJECT_ID]', // projectId - '[WEBHOOK_ID]', // webhookId - '[NAME]', // name + '<PROJECT_ID>', // projectId + '<WEBHOOK_ID>', // webhookId + '<NAME>', // name [], // events '', // url false, // security false, // enabled (optional) - '[HTTP_USER]', // httpUser (optional) - '[HTTP_PASS]' // httpPass (optional) + '<HTTP_USER>', // httpUser (optional) + '<HTTP_PASS>' // httpPass (optional) ); console.log(response); diff --git a/docs/examples/projects/update.md b/docs/examples/projects/update.md index 8520b7b..f77fdb2 100644 --- a/docs/examples/projects/update.md +++ b/docs/examples/projects/update.md @@ -7,17 +7,17 @@ const client = new Client() const projects = new Projects(client); const result = await projects.update( - '[PROJECT_ID]', // projectId - '[NAME]', // name - '[DESCRIPTION]', // description (optional) - '[LOGO]', // logo (optional) + '<PROJECT_ID>', // projectId + '<NAME>', // name + '<DESCRIPTION>', // description (optional) + '<LOGO>', // logo (optional) 'https://example.com', // url (optional) - '[LEGAL_NAME]', // legalName (optional) - '[LEGAL_COUNTRY]', // legalCountry (optional) - '[LEGAL_STATE]', // legalState (optional) - '[LEGAL_CITY]', // legalCity (optional) - '[LEGAL_ADDRESS]', // legalAddress (optional) - '[LEGAL_TAX_ID]' // legalTaxId (optional) + '<LEGAL_NAME>', // legalName (optional) + '<LEGAL_COUNTRY>', // legalCountry (optional) + '<LEGAL_STATE>', // legalState (optional) + '<LEGAL_CITY>', // legalCity (optional) + '<LEGAL_ADDRESS>', // legalAddress (optional) + '<LEGAL_TAX_ID>' // legalTaxId (optional) ); console.log(response); diff --git a/docs/examples/proxy/create-rule.md b/docs/examples/proxy/create-rule.md index 6933c12..69b7396 100644 --- a/docs/examples/proxy/create-rule.md +++ b/docs/examples/proxy/create-rule.md @@ -9,7 +9,7 @@ const proxy = new Proxy(client); const result = await proxy.createRule( '', // domain .Api, // resourceType - '[RESOURCE_ID]' // resourceId (optional) + '<RESOURCE_ID>' // resourceId (optional) ); console.log(response); diff --git a/docs/examples/proxy/delete-rule.md b/docs/examples/proxy/delete-rule.md index e9d50a4..6db415e 100644 --- a/docs/examples/proxy/delete-rule.md +++ b/docs/examples/proxy/delete-rule.md @@ -7,7 +7,7 @@ const client = new Client() const proxy = new Proxy(client); const result = await proxy.deleteRule( - '[RULE_ID]' // ruleId + '<RULE_ID>' // ruleId ); console.log(response); diff --git a/docs/examples/proxy/get-rule.md b/docs/examples/proxy/get-rule.md index 96b3da3..41dfcb1 100644 --- a/docs/examples/proxy/get-rule.md +++ b/docs/examples/proxy/get-rule.md @@ -7,7 +7,7 @@ const client = new Client() const proxy = new Proxy(client); const result = await proxy.getRule( - '[RULE_ID]' // ruleId + '<RULE_ID>' // ruleId ); console.log(response); diff --git a/docs/examples/proxy/list-rules.md b/docs/examples/proxy/list-rules.md index d74ea26..3497504 100644 --- a/docs/examples/proxy/list-rules.md +++ b/docs/examples/proxy/list-rules.md @@ -8,7 +8,7 @@ const proxy = new Proxy(client); const result = await proxy.listRules( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/proxy/update-rule-verification.md b/docs/examples/proxy/update-rule-verification.md index 966c641..480053b 100644 --- a/docs/examples/proxy/update-rule-verification.md +++ b/docs/examples/proxy/update-rule-verification.md @@ -7,7 +7,7 @@ const client = new Client() const proxy = new Proxy(client); const result = await proxy.updateRuleVerification( - '[RULE_ID]' // ruleId + '<RULE_ID>' // ruleId ); console.log(response); diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md index d9d05fa..3967160 100644 --- a/docs/examples/storage/create-bucket.md +++ b/docs/examples/storage/create-bucket.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = await storage.createBucket( - '[BUCKET_ID]', // bucketId - '[NAME]', // name + '<BUCKET_ID>', // bucketId + '<NAME>', // name ["read("any")"], // permissions (optional) false, // fileSecurity (optional) false, // enabled (optional) diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md index 00bae8b..639676f 100644 --- a/docs/examples/storage/create-file.md +++ b/docs/examples/storage/create-file.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = await storage.createFile( - '[BUCKET_ID]', // bucketId - '[FILE_ID]', // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId document.getElementById('uploader').files[0], // file ["read("any")"] // permissions (optional) ); diff --git a/docs/examples/storage/delete-bucket.md b/docs/examples/storage/delete-bucket.md index 598d627..0a924a6 100644 --- a/docs/examples/storage/delete-bucket.md +++ b/docs/examples/storage/delete-bucket.md @@ -7,7 +7,7 @@ const client = new Client() const storage = new Storage(client); const result = await storage.deleteBucket( - '[BUCKET_ID]' // bucketId + '<BUCKET_ID>' // bucketId ); console.log(response); diff --git a/docs/examples/storage/delete-file.md b/docs/examples/storage/delete-file.md index b61d84d..00ffd6e 100644 --- a/docs/examples/storage/delete-file.md +++ b/docs/examples/storage/delete-file.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = await storage.deleteFile( - '[BUCKET_ID]', // bucketId - '[FILE_ID]' // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId ); console.log(response); diff --git a/docs/examples/storage/get-bucket-usage.md b/docs/examples/storage/get-bucket-usage.md index c696205..2511bbc 100644 --- a/docs/examples/storage/get-bucket-usage.md +++ b/docs/examples/storage/get-bucket-usage.md @@ -7,7 +7,7 @@ const client = new Client() const storage = new Storage(client); const result = await storage.getBucketUsage( - '[BUCKET_ID]', // bucketId + '<BUCKET_ID>', // bucketId StorageUsageRange.TwentyFourHours // range (optional) ); diff --git a/docs/examples/storage/get-bucket.md b/docs/examples/storage/get-bucket.md index ab79993..669d974 100644 --- a/docs/examples/storage/get-bucket.md +++ b/docs/examples/storage/get-bucket.md @@ -7,7 +7,7 @@ const client = new Client() const storage = new Storage(client); const result = await storage.getBucket( - '[BUCKET_ID]' // bucketId + '<BUCKET_ID>' // bucketId ); console.log(response); diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index 5b34830..2d9ca0b 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = storage.getFileDownload( - '[BUCKET_ID]', // bucketId - '[FILE_ID]' // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId ); console.log(result); diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index f1ea3d4..e63beb9 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = storage.getFilePreview( - '[BUCKET_ID]', // bucketId - '[FILE_ID]', // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId 0, // width (optional) 0, // height (optional) ImageGravity.Center, // gravity (optional) diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md index dc6c5f4..fe46fd5 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = storage.getFileView( - '[BUCKET_ID]', // bucketId - '[FILE_ID]' // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId ); console.log(result); diff --git a/docs/examples/storage/get-file.md b/docs/examples/storage/get-file.md index bdeb8a8..e901709 100644 --- a/docs/examples/storage/get-file.md +++ b/docs/examples/storage/get-file.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = await storage.getFile( - '[BUCKET_ID]', // bucketId - '[FILE_ID]' // fileId + '<BUCKET_ID>', // bucketId + '<FILE_ID>' // fileId ); console.log(response); diff --git a/docs/examples/storage/list-buckets.md b/docs/examples/storage/list-buckets.md index d2858be..a5b8c01 100644 --- a/docs/examples/storage/list-buckets.md +++ b/docs/examples/storage/list-buckets.md @@ -8,7 +8,7 @@ const storage = new Storage(client); const result = await storage.listBuckets( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md index 951aaed..db6aaf8 100644 --- a/docs/examples/storage/list-files.md +++ b/docs/examples/storage/list-files.md @@ -7,9 +7,9 @@ const client = new Client() const storage = new Storage(client); const result = await storage.listFiles( - '[BUCKET_ID]', // bucketId + '<BUCKET_ID>', // bucketId [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md index 940fb06..3561b37 100644 --- a/docs/examples/storage/update-bucket.md +++ b/docs/examples/storage/update-bucket.md @@ -7,8 +7,8 @@ const client = new Client() const storage = new Storage(client); const result = await storage.updateBucket( - '[BUCKET_ID]', // bucketId - '[NAME]', // name + '<BUCKET_ID>', // bucketId + '<NAME>', // name ["read("any")"], // permissions (optional) false, // fileSecurity (optional) false, // enabled (optional) diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md index 47c9d6e..759adae 100644 --- a/docs/examples/storage/update-file.md +++ b/docs/examples/storage/update-file.md @@ -7,9 +7,9 @@ const client = new Client() const storage = new Storage(client); const result = await storage.updateFile( - '[BUCKET_ID]', // bucketId - '[FILE_ID]', // fileId - '[NAME]', // name (optional) + '<BUCKET_ID>', // bucketId + '<FILE_ID>', // fileId + '<NAME>', // name (optional) ["read("any")"] // permissions (optional) ); diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md index 23a8456..6988e39 100644 --- a/docs/examples/teams/create-membership.md +++ b/docs/examples/teams/create-membership.md @@ -7,13 +7,13 @@ const client = new Client() const teams = new Teams(client); const result = await teams.createMembership( - '[TEAM_ID]', // teamId + '<TEAM_ID>', // teamId [], // roles 'email@example.com', // email (optional) - '[USER_ID]', // userId (optional) + '<USER_ID>', // userId (optional) '+12065550100', // phone (optional) 'https://example.com', // url (optional) - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md index a0d5bfa..b9c4be1 100644 --- a/docs/examples/teams/create.md +++ b/docs/examples/teams/create.md @@ -7,8 +7,8 @@ const client = new Client() const teams = new Teams(client); const result = await teams.create( - '[TEAM_ID]', // teamId - '[NAME]', // name + '<TEAM_ID>', // teamId + '<NAME>', // name [] // roles (optional) ); diff --git a/docs/examples/teams/delete-membership.md b/docs/examples/teams/delete-membership.md index 1ecbc2d..afe0791 100644 --- a/docs/examples/teams/delete-membership.md +++ b/docs/examples/teams/delete-membership.md @@ -7,8 +7,8 @@ const client = new Client() const teams = new Teams(client); const result = await teams.deleteMembership( - '[TEAM_ID]', // teamId - '[MEMBERSHIP_ID]' // membershipId + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId ); console.log(response); diff --git a/docs/examples/teams/delete.md b/docs/examples/teams/delete.md index 40e81ab..8e02cdd 100644 --- a/docs/examples/teams/delete.md +++ b/docs/examples/teams/delete.md @@ -7,7 +7,7 @@ const client = new Client() const teams = new Teams(client); const result = await teams.delete( - '[TEAM_ID]' // teamId + '<TEAM_ID>' // teamId ); console.log(response); diff --git a/docs/examples/teams/get-membership.md b/docs/examples/teams/get-membership.md index ab5ef4d..cf9117c 100644 --- a/docs/examples/teams/get-membership.md +++ b/docs/examples/teams/get-membership.md @@ -7,8 +7,8 @@ const client = new Client() const teams = new Teams(client); const result = await teams.getMembership( - '[TEAM_ID]', // teamId - '[MEMBERSHIP_ID]' // membershipId + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>' // membershipId ); console.log(response); diff --git a/docs/examples/teams/get-prefs.md b/docs/examples/teams/get-prefs.md index 787ea8a..bb79b37 100644 --- a/docs/examples/teams/get-prefs.md +++ b/docs/examples/teams/get-prefs.md @@ -7,7 +7,7 @@ const client = new Client() const teams = new Teams(client); const result = await teams.getPrefs( - '[TEAM_ID]' // teamId + '<TEAM_ID>' // teamId ); console.log(response); diff --git a/docs/examples/teams/get.md b/docs/examples/teams/get.md index 928d7ff..1d629a8 100644 --- a/docs/examples/teams/get.md +++ b/docs/examples/teams/get.md @@ -7,7 +7,7 @@ const client = new Client() const teams = new Teams(client); const result = await teams.get( - '[TEAM_ID]' // teamId + '<TEAM_ID>' // teamId ); console.log(response); diff --git a/docs/examples/teams/list-logs.md b/docs/examples/teams/list-logs.md index d51c9d0..51d0855 100644 --- a/docs/examples/teams/list-logs.md +++ b/docs/examples/teams/list-logs.md @@ -7,7 +7,7 @@ const client = new Client() const teams = new Teams(client); const result = await teams.listLogs( - '[TEAM_ID]', // teamId + '<TEAM_ID>', // teamId [] // queries (optional) ); diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md index 5414859..dfb8dfd 100644 --- a/docs/examples/teams/list-memberships.md +++ b/docs/examples/teams/list-memberships.md @@ -7,9 +7,9 @@ const client = new Client() const teams = new Teams(client); const result = await teams.listMemberships( - '[TEAM_ID]', // teamId + '<TEAM_ID>', // teamId [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md index b0c37ce..3b2aea9 100644 --- a/docs/examples/teams/list.md +++ b/docs/examples/teams/list.md @@ -8,7 +8,7 @@ const teams = new Teams(client); const result = await teams.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/teams/update-membership-status.md b/docs/examples/teams/update-membership-status.md index c6d2326..ec9f36e 100644 --- a/docs/examples/teams/update-membership-status.md +++ b/docs/examples/teams/update-membership-status.md @@ -7,10 +7,10 @@ const client = new Client() const teams = new Teams(client); const result = await teams.updateMembershipStatus( - '[TEAM_ID]', // teamId - '[MEMBERSHIP_ID]', // membershipId - '[USER_ID]', // userId - '[SECRET]' // secret + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId + '<USER_ID>', // userId + '<SECRET>' // secret ); console.log(response); diff --git a/docs/examples/teams/update-membership.md b/docs/examples/teams/update-membership.md index 4052789..35df0fb 100644 --- a/docs/examples/teams/update-membership.md +++ b/docs/examples/teams/update-membership.md @@ -7,8 +7,8 @@ const client = new Client() const teams = new Teams(client); const result = await teams.updateMembership( - '[TEAM_ID]', // teamId - '[MEMBERSHIP_ID]', // membershipId + '<TEAM_ID>', // teamId + '<MEMBERSHIP_ID>', // membershipId [] // roles ); diff --git a/docs/examples/teams/update-name.md b/docs/examples/teams/update-name.md index 500d727..3cfcec1 100644 --- a/docs/examples/teams/update-name.md +++ b/docs/examples/teams/update-name.md @@ -7,8 +7,8 @@ const client = new Client() const teams = new Teams(client); const result = await teams.updateName( - '[TEAM_ID]', // teamId - '[NAME]' // name + '<TEAM_ID>', // teamId + '<NAME>' // name ); console.log(response); diff --git a/docs/examples/teams/update-prefs.md b/docs/examples/teams/update-prefs.md index a185eca..42689cd 100644 --- a/docs/examples/teams/update-prefs.md +++ b/docs/examples/teams/update-prefs.md @@ -7,7 +7,7 @@ const client = new Client() const teams = new Teams(client); const result = await teams.updatePrefs( - '[TEAM_ID]', // teamId + '<TEAM_ID>', // teamId {} // prefs ); diff --git a/docs/examples/users/create-argon2user.md b/docs/examples/users/create-argon2user.md index 8d3644a..93d7ef2 100644 --- a/docs/examples/users/create-argon2user.md +++ b/docs/examples/users/create-argon2user.md @@ -7,10 +7,10 @@ const client = new Client() const users = new Users(client); const result = await users.createArgon2User( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-bcrypt-user.md b/docs/examples/users/create-bcrypt-user.md index 0828efb..d063174 100644 --- a/docs/examples/users/create-bcrypt-user.md +++ b/docs/examples/users/create-bcrypt-user.md @@ -7,10 +7,10 @@ const client = new Client() const users = new Users(client); const result = await users.createBcryptUser( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-m-d5user.md b/docs/examples/users/create-m-d5user.md index 3139ccc..8bad78c 100644 --- a/docs/examples/users/create-m-d5user.md +++ b/docs/examples/users/create-m-d5user.md @@ -7,10 +7,10 @@ const client = new Client() const users = new Users(client); const result = await users.createMD5User( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-p-h-pass-user.md b/docs/examples/users/create-p-h-pass-user.md index 3416bd6..bb26fed 100644 --- a/docs/examples/users/create-p-h-pass-user.md +++ b/docs/examples/users/create-p-h-pass-user.md @@ -7,10 +7,10 @@ const client = new Client() const users = new Users(client); const result = await users.createPHPassUser( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-s-h-a-user.md b/docs/examples/users/create-s-h-a-user.md index 8440c14..4315928 100644 --- a/docs/examples/users/create-s-h-a-user.md +++ b/docs/examples/users/create-s-h-a-user.md @@ -7,11 +7,11 @@ const client = new Client() const users = new Users(client); const result = await users.createSHAUser( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password PasswordHash.Sha1, // passwordVersion (optional) - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-scrypt-modified-user.md b/docs/examples/users/create-scrypt-modified-user.md index 3aa538d..401eb4c 100644 --- a/docs/examples/users/create-scrypt-modified-user.md +++ b/docs/examples/users/create-scrypt-modified-user.md @@ -7,13 +7,13 @@ const client = new Client() const users = new Users(client); const result = await users.createScryptModifiedUser( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[PASSWORD_SALT]', // passwordSalt - '[PASSWORD_SALT_SEPARATOR]', // passwordSaltSeparator - '[PASSWORD_SIGNER_KEY]', // passwordSignerKey - '[NAME]' // name (optional) + '<PASSWORD_SALT>', // passwordSalt + '<PASSWORD_SALT_SEPARATOR>', // passwordSaltSeparator + '<PASSWORD_SIGNER_KEY>', // passwordSignerKey + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-scrypt-user.md b/docs/examples/users/create-scrypt-user.md index 825564e..2efaaa8 100644 --- a/docs/examples/users/create-scrypt-user.md +++ b/docs/examples/users/create-scrypt-user.md @@ -7,15 +7,15 @@ const client = new Client() const users = new Users(client); const result = await users.createScryptUser( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email 'password', // password - '[PASSWORD_SALT]', // passwordSalt + '<PASSWORD_SALT>', // passwordSalt null, // passwordCpu null, // passwordMemory null, // passwordParallel null, // passwordLength - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-session.md b/docs/examples/users/create-session.md index be620bd..d64ce3b 100644 --- a/docs/examples/users/create-session.md +++ b/docs/examples/users/create-session.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.createSession( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/create-target.md b/docs/examples/users/create-target.md index 867d702..bcb047c 100644 --- a/docs/examples/users/create-target.md +++ b/docs/examples/users/create-target.md @@ -7,12 +7,12 @@ const client = new Client() const users = new Users(client); const result = await users.createTarget( - '[USER_ID]', // userId - '[TARGET_ID]', // targetId + '<USER_ID>', // userId + '<TARGET_ID>', // targetId MessagingProviderType.Email, // providerType - '[IDENTIFIER]', // identifier - '[PROVIDER_ID]', // providerId (optional) - '[NAME]' // name (optional) + '<IDENTIFIER>', // identifier + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/create-token.md b/docs/examples/users/create-token.md index 23d7efc..af25ba8 100644 --- a/docs/examples/users/create-token.md +++ b/docs/examples/users/create-token.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.createToken( - '[USER_ID]', // userId + '<USER_ID>', // userId 4, // length (optional) 60 // expire (optional) ); diff --git a/docs/examples/users/create.md b/docs/examples/users/create.md index 966c8bc..c83f8d0 100644 --- a/docs/examples/users/create.md +++ b/docs/examples/users/create.md @@ -7,11 +7,11 @@ const client = new Client() const users = new Users(client); const result = await users.create( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com', // email (optional) '+12065550100', // phone (optional) '', // password (optional) - '[NAME]' // name (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/users/delete-authenticator.md b/docs/examples/users/delete-authenticator.md index 38a276c..276c05a 100644 --- a/docs/examples/users/delete-authenticator.md +++ b/docs/examples/users/delete-authenticator.md @@ -7,9 +7,9 @@ const client = new Client() const users = new Users(client); const result = await users.deleteAuthenticator( - '[USER_ID]', // userId + '<USER_ID>', // userId AuthenticatorType.Totp, // type - '[OTP]' // otp + '<OTP>' // otp ); console.log(response); diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md index babe0ad..e6e9381 100644 --- a/docs/examples/users/delete-identity.md +++ b/docs/examples/users/delete-identity.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.deleteIdentity( - '[IDENTITY_ID]' // identityId + '<IDENTITY_ID>' // identityId ); console.log(response); diff --git a/docs/examples/users/delete-session.md b/docs/examples/users/delete-session.md index c59f328..89534bf 100644 --- a/docs/examples/users/delete-session.md +++ b/docs/examples/users/delete-session.md @@ -7,8 +7,8 @@ const client = new Client() const users = new Users(client); const result = await users.deleteSession( - '[USER_ID]', // userId - '[SESSION_ID]' // sessionId + '<USER_ID>', // userId + '<SESSION_ID>' // sessionId ); console.log(response); diff --git a/docs/examples/users/delete-sessions.md b/docs/examples/users/delete-sessions.md index 050e8c5..fd0de48 100644 --- a/docs/examples/users/delete-sessions.md +++ b/docs/examples/users/delete-sessions.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.deleteSessions( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/delete-target.md b/docs/examples/users/delete-target.md index d08a773..cd0e15c 100644 --- a/docs/examples/users/delete-target.md +++ b/docs/examples/users/delete-target.md @@ -7,8 +7,8 @@ const client = new Client() const users = new Users(client); const result = await users.deleteTarget( - '[USER_ID]', // userId - '[TARGET_ID]' // targetId + '<USER_ID>', // userId + '<TARGET_ID>' // targetId ); console.log(response); diff --git a/docs/examples/users/delete.md b/docs/examples/users/delete.md index 2f87bd4..db3dbb2 100644 --- a/docs/examples/users/delete.md +++ b/docs/examples/users/delete.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.delete( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/get-prefs.md b/docs/examples/users/get-prefs.md index 902a69a..fff61ee 100644 --- a/docs/examples/users/get-prefs.md +++ b/docs/examples/users/get-prefs.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.getPrefs( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/get-target.md b/docs/examples/users/get-target.md index 491401c..803e876 100644 --- a/docs/examples/users/get-target.md +++ b/docs/examples/users/get-target.md @@ -7,8 +7,8 @@ const client = new Client() const users = new Users(client); const result = await users.getTarget( - '[USER_ID]', // userId - '[TARGET_ID]' // targetId + '<USER_ID>', // userId + '<TARGET_ID>' // targetId ); console.log(response); diff --git a/docs/examples/users/get.md b/docs/examples/users/get.md index a591d58..791292a 100644 --- a/docs/examples/users/get.md +++ b/docs/examples/users/get.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.get( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/list-factors.md b/docs/examples/users/list-factors.md index e302044..7f84d3d 100644 --- a/docs/examples/users/list-factors.md +++ b/docs/examples/users/list-factors.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.listFactors( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md index d551a28..72f6021 100644 --- a/docs/examples/users/list-identities.md +++ b/docs/examples/users/list-identities.md @@ -8,7 +8,7 @@ const users = new Users(client); const result = await users.listIdentities( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/users/list-logs.md b/docs/examples/users/list-logs.md index f4610dc..23436ba 100644 --- a/docs/examples/users/list-logs.md +++ b/docs/examples/users/list-logs.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.listLogs( - '[USER_ID]', // userId + '<USER_ID>', // userId [] // queries (optional) ); diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index c5a4d6f..07b04eb 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.listMemberships( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/list-sessions.md b/docs/examples/users/list-sessions.md index 82f8642..537dd7b 100644 --- a/docs/examples/users/list-sessions.md +++ b/docs/examples/users/list-sessions.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.listSessions( - '[USER_ID]' // userId + '<USER_ID>' // userId ); console.log(response); diff --git a/docs/examples/users/list-targets.md b/docs/examples/users/list-targets.md index 35ec342..3d414af 100644 --- a/docs/examples/users/list-targets.md +++ b/docs/examples/users/list-targets.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.listTargets( - '[USER_ID]', // userId + '<USER_ID>', // userId [] // queries (optional) ); diff --git a/docs/examples/users/list.md b/docs/examples/users/list.md index 59bb300..c26f302 100644 --- a/docs/examples/users/list.md +++ b/docs/examples/users/list.md @@ -8,7 +8,7 @@ const users = new Users(client); const result = await users.list( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/users/update-email-verification.md b/docs/examples/users/update-email-verification.md index f29aae2..2548b1e 100644 --- a/docs/examples/users/update-email-verification.md +++ b/docs/examples/users/update-email-verification.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updateEmailVerification( - '[USER_ID]', // userId + '<USER_ID>', // userId false // emailVerification ); diff --git a/docs/examples/users/update-email.md b/docs/examples/users/update-email.md index c6d4945..9600c18 100644 --- a/docs/examples/users/update-email.md +++ b/docs/examples/users/update-email.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updateEmail( - '[USER_ID]', // userId + '<USER_ID>', // userId 'email@example.com' // email ); diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md index dcd091c..aa6e30e 100644 --- a/docs/examples/users/update-labels.md +++ b/docs/examples/users/update-labels.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updateLabels( - '[USER_ID]', // userId + '<USER_ID>', // userId [] // labels ); diff --git a/docs/examples/users/update-mfa.md b/docs/examples/users/update-mfa.md index f2e3e7a..b8cb93b 100644 --- a/docs/examples/users/update-mfa.md +++ b/docs/examples/users/update-mfa.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updateMfa( - '[USER_ID]', // userId + '<USER_ID>', // userId false // mfa ); diff --git a/docs/examples/users/update-name.md b/docs/examples/users/update-name.md index 0c5dd3b..0e1e07e 100644 --- a/docs/examples/users/update-name.md +++ b/docs/examples/users/update-name.md @@ -7,8 +7,8 @@ const client = new Client() const users = new Users(client); const result = await users.updateName( - '[USER_ID]', // userId - '[NAME]' // name + '<USER_ID>', // userId + '<NAME>' // name ); console.log(response); diff --git a/docs/examples/users/update-password.md b/docs/examples/users/update-password.md index dc98d36..5861572 100644 --- a/docs/examples/users/update-password.md +++ b/docs/examples/users/update-password.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updatePassword( - '[USER_ID]', // userId + '<USER_ID>', // userId '' // password ); diff --git a/docs/examples/users/update-phone-verification.md b/docs/examples/users/update-phone-verification.md index 1af45c8..0d141db 100644 --- a/docs/examples/users/update-phone-verification.md +++ b/docs/examples/users/update-phone-verification.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updatePhoneVerification( - '[USER_ID]', // userId + '<USER_ID>', // userId false // phoneVerification ); diff --git a/docs/examples/users/update-phone.md b/docs/examples/users/update-phone.md index 45414e9..4ac5380 100644 --- a/docs/examples/users/update-phone.md +++ b/docs/examples/users/update-phone.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updatePhone( - '[USER_ID]', // userId + '<USER_ID>', // userId '+12065550100' // number ); diff --git a/docs/examples/users/update-prefs.md b/docs/examples/users/update-prefs.md index f48d561..227ca36 100644 --- a/docs/examples/users/update-prefs.md +++ b/docs/examples/users/update-prefs.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updatePrefs( - '[USER_ID]', // userId + '<USER_ID>', // userId {} // prefs ); diff --git a/docs/examples/users/update-status.md b/docs/examples/users/update-status.md index 485d6b9..cbc4dfe 100644 --- a/docs/examples/users/update-status.md +++ b/docs/examples/users/update-status.md @@ -7,7 +7,7 @@ const client = new Client() const users = new Users(client); const result = await users.updateStatus( - '[USER_ID]', // userId + '<USER_ID>', // userId false // status ); diff --git a/docs/examples/users/update-target.md b/docs/examples/users/update-target.md index e60e189..3bb8899 100644 --- a/docs/examples/users/update-target.md +++ b/docs/examples/users/update-target.md @@ -7,11 +7,11 @@ const client = new Client() const users = new Users(client); const result = await users.updateTarget( - '[USER_ID]', // userId - '[TARGET_ID]', // targetId - '[IDENTIFIER]', // identifier (optional) - '[PROVIDER_ID]', // providerId (optional) - '[NAME]' // name (optional) + '<USER_ID>', // userId + '<TARGET_ID>', // targetId + '<IDENTIFIER>', // identifier (optional) + '<PROVIDER_ID>', // providerId (optional) + '<NAME>' // name (optional) ); console.log(response); diff --git a/docs/examples/vcs/create-repository-detection.md b/docs/examples/vcs/create-repository-detection.md index a2bdcc3..22b49a8 100644 --- a/docs/examples/vcs/create-repository-detection.md +++ b/docs/examples/vcs/create-repository-detection.md @@ -7,9 +7,9 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.createRepositoryDetection( - '[INSTALLATION_ID]', // installationId - '[PROVIDER_REPOSITORY_ID]', // providerRepositoryId - '[PROVIDER_ROOT_DIRECTORY]' // providerRootDirectory (optional) + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>', // providerRepositoryId + '<PROVIDER_ROOT_DIRECTORY>' // providerRootDirectory (optional) ); console.log(response); diff --git a/docs/examples/vcs/create-repository.md b/docs/examples/vcs/create-repository.md index 834183a..43abe6a 100644 --- a/docs/examples/vcs/create-repository.md +++ b/docs/examples/vcs/create-repository.md @@ -7,8 +7,8 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.createRepository( - '[INSTALLATION_ID]', // installationId - '[NAME]', // name + '<INSTALLATION_ID>', // installationId + '<NAME>', // name false // private ); diff --git a/docs/examples/vcs/delete-installation.md b/docs/examples/vcs/delete-installation.md index e250838..f4d6578 100644 --- a/docs/examples/vcs/delete-installation.md +++ b/docs/examples/vcs/delete-installation.md @@ -7,7 +7,7 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.deleteInstallation( - '[INSTALLATION_ID]' // installationId + '<INSTALLATION_ID>' // installationId ); console.log(response); diff --git a/docs/examples/vcs/get-installation.md b/docs/examples/vcs/get-installation.md index 8185d89..1f97d20 100644 --- a/docs/examples/vcs/get-installation.md +++ b/docs/examples/vcs/get-installation.md @@ -7,7 +7,7 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.getInstallation( - '[INSTALLATION_ID]' // installationId + '<INSTALLATION_ID>' // installationId ); console.log(response); diff --git a/docs/examples/vcs/get-repository.md b/docs/examples/vcs/get-repository.md index 26a3ecd..9707e9e 100644 --- a/docs/examples/vcs/get-repository.md +++ b/docs/examples/vcs/get-repository.md @@ -7,8 +7,8 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.getRepository( - '[INSTALLATION_ID]', // installationId - '[PROVIDER_REPOSITORY_ID]' // providerRepositoryId + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId ); console.log(response); diff --git a/docs/examples/vcs/list-installations.md b/docs/examples/vcs/list-installations.md index 8a7506f..a7e8307 100644 --- a/docs/examples/vcs/list-installations.md +++ b/docs/examples/vcs/list-installations.md @@ -8,7 +8,7 @@ const vcs = new Vcs(client); const result = await vcs.listInstallations( [], // queries (optional) - '[SEARCH]' // search (optional) + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/vcs/list-repositories.md b/docs/examples/vcs/list-repositories.md index 38667a6..365f028 100644 --- a/docs/examples/vcs/list-repositories.md +++ b/docs/examples/vcs/list-repositories.md @@ -7,8 +7,8 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.listRepositories( - '[INSTALLATION_ID]', // installationId - '[SEARCH]' // search (optional) + '<INSTALLATION_ID>', // installationId + '<SEARCH>' // search (optional) ); console.log(response); diff --git a/docs/examples/vcs/list-repository-branches.md b/docs/examples/vcs/list-repository-branches.md index c49925b..affe85a 100644 --- a/docs/examples/vcs/list-repository-branches.md +++ b/docs/examples/vcs/list-repository-branches.md @@ -7,8 +7,8 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.listRepositoryBranches( - '[INSTALLATION_ID]', // installationId - '[PROVIDER_REPOSITORY_ID]' // providerRepositoryId + '<INSTALLATION_ID>', // installationId + '<PROVIDER_REPOSITORY_ID>' // providerRepositoryId ); console.log(response); diff --git a/docs/examples/vcs/update-external-deployments.md b/docs/examples/vcs/update-external-deployments.md index 2b2d30e..d1fbf34 100644 --- a/docs/examples/vcs/update-external-deployments.md +++ b/docs/examples/vcs/update-external-deployments.md @@ -7,9 +7,9 @@ const client = new Client() const vcs = new Vcs(client); const result = await vcs.updateExternalDeployments( - '[INSTALLATION_ID]', // installationId - '[REPOSITORY_ID]', // repositoryId - '[PROVIDER_PULL_REQUEST_ID]' // providerPullRequestId + '<INSTALLATION_ID>', // installationId + '<REPOSITORY_ID>', // repositoryId + '<PROVIDER_PULL_REQUEST_ID>' // providerPullRequestId ); console.log(response); diff --git a/package.json b/package.json index 148f222..77cd5f8 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@appwrite.io/console", "homepage": "https://appwrite.io/support", "description": "Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API", - "version": "0.6.0-rc.12", + "version": "0.6.0-rc.13", "license": "BSD-3-Clause", "main": "dist/cjs/sdk.js", "exports": { diff --git a/src/client.ts b/src/client.ts index eab06d6..098d4b8 100644 --- a/src/client.ts +++ b/src/client.ts @@ -104,7 +104,7 @@ class Client { 'x-sdk-name': 'Console', 'x-sdk-platform': 'console', 'x-sdk-language': 'web', - 'x-sdk-version': '0.6.0-rc.12', + 'x-sdk-version': '0.6.0-rc.13', 'X-Appwrite-Response-Format': '1.5.0', }; diff --git a/src/enums/email-template-type.ts b/src/enums/email-template-type.ts index 9ef83f5..e0ab5c6 100644 --- a/src/enums/email-template-type.ts +++ b/src/enums/email-template-type.ts @@ -3,4 +3,5 @@ export enum EmailTemplateType { Magicsession = 'magicsession', Recovery = 'recovery', Invitation = 'invitation', + Mfachallenge = 'mfachallenge', } \ No newline at end of file diff --git a/src/enums/sms-template-type.ts b/src/enums/sms-template-type.ts index 031b00e..581918b 100644 --- a/src/enums/sms-template-type.ts +++ b/src/enums/sms-template-type.ts @@ -2,4 +2,5 @@ export enum SmsTemplateType { Verification = 'verification', Login = 'login', Invitation = 'invitation', + Mfachallenge = 'mfachallenge', } \ No newline at end of file diff --git a/src/enums/encryption.ts b/src/enums/smtp-encryption.ts similarity index 65% rename from src/enums/encryption.ts rename to src/enums/smtp-encryption.ts index 4ce5dda..876177b 100644 --- a/src/enums/encryption.ts +++ b/src/enums/smtp-encryption.ts @@ -1,4 +1,4 @@ -export enum Encryption { +export enum SmtpEncryption { None = 'none', Ssl = 'ssl', Tls = 'tls', diff --git a/src/index.ts b/src/index.ts index 03fa8fa..4877fdb 100644 --- a/src/index.ts +++ b/src/index.ts @@ -37,7 +37,7 @@ export { FunctionUsageRange } from './enums/function-usage-range'; export { ExecutionMethod } from './enums/execution-method'; export { Name } from './enums/name'; export { MessageStatus } from './enums/message-status'; -export { Encryption } from './enums/encryption'; +export { SmtpEncryption } from './enums/smtp-encryption'; export { ProjectUsageRange } from './enums/project-usage-range'; export { Region } from './enums/region'; export { AuthMethod } from './enums/auth-method'; diff --git a/src/service.ts b/src/service.ts index fef8389..fe17699 100644 --- a/src/service.ts +++ b/src/service.ts @@ -1,6 +1,5 @@ import { Client } from './client'; import type { Payload } from './client'; -import { Query } from './query'; export class Service { static CHUNK_SIZE = 5*1024*1024; // 5MB @@ -18,8 +17,6 @@ export class Service { let finalKey = prefix ? prefix + '[' + key +']' : key; if (Array.isArray(value)) { output = { ...output, ...Service.flatten(value, finalKey) }; - } else if (value instanceof Query) { - output[finalKey] = JSON.stringify(value); } else { output[finalKey] = value; } diff --git a/src/services/account.ts b/src/services/account.ts index 6a70ddc..8144fa4 100644 --- a/src/services/account.ts +++ b/src/services/account.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { AuthenticationFactor } from '../enums/authentication-factor'; import { AuthenticatorType } from '../enums/authenticator-type'; import { OAuthProvider } from '../enums/o-auth-provider'; @@ -275,7 +274,7 @@ export class Account extends Service { * @throws {AppwriteException} * @returns {Promise} */ - async create2FAChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> { + async createChallenge(factor: AuthenticationFactor): Promise<Models.MfaChallenge> { if (typeof factor === 'undefined') { throw new AppwriteException('Missing required parameter: "factor"'); } @@ -838,12 +837,11 @@ export class Account extends Service { * @param {OAuthProvider} provider * @param {string} success * @param {string} failure - * @param {boolean} token * @param {string[]} scopes * @throws {AppwriteException} * @returns {void|string} */ - createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, token?: boolean, scopes?: string[]): void | URL { + createOAuth2Session(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL { if (typeof provider === 'undefined') { throw new AppwriteException('Missing required parameter: "provider"'); } @@ -859,10 +857,6 @@ export class Account extends Service { payload['failure'] = failure; } - if (typeof token !== 'undefined') { - payload['token'] = token; - } - if (typeof scopes !== 'undefined') { payload['scopes'] = scopes; } @@ -1218,6 +1212,65 @@ export class Account extends Service { }, payload); } + /** + * Create OAuth2 token + * + * Allow the user to login to their account using the OAuth2 provider of their + * choice. Each OAuth2 provider should be enabled from the Appwrite console + * first. Use the success and failure arguments to provide a redirect URL's + * back to your app when login is completed. + * + * If authentication succeeds, `userId` and `secret` of a token will be + * appended to the success URL as query parameters. These can be used to + * create a new session using the [Create + * session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + * endpoint. + * + * A user is limited to 10 active sessions at a time by default. [Learn more + * about session + * limits](https://appwrite.io/docs/authentication-security#limits). + * + * @param {OAuthProvider} provider + * @param {string} success + * @param {string} failure + * @param {string[]} scopes + * @throws {AppwriteException} + * @returns {void|string} + */ + createOAuth2Token(provider: OAuthProvider, success?: string, failure?: string, scopes?: string[]): void | URL { + if (typeof provider === 'undefined') { + throw new AppwriteException('Missing required parameter: "provider"'); + } + + const apiPath = '/account/tokens/oauth2/{provider}'.replace('{provider}', provider); + const payload: Payload = {}; + + if (typeof success !== 'undefined') { + payload['success'] = success; + } + + if (typeof failure !== 'undefined') { + payload['failure'] = failure; + } + + if (typeof scopes !== 'undefined') { + payload['scopes'] = scopes; + } + + const uri = new URL(this.client.config.endpoint + apiPath); + payload['project'] = this.client.config.project; + + + for (const [key, value] of Object.entries(Service.flatten(payload))) { + uri.searchParams.append(key, value); + } + if (typeof window !== 'undefined' && window?.location) { + window.location.href = uri.toString(); + } else { + return uri; + } + } + /** * Create phone token * diff --git a/src/services/assistant.ts b/src/services/assistant.ts index b05c90d..108aa25 100644 --- a/src/services/assistant.ts +++ b/src/services/assistant.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Assistant extends Service { diff --git a/src/services/avatars.ts b/src/services/avatars.ts index 675e616..fae5666 100644 --- a/src/services/avatars.ts +++ b/src/services/avatars.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { Browser } from '../enums/browser'; import { CreditCard } from '../enums/credit-card'; import { Flag } from '../enums/flag'; diff --git a/src/services/console.ts b/src/services/console.ts index 934de63..4ac795c 100644 --- a/src/services/console.ts +++ b/src/services/console.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Console extends Service { diff --git a/src/services/databases.ts b/src/services/databases.ts index e789fb1..1817e18 100644 --- a/src/services/databases.ts +++ b/src/services/databases.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { DatabaseUsageRange } from '../enums/database-usage-range'; import { RelationshipType } from '../enums/relationship-type'; import { RelationMutate } from '../enums/relation-mutate'; diff --git a/src/services/functions.ts b/src/services/functions.ts index a94458c..d095e2e 100644 --- a/src/services/functions.ts +++ b/src/services/functions.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { Runtime } from '../enums/runtime'; import { FunctionUsageRange } from '../enums/function-usage-range'; import { ExecutionMethod } from '../enums/execution-method'; diff --git a/src/services/graphql.ts b/src/services/graphql.ts index 1a2e4f8..ca03efb 100644 --- a/src/services/graphql.ts +++ b/src/services/graphql.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Graphql extends Service { diff --git a/src/services/health.ts b/src/services/health.ts index 3939aff..f9571f6 100644 --- a/src/services/health.ts +++ b/src/services/health.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { Name } from '../enums/name'; export class Health extends Service { diff --git a/src/services/locale.ts b/src/services/locale.ts index e9386f2..d70b5ed 100644 --- a/src/services/locale.ts +++ b/src/services/locale.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Locale extends Service { diff --git a/src/services/messaging.ts b/src/services/messaging.ts index 741fca5..c4f4f14 100644 --- a/src/services/messaging.ts +++ b/src/services/messaging.ts @@ -2,9 +2,8 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { MessageStatus } from '../enums/message-status'; -import { Encryption } from '../enums/encryption'; +import { SmtpEncryption } from '../enums/smtp-encryption'; export class Messaging extends Service { @@ -670,11 +669,12 @@ export class Messaging extends Service { * @param {string} authKeyId * @param {string} teamId * @param {string} bundleId + * @param {boolean} sandbox * @param {boolean} enabled * @throws {AppwriteException} * @returns {Promise} */ - async createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, enabled?: boolean): Promise<Models.Provider> { + async createApnsProvider(providerId: string, name: string, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean, enabled?: boolean): Promise<Models.Provider> { if (typeof providerId === 'undefined') { throw new AppwriteException('Missing required parameter: "providerId"'); } @@ -710,6 +710,10 @@ export class Messaging extends Service { payload['bundleId'] = bundleId; } + if (typeof sandbox !== 'undefined') { + payload['sandbox'] = sandbox; + } + if (typeof enabled !== 'undefined') { payload['enabled'] = enabled; } @@ -732,10 +736,11 @@ export class Messaging extends Service { * @param {string} authKeyId * @param {string} teamId * @param {string} bundleId + * @param {boolean} sandbox * @throws {AppwriteException} * @returns {Promise} */ - async updateAPNSProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string): Promise<Models.Provider> { + async updateApnsProvider(providerId: string, name?: string, enabled?: boolean, authKey?: string, authKeyId?: string, teamId?: string, bundleId?: string, sandbox?: boolean): Promise<Models.Provider> { if (typeof providerId === 'undefined') { throw new AppwriteException('Missing required parameter: "providerId"'); } @@ -767,6 +772,10 @@ export class Messaging extends Service { payload['bundleId'] = bundleId; } + if (typeof sandbox !== 'undefined') { + payload['sandbox'] = sandbox; + } + const uri = new URL(this.client.config.endpoint + apiPath); return await this.client.call('patch', uri, { 'content-type': 'application/json', @@ -831,7 +840,7 @@ export class Messaging extends Service { * @throws {AppwriteException} * @returns {Promise} */ - async updateFCMProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider> { + async updateFcmProvider(providerId: string, name?: string, enabled?: boolean, serviceAccountJSON?: object): Promise<Models.Provider> { if (typeof providerId === 'undefined') { throw new AppwriteException('Missing required parameter: "providerId"'); } @@ -1239,7 +1248,7 @@ export class Messaging extends Service { * @param {number} port * @param {string} username * @param {string} password - * @param {Encryption} encryption + * @param {SmtpEncryption} encryption * @param {boolean} autoTLS * @param {string} mailer * @param {string} fromName @@ -1250,7 +1259,7 @@ export class Messaging extends Service { * @throws {AppwriteException} * @returns {Promise} */ - async createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: Encryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider> { + async createSmtpProvider(providerId: string, name: string, host: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider> { if (typeof providerId === 'undefined') { throw new AppwriteException('Missing required parameter: "providerId"'); } @@ -1339,7 +1348,7 @@ export class Messaging extends Service { * @param {number} port * @param {string} username * @param {string} password - * @param {Encryption} encryption + * @param {SmtpEncryption} encryption * @param {boolean} autoTLS * @param {string} mailer * @param {string} fromName @@ -1350,7 +1359,7 @@ export class Messaging extends Service { * @throws {AppwriteException} * @returns {Promise} */ - async updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: Encryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider> { + async updateSmtpProvider(providerId: string, name?: string, host?: string, port?: number, username?: string, password?: string, encryption?: SmtpEncryption, autoTLS?: boolean, mailer?: string, fromName?: string, fromEmail?: string, replyToName?: string, replyToEmail?: string, enabled?: boolean): Promise<Models.Provider> { if (typeof providerId === 'undefined') { throw new AppwriteException('Missing required parameter: "providerId"'); } @@ -2036,10 +2045,11 @@ export class Messaging extends Service { * * @param {string} topicId * @param {string} name + * @param {string[]} subscribe * @throws {AppwriteException} * @returns {Promise} */ - async updateTopic(topicId: string, name?: string): Promise<Models.Topic> { + async updateTopic(topicId: string, name?: string, subscribe?: string[]): Promise<Models.Topic> { if (typeof topicId === 'undefined') { throw new AppwriteException('Missing required parameter: "topicId"'); } @@ -2051,6 +2061,10 @@ export class Messaging extends Service { payload['name'] = name; } + if (typeof subscribe !== 'undefined') { + payload['subscribe'] = subscribe; + } + const uri = new URL(this.client.config.endpoint + apiPath); return await this.client.call('patch', uri, { 'content-type': 'application/json', diff --git a/src/services/migrations.ts b/src/services/migrations.ts index 3450dc3..18ea195 100644 --- a/src/services/migrations.ts +++ b/src/services/migrations.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Migrations extends Service { diff --git a/src/services/project.ts b/src/services/project.ts index 3206279..1bc2952 100644 --- a/src/services/project.ts +++ b/src/services/project.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { ProjectUsageRange } from '../enums/project-usage-range'; export class Project extends Service { diff --git a/src/services/projects.ts b/src/services/projects.ts index a48321e..ec536e5 100644 --- a/src/services/projects.ts +++ b/src/services/projects.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { Region } from '../enums/region'; import { AuthMethod } from '../enums/auth-method'; import { OAuthProvider } from '../enums/o-auth-provider'; diff --git a/src/services/proxy.ts b/src/services/proxy.ts index 24f0252..b00688e 100644 --- a/src/services/proxy.ts +++ b/src/services/proxy.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { ResourceType } from '../enums/resource-type'; export class Proxy extends Service { diff --git a/src/services/storage.ts b/src/services/storage.ts index f8b64c5..4440d1c 100644 --- a/src/services/storage.ts +++ b/src/services/storage.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { Compression } from '../enums/compression'; import { ImageGravity } from '../enums/image-gravity'; import { ImageFormat } from '../enums/image-format'; diff --git a/src/services/teams.ts b/src/services/teams.ts index 090f9df..1422282 100644 --- a/src/services/teams.ts +++ b/src/services/teams.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Teams extends Service { diff --git a/src/services/users.ts b/src/services/users.ts index 79cfcc6..b5ab9a3 100644 --- a/src/services/users.ts +++ b/src/services/users.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; import { PasswordHash } from '../enums/password-hash'; import { UserUsageRange } from '../enums/user-usage-range'; import { AuthenticatorType } from '../enums/authenticator-type'; diff --git a/src/services/vcs.ts b/src/services/vcs.ts index 9220943..95ddf7b 100644 --- a/src/services/vcs.ts +++ b/src/services/vcs.ts @@ -2,7 +2,6 @@ import { Service } from '../service'; import { AppwriteException, Client } from '../client'; import type { Models } from '../models'; import type { UploadProgress, Payload } from '../client'; -import { Query } from '../query'; export class Vcs extends Service {