From 9ff8b24c105ecff275928786b2423536ef41ed0b Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Thu, 8 May 2025 23:28:12 +1200 Subject: [PATCH 1/3] Add bulk API methods --- appwrite.gemspec | 2 +- .../account/create-anonymous-session.md | 2 +- .../account/create-email-password-session.md | 2 +- docs/examples/account/create-email-token.md | 2 +- docs/examples/account/create-j-w-t.md | 2 +- .../account/create-magic-u-r-l-token.md | 2 +- .../account/create-mfa-authenticator.md | 2 +- docs/examples/account/create-mfa-challenge.md | 2 +- .../account/create-mfa-recovery-codes.md | 2 +- docs/examples/account/create-o-auth2token.md | 2 +- docs/examples/account/create-phone-token.md | 2 +- .../account/create-phone-verification.md | 2 +- docs/examples/account/create-recovery.md | 2 +- docs/examples/account/create-session.md | 2 +- docs/examples/account/create-verification.md | 2 +- docs/examples/account/create.md | 2 +- docs/examples/account/delete-identity.md | 2 +- .../account/delete-mfa-authenticator.md | 2 +- docs/examples/account/delete-session.md | 2 +- docs/examples/account/delete-sessions.md | 2 +- .../account/get-mfa-recovery-codes.md | 2 +- docs/examples/account/get-prefs.md | 2 +- docs/examples/account/get-session.md | 2 +- docs/examples/account/get.md | 2 +- docs/examples/account/list-identities.md | 2 +- docs/examples/account/list-logs.md | 2 +- docs/examples/account/list-mfa-factors.md | 2 +- docs/examples/account/list-sessions.md | 2 +- docs/examples/account/update-email.md | 2 +- docs/examples/account/update-m-f-a.md | 2 +- .../account/update-magic-u-r-l-session.md | 2 +- .../account/update-mfa-authenticator.md | 2 +- docs/examples/account/update-mfa-challenge.md | 2 +- .../account/update-mfa-recovery-codes.md | 2 +- docs/examples/account/update-name.md | 2 +- docs/examples/account/update-password.md | 2 +- docs/examples/account/update-phone-session.md | 2 +- .../account/update-phone-verification.md | 2 +- docs/examples/account/update-phone.md | 2 +- docs/examples/account/update-prefs.md | 2 +- docs/examples/account/update-recovery.md | 2 +- docs/examples/account/update-session.md | 2 +- docs/examples/account/update-status.md | 2 +- docs/examples/account/update-verification.md | 2 +- docs/examples/avatars/get-browser.md | 2 +- docs/examples/avatars/get-credit-card.md | 2 +- docs/examples/avatars/get-favicon.md | 2 +- docs/examples/avatars/get-flag.md | 2 +- docs/examples/avatars/get-image.md | 2 +- docs/examples/avatars/get-initials.md | 2 +- docs/examples/avatars/get-q-r.md | 2 +- .../databases/create-boolean-attribute.md | 2 +- docs/examples/databases/create-collection.md | 2 +- .../databases/create-datetime-attribute.md | 2 +- docs/examples/databases/create-document.md | 2 +- docs/examples/databases/create-documents.md | 16 ++ .../databases/create-email-attribute.md | 2 +- .../databases/create-enum-attribute.md | 2 +- .../databases/create-float-attribute.md | 2 +- docs/examples/databases/create-index.md | 2 +- .../databases/create-integer-attribute.md | 2 +- .../examples/databases/create-ip-attribute.md | 2 +- .../create-relationship-attribute.md | 2 +- .../databases/create-string-attribute.md | 2 +- .../databases/create-url-attribute.md | 2 +- docs/examples/databases/create.md | 2 +- docs/examples/databases/delete-attribute.md | 2 +- docs/examples/databases/delete-collection.md | 2 +- docs/examples/databases/delete-document.md | 2 +- docs/examples/databases/delete-documents.md | 16 ++ docs/examples/databases/delete-index.md | 2 +- docs/examples/databases/delete.md | 2 +- docs/examples/databases/get-attribute.md | 2 +- docs/examples/databases/get-collection.md | 2 +- docs/examples/databases/get-document.md | 2 +- docs/examples/databases/get-index.md | 2 +- docs/examples/databases/get.md | 2 +- docs/examples/databases/list-attributes.md | 2 +- docs/examples/databases/list-collections.md | 2 +- docs/examples/databases/list-documents.md | 2 +- docs/examples/databases/list-indexes.md | 2 +- docs/examples/databases/list.md | 2 +- .../databases/update-boolean-attribute.md | 2 +- docs/examples/databases/update-collection.md | 2 +- .../databases/update-datetime-attribute.md | 2 +- docs/examples/databases/update-document.md | 2 +- docs/examples/databases/update-documents.md | 17 ++ .../databases/update-email-attribute.md | 2 +- .../databases/update-enum-attribute.md | 2 +- .../databases/update-float-attribute.md | 2 +- .../databases/update-integer-attribute.md | 2 +- .../examples/databases/update-ip-attribute.md | 2 +- .../update-relationship-attribute.md | 2 +- .../databases/update-string-attribute.md | 2 +- .../databases/update-url-attribute.md | 2 +- docs/examples/databases/update.md | 2 +- docs/examples/databases/upsert-documents.md | 16 ++ docs/examples/functions/create-build.md | 2 +- docs/examples/functions/create-deployment.md | 2 +- docs/examples/functions/create-execution.md | 2 +- docs/examples/functions/create-variable.md | 2 +- docs/examples/functions/create.md | 2 +- docs/examples/functions/delete-deployment.md | 2 +- docs/examples/functions/delete-execution.md | 2 +- docs/examples/functions/delete-variable.md | 2 +- docs/examples/functions/delete.md | 2 +- .../functions/get-deployment-download.md | 2 +- docs/examples/functions/get-deployment.md | 2 +- docs/examples/functions/get-execution.md | 2 +- docs/examples/functions/get-variable.md | 2 +- docs/examples/functions/get.md | 2 +- docs/examples/functions/list-deployments.md | 2 +- docs/examples/functions/list-executions.md | 2 +- docs/examples/functions/list-runtimes.md | 2 +- .../examples/functions/list-specifications.md | 2 +- docs/examples/functions/list-variables.md | 2 +- docs/examples/functions/list.md | 2 +- .../functions/update-deployment-build.md | 2 +- docs/examples/functions/update-deployment.md | 2 +- docs/examples/functions/update-variable.md | 2 +- docs/examples/functions/update.md | 2 +- docs/examples/graphql/mutation.md | 2 +- docs/examples/graphql/query.md | 2 +- docs/examples/health/get-antivirus.md | 2 +- docs/examples/health/get-cache.md | 2 +- docs/examples/health/get-certificate.md | 2 +- docs/examples/health/get-d-b.md | 2 +- docs/examples/health/get-failed-jobs.md | 2 +- docs/examples/health/get-pub-sub.md | 2 +- docs/examples/health/get-queue-builds.md | 2 +- .../examples/health/get-queue-certificates.md | 2 +- docs/examples/health/get-queue-databases.md | 2 +- docs/examples/health/get-queue-deletes.md | 2 +- docs/examples/health/get-queue-functions.md | 2 +- docs/examples/health/get-queue-logs.md | 2 +- docs/examples/health/get-queue-mails.md | 2 +- docs/examples/health/get-queue-messaging.md | 2 +- docs/examples/health/get-queue-migrations.md | 2 +- .../health/get-queue-stats-resources.md | 2 +- docs/examples/health/get-queue-usage.md | 2 +- docs/examples/health/get-queue-webhooks.md | 2 +- docs/examples/health/get-storage-local.md | 2 +- docs/examples/health/get-storage.md | 2 +- docs/examples/health/get-time.md | 2 +- docs/examples/health/get.md | 2 +- docs/examples/locale/get.md | 2 +- docs/examples/locale/list-codes.md | 2 +- docs/examples/locale/list-continents.md | 2 +- docs/examples/locale/list-countries-e-u.md | 2 +- docs/examples/locale/list-countries-phones.md | 2 +- docs/examples/locale/list-countries.md | 2 +- docs/examples/locale/list-currencies.md | 2 +- docs/examples/locale/list-languages.md | 2 +- .../messaging/create-apns-provider.md | 2 +- docs/examples/messaging/create-email.md | 2 +- .../examples/messaging/create-fcm-provider.md | 2 +- .../messaging/create-mailgun-provider.md | 2 +- .../messaging/create-msg91provider.md | 2 +- docs/examples/messaging/create-push.md | 2 +- .../messaging/create-sendgrid-provider.md | 2 +- docs/examples/messaging/create-sms.md | 2 +- .../messaging/create-smtp-provider.md | 2 +- docs/examples/messaging/create-subscriber.md | 2 +- .../messaging/create-telesign-provider.md | 2 +- .../messaging/create-textmagic-provider.md | 2 +- docs/examples/messaging/create-topic.md | 2 +- .../messaging/create-twilio-provider.md | 2 +- .../messaging/create-vonage-provider.md | 2 +- docs/examples/messaging/delete-provider.md | 2 +- docs/examples/messaging/delete-subscriber.md | 2 +- 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 | 2 +- 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 | 2 +- docs/examples/messaging/list-targets.md | 2 +- docs/examples/messaging/list-topic-logs.md | 2 +- docs/examples/messaging/list-topics.md | 2 +- .../messaging/update-apns-provider.md | 2 +- docs/examples/messaging/update-email.md | 2 +- .../examples/messaging/update-fcm-provider.md | 2 +- .../messaging/update-mailgun-provider.md | 2 +- .../messaging/update-msg91provider.md | 2 +- docs/examples/messaging/update-push.md | 2 +- .../messaging/update-sendgrid-provider.md | 2 +- docs/examples/messaging/update-sms.md | 2 +- .../messaging/update-smtp-provider.md | 2 +- .../messaging/update-telesign-provider.md | 2 +- .../messaging/update-textmagic-provider.md | 2 +- docs/examples/messaging/update-topic.md | 2 +- .../messaging/update-twilio-provider.md | 2 +- .../messaging/update-vonage-provider.md | 2 +- docs/examples/storage/create-bucket.md | 2 +- docs/examples/storage/create-file.md | 2 +- docs/examples/storage/delete-bucket.md | 2 +- docs/examples/storage/delete-file.md | 2 +- docs/examples/storage/get-bucket.md | 2 +- docs/examples/storage/get-file-download.md | 2 +- docs/examples/storage/get-file-preview.md | 2 +- docs/examples/storage/get-file-view.md | 2 +- docs/examples/storage/get-file.md | 2 +- docs/examples/storage/list-buckets.md | 2 +- docs/examples/storage/list-files.md | 2 +- docs/examples/storage/update-bucket.md | 2 +- docs/examples/storage/update-file.md | 2 +- docs/examples/teams/create-membership.md | 2 +- docs/examples/teams/create.md | 2 +- docs/examples/teams/delete-membership.md | 2 +- docs/examples/teams/delete.md | 2 +- docs/examples/teams/get-membership.md | 2 +- docs/examples/teams/get-prefs.md | 2 +- docs/examples/teams/get.md | 2 +- docs/examples/teams/list-memberships.md | 2 +- docs/examples/teams/list.md | 2 +- .../teams/update-membership-status.md | 2 +- docs/examples/teams/update-membership.md | 2 +- docs/examples/teams/update-name.md | 2 +- docs/examples/teams/update-prefs.md | 2 +- docs/examples/users/create-argon2user.md | 2 +- docs/examples/users/create-bcrypt-user.md | 2 +- docs/examples/users/create-j-w-t.md | 2 +- docs/examples/users/create-m-d5user.md | 2 +- .../users/create-mfa-recovery-codes.md | 2 +- docs/examples/users/create-p-h-pass-user.md | 2 +- docs/examples/users/create-s-h-a-user.md | 2 +- .../users/create-scrypt-modified-user.md | 2 +- docs/examples/users/create-scrypt-user.md | 2 +- docs/examples/users/create-session.md | 2 +- docs/examples/users/create-target.md | 2 +- docs/examples/users/create-token.md | 2 +- docs/examples/users/create.md | 2 +- docs/examples/users/delete-identity.md | 2 +- .../users/delete-mfa-authenticator.md | 2 +- docs/examples/users/delete-session.md | 2 +- docs/examples/users/delete-sessions.md | 2 +- docs/examples/users/delete-target.md | 2 +- docs/examples/users/delete.md | 2 +- docs/examples/users/get-mfa-recovery-codes.md | 2 +- docs/examples/users/get-prefs.md | 2 +- docs/examples/users/get-target.md | 2 +- docs/examples/users/get.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-mfa-factors.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 +- .../users/update-mfa-recovery-codes.md | 2 +- docs/examples/users/update-mfa.md | 2 +- docs/examples/users/update-name.md | 2 +- 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 | 2 +- lib/appwrite/client.rb | 2 +- lib/appwrite/services/databases.rb | 170 +++++++++++++++++- 269 files changed, 498 insertions(+), 265 deletions(-) create mode 100644 docs/examples/databases/create-documents.md create mode 100644 docs/examples/databases/delete-documents.md create mode 100644 docs/examples/databases/update-documents.md create mode 100644 docs/examples/databases/upsert-documents.md diff --git a/appwrite.gemspec b/appwrite.gemspec index d5f6abc..ee01fa2 100644 --- a/appwrite.gemspec +++ b/appwrite.gemspec @@ -1,7 +1,7 @@ Gem::Specification.new do |spec| spec.name = 'appwrite' - spec.version = '15.0.0' + spec.version = '15.1.0-rc.1' spec.license = 'BSD-3-Clause' spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API' spec.author = 'Appwrite Team' diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md index a54d5f0..bcb25d6 100644 --- a/docs/examples/account/create-anonymous-session.md +++ b/docs/examples/account/create-anonymous-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-email-password-session.md b/docs/examples/account/create-email-password-session.md index 08d3423..be5fc1c 100644 --- a/docs/examples/account/create-email-password-session.md +++ b/docs/examples/account/create-email-password-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md index 1e85706..d75e310 100644 --- a/docs/examples/account/create-email-token.md +++ b/docs/examples/account/create-email-token.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-j-w-t.md b/docs/examples/account/create-j-w-t.md index 8ad2db1..8e5b6b7 100644 --- a/docs/examples/account/create-j-w-t.md +++ b/docs/examples/account/create-j-w-t.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) 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 253b263..9537d1f 100644 --- a/docs/examples/account/create-magic-u-r-l-token.md +++ b/docs/examples/account/create-magic-u-r-l-token.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md index 38ad549..a3cc71c 100644 --- a/docs/examples/account/create-mfa-authenticator.md +++ b/docs/examples/account/create-mfa-authenticator.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/create-mfa-challenge.md b/docs/examples/account/create-mfa-challenge.md index b5fa72f..ba34779 100644 --- a/docs/examples/account/create-mfa-challenge.md +++ b/docs/examples/account/create-mfa-challenge.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md index 9c64fdf..db91cf5 100644 --- a/docs/examples/account/create-mfa-recovery-codes.md +++ b/docs/examples/account/create-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/create-o-auth2token.md b/docs/examples/account/create-o-auth2token.md index be8169e..52bc5d6 100644 --- a/docs/examples/account/create-o-auth2token.md +++ b/docs/examples/account/create-o-auth2token.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md index 70e8be2..81bedd0 100644 --- a/docs/examples/account/create-phone-token.md +++ b/docs/examples/account/create-phone-token.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-phone-verification.md b/docs/examples/account/create-phone-verification.md index 0f5685b..a7dec8f 100644 --- a/docs/examples/account/create-phone-verification.md +++ b/docs/examples/account/create-phone-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md index 15f0f93..e344baf 100644 --- a/docs/examples/account/create-recovery.md +++ b/docs/examples/account/create-recovery.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md index 27c2655..4b8ce21 100644 --- a/docs/examples/account/create-session.md +++ b/docs/examples/account/create-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md index 216d88c..2eba7c7 100644 --- a/docs/examples/account/create-verification.md +++ b/docs/examples/account/create-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md index e27f488..84228b8 100644 --- a/docs/examples/account/create.md +++ b/docs/examples/account/create.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md index a38eccd..e8f8e83 100644 --- a/docs/examples/account/delete-identity.md +++ b/docs/examples/account/delete-identity.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/delete-mfa-authenticator.md b/docs/examples/account/delete-mfa-authenticator.md index 9b4f352..832ff6a 100644 --- a/docs/examples/account/delete-mfa-authenticator.md +++ b/docs/examples/account/delete-mfa-authenticator.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md index 4781eec..7496caf 100644 --- a/docs/examples/account/delete-session.md +++ b/docs/examples/account/delete-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md index 776938e..ca5d922 100644 --- a/docs/examples/account/delete-sessions.md +++ b/docs/examples/account/delete-sessions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/get-mfa-recovery-codes.md b/docs/examples/account/get-mfa-recovery-codes.md index 207e521..26ffa9d 100644 --- a/docs/examples/account/get-mfa-recovery-codes.md +++ b/docs/examples/account/get-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md index 0a1ca1c..664454c 100644 --- a/docs/examples/account/get-prefs.md +++ b/docs/examples/account/get-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md index 32a162e..c433b22 100644 --- a/docs/examples/account/get-session.md +++ b/docs/examples/account/get-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md index 5174ab7..f330503 100644 --- a/docs/examples/account/get.md +++ b/docs/examples/account/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md index 91b513b..696e02d 100644 --- a/docs/examples/account/list-identities.md +++ b/docs/examples/account/list-identities.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md index b11dc1a..1f3366a 100644 --- a/docs/examples/account/list-logs.md +++ b/docs/examples/account/list-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/list-mfa-factors.md b/docs/examples/account/list-mfa-factors.md index 48050f2..460ac87 100644 --- a/docs/examples/account/list-mfa-factors.md +++ b/docs/examples/account/list-mfa-factors.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/list-sessions.md b/docs/examples/account/list-sessions.md index 65d5048..b5968c4 100644 --- a/docs/examples/account/list-sessions.md +++ b/docs/examples/account/list-sessions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md index 69e4984..24b43ed 100644 --- a/docs/examples/account/update-email.md +++ b/docs/examples/account/update-email.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-m-f-a.md b/docs/examples/account/update-m-f-a.md index bf5d745..b1b50f3 100644 --- a/docs/examples/account/update-m-f-a.md +++ b/docs/examples/account/update-m-f-a.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with 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 7e72263..c96820f 100644 --- a/docs/examples/account/update-magic-u-r-l-session.md +++ b/docs/examples/account/update-magic-u-r-l-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md index ba6389d..5ff2adc 100644 --- a/docs/examples/account/update-mfa-authenticator.md +++ b/docs/examples/account/update-mfa-authenticator.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-mfa-challenge.md b/docs/examples/account/update-mfa-challenge.md index ab0d4d3..2f4b61d 100644 --- a/docs/examples/account/update-mfa-challenge.md +++ b/docs/examples/account/update-mfa-challenge.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-mfa-recovery-codes.md b/docs/examples/account/update-mfa-recovery-codes.md index 5724025..ad1f2e5 100644 --- a/docs/examples/account/update-mfa-recovery-codes.md +++ b/docs/examples/account/update-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md index e071dd9..ef8a5cb 100644 --- a/docs/examples/account/update-name.md +++ b/docs/examples/account/update-name.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md index 8dd0da6..4b87053 100644 --- a/docs/examples/account/update-password.md +++ b/docs/examples/account/update-password.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-phone-session.md b/docs/examples/account/update-phone-session.md index 90776ce..b81c485 100644 --- a/docs/examples/account/update-phone-session.md +++ b/docs/examples/account/update-phone-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID account = Account.new(client) diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md index b41bb42..8dcf316 100644 --- a/docs/examples/account/update-phone-verification.md +++ b/docs/examples/account/update-phone-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-phone.md b/docs/examples/account/update-phone.md index b562355..ea758a8 100644 --- a/docs/examples/account/update-phone.md +++ b/docs/examples/account/update-phone.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md index 5dc92d1..ecfe4f4 100644 --- a/docs/examples/account/update-prefs.md +++ b/docs/examples/account/update-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md index 06372cb..42c4837 100644 --- a/docs/examples/account/update-recovery.md +++ b/docs/examples/account/update-recovery.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md index b1181e0..34e00ee 100644 --- a/docs/examples/account/update-session.md +++ b/docs/examples/account/update-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-status.md b/docs/examples/account/update-status.md index f69f527..5c543b7 100644 --- a/docs/examples/account/update-status.md +++ b/docs/examples/account/update-status.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md index 5a0cff8..9866ade 100644 --- a/docs/examples/account/update-verification.md +++ b/docs/examples/account/update-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index f48a05a..4afdf77 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md index 99b3c62..a324f6d 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md index 4705128..7c8bd43 100644 --- a/docs/examples/avatars/get-favicon.md +++ b/docs/examples/avatars/get-favicon.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md index cd162a5..f648a28 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md index bc38de1..f46fad0 100644 --- a/docs/examples/avatars/get-image.md +++ b/docs/examples/avatars/get-image.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md index 9d79e8e..85e5a6a 100644 --- a/docs/examples/avatars/get-initials.md +++ b/docs/examples/avatars/get-initials.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/avatars/get-q-r.md b/docs/examples/avatars/get-q-r.md index f522866..9c6e346 100644 --- a/docs/examples/avatars/get-q-r.md +++ b/docs/examples/avatars/get-q-r.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/create-boolean-attribute.md b/docs/examples/databases/create-boolean-attribute.md index 35449c2..158ea05 100644 --- a/docs/examples/databases/create-boolean-attribute.md +++ b/docs/examples/databases/create-boolean-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md index 8d564a3..c22b348 100644 --- a/docs/examples/databases/create-collection.md +++ b/docs/examples/databases/create-collection.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md index 594f36e..af12b79 100644 --- a/docs/examples/databases/create-datetime-attribute.md +++ b/docs/examples/databases/create-datetime-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index 30ef93f..e683108 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md new file mode 100644 index 0000000..98eadab --- /dev/null +++ b/docs/examples/databases/create-documents.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_session('') # The user session to authenticate with + +databases = Databases.new(client) + +result = databases.create_documents( + database_id: '', + collection_id: '', + documents: [] +) diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md index d7456a1..7f36f6b 100644 --- a/docs/examples/databases/create-email-attribute.md +++ b/docs/examples/databases/create-email-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md index 8621279..c8e390a 100644 --- a/docs/examples/databases/create-enum-attribute.md +++ b/docs/examples/databases/create-enum-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-float-attribute.md b/docs/examples/databases/create-float-attribute.md index 3b61bf5..fa77f89 100644 --- a/docs/examples/databases/create-float-attribute.md +++ b/docs/examples/databases/create-float-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index 865ce93..e75478d 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-integer-attribute.md b/docs/examples/databases/create-integer-attribute.md index 88832bd..a689502 100644 --- a/docs/examples/databases/create-integer-attribute.md +++ b/docs/examples/databases/create-integer-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-ip-attribute.md b/docs/examples/databases/create-ip-attribute.md index 88167e1..7abeee9 100644 --- a/docs/examples/databases/create-ip-attribute.md +++ b/docs/examples/databases/create-ip-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md index d80f19c..b056f3b 100644 --- a/docs/examples/databases/create-relationship-attribute.md +++ b/docs/examples/databases/create-relationship-attribute.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md index 05f96cf..d94af0f 100644 --- a/docs/examples/databases/create-string-attribute.md +++ b/docs/examples/databases/create-string-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create-url-attribute.md b/docs/examples/databases/create-url-attribute.md index 9f216d9..3ffd732 100644 --- a/docs/examples/databases/create-url-attribute.md +++ b/docs/examples/databases/create-url-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md index 3846e50..62675e6 100644 --- a/docs/examples/databases/create.md +++ b/docs/examples/databases/create.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/delete-attribute.md b/docs/examples/databases/delete-attribute.md index a352a73..816b31e 100644 --- a/docs/examples/databases/delete-attribute.md +++ b/docs/examples/databases/delete-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/delete-collection.md b/docs/examples/databases/delete-collection.md index 1c0b961..28dd8d7 100644 --- a/docs/examples/databases/delete-collection.md +++ b/docs/examples/databases/delete-collection.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md index 5195ea4..2102d26 100644 --- a/docs/examples/databases/delete-document.md +++ b/docs/examples/databases/delete-document.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/delete-documents.md b/docs/examples/databases/delete-documents.md new file mode 100644 index 0000000..d0f10d0 --- /dev/null +++ b/docs/examples/databases/delete-documents.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +databases = Databases.new(client) + +result = databases.delete_documents( + database_id: '', + collection_id: '', + queries: [] # optional +) diff --git a/docs/examples/databases/delete-index.md b/docs/examples/databases/delete-index.md index e91770c..b5d9231 100644 --- a/docs/examples/databases/delete-index.md +++ b/docs/examples/databases/delete-index.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/delete.md b/docs/examples/databases/delete.md index dbd5b55..802f5d6 100644 --- a/docs/examples/databases/delete.md +++ b/docs/examples/databases/delete.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/get-attribute.md b/docs/examples/databases/get-attribute.md index 94ed06a..1558de6 100644 --- a/docs/examples/databases/get-attribute.md +++ b/docs/examples/databases/get-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/get-collection.md b/docs/examples/databases/get-collection.md index ff66336..89ae0e3 100644 --- a/docs/examples/databases/get-collection.md +++ b/docs/examples/databases/get-collection.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md index bd0e4ec..f43a1a2 100644 --- a/docs/examples/databases/get-document.md +++ b/docs/examples/databases/get-document.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/get-index.md b/docs/examples/databases/get-index.md index 3042e14..cd5fca3 100644 --- a/docs/examples/databases/get-index.md +++ b/docs/examples/databases/get-index.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/get.md b/docs/examples/databases/get.md index cd8b777..c042cd7 100644 --- a/docs/examples/databases/get.md +++ b/docs/examples/databases/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md index 2a500a6..f1ec0de 100644 --- a/docs/examples/databases/list-attributes.md +++ b/docs/examples/databases/list-attributes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/list-collections.md b/docs/examples/databases/list-collections.md index bac8095..26f3d35 100644 --- a/docs/examples/databases/list-collections.md +++ b/docs/examples/databases/list-collections.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md index 891e534..6617198 100644 --- a/docs/examples/databases/list-documents.md +++ b/docs/examples/databases/list-documents.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md index 7f86bb7..f98c62a 100644 --- a/docs/examples/databases/list-indexes.md +++ b/docs/examples/databases/list-indexes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/list.md b/docs/examples/databases/list.md index 14c6fd1..2e093f7 100644 --- a/docs/examples/databases/list.md +++ b/docs/examples/databases/list.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-boolean-attribute.md b/docs/examples/databases/update-boolean-attribute.md index 8548486..72f0eac 100644 --- a/docs/examples/databases/update-boolean-attribute.md +++ b/docs/examples/databases/update-boolean-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-collection.md b/docs/examples/databases/update-collection.md index 9a1c73c..d42a651 100644 --- a/docs/examples/databases/update-collection.md +++ b/docs/examples/databases/update-collection.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-datetime-attribute.md b/docs/examples/databases/update-datetime-attribute.md index a7c8b32..b726283 100644 --- a/docs/examples/databases/update-datetime-attribute.md +++ b/docs/examples/databases/update-datetime-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md index dce09af..485eb04 100644 --- a/docs/examples/databases/update-document.md +++ b/docs/examples/databases/update-document.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/databases/update-documents.md b/docs/examples/databases/update-documents.md new file mode 100644 index 0000000..2f69072 --- /dev/null +++ b/docs/examples/databases/update-documents.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +databases = Databases.new(client) + +result = databases.update_documents( + database_id: '', + collection_id: '', + data: {}, # optional + queries: [] # optional +) diff --git a/docs/examples/databases/update-email-attribute.md b/docs/examples/databases/update-email-attribute.md index 9845f4b..3324e39 100644 --- a/docs/examples/databases/update-email-attribute.md +++ b/docs/examples/databases/update-email-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-enum-attribute.md b/docs/examples/databases/update-enum-attribute.md index 6bc28c3..72a0515 100644 --- a/docs/examples/databases/update-enum-attribute.md +++ b/docs/examples/databases/update-enum-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-float-attribute.md b/docs/examples/databases/update-float-attribute.md index 241a639..738e6de 100644 --- a/docs/examples/databases/update-float-attribute.md +++ b/docs/examples/databases/update-float-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-integer-attribute.md b/docs/examples/databases/update-integer-attribute.md index 15e3960..dece445 100644 --- a/docs/examples/databases/update-integer-attribute.md +++ b/docs/examples/databases/update-integer-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-ip-attribute.md b/docs/examples/databases/update-ip-attribute.md index b53719e..deceb73 100644 --- a/docs/examples/databases/update-ip-attribute.md +++ b/docs/examples/databases/update-ip-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-relationship-attribute.md b/docs/examples/databases/update-relationship-attribute.md index 2b9d72a..679edb8 100644 --- a/docs/examples/databases/update-relationship-attribute.md +++ b/docs/examples/databases/update-relationship-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md index 5e4ac57..66f458e 100644 --- a/docs/examples/databases/update-string-attribute.md +++ b/docs/examples/databases/update-string-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update-url-attribute.md b/docs/examples/databases/update-url-attribute.md index 4367107..cbf417b 100644 --- a/docs/examples/databases/update-url-attribute.md +++ b/docs/examples/databases/update-url-attribute.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md index eb5e42c..e5c02a1 100644 --- a/docs/examples/databases/update.md +++ b/docs/examples/databases/update.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/databases/upsert-documents.md b/docs/examples/databases/upsert-documents.md new file mode 100644 index 0000000..353e38f --- /dev/null +++ b/docs/examples/databases/upsert-documents.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +databases = Databases.new(client) + +result = databases.upsert_documents( + database_id: '', + collection_id: '', + documents: [] # optional +) diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-build.md index 031bf03..ef6151c 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-build.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md index 8c0b3a5..0ff3db3 100644 --- a/docs/examples/functions/create-deployment.md +++ b/docs/examples/functions/create-deployment.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md index bda612c..b64b1d5 100644 --- a/docs/examples/functions/create-execution.md +++ b/docs/examples/functions/create-execution.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index 10fa86e..8094b7d 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index 9c0bf29..100491d 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/delete-deployment.md b/docs/examples/functions/delete-deployment.md index 642bf23..192172c 100644 --- a/docs/examples/functions/delete-deployment.md +++ b/docs/examples/functions/delete-deployment.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/delete-execution.md b/docs/examples/functions/delete-execution.md index bb91baa..4172aad 100644 --- a/docs/examples/functions/delete-execution.md +++ b/docs/examples/functions/delete-execution.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/delete-variable.md b/docs/examples/functions/delete-variable.md index c36a583..ffbe69f 100644 --- a/docs/examples/functions/delete-variable.md +++ b/docs/examples/functions/delete-variable.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/delete.md b/docs/examples/functions/delete.md index 787692a..e5c59e3 100644 --- a/docs/examples/functions/delete.md +++ b/docs/examples/functions/delete.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md index 01db87c..57cacc6 100644 --- a/docs/examples/functions/get-deployment-download.md +++ b/docs/examples/functions/get-deployment-download.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/get-deployment.md b/docs/examples/functions/get-deployment.md index b6baee4..1651ae1 100644 --- a/docs/examples/functions/get-deployment.md +++ b/docs/examples/functions/get-deployment.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md index 6b19e4e..7ab910e 100644 --- a/docs/examples/functions/get-execution.md +++ b/docs/examples/functions/get-execution.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/functions/get-variable.md b/docs/examples/functions/get-variable.md index 30d6a00..5022cf8 100644 --- a/docs/examples/functions/get-variable.md +++ b/docs/examples/functions/get-variable.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/get.md b/docs/examples/functions/get.md index c2d63de..5cfd135 100644 --- a/docs/examples/functions/get.md +++ b/docs/examples/functions/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/list-deployments.md b/docs/examples/functions/list-deployments.md index 7db9d45..3df3dd3 100644 --- a/docs/examples/functions/list-deployments.md +++ b/docs/examples/functions/list-deployments.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index 159c78d..df63053 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/functions/list-runtimes.md b/docs/examples/functions/list-runtimes.md index 938fcf7..1b6d25e 100644 --- a/docs/examples/functions/list-runtimes.md +++ b/docs/examples/functions/list-runtimes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/list-specifications.md b/docs/examples/functions/list-specifications.md index 2ccd05e..2c9cf7c 100644 --- a/docs/examples/functions/list-specifications.md +++ b/docs/examples/functions/list-specifications.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/list-variables.md b/docs/examples/functions/list-variables.md index 6159bf1..dd3fc4f 100644 --- a/docs/examples/functions/list-variables.md +++ b/docs/examples/functions/list-variables.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/list.md b/docs/examples/functions/list.md index a49034d..0cab1c3 100644 --- a/docs/examples/functions/list.md +++ b/docs/examples/functions/list.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/update-deployment-build.md b/docs/examples/functions/update-deployment-build.md index 5164aeb..b8611f2 100644 --- a/docs/examples/functions/update-deployment-build.md +++ b/docs/examples/functions/update-deployment-build.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-deployment.md index 862e86d..c460885 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-deployment.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index 6ac47f8..f0b6002 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md index 8f5cafd..45b6e32 100644 --- a/docs/examples/functions/update.md +++ b/docs/examples/functions/update.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/graphql/mutation.md b/docs/examples/graphql/mutation.md index 7daf975..08ca6f3 100644 --- a/docs/examples/graphql/mutation.md +++ b/docs/examples/graphql/mutation.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/graphql/query.md b/docs/examples/graphql/query.md index 0825bde..05e6950 100644 --- a/docs/examples/graphql/query.md +++ b/docs/examples/graphql/query.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-antivirus.md b/docs/examples/health/get-antivirus.md index 5112507..5f8d060 100644 --- a/docs/examples/health/get-antivirus.md +++ b/docs/examples/health/get-antivirus.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-cache.md b/docs/examples/health/get-cache.md index 5493b75..01bd46c 100644 --- a/docs/examples/health/get-cache.md +++ b/docs/examples/health/get-cache.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-certificate.md b/docs/examples/health/get-certificate.md index dcfcb6a..64699d4 100644 --- a/docs/examples/health/get-certificate.md +++ b/docs/examples/health/get-certificate.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-d-b.md b/docs/examples/health/get-d-b.md index a707a14..d966833 100644 --- a/docs/examples/health/get-d-b.md +++ b/docs/examples/health/get-d-b.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md index da41856..73e1983 100644 --- a/docs/examples/health/get-failed-jobs.md +++ b/docs/examples/health/get-failed-jobs.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-pub-sub.md b/docs/examples/health/get-pub-sub.md index 4d86e06..86e9c40 100644 --- a/docs/examples/health/get-pub-sub.md +++ b/docs/examples/health/get-pub-sub.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-builds.md b/docs/examples/health/get-queue-builds.md index bb002f8..9f87698 100644 --- a/docs/examples/health/get-queue-builds.md +++ b/docs/examples/health/get-queue-builds.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-certificates.md b/docs/examples/health/get-queue-certificates.md index 59572f9..d10c2fe 100644 --- a/docs/examples/health/get-queue-certificates.md +++ b/docs/examples/health/get-queue-certificates.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md index e09233b..37024d8 100644 --- a/docs/examples/health/get-queue-databases.md +++ b/docs/examples/health/get-queue-databases.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-deletes.md b/docs/examples/health/get-queue-deletes.md index 184c134..2508be2 100644 --- a/docs/examples/health/get-queue-deletes.md +++ b/docs/examples/health/get-queue-deletes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-functions.md b/docs/examples/health/get-queue-functions.md index b44b7b8..e5b5647 100644 --- a/docs/examples/health/get-queue-functions.md +++ b/docs/examples/health/get-queue-functions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-logs.md b/docs/examples/health/get-queue-logs.md index dd3f875..cb35ac3 100644 --- a/docs/examples/health/get-queue-logs.md +++ b/docs/examples/health/get-queue-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-mails.md b/docs/examples/health/get-queue-mails.md index ce7c405..36cfec3 100644 --- a/docs/examples/health/get-queue-mails.md +++ b/docs/examples/health/get-queue-mails.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-messaging.md b/docs/examples/health/get-queue-messaging.md index 842da5b..d317f2a 100644 --- a/docs/examples/health/get-queue-messaging.md +++ b/docs/examples/health/get-queue-messaging.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-migrations.md b/docs/examples/health/get-queue-migrations.md index 3349291..3c68c86 100644 --- a/docs/examples/health/get-queue-migrations.md +++ b/docs/examples/health/get-queue-migrations.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-stats-resources.md b/docs/examples/health/get-queue-stats-resources.md index 9796195..7024bac 100644 --- a/docs/examples/health/get-queue-stats-resources.md +++ b/docs/examples/health/get-queue-stats-resources.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md index b1d1704..b687bd8 100644 --- a/docs/examples/health/get-queue-usage.md +++ b/docs/examples/health/get-queue-usage.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-queue-webhooks.md b/docs/examples/health/get-queue-webhooks.md index 982e244..28f28ea 100644 --- a/docs/examples/health/get-queue-webhooks.md +++ b/docs/examples/health/get-queue-webhooks.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-storage-local.md b/docs/examples/health/get-storage-local.md index 8a04f77..a122de5 100644 --- a/docs/examples/health/get-storage-local.md +++ b/docs/examples/health/get-storage-local.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-storage.md b/docs/examples/health/get-storage.md index 6a5dfa9..ee77864 100644 --- a/docs/examples/health/get-storage.md +++ b/docs/examples/health/get-storage.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get-time.md b/docs/examples/health/get-time.md index 9e95c23..9d34555 100644 --- a/docs/examples/health/get-time.md +++ b/docs/examples/health/get-time.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/health/get.md b/docs/examples/health/get.md index 5c82e66..4bbf0c0 100644 --- a/docs/examples/health/get.md +++ b/docs/examples/health/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/locale/get.md b/docs/examples/locale/get.md index d3a982d..264da0e 100644 --- a/docs/examples/locale/get.md +++ b/docs/examples/locale/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-codes.md b/docs/examples/locale/list-codes.md index 74a41b9..2763266 100644 --- a/docs/examples/locale/list-codes.md +++ b/docs/examples/locale/list-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-continents.md b/docs/examples/locale/list-continents.md index 3129361..b78f130 100644 --- a/docs/examples/locale/list-continents.md +++ b/docs/examples/locale/list-continents.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-countries-e-u.md b/docs/examples/locale/list-countries-e-u.md index 9b19151..8498f2b 100644 --- a/docs/examples/locale/list-countries-e-u.md +++ b/docs/examples/locale/list-countries-e-u.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-countries-phones.md b/docs/examples/locale/list-countries-phones.md index c011734..8fa087e 100644 --- a/docs/examples/locale/list-countries-phones.md +++ b/docs/examples/locale/list-countries-phones.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-countries.md b/docs/examples/locale/list-countries.md index 4884f6a..a635a4e 100644 --- a/docs/examples/locale/list-countries.md +++ b/docs/examples/locale/list-countries.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-currencies.md b/docs/examples/locale/list-currencies.md index 3dcfb70..60e9d94 100644 --- a/docs/examples/locale/list-currencies.md +++ b/docs/examples/locale/list-currencies.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/locale/list-languages.md b/docs/examples/locale/list-languages.md index 3d9a2db..e5b9df1 100644 --- a/docs/examples/locale/list-languages.md +++ b/docs/examples/locale/list-languages.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/messaging/create-apns-provider.md b/docs/examples/messaging/create-apns-provider.md index 88988f6..a280340 100644 --- a/docs/examples/messaging/create-apns-provider.md +++ b/docs/examples/messaging/create-apns-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-email.md b/docs/examples/messaging/create-email.md index c64cf5f..573a5b8 100644 --- a/docs/examples/messaging/create-email.md +++ b/docs/examples/messaging/create-email.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-fcm-provider.md b/docs/examples/messaging/create-fcm-provider.md index 1c23df8..a1e8b67 100644 --- a/docs/examples/messaging/create-fcm-provider.md +++ b/docs/examples/messaging/create-fcm-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-mailgun-provider.md b/docs/examples/messaging/create-mailgun-provider.md index 3c8a574..aa5b7f1 100644 --- a/docs/examples/messaging/create-mailgun-provider.md +++ b/docs/examples/messaging/create-mailgun-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-msg91provider.md b/docs/examples/messaging/create-msg91provider.md index 7037f00..35a192f 100644 --- a/docs/examples/messaging/create-msg91provider.md +++ b/docs/examples/messaging/create-msg91provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md index 61663f4..5c58fa5 100644 --- a/docs/examples/messaging/create-push.md +++ b/docs/examples/messaging/create-push.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-sendgrid-provider.md b/docs/examples/messaging/create-sendgrid-provider.md index e9c3154..eae3ad3 100644 --- a/docs/examples/messaging/create-sendgrid-provider.md +++ b/docs/examples/messaging/create-sendgrid-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-sms.md b/docs/examples/messaging/create-sms.md index 58a96aa..901ec40 100644 --- a/docs/examples/messaging/create-sms.md +++ b/docs/examples/messaging/create-sms.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-smtp-provider.md b/docs/examples/messaging/create-smtp-provider.md index cbdaaaf..b062e57 100644 --- a/docs/examples/messaging/create-smtp-provider.md +++ b/docs/examples/messaging/create-smtp-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-subscriber.md b/docs/examples/messaging/create-subscriber.md index 9733490..1f6fa43 100644 --- a/docs/examples/messaging/create-subscriber.md +++ b/docs/examples/messaging/create-subscriber.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_jwt('') # Your secret JSON Web Token diff --git a/docs/examples/messaging/create-telesign-provider.md b/docs/examples/messaging/create-telesign-provider.md index 40c60a7..b26d9d2 100644 --- a/docs/examples/messaging/create-telesign-provider.md +++ b/docs/examples/messaging/create-telesign-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-textmagic-provider.md b/docs/examples/messaging/create-textmagic-provider.md index 804f0b2..4fd1a36 100644 --- a/docs/examples/messaging/create-textmagic-provider.md +++ b/docs/examples/messaging/create-textmagic-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-topic.md b/docs/examples/messaging/create-topic.md index f1f29c9..da2cf5e 100644 --- a/docs/examples/messaging/create-topic.md +++ b/docs/examples/messaging/create-topic.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-twilio-provider.md b/docs/examples/messaging/create-twilio-provider.md index 1350b85..a945602 100644 --- a/docs/examples/messaging/create-twilio-provider.md +++ b/docs/examples/messaging/create-twilio-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/create-vonage-provider.md b/docs/examples/messaging/create-vonage-provider.md index c1c83a4..5a5f6eb 100644 --- a/docs/examples/messaging/create-vonage-provider.md +++ b/docs/examples/messaging/create-vonage-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/delete-provider.md b/docs/examples/messaging/delete-provider.md index 86c9ae1..3c19e1b 100644 --- a/docs/examples/messaging/delete-provider.md +++ b/docs/examples/messaging/delete-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/delete-subscriber.md b/docs/examples/messaging/delete-subscriber.md index 5606269..a82e5e9 100644 --- a/docs/examples/messaging/delete-subscriber.md +++ b/docs/examples/messaging/delete-subscriber.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_jwt('') # Your secret JSON Web Token diff --git a/docs/examples/messaging/delete-topic.md b/docs/examples/messaging/delete-topic.md index d850662..cb58ee5 100644 --- a/docs/examples/messaging/delete-topic.md +++ b/docs/examples/messaging/delete-topic.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/delete.md b/docs/examples/messaging/delete.md index 1155406..e3db261 100644 --- a/docs/examples/messaging/delete.md +++ b/docs/examples/messaging/delete.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/get-message.md b/docs/examples/messaging/get-message.md index 8b7ffad..f5449a0 100644 --- a/docs/examples/messaging/get-message.md +++ b/docs/examples/messaging/get-message.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/get-provider.md b/docs/examples/messaging/get-provider.md index 3da5beb..ddb28da 100644 --- a/docs/examples/messaging/get-provider.md +++ b/docs/examples/messaging/get-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/get-subscriber.md b/docs/examples/messaging/get-subscriber.md index 278aba0..3c7d053 100644 --- a/docs/examples/messaging/get-subscriber.md +++ b/docs/examples/messaging/get-subscriber.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/get-topic.md b/docs/examples/messaging/get-topic.md index ec58550..9ff732f 100644 --- a/docs/examples/messaging/get-topic.md +++ b/docs/examples/messaging/get-topic.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-message-logs.md b/docs/examples/messaging/list-message-logs.md index 7db1381..f20d6fb 100644 --- a/docs/examples/messaging/list-message-logs.md +++ b/docs/examples/messaging/list-message-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-messages.md b/docs/examples/messaging/list-messages.md index 07fc3fc..ffc5dcd 100644 --- a/docs/examples/messaging/list-messages.md +++ b/docs/examples/messaging/list-messages.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-provider-logs.md b/docs/examples/messaging/list-provider-logs.md index fda60b6..af3751a 100644 --- a/docs/examples/messaging/list-provider-logs.md +++ b/docs/examples/messaging/list-provider-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-providers.md b/docs/examples/messaging/list-providers.md index 43f4a21..a857f05 100644 --- a/docs/examples/messaging/list-providers.md +++ b/docs/examples/messaging/list-providers.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-subscriber-logs.md b/docs/examples/messaging/list-subscriber-logs.md index 5be2900..06550e7 100644 --- a/docs/examples/messaging/list-subscriber-logs.md +++ b/docs/examples/messaging/list-subscriber-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-subscribers.md b/docs/examples/messaging/list-subscribers.md index 6583f93..07ebc99 100644 --- a/docs/examples/messaging/list-subscribers.md +++ b/docs/examples/messaging/list-subscribers.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-targets.md b/docs/examples/messaging/list-targets.md index 7354fc5..0407255 100644 --- a/docs/examples/messaging/list-targets.md +++ b/docs/examples/messaging/list-targets.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-topic-logs.md b/docs/examples/messaging/list-topic-logs.md index fb1f0e2..9b53c47 100644 --- a/docs/examples/messaging/list-topic-logs.md +++ b/docs/examples/messaging/list-topic-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/list-topics.md b/docs/examples/messaging/list-topics.md index c00b8f1..5e7b674 100644 --- a/docs/examples/messaging/list-topics.md +++ b/docs/examples/messaging/list-topics.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-apns-provider.md b/docs/examples/messaging/update-apns-provider.md index e1748e6..b19704a 100644 --- a/docs/examples/messaging/update-apns-provider.md +++ b/docs/examples/messaging/update-apns-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-email.md b/docs/examples/messaging/update-email.md index baae0f9..aa35932 100644 --- a/docs/examples/messaging/update-email.md +++ b/docs/examples/messaging/update-email.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-fcm-provider.md b/docs/examples/messaging/update-fcm-provider.md index 463e028..44ea0d2 100644 --- a/docs/examples/messaging/update-fcm-provider.md +++ b/docs/examples/messaging/update-fcm-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-mailgun-provider.md b/docs/examples/messaging/update-mailgun-provider.md index 38f7417..a2e5319 100644 --- a/docs/examples/messaging/update-mailgun-provider.md +++ b/docs/examples/messaging/update-mailgun-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-msg91provider.md b/docs/examples/messaging/update-msg91provider.md index b58c04f..0e88382 100644 --- a/docs/examples/messaging/update-msg91provider.md +++ b/docs/examples/messaging/update-msg91provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md index 6bf9fca..42a5104 100644 --- a/docs/examples/messaging/update-push.md +++ b/docs/examples/messaging/update-push.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-sendgrid-provider.md b/docs/examples/messaging/update-sendgrid-provider.md index afa2c17..99f1a9c 100644 --- a/docs/examples/messaging/update-sendgrid-provider.md +++ b/docs/examples/messaging/update-sendgrid-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-sms.md b/docs/examples/messaging/update-sms.md index 31adae7..b31480c 100644 --- a/docs/examples/messaging/update-sms.md +++ b/docs/examples/messaging/update-sms.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-smtp-provider.md b/docs/examples/messaging/update-smtp-provider.md index 00c6d57..bbaebf3 100644 --- a/docs/examples/messaging/update-smtp-provider.md +++ b/docs/examples/messaging/update-smtp-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-telesign-provider.md b/docs/examples/messaging/update-telesign-provider.md index 1d530f0..4f1bf6f 100644 --- a/docs/examples/messaging/update-telesign-provider.md +++ b/docs/examples/messaging/update-telesign-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-textmagic-provider.md b/docs/examples/messaging/update-textmagic-provider.md index e4e7a42..c8cd2f0 100644 --- a/docs/examples/messaging/update-textmagic-provider.md +++ b/docs/examples/messaging/update-textmagic-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-topic.md b/docs/examples/messaging/update-topic.md index c944fb4..d20d945 100644 --- a/docs/examples/messaging/update-topic.md +++ b/docs/examples/messaging/update-topic.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-twilio-provider.md b/docs/examples/messaging/update-twilio-provider.md index 8203054..0f6a676 100644 --- a/docs/examples/messaging/update-twilio-provider.md +++ b/docs/examples/messaging/update-twilio-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/messaging/update-vonage-provider.md b/docs/examples/messaging/update-vonage-provider.md index 01d7fe1..e75bfbd 100644 --- a/docs/examples/messaging/update-vonage-provider.md +++ b/docs/examples/messaging/update-vonage-provider.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md index a6bb22c..643431e 100644 --- a/docs/examples/storage/create-bucket.md +++ b/docs/examples/storage/create-bucket.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md index c6f3e26..99e07c3 100644 --- a/docs/examples/storage/create-file.md +++ b/docs/examples/storage/create-file.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/delete-bucket.md b/docs/examples/storage/delete-bucket.md index 37d504c..dda3264 100644 --- a/docs/examples/storage/delete-bucket.md +++ b/docs/examples/storage/delete-bucket.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/delete-file.md b/docs/examples/storage/delete-file.md index 74bd8df..eef0588 100644 --- a/docs/examples/storage/delete-file.md +++ b/docs/examples/storage/delete-file.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/get-bucket.md b/docs/examples/storage/get-bucket.md index 158fc30..7c8580d 100644 --- a/docs/examples/storage/get-bucket.md +++ b/docs/examples/storage/get-bucket.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index 86efd7c..0747fdf 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index 2babfbd..38a68a8 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md index b6b0c56..4c31305 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/get-file.md b/docs/examples/storage/get-file.md index 76bcca4..b816bdb 100644 --- a/docs/examples/storage/get-file.md +++ b/docs/examples/storage/get-file.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/list-buckets.md b/docs/examples/storage/list-buckets.md index 73cf40e..dfee831 100644 --- a/docs/examples/storage/list-buckets.md +++ b/docs/examples/storage/list-buckets.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md index 0ce09d8..078ff55 100644 --- a/docs/examples/storage/list-files.md +++ b/docs/examples/storage/list-files.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md index 3db084d..09b915e 100644 --- a/docs/examples/storage/update-bucket.md +++ b/docs/examples/storage/update-bucket.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md index ed50e9c..a454499 100644 --- a/docs/examples/storage/update-file.md +++ b/docs/examples/storage/update-file.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md index 1990223..6c0faba 100644 --- a/docs/examples/teams/create-membership.md +++ b/docs/examples/teams/create-membership.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md index e462cf4..ba71a1d 100644 --- a/docs/examples/teams/create.md +++ b/docs/examples/teams/create.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/delete-membership.md b/docs/examples/teams/delete-membership.md index 4dc3397..5d815a8 100644 --- a/docs/examples/teams/delete-membership.md +++ b/docs/examples/teams/delete-membership.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/delete.md b/docs/examples/teams/delete.md index f4879ba..c9f7c40 100644 --- a/docs/examples/teams/delete.md +++ b/docs/examples/teams/delete.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/get-membership.md b/docs/examples/teams/get-membership.md index ed60299..41a2c7b 100644 --- a/docs/examples/teams/get-membership.md +++ b/docs/examples/teams/get-membership.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/get-prefs.md b/docs/examples/teams/get-prefs.md index 1708412..e6b2cfa 100644 --- a/docs/examples/teams/get-prefs.md +++ b/docs/examples/teams/get-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/get.md b/docs/examples/teams/get.md index 5d5a274..af51193 100644 --- a/docs/examples/teams/get.md +++ b/docs/examples/teams/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md index ac22269..db48f0c 100644 --- a/docs/examples/teams/list-memberships.md +++ b/docs/examples/teams/list-memberships.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md index 50b49f8..9e96391 100644 --- a/docs/examples/teams/list.md +++ b/docs/examples/teams/list.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/update-membership-status.md b/docs/examples/teams/update-membership-status.md index bb22ef0..40d82b8 100644 --- a/docs/examples/teams/update-membership-status.md +++ b/docs/examples/teams/update-membership-status.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/update-membership.md b/docs/examples/teams/update-membership.md index 7f92ff0..92b69b1 100644 --- a/docs/examples/teams/update-membership.md +++ b/docs/examples/teams/update-membership.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/update-name.md b/docs/examples/teams/update-name.md index 267e5f2..74f785c 100644 --- a/docs/examples/teams/update-name.md +++ b/docs/examples/teams/update-name.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/teams/update-prefs.md b/docs/examples/teams/update-prefs.md index 337db7f..03426aa 100644 --- a/docs/examples/teams/update-prefs.md +++ b/docs/examples/teams/update-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_session('') # The user session to authenticate with diff --git a/docs/examples/users/create-argon2user.md b/docs/examples/users/create-argon2user.md index 8b633da..8da9e0b 100644 --- a/docs/examples/users/create-argon2user.md +++ b/docs/examples/users/create-argon2user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-bcrypt-user.md b/docs/examples/users/create-bcrypt-user.md index d76f653..7c2b852 100644 --- a/docs/examples/users/create-bcrypt-user.md +++ b/docs/examples/users/create-bcrypt-user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-j-w-t.md b/docs/examples/users/create-j-w-t.md index a30a2b6..57f7f1d 100644 --- a/docs/examples/users/create-j-w-t.md +++ b/docs/examples/users/create-j-w-t.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-m-d5user.md b/docs/examples/users/create-m-d5user.md index 80ca9f5..63fb687 100644 --- a/docs/examples/users/create-m-d5user.md +++ b/docs/examples/users/create-m-d5user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-mfa-recovery-codes.md b/docs/examples/users/create-mfa-recovery-codes.md index 64fc8d5..0cdea46 100644 --- a/docs/examples/users/create-mfa-recovery-codes.md +++ b/docs/examples/users/create-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-p-h-pass-user.md b/docs/examples/users/create-p-h-pass-user.md index 2fa6081..7cd898a 100644 --- a/docs/examples/users/create-p-h-pass-user.md +++ b/docs/examples/users/create-p-h-pass-user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-s-h-a-user.md b/docs/examples/users/create-s-h-a-user.md index 39c1774..f3951d9 100644 --- a/docs/examples/users/create-s-h-a-user.md +++ b/docs/examples/users/create-s-h-a-user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-scrypt-modified-user.md b/docs/examples/users/create-scrypt-modified-user.md index 2a0ac89..d84c2ee 100644 --- a/docs/examples/users/create-scrypt-modified-user.md +++ b/docs/examples/users/create-scrypt-modified-user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-scrypt-user.md b/docs/examples/users/create-scrypt-user.md index 38c250e..53aa253 100644 --- a/docs/examples/users/create-scrypt-user.md +++ b/docs/examples/users/create-scrypt-user.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-session.md b/docs/examples/users/create-session.md index ece2f42..32d2b5f 100644 --- a/docs/examples/users/create-session.md +++ b/docs/examples/users/create-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-target.md b/docs/examples/users/create-target.md index 5e5d943..3e87868 100644 --- a/docs/examples/users/create-target.md +++ b/docs/examples/users/create-target.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create-token.md b/docs/examples/users/create-token.md index 318294b..85e5f44 100644 --- a/docs/examples/users/create-token.md +++ b/docs/examples/users/create-token.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/create.md b/docs/examples/users/create.md index aa742f6..4f57ade 100644 --- a/docs/examples/users/create.md +++ b/docs/examples/users/create.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md index 3c2e7a5..d2482df 100644 --- a/docs/examples/users/delete-identity.md +++ b/docs/examples/users/delete-identity.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete-mfa-authenticator.md b/docs/examples/users/delete-mfa-authenticator.md index 9bed863..50fcb0f 100644 --- a/docs/examples/users/delete-mfa-authenticator.md +++ b/docs/examples/users/delete-mfa-authenticator.md @@ -4,7 +4,7 @@ include Appwrite include Appwrite::Enums client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete-session.md b/docs/examples/users/delete-session.md index 4ac5f27..9b14cc4 100644 --- a/docs/examples/users/delete-session.md +++ b/docs/examples/users/delete-session.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete-sessions.md b/docs/examples/users/delete-sessions.md index b83a422..23fd505 100644 --- a/docs/examples/users/delete-sessions.md +++ b/docs/examples/users/delete-sessions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete-target.md b/docs/examples/users/delete-target.md index 0e016cf..f156402 100644 --- a/docs/examples/users/delete-target.md +++ b/docs/examples/users/delete-target.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/delete.md b/docs/examples/users/delete.md index 0aea693..db7f2ee 100644 --- a/docs/examples/users/delete.md +++ b/docs/examples/users/delete.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/get-mfa-recovery-codes.md b/docs/examples/users/get-mfa-recovery-codes.md index f12a287..f984517 100644 --- a/docs/examples/users/get-mfa-recovery-codes.md +++ b/docs/examples/users/get-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/get-prefs.md b/docs/examples/users/get-prefs.md index afcb56f..0118b39 100644 --- a/docs/examples/users/get-prefs.md +++ b/docs/examples/users/get-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/get-target.md b/docs/examples/users/get-target.md index b2e268e..10ce49b 100644 --- a/docs/examples/users/get-target.md +++ b/docs/examples/users/get-target.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/get.md b/docs/examples/users/get.md index 86ec849..95865b7 100644 --- a/docs/examples/users/get.md +++ b/docs/examples/users/get.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md index 2d4aa2f..78c8cf5 100644 --- a/docs/examples/users/list-identities.md +++ b/docs/examples/users/list-identities.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-logs.md b/docs/examples/users/list-logs.md index a13cec1..6864348 100644 --- a/docs/examples/users/list-logs.md +++ b/docs/examples/users/list-logs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index 8706af1..d36c380 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-mfa-factors.md b/docs/examples/users/list-mfa-factors.md index ab98651..ca1e2b2 100644 --- a/docs/examples/users/list-mfa-factors.md +++ b/docs/examples/users/list-mfa-factors.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-sessions.md b/docs/examples/users/list-sessions.md index 17faa16..3114205 100644 --- a/docs/examples/users/list-sessions.md +++ b/docs/examples/users/list-sessions.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list-targets.md b/docs/examples/users/list-targets.md index 9b849e4..aae9941 100644 --- a/docs/examples/users/list-targets.md +++ b/docs/examples/users/list-targets.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/list.md b/docs/examples/users/list.md index 40d1e83..b490b65 100644 --- a/docs/examples/users/list.md +++ b/docs/examples/users/list.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-email-verification.md b/docs/examples/users/update-email-verification.md index 439fa33..07f85f0 100644 --- a/docs/examples/users/update-email-verification.md +++ b/docs/examples/users/update-email-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-email.md b/docs/examples/users/update-email.md index d93141f..b36aac5 100644 --- a/docs/examples/users/update-email.md +++ b/docs/examples/users/update-email.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md index 2789e8f..a62d34b 100644 --- a/docs/examples/users/update-labels.md +++ b/docs/examples/users/update-labels.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-mfa-recovery-codes.md b/docs/examples/users/update-mfa-recovery-codes.md index 1fc497c..aaf5ba1 100644 --- a/docs/examples/users/update-mfa-recovery-codes.md +++ b/docs/examples/users/update-mfa-recovery-codes.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-mfa.md b/docs/examples/users/update-mfa.md index 9bafee4..3ebfb96 100644 --- a/docs/examples/users/update-mfa.md +++ b/docs/examples/users/update-mfa.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-name.md b/docs/examples/users/update-name.md index 7645c16..e7ade96 100644 --- a/docs/examples/users/update-name.md +++ b/docs/examples/users/update-name.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-password.md b/docs/examples/users/update-password.md index 40e03ee..47c1f1e 100644 --- a/docs/examples/users/update-password.md +++ b/docs/examples/users/update-password.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-phone-verification.md b/docs/examples/users/update-phone-verification.md index 88082ee..6af7fcb 100644 --- a/docs/examples/users/update-phone-verification.md +++ b/docs/examples/users/update-phone-verification.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-phone.md b/docs/examples/users/update-phone.md index b08daa8..bd26547 100644 --- a/docs/examples/users/update-phone.md +++ b/docs/examples/users/update-phone.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-prefs.md b/docs/examples/users/update-prefs.md index 9871ff5..fbdccd7 100644 --- a/docs/examples/users/update-prefs.md +++ b/docs/examples/users/update-prefs.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-status.md b/docs/examples/users/update-status.md index a5d9544..d73982c 100644 --- a/docs/examples/users/update-status.md +++ b/docs/examples/users/update-status.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/docs/examples/users/update-target.md b/docs/examples/users/update-target.md index 6acc913..dbcd1bd 100644 --- a/docs/examples/users/update-target.md +++ b/docs/examples/users/update-target.md @@ -3,7 +3,7 @@ require 'appwrite' include Appwrite client = Client.new - .set_endpoint('https://cloud.appwrite.io/v1') # Your API Endpoint + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint .set_project('') # Your project ID .set_key('') # Your secret API key diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb index 1d2d567..0ef665f 100644 --- a/lib/appwrite/client.rb +++ b/lib/appwrite/client.rb @@ -15,7 +15,7 @@ def initialize 'x-sdk-name'=> 'Ruby', 'x-sdk-platform'=> 'server', 'x-sdk-language'=> 'ruby', - 'x-sdk-version'=> '15.0.0', + 'x-sdk-version'=> '15.1.0-rc.1', 'X-Appwrite-Response-Format' => '1.6.0' } @endpoint = 'https://cloud.appwrite.io/v1' diff --git a/lib/appwrite/services/databases.rb b/lib/appwrite/services/databases.rb index d36db4a..48e3ab4 100644 --- a/lib/appwrite/services/databases.rb +++ b/lib/appwrite/services/databases.rb @@ -1680,7 +1680,6 @@ def list_documents(database_id:, collection_id:, queries: nil) # collection resource using either a [server # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) # API or directly from your database console. - # # # @param [String] database_id Database ID. # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents. @@ -1730,6 +1729,175 @@ def create_document(database_id:, collection_id:, document_id:, data:, permissio end + # Create new Documents. Before using this route, you should create a new + # collection resource using either a [server + # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + # API or directly from your database console. + # + # + # @param [String] database_id Database ID. + # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents. + # @param [Array] documents Array of documents data as JSON objects. + # + # @return [DocumentList] + def create_documents(database_id:, collection_id:, documents:) + api_path = '/databases/{databaseId}/collections/{collectionId}/documents' + .gsub('{databaseId}', database_id) + .gsub('{collectionId}', collection_id) + + if database_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "databaseId"') + end + + if collection_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "collectionId"') + end + + if documents.nil? + raise Appwrite::Exception.new('Missing required parameter: "documents"') + end + + api_params = { + documents: documents, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::DocumentList + ) + end + + + # Create or update Documents. Before using this route, you should create a + # new collection resource using either a [server + # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + # API or directly from your database console. + # + # + # @param [String] database_id Database ID. + # @param [String] collection_id Collection ID. + # @param [Array] documents Array of document data as JSON objects. May contain partial documents. + # + # @return [DocumentList] + def upsert_documents(database_id:, collection_id:, documents: nil) + api_path = '/databases/{databaseId}/collections/{collectionId}/documents' + .gsub('{databaseId}', database_id) + .gsub('{collectionId}', collection_id) + + if database_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "databaseId"') + end + + if collection_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "collectionId"') + end + + api_params = { + documents: documents, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PUT', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::DocumentList + ) + end + + + # Update all documents that match your queries, if no queries are submitted + # then all documents are updated. You can pass only specific fields to be + # updated. + # + # @param [String] database_id Database ID. + # @param [String] collection_id Collection ID. + # @param [Hash] data Document data as JSON object. Include only attribute and value pairs to be updated. + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. + # + # @return [DocumentList] + def update_documents(database_id:, collection_id:, data: nil, queries: nil) + api_path = '/databases/{databaseId}/collections/{collectionId}/documents' + .gsub('{databaseId}', database_id) + .gsub('{collectionId}', collection_id) + + if database_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "databaseId"') + end + + if collection_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "collectionId"') + end + + api_params = { + data: data, + queries: queries, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PATCH', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::DocumentList + ) + end + + + # Bulk delete documents using queries, if no queries are passed then all + # documents are deleted. + # + # @param [String] database_id Database ID. + # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. + # + # @return [DocumentList] + def delete_documents(database_id:, collection_id:, queries: nil) + api_path = '/databases/{databaseId}/collections/{collectionId}/documents' + .gsub('{databaseId}', database_id) + .gsub('{collectionId}', collection_id) + + if database_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "databaseId"') + end + + if collection_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "collectionId"') + end + + api_params = { + queries: queries, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::DocumentList + ) + end + + # Get a document by its unique ID. This endpoint response returns a JSON # object with the document data. # From 2f4e1313a59a29a7950884d3dec41cb0c8662cfe Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Sun, 18 May 2025 00:05:15 +1200 Subject: [PATCH 2/3] Add support for 1.7 --- README.md | 4 +- appwrite.gemspec | 2 +- docs/examples/avatars/get-browser.md | 2 +- docs/examples/avatars/get-credit-card.md | 2 +- docs/examples/avatars/get-flag.md | 2 +- docs/examples/databases/create-document.md | 3 +- docs/examples/databases/create-documents.md | 3 +- docs/examples/databases/create-index.md | 3 +- ...uild.md => create-duplicate-deployment.md} | 2 +- .../functions/create-template-deployment.md | 19 + docs/examples/functions/create-variable.md | 3 +- .../functions/create-vcs-deployment.md | 18 + docs/examples/functions/create.md | 4 - .../functions/get-deployment-download.md | 3 +- docs/examples/functions/list-executions.md | 3 +- ...t-build.md => update-deployment-status.md} | 2 +- ...yment.md => update-function-deployment.md} | 2 +- docs/examples/functions/update-variable.md | 3 +- docs/examples/sites/create-deployment.md | 19 + .../sites/create-duplicate-deployment.md | 15 + .../sites/create-template-deployment.md | 19 + docs/examples/sites/create-variable.md | 17 + docs/examples/sites/create-vcs-deployment.md | 18 + docs/examples/sites/create.md | 32 + docs/examples/sites/delete-deployment.md | 15 + docs/examples/sites/delete-log.md | 15 + docs/examples/sites/delete-variable.md | 15 + docs/examples/sites/delete.md | 14 + .../examples/sites/get-deployment-download.md | 16 + docs/examples/sites/get-deployment.md | 15 + docs/examples/sites/get-log.md | 15 + docs/examples/sites/get-variable.md | 15 + docs/examples/sites/get.md | 14 + docs/examples/sites/list-deployments.md | 16 + docs/examples/sites/list-frameworks.md | 12 + docs/examples/sites/list-logs.md | 15 + docs/examples/sites/list-specifications.md | 12 + docs/examples/sites/list-variables.md | 14 + docs/examples/sites/list.md | 15 + .../sites/update-deployment-status.md | 15 + docs/examples/sites/update-site-deployment.md | 15 + docs/examples/sites/update-variable.md | 18 + docs/examples/sites/update.md | 32 + docs/examples/storage/get-file-download.md | 3 +- docs/examples/storage/get-file-preview.md | 5 +- docs/examples/storage/get-file-view.md | 3 +- docs/examples/tokens/create-file-token.md | 16 + docs/examples/tokens/delete.md | 14 + docs/examples/tokens/get.md | 14 + docs/examples/tokens/list.md | 16 + docs/examples/tokens/update.md | 15 + docs/examples/users/list-memberships.md | 4 +- lib/appwrite.rb | 15 +- lib/appwrite/client.rb | 4 +- lib/appwrite/enums/adapter.rb | 8 + lib/appwrite/enums/build_runtime.rb | 69 ++ .../enums/deployment_download_type.rb | 8 + lib/appwrite/enums/framework.rb | 20 + lib/appwrite/enums/image_format.rb | 1 - lib/appwrite/enums/runtime.rb | 4 + lib/appwrite/enums/vcs_deployment_type.rb | 9 + lib/appwrite/models/build.rb | 67 -- lib/appwrite/models/deployment.rb | 35 +- lib/appwrite/models/framework.rb | 47 + lib/appwrite/models/framework_adapter.rb | 47 + lib/appwrite/models/framework_list.rb | 32 + lib/appwrite/models/function.rb | 30 +- lib/appwrite/models/index.rb | 5 + lib/appwrite/models/resource_token.rb | 57 + lib/appwrite/models/resource_token_list.rb | 32 + lib/appwrite/models/site.rb | 167 +++ lib/appwrite/models/site_list.rb | 32 + lib/appwrite/models/variable.rb | 5 + lib/appwrite/services/avatars.rb | 6 +- lib/appwrite/services/databases.rb | 5 +- lib/appwrite/services/functions.rb | 241 ++-- lib/appwrite/services/sites.rb | 1004 +++++++++++++++++ lib/appwrite/services/storage.rb | 14 +- lib/appwrite/services/teams.rb | 2 +- lib/appwrite/services/tokens.rb | 179 +++ lib/appwrite/services/users.rb | 6 +- 81 files changed, 2545 insertions(+), 194 deletions(-) rename docs/examples/functions/{create-build.md => create-duplicate-deployment.md} (89%) create mode 100644 docs/examples/functions/create-template-deployment.md create mode 100644 docs/examples/functions/create-vcs-deployment.md rename docs/examples/functions/{update-deployment-build.md => update-deployment-status.md} (88%) rename docs/examples/functions/{update-deployment.md => update-function-deployment.md} (88%) create mode 100644 docs/examples/sites/create-deployment.md create mode 100644 docs/examples/sites/create-duplicate-deployment.md create mode 100644 docs/examples/sites/create-template-deployment.md create mode 100644 docs/examples/sites/create-variable.md create mode 100644 docs/examples/sites/create-vcs-deployment.md create mode 100644 docs/examples/sites/create.md create mode 100644 docs/examples/sites/delete-deployment.md create mode 100644 docs/examples/sites/delete-log.md create mode 100644 docs/examples/sites/delete-variable.md create mode 100644 docs/examples/sites/delete.md create mode 100644 docs/examples/sites/get-deployment-download.md create mode 100644 docs/examples/sites/get-deployment.md create mode 100644 docs/examples/sites/get-log.md create mode 100644 docs/examples/sites/get-variable.md create mode 100644 docs/examples/sites/get.md create mode 100644 docs/examples/sites/list-deployments.md create mode 100644 docs/examples/sites/list-frameworks.md create mode 100644 docs/examples/sites/list-logs.md create mode 100644 docs/examples/sites/list-specifications.md create mode 100644 docs/examples/sites/list-variables.md create mode 100644 docs/examples/sites/list.md create mode 100644 docs/examples/sites/update-deployment-status.md create mode 100644 docs/examples/sites/update-site-deployment.md create mode 100644 docs/examples/sites/update-variable.md create mode 100644 docs/examples/sites/update.md create mode 100644 docs/examples/tokens/create-file-token.md create mode 100644 docs/examples/tokens/delete.md create mode 100644 docs/examples/tokens/get.md create mode 100644 docs/examples/tokens/list.md create mode 100644 docs/examples/tokens/update.md create mode 100644 lib/appwrite/enums/adapter.rb create mode 100644 lib/appwrite/enums/build_runtime.rb create mode 100644 lib/appwrite/enums/deployment_download_type.rb create mode 100644 lib/appwrite/enums/framework.rb create mode 100644 lib/appwrite/enums/vcs_deployment_type.rb delete mode 100644 lib/appwrite/models/build.rb create mode 100644 lib/appwrite/models/framework.rb create mode 100644 lib/appwrite/models/framework_adapter.rb create mode 100644 lib/appwrite/models/framework_list.rb create mode 100644 lib/appwrite/models/resource_token.rb create mode 100644 lib/appwrite/models/resource_token_list.rb create mode 100644 lib/appwrite/models/site.rb create mode 100644 lib/appwrite/models/site_list.rb create mode 100644 lib/appwrite/services/sites.rb create mode 100644 lib/appwrite/services/tokens.rb diff --git a/README.md b/README.md index 485cc7b..4d908bc 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Appwrite Ruby SDK ![License](https://img.shields.io/github/license/appwrite/sdk-for-ruby.svg?style=flat-square) -![Version](https://img.shields.io/badge/api%20version-1.6.2-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-1.7.0-blue.svg?style=flat-square) [![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator) [![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) -**This SDK is compatible with Appwrite server version 1.6.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).** +**This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-ruby/releases).** Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way. Use the Ruby SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs) diff --git a/appwrite.gemspec b/appwrite.gemspec index ee01fa2..3864ac0 100644 --- a/appwrite.gemspec +++ b/appwrite.gemspec @@ -1,7 +1,7 @@ Gem::Specification.new do |spec| spec.name = 'appwrite' - spec.version = '15.1.0-rc.1' + spec.version = '15.2.0' spec.license = 'BSD-3-Clause' spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API' spec.author = 'Appwrite Team' diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index 4afdf77..36354d1 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -14,5 +14,5 @@ result = avatars.get_browser( code: Browser::AVANT_BROWSER, width: 0, # optional height: 0, # optional - quality: 0 # optional + quality: -1 # optional ) diff --git a/docs/examples/avatars/get-credit-card.md b/docs/examples/avatars/get-credit-card.md index a324f6d..09a0245 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -14,5 +14,5 @@ result = avatars.get_credit_card( code: CreditCard::AMERICAN_EXPRESS, width: 0, # optional height: 0, # optional - quality: 0 # optional + quality: -1 # optional ) diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md index f648a28..61b7793 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -14,5 +14,5 @@ result = avatars.get_flag( code: Flag::AFGHANISTAN, width: 0, # optional height: 0, # optional - quality: 0 # optional + quality: -1 # optional ) diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index e683108..ce8dea7 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -4,8 +4,9 @@ include Appwrite client = Client.new .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID .set_session('') # The user session to authenticate with + .set_key('') # Your secret API key + .set_jwt('') # Your secret JSON Web Token databases = Databases.new(client) diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md index 98eadab..469234c 100644 --- a/docs/examples/databases/create-documents.md +++ b/docs/examples/databases/create-documents.md @@ -4,8 +4,7 @@ include Appwrite client = Client.new .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_session('') # The user session to authenticate with + .set_key('') # Your secret API key databases = Databases.new(client) diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index e75478d..18c2f0e 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -16,5 +16,6 @@ result = databases.create_index( key: '', type: IndexType::KEY, attributes: [], - orders: [] # optional + orders: [], # optional + lengths: [] # optional ) diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-duplicate-deployment.md similarity index 89% rename from docs/examples/functions/create-build.md rename to docs/examples/functions/create-duplicate-deployment.md index ef6151c..cd432af 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-duplicate-deployment.md @@ -9,7 +9,7 @@ client = Client.new functions = Functions.new(client) -result = functions.create_build( +result = functions.create_duplicate_deployment( function_id: '', deployment_id: '', build_id: '' # optional diff --git a/docs/examples/functions/create-template-deployment.md b/docs/examples/functions/create-template-deployment.md new file mode 100644 index 0000000..a447b6e --- /dev/null +++ b/docs/examples/functions/create-template-deployment.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +functions = Functions.new(client) + +result = functions.create_template_deployment( + function_id: '', + repository: '', + owner: '', + root_directory: '', + version: '', + activate: false # optional +) diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index 8094b7d..3c957d4 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -12,5 +12,6 @@ functions = Functions.new(client) result = functions.create_variable( function_id: '', key: '', - value: '' + value: '', + secret: false # optional ) diff --git a/docs/examples/functions/create-vcs-deployment.md b/docs/examples/functions/create-vcs-deployment.md new file mode 100644 index 0000000..75bd3c4 --- /dev/null +++ b/docs/examples/functions/create-vcs-deployment.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +functions = Functions.new(client) + +result = functions.create_vcs_deployment( + function_id: '', + type: VCSDeploymentType::BRANCH, + reference: '', + activate: false # optional +) diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index 100491d..cad021b 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -28,9 +28,5 @@ result = functions.create( provider_branch: '', # optional provider_silent_mode: false, # optional provider_root_directory: '', # optional - template_repository: '', # optional - template_owner: '', # optional - template_root_directory: '', # optional - template_version: '', # optional specification: '' # optional ) diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md index 57cacc6..a1a50a5 100644 --- a/docs/examples/functions/get-deployment-download.md +++ b/docs/examples/functions/get-deployment-download.md @@ -11,5 +11,6 @@ functions = Functions.new(client) result = functions.get_deployment_download( function_id: '', - deployment_id: '' + deployment_id: '', + type: DeploymentDownloadType::SOURCE # optional ) diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index df63053..57b4ba2 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -11,6 +11,5 @@ functions = Functions.new(client) result = functions.list_executions( function_id: '', - queries: [], # optional - search: '' # optional + queries: [] # optional ) diff --git a/docs/examples/functions/update-deployment-build.md b/docs/examples/functions/update-deployment-status.md similarity index 88% rename from docs/examples/functions/update-deployment-build.md rename to docs/examples/functions/update-deployment-status.md index b8611f2..6664e05 100644 --- a/docs/examples/functions/update-deployment-build.md +++ b/docs/examples/functions/update-deployment-status.md @@ -9,7 +9,7 @@ client = Client.new functions = Functions.new(client) -result = functions.update_deployment_build( +result = functions.update_deployment_status( function_id: '', deployment_id: '' ) diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-function-deployment.md similarity index 88% rename from docs/examples/functions/update-deployment.md rename to docs/examples/functions/update-function-deployment.md index c460885..68c5d7f 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-function-deployment.md @@ -9,7 +9,7 @@ client = Client.new functions = Functions.new(client) -result = functions.update_deployment( +result = functions.update_function_deployment( function_id: '', deployment_id: '' ) diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index f0b6002..7c4e402 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -13,5 +13,6 @@ result = functions.update_variable( function_id: '', variable_id: '', key: '', - value: '' # optional + value: '', # optional + secret: false # optional ) diff --git a/docs/examples/sites/create-deployment.md b/docs/examples/sites/create-deployment.md new file mode 100644 index 0000000..b392b86 --- /dev/null +++ b/docs/examples/sites/create-deployment.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create_deployment( + site_id: '', + code: InputFile.from_path('dir/file.png'), + activate: false, + install_command: '', # optional + build_command: '', # optional + output_directory: '' # optional +) diff --git a/docs/examples/sites/create-duplicate-deployment.md b/docs/examples/sites/create-duplicate-deployment.md new file mode 100644 index 0000000..f72b7a6 --- /dev/null +++ b/docs/examples/sites/create-duplicate-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create_duplicate_deployment( + site_id: '', + deployment_id: '' +) diff --git a/docs/examples/sites/create-template-deployment.md b/docs/examples/sites/create-template-deployment.md new file mode 100644 index 0000000..7df9665 --- /dev/null +++ b/docs/examples/sites/create-template-deployment.md @@ -0,0 +1,19 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create_template_deployment( + site_id: '', + repository: '', + owner: '', + root_directory: '', + version: '', + activate: false # optional +) diff --git a/docs/examples/sites/create-variable.md b/docs/examples/sites/create-variable.md new file mode 100644 index 0000000..4d2031f --- /dev/null +++ b/docs/examples/sites/create-variable.md @@ -0,0 +1,17 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create_variable( + site_id: '', + key: '', + value: '', + secret: false # optional +) diff --git a/docs/examples/sites/create-vcs-deployment.md b/docs/examples/sites/create-vcs-deployment.md new file mode 100644 index 0000000..2e72b6e --- /dev/null +++ b/docs/examples/sites/create-vcs-deployment.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create_vcs_deployment( + site_id: '', + type: VCSDeploymentType::BRANCH, + reference: '', + activate: false # optional +) diff --git a/docs/examples/sites/create.md b/docs/examples/sites/create.md new file mode 100644 index 0000000..2243185 --- /dev/null +++ b/docs/examples/sites/create.md @@ -0,0 +1,32 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.create( + site_id: '', + name: '', + framework: ::ANALOG, + build_runtime: ::NODE_14_5, + enabled: false, # optional + logging: false, # optional + timeout: 1, # optional + install_command: '', # optional + build_command: '', # optional + output_directory: '', # optional + adapter: ::STATIC, # optional + installation_id: '', # optional + fallback_file: '', # optional + provider_repository_id: '', # optional + provider_branch: '', # optional + provider_silent_mode: false, # optional + provider_root_directory: '', # optional + specification: '' # optional +) diff --git a/docs/examples/sites/delete-deployment.md b/docs/examples/sites/delete-deployment.md new file mode 100644 index 0000000..6f96e05 --- /dev/null +++ b/docs/examples/sites/delete-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.delete_deployment( + site_id: '', + deployment_id: '' +) diff --git a/docs/examples/sites/delete-log.md b/docs/examples/sites/delete-log.md new file mode 100644 index 0000000..556f3e2 --- /dev/null +++ b/docs/examples/sites/delete-log.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.delete_log( + site_id: '', + log_id: '' +) diff --git a/docs/examples/sites/delete-variable.md b/docs/examples/sites/delete-variable.md new file mode 100644 index 0000000..ca5e51b --- /dev/null +++ b/docs/examples/sites/delete-variable.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.delete_variable( + site_id: '', + variable_id: '' +) diff --git a/docs/examples/sites/delete.md b/docs/examples/sites/delete.md new file mode 100644 index 0000000..e92d642 --- /dev/null +++ b/docs/examples/sites/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.delete( + site_id: '' +) diff --git a/docs/examples/sites/get-deployment-download.md b/docs/examples/sites/get-deployment-download.md new file mode 100644 index 0000000..8516262 --- /dev/null +++ b/docs/examples/sites/get-deployment-download.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.get_deployment_download( + site_id: '', + deployment_id: '', + type: DeploymentDownloadType::SOURCE # optional +) diff --git a/docs/examples/sites/get-deployment.md b/docs/examples/sites/get-deployment.md new file mode 100644 index 0000000..79f47e4 --- /dev/null +++ b/docs/examples/sites/get-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.get_deployment( + site_id: '', + deployment_id: '' +) diff --git a/docs/examples/sites/get-log.md b/docs/examples/sites/get-log.md new file mode 100644 index 0000000..2e5e8c2 --- /dev/null +++ b/docs/examples/sites/get-log.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.get_log( + site_id: '', + log_id: '' +) diff --git a/docs/examples/sites/get-variable.md b/docs/examples/sites/get-variable.md new file mode 100644 index 0000000..ac27efc --- /dev/null +++ b/docs/examples/sites/get-variable.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.get_variable( + site_id: '', + variable_id: '' +) diff --git a/docs/examples/sites/get.md b/docs/examples/sites/get.md new file mode 100644 index 0000000..a8d3aac --- /dev/null +++ b/docs/examples/sites/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.get( + site_id: '' +) diff --git a/docs/examples/sites/list-deployments.md b/docs/examples/sites/list-deployments.md new file mode 100644 index 0000000..8571f85 --- /dev/null +++ b/docs/examples/sites/list-deployments.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list_deployments( + site_id: '', + queries: [], # optional + search: '' # optional +) diff --git a/docs/examples/sites/list-frameworks.md b/docs/examples/sites/list-frameworks.md new file mode 100644 index 0000000..61f18fb --- /dev/null +++ b/docs/examples/sites/list-frameworks.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list_frameworks() diff --git a/docs/examples/sites/list-logs.md b/docs/examples/sites/list-logs.md new file mode 100644 index 0000000..919be96 --- /dev/null +++ b/docs/examples/sites/list-logs.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list_logs( + site_id: '', + queries: [] # optional +) diff --git a/docs/examples/sites/list-specifications.md b/docs/examples/sites/list-specifications.md new file mode 100644 index 0000000..42f4115 --- /dev/null +++ b/docs/examples/sites/list-specifications.md @@ -0,0 +1,12 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list_specifications() diff --git a/docs/examples/sites/list-variables.md b/docs/examples/sites/list-variables.md new file mode 100644 index 0000000..cf10fa4 --- /dev/null +++ b/docs/examples/sites/list-variables.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list_variables( + site_id: '' +) diff --git a/docs/examples/sites/list.md b/docs/examples/sites/list.md new file mode 100644 index 0000000..ba70205 --- /dev/null +++ b/docs/examples/sites/list.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.list( + queries: [], # optional + search: '' # optional +) diff --git a/docs/examples/sites/update-deployment-status.md b/docs/examples/sites/update-deployment-status.md new file mode 100644 index 0000000..859ad22 --- /dev/null +++ b/docs/examples/sites/update-deployment-status.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.update_deployment_status( + site_id: '', + deployment_id: '' +) diff --git a/docs/examples/sites/update-site-deployment.md b/docs/examples/sites/update-site-deployment.md new file mode 100644 index 0000000..bc033e9 --- /dev/null +++ b/docs/examples/sites/update-site-deployment.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.update_site_deployment( + site_id: '', + deployment_id: '' +) diff --git a/docs/examples/sites/update-variable.md b/docs/examples/sites/update-variable.md new file mode 100644 index 0000000..e61f129 --- /dev/null +++ b/docs/examples/sites/update-variable.md @@ -0,0 +1,18 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.update_variable( + site_id: '', + variable_id: '', + key: '', + value: '', # optional + secret: false # optional +) diff --git a/docs/examples/sites/update.md b/docs/examples/sites/update.md new file mode 100644 index 0000000..922255a --- /dev/null +++ b/docs/examples/sites/update.md @@ -0,0 +1,32 @@ +require 'appwrite' + +include Appwrite +include Appwrite::Enums + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +sites = Sites.new(client) + +result = sites.update( + site_id: '', + name: '', + framework: ::ANALOG, + enabled: false, # optional + logging: false, # optional + timeout: 1, # optional + install_command: '', # optional + build_command: '', # optional + output_directory: '', # optional + build_runtime: ::NODE_14_5, # optional + adapter: ::STATIC, # optional + fallback_file: '', # optional + installation_id: '', # optional + provider_repository_id: '', # optional + provider_branch: '', # optional + provider_silent_mode: false, # optional + provider_root_directory: '', # optional + specification: '' # optional +) diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index 0747fdf..7b70751 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -11,5 +11,6 @@ storage = Storage.new(client) result = storage.get_file_download( bucket_id: '', - file_id: '' + file_id: '', + token: '' # optional ) diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index 38a68a8..2325461 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -15,12 +15,13 @@ result = storage.get_file_preview( width: 0, # optional height: 0, # optional gravity: ImageGravity::CENTER, # optional - quality: 0, # optional + quality: -1, # optional border_width: 0, # optional border_color: '', # optional border_radius: 0, # optional opacity: 0, # optional rotation: -360, # optional background: '', # optional - output: ImageFormat::JPG # optional + output: ImageFormat::JPG, # optional + token: '' # optional ) diff --git a/docs/examples/storage/get-file-view.md b/docs/examples/storage/get-file-view.md index 4c31305..c9e9952 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -11,5 +11,6 @@ storage = Storage.new(client) result = storage.get_file_view( bucket_id: '', - file_id: '' + file_id: '', + token: '' # optional ) diff --git a/docs/examples/tokens/create-file-token.md b/docs/examples/tokens/create-file-token.md new file mode 100644 index 0000000..8c432c5 --- /dev/null +++ b/docs/examples/tokens/create-file-token.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +tokens = Tokens.new(client) + +result = tokens.create_file_token( + bucket_id: '', + file_id: '', + expire: '' # optional +) diff --git a/docs/examples/tokens/delete.md b/docs/examples/tokens/delete.md new file mode 100644 index 0000000..cb59147 --- /dev/null +++ b/docs/examples/tokens/delete.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +tokens = Tokens.new(client) + +result = tokens.delete( + token_id: '' +) diff --git a/docs/examples/tokens/get.md b/docs/examples/tokens/get.md new file mode 100644 index 0000000..ef87c74 --- /dev/null +++ b/docs/examples/tokens/get.md @@ -0,0 +1,14 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +tokens = Tokens.new(client) + +result = tokens.get( + token_id: '' +) diff --git a/docs/examples/tokens/list.md b/docs/examples/tokens/list.md new file mode 100644 index 0000000..4932f04 --- /dev/null +++ b/docs/examples/tokens/list.md @@ -0,0 +1,16 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +tokens = Tokens.new(client) + +result = tokens.list( + bucket_id: '', + file_id: '', + queries: [] # optional +) diff --git a/docs/examples/tokens/update.md b/docs/examples/tokens/update.md new file mode 100644 index 0000000..9171373 --- /dev/null +++ b/docs/examples/tokens/update.md @@ -0,0 +1,15 @@ +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint + .set_project('') # Your project ID + .set_key('') # Your secret API key + +tokens = Tokens.new(client) + +result = tokens.update( + token_id: '', + expire: '' # optional +) diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index d36c380..a4c3aa1 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -10,5 +10,7 @@ client = Client.new users = Users.new(client) result = users.list_memberships( - user_id: '' + user_id: '', + queries: [], # optional + search: '' # optional ) diff --git a/lib/appwrite.rb b/lib/appwrite.rb index ca4ac39..e80df28 100644 --- a/lib/appwrite.rb +++ b/lib/appwrite.rb @@ -22,9 +22,12 @@ require_relative 'appwrite/models/log_list' require_relative 'appwrite/models/file_list' require_relative 'appwrite/models/bucket_list' +require_relative 'appwrite/models/resource_token_list' require_relative 'appwrite/models/team_list' require_relative 'appwrite/models/membership_list' +require_relative 'appwrite/models/site_list' require_relative 'appwrite/models/function_list' +require_relative 'appwrite/models/framework_list' require_relative 'appwrite/models/runtime_list' require_relative 'appwrite/models/deployment_list' require_relative 'appwrite/models/execution_list' @@ -74,13 +77,16 @@ require_relative 'appwrite/models/locale_code' require_relative 'appwrite/models/file' require_relative 'appwrite/models/bucket' +require_relative 'appwrite/models/resource_token' require_relative 'appwrite/models/team' require_relative 'appwrite/models/membership' +require_relative 'appwrite/models/site' require_relative 'appwrite/models/function' require_relative 'appwrite/models/runtime' +require_relative 'appwrite/models/framework' +require_relative 'appwrite/models/framework_adapter' require_relative 'appwrite/models/deployment' require_relative 'appwrite/models/execution' -require_relative 'appwrite/models/build' require_relative 'appwrite/models/variable' require_relative 'appwrite/models/country' require_relative 'appwrite/models/continent' @@ -114,10 +120,15 @@ require_relative 'appwrite/enums/relation_mutate' require_relative 'appwrite/enums/index_type' require_relative 'appwrite/enums/runtime' +require_relative 'appwrite/enums/vcs_deployment_type' +require_relative 'appwrite/enums/deployment_download_type' require_relative 'appwrite/enums/execution_method' require_relative 'appwrite/enums/name' require_relative 'appwrite/enums/message_priority' require_relative 'appwrite/enums/smtp_encryption' +require_relative 'appwrite/enums/framework' +require_relative 'appwrite/enums/build_runtime' +require_relative 'appwrite/enums/adapter' require_relative 'appwrite/enums/compression' require_relative 'appwrite/enums/image_gravity' require_relative 'appwrite/enums/image_format' @@ -132,6 +143,8 @@ require_relative 'appwrite/services/health' require_relative 'appwrite/services/locale' require_relative 'appwrite/services/messaging' +require_relative 'appwrite/services/sites' require_relative 'appwrite/services/storage' require_relative 'appwrite/services/teams' +require_relative 'appwrite/services/tokens' require_relative 'appwrite/services/users' diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb index 0ef665f..5501cdf 100644 --- a/lib/appwrite/client.rb +++ b/lib/appwrite/client.rb @@ -15,8 +15,8 @@ def initialize 'x-sdk-name'=> 'Ruby', 'x-sdk-platform'=> 'server', 'x-sdk-language'=> 'ruby', - 'x-sdk-version'=> '15.1.0-rc.1', - 'X-Appwrite-Response-Format' => '1.6.0' + 'x-sdk-version'=> '15.2.0', + 'X-Appwrite-Response-Format' => '1.7.0' } @endpoint = 'https://cloud.appwrite.io/v1' end diff --git a/lib/appwrite/enums/adapter.rb b/lib/appwrite/enums/adapter.rb new file mode 100644 index 0000000..3d66017 --- /dev/null +++ b/lib/appwrite/enums/adapter.rb @@ -0,0 +1,8 @@ +module Appwrite + module Enums + module Adapter + STATIC = 'static' + SSR = 'ssr' + end + end +end \ No newline at end of file diff --git a/lib/appwrite/enums/build_runtime.rb b/lib/appwrite/enums/build_runtime.rb new file mode 100644 index 0000000..e113a77 --- /dev/null +++ b/lib/appwrite/enums/build_runtime.rb @@ -0,0 +1,69 @@ +module Appwrite + module Enums + module BuildRuntime + NODE_14_5 = 'node-14.5' + NODE_16_0 = 'node-16.0' + NODE_18_0 = 'node-18.0' + NODE_19_0 = 'node-19.0' + NODE_20_0 = 'node-20.0' + NODE_21_0 = 'node-21.0' + NODE_22 = 'node-22' + PHP_8_0 = 'php-8.0' + PHP_8_1 = 'php-8.1' + PHP_8_2 = 'php-8.2' + PHP_8_3 = 'php-8.3' + RUBY_3_0 = 'ruby-3.0' + RUBY_3_1 = 'ruby-3.1' + RUBY_3_2 = 'ruby-3.2' + RUBY_3_3 = 'ruby-3.3' + PYTHON_3_8 = 'python-3.8' + PYTHON_3_9 = 'python-3.9' + PYTHON_3_10 = 'python-3.10' + PYTHON_3_11 = 'python-3.11' + PYTHON_3_12 = 'python-3.12' + PYTHON_ML_3_11 = 'python-ml-3.11' + PYTHON_ML_3_12 = 'python-ml-3.12' + DENO_1_21 = 'deno-1.21' + DENO_1_24 = 'deno-1.24' + DENO_1_35 = 'deno-1.35' + DENO_1_40 = 'deno-1.40' + DENO_1_46 = 'deno-1.46' + DENO_2_0 = 'deno-2.0' + DART_2_15 = 'dart-2.15' + DART_2_16 = 'dart-2.16' + DART_2_17 = 'dart-2.17' + DART_2_18 = 'dart-2.18' + DART_2_19 = 'dart-2.19' + DART_3_0 = 'dart-3.0' + DART_3_1 = 'dart-3.1' + DART_3_3 = 'dart-3.3' + DART_3_5 = 'dart-3.5' + DOTNET_6_0 = 'dotnet-6.0' + DOTNET_7_0 = 'dotnet-7.0' + DOTNET_8_0 = 'dotnet-8.0' + JAVA_8_0 = 'java-8.0' + JAVA_11_0 = 'java-11.0' + JAVA_17_0 = 'java-17.0' + JAVA_18_0 = 'java-18.0' + JAVA_21_0 = 'java-21.0' + JAVA_22 = 'java-22' + SWIFT_5_5 = 'swift-5.5' + SWIFT_5_8 = 'swift-5.8' + SWIFT_5_9 = 'swift-5.9' + SWIFT_5_10 = 'swift-5.10' + KOTLIN_1_6 = 'kotlin-1.6' + KOTLIN_1_8 = 'kotlin-1.8' + KOTLIN_1_9 = 'kotlin-1.9' + KOTLIN_2_0 = 'kotlin-2.0' + CPP_17 = 'cpp-17' + CPP_20 = 'cpp-20' + BUN_1_0 = 'bun-1.0' + BUN_1_1 = 'bun-1.1' + GO_1_23 = 'go-1.23' + STATIC_1 = 'static-1' + FLUTTER_3_24 = 'flutter-3.24' + FLUTTER_3_27 = 'flutter-3.27' + FLUTTER_3_29 = 'flutter-3.29' + end + end +end \ No newline at end of file diff --git a/lib/appwrite/enums/deployment_download_type.rb b/lib/appwrite/enums/deployment_download_type.rb new file mode 100644 index 0000000..4c8a60b --- /dev/null +++ b/lib/appwrite/enums/deployment_download_type.rb @@ -0,0 +1,8 @@ +module Appwrite + module Enums + module DeploymentDownloadType + SOURCE = 'source' + OUTPUT = 'output' + end + end +end \ No newline at end of file diff --git a/lib/appwrite/enums/framework.rb b/lib/appwrite/enums/framework.rb new file mode 100644 index 0000000..63d9c0f --- /dev/null +++ b/lib/appwrite/enums/framework.rb @@ -0,0 +1,20 @@ +module Appwrite + module Enums + module Framework + ANALOG = 'analog' + ANGULAR = 'angular' + NEXTJS = 'nextjs' + REACT = 'react' + NUXT = 'nuxt' + VUE = 'vue' + SVELTEKIT = 'sveltekit' + ASTRO = 'astro' + REMIX = 'remix' + LYNX = 'lynx' + FLUTTER = 'flutter' + REACT_NATIVE = 'react-native' + VITE = 'vite' + OTHER = 'other' + end + end +end \ No newline at end of file diff --git a/lib/appwrite/enums/image_format.rb b/lib/appwrite/enums/image_format.rb index ac94556..f1e0ea2 100644 --- a/lib/appwrite/enums/image_format.rb +++ b/lib/appwrite/enums/image_format.rb @@ -3,7 +3,6 @@ module Enums module ImageFormat JPG = 'jpg' JPEG = 'jpeg' - GIF = 'gif' PNG = 'png' WEBP = 'webp' HEIC = 'heic' diff --git a/lib/appwrite/enums/runtime.rb b/lib/appwrite/enums/runtime.rb index 37eaf17..726c326 100644 --- a/lib/appwrite/enums/runtime.rb +++ b/lib/appwrite/enums/runtime.rb @@ -22,6 +22,7 @@ module Runtime PYTHON_3_11 = 'python-3.11' PYTHON_3_12 = 'python-3.12' PYTHON_ML_3_11 = 'python-ml-3.11' + PYTHON_ML_3_12 = 'python-ml-3.12' DENO_1_21 = 'deno-1.21' DENO_1_24 = 'deno-1.24' DENO_1_35 = 'deno-1.35' @@ -32,6 +33,7 @@ module Runtime DART_2_16 = 'dart-2.16' DART_2_17 = 'dart-2.17' DART_2_18 = 'dart-2.18' + DART_2_19 = 'dart-2.19' DART_3_0 = 'dart-3.0' DART_3_1 = 'dart-3.1' DART_3_3 = 'dart-3.3' @@ -60,6 +62,8 @@ module Runtime GO_1_23 = 'go-1.23' STATIC_1 = 'static-1' FLUTTER_3_24 = 'flutter-3.24' + FLUTTER_3_27 = 'flutter-3.27' + FLUTTER_3_29 = 'flutter-3.29' end end end \ No newline at end of file diff --git a/lib/appwrite/enums/vcs_deployment_type.rb b/lib/appwrite/enums/vcs_deployment_type.rb new file mode 100644 index 0000000..f2688df --- /dev/null +++ b/lib/appwrite/enums/vcs_deployment_type.rb @@ -0,0 +1,9 @@ +module Appwrite + module Enums + module VCSDeploymentType + BRANCH = 'branch' + COMMIT = 'commit' + TAG = 'tag' + end + end +end \ No newline at end of file diff --git a/lib/appwrite/models/build.rb b/lib/appwrite/models/build.rb deleted file mode 100644 index 1ed9ccd..0000000 --- a/lib/appwrite/models/build.rb +++ /dev/null @@ -1,67 +0,0 @@ -#frozen_string_literal: true - -module Appwrite - module Models - class Build - attr_reader :id - attr_reader :deployment_id - attr_reader :status - attr_reader :stdout - attr_reader :stderr - attr_reader :start_time - attr_reader :end_time - attr_reader :duration - attr_reader :size - - def initialize( - id:, - deployment_id:, - status:, - stdout:, - stderr:, - start_time:, - end_time:, - duration:, - size: - ) - @id = id - @deployment_id = deployment_id - @status = status - @stdout = stdout - @stderr = stderr - @start_time = start_time - @end_time = end_time - @duration = duration - @size = size - end - - def self.from(map:) - Build.new( - id: map["$id"], - deployment_id: map["deploymentId"], - status: map["status"], - stdout: map["stdout"], - stderr: map["stderr"], - start_time: map["startTime"], - end_time: map["endTime"], - duration: map["duration"], - size: map["size"] - ) - end - - def to_map - { - "$id": @id, - "deploymentId": @deployment_id, - "status": @status, - "stdout": @stdout, - "stderr": @stderr, - "startTime": @start_time, - "endTime": @end_time, - "duration": @duration, - "size": @size - } - end - end - end -end diff --git a/lib/appwrite/models/deployment.rb b/lib/appwrite/models/deployment.rb index f870acc..2a385cc 100644 --- a/lib/appwrite/models/deployment.rb +++ b/lib/appwrite/models/deployment.rb @@ -10,13 +10,16 @@ class Deployment attr_reader :resource_id attr_reader :resource_type attr_reader :entrypoint - attr_reader :size + attr_reader :source_size attr_reader :build_size + attr_reader :total_size attr_reader :build_id attr_reader :activate + attr_reader :screenshot_light + attr_reader :screenshot_dark attr_reader :status attr_reader :build_logs - attr_reader :build_time + attr_reader :build_duration attr_reader :provider_repository_name attr_reader :provider_repository_owner attr_reader :provider_repository_url @@ -36,13 +39,16 @@ def initialize( resource_id:, resource_type:, entrypoint:, - size:, + source_size:, build_size:, + total_size:, build_id:, activate:, + screenshot_light:, + screenshot_dark:, status:, build_logs:, - build_time:, + build_duration:, provider_repository_name:, provider_repository_owner:, provider_repository_url:, @@ -61,13 +67,16 @@ def initialize( @resource_id = resource_id @resource_type = resource_type @entrypoint = entrypoint - @size = size + @source_size = source_size @build_size = build_size + @total_size = total_size @build_id = build_id @activate = activate + @screenshot_light = screenshot_light + @screenshot_dark = screenshot_dark @status = status @build_logs = build_logs - @build_time = build_time + @build_duration = build_duration @provider_repository_name = provider_repository_name @provider_repository_owner = provider_repository_owner @provider_repository_url = provider_repository_url @@ -89,13 +98,16 @@ def self.from(map:) resource_id: map["resourceId"], resource_type: map["resourceType"], entrypoint: map["entrypoint"], - size: map["size"], + source_size: map["sourceSize"], build_size: map["buildSize"], + total_size: map["totalSize"], build_id: map["buildId"], activate: map["activate"], + screenshot_light: map["screenshotLight"], + screenshot_dark: map["screenshotDark"], status: map["status"], build_logs: map["buildLogs"], - build_time: map["buildTime"], + build_duration: map["buildDuration"], provider_repository_name: map["providerRepositoryName"], provider_repository_owner: map["providerRepositoryOwner"], provider_repository_url: map["providerRepositoryUrl"], @@ -118,13 +130,16 @@ def to_map "resourceId": @resource_id, "resourceType": @resource_type, "entrypoint": @entrypoint, - "size": @size, + "sourceSize": @source_size, "buildSize": @build_size, + "totalSize": @total_size, "buildId": @build_id, "activate": @activate, + "screenshotLight": @screenshot_light, + "screenshotDark": @screenshot_dark, "status": @status, "buildLogs": @build_logs, - "buildTime": @build_time, + "buildDuration": @build_duration, "providerRepositoryName": @provider_repository_name, "providerRepositoryOwner": @provider_repository_owner, "providerRepositoryUrl": @provider_repository_url, diff --git a/lib/appwrite/models/framework.rb b/lib/appwrite/models/framework.rb new file mode 100644 index 0000000..a465400 --- /dev/null +++ b/lib/appwrite/models/framework.rb @@ -0,0 +1,47 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class Framework + attr_reader :key + attr_reader :name + attr_reader :build_runtime + attr_reader :runtimes + attr_reader :adapters + + def initialize( + key:, + name:, + build_runtime:, + runtimes:, + adapters: + ) + @key = key + @name = name + @build_runtime = build_runtime + @runtimes = runtimes + @adapters = adapters + end + + def self.from(map:) + Framework.new( + key: map["key"], + name: map["name"], + build_runtime: map["buildRuntime"], + runtimes: map["runtimes"], + adapters: map["adapters"].map { |it| FrameworkAdapter.from(map: it) } + ) + end + + def to_map + { + "key": @key, + "name": @name, + "buildRuntime": @build_runtime, + "runtimes": @runtimes, + "adapters": @adapters.map { |it| it.to_map } + } + end + end + end +end diff --git a/lib/appwrite/models/framework_adapter.rb b/lib/appwrite/models/framework_adapter.rb new file mode 100644 index 0000000..e96509a --- /dev/null +++ b/lib/appwrite/models/framework_adapter.rb @@ -0,0 +1,47 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class FrameworkAdapter + attr_reader :key + attr_reader :install_command + attr_reader :build_command + attr_reader :output_directory + attr_reader :fallback_file + + def initialize( + key:, + install_command:, + build_command:, + output_directory:, + fallback_file: + ) + @key = key + @install_command = install_command + @build_command = build_command + @output_directory = output_directory + @fallback_file = fallback_file + end + + def self.from(map:) + FrameworkAdapter.new( + key: map["key"], + install_command: map["installCommand"], + build_command: map["buildCommand"], + output_directory: map["outputDirectory"], + fallback_file: map["fallbackFile"] + ) + end + + def to_map + { + "key": @key, + "installCommand": @install_command, + "buildCommand": @build_command, + "outputDirectory": @output_directory, + "fallbackFile": @fallback_file + } + end + end + end +end diff --git a/lib/appwrite/models/framework_list.rb b/lib/appwrite/models/framework_list.rb new file mode 100644 index 0000000..6fe936e --- /dev/null +++ b/lib/appwrite/models/framework_list.rb @@ -0,0 +1,32 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class FrameworkList + attr_reader :total + attr_reader :frameworks + + def initialize( + total:, + frameworks: + ) + @total = total + @frameworks = frameworks + end + + def self.from(map:) + FrameworkList.new( + total: map["total"], + frameworks: map["frameworks"].map { |it| Framework.from(map: it) } + ) + end + + def to_map + { + "total": @total, + "frameworks": @frameworks.map { |it| it.to_map } + } + end + end + end +end diff --git a/lib/appwrite/models/function.rb b/lib/appwrite/models/function.rb index 29f829d..ae155e8 100644 --- a/lib/appwrite/models/function.rb +++ b/lib/appwrite/models/function.rb @@ -12,7 +12,11 @@ class Function attr_reader :live attr_reader :logging attr_reader :runtime - attr_reader :deployment + attr_reader :deployment_id + attr_reader :deployment_created_at + attr_reader :latest_deployment_id + attr_reader :latest_deployment_created_at + attr_reader :latest_deployment_status attr_reader :scopes attr_reader :vars attr_reader :events @@ -38,7 +42,11 @@ def initialize( live:, logging:, runtime:, - deployment:, + deployment_id:, + deployment_created_at:, + latest_deployment_id:, + latest_deployment_created_at:, + latest_deployment_status:, scopes:, vars:, events:, @@ -63,7 +71,11 @@ def initialize( @live = live @logging = logging @runtime = runtime - @deployment = deployment + @deployment_id = deployment_id + @deployment_created_at = deployment_created_at + @latest_deployment_id = latest_deployment_id + @latest_deployment_created_at = latest_deployment_created_at + @latest_deployment_status = latest_deployment_status @scopes = scopes @vars = vars @events = events @@ -91,7 +103,11 @@ def self.from(map:) live: map["live"], logging: map["logging"], runtime: map["runtime"], - deployment: map["deployment"], + deployment_id: map["deploymentId"], + deployment_created_at: map["deploymentCreatedAt"], + latest_deployment_id: map["latestDeploymentId"], + latest_deployment_created_at: map["latestDeploymentCreatedAt"], + latest_deployment_status: map["latestDeploymentStatus"], scopes: map["scopes"], vars: map["vars"].map { |it| Variable.from(map: it) }, events: map["events"], @@ -120,7 +136,11 @@ def to_map "live": @live, "logging": @logging, "runtime": @runtime, - "deployment": @deployment, + "deploymentId": @deployment_id, + "deploymentCreatedAt": @deployment_created_at, + "latestDeploymentId": @latest_deployment_id, + "latestDeploymentCreatedAt": @latest_deployment_created_at, + "latestDeploymentStatus": @latest_deployment_status, "scopes": @scopes, "vars": @vars.map { |it| it.to_map }, "events": @events, diff --git a/lib/appwrite/models/index.rb b/lib/appwrite/models/index.rb index 76c45af..b7495ab 100644 --- a/lib/appwrite/models/index.rb +++ b/lib/appwrite/models/index.rb @@ -8,6 +8,7 @@ class Index attr_reader :status attr_reader :error attr_reader :attributes + attr_reader :lengths attr_reader :orders attr_reader :created_at attr_reader :updated_at @@ -18,6 +19,7 @@ def initialize( status:, error:, attributes:, + lengths:, orders: , created_at:, updated_at: @@ -27,6 +29,7 @@ def initialize( @status = status @error = error @attributes = attributes + @lengths = lengths @orders = orders @created_at = created_at @updated_at = updated_at @@ -39,6 +42,7 @@ def self.from(map:) status: map["status"], error: map["error"], attributes: map["attributes"], + lengths: map["lengths"], orders: map["orders"], created_at: map["$createdAt"], updated_at: map["$updatedAt"] @@ -52,6 +56,7 @@ def to_map "status": @status, "error": @error, "attributes": @attributes, + "lengths": @lengths, "orders": @orders, "$createdAt": @created_at, "$updatedAt": @updated_at diff --git a/lib/appwrite/models/resource_token.rb b/lib/appwrite/models/resource_token.rb new file mode 100644 index 0000000..1d01e10 --- /dev/null +++ b/lib/appwrite/models/resource_token.rb @@ -0,0 +1,57 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class ResourceToken + attr_reader :id + attr_reader :created_at + attr_reader :resource_id + attr_reader :resource_type + attr_reader :expire + attr_reader :secret + attr_reader :accessed_at + + def initialize( + id:, + created_at:, + resource_id:, + resource_type:, + expire:, + secret:, + accessed_at: + ) + @id = id + @created_at = created_at + @resource_id = resource_id + @resource_type = resource_type + @expire = expire + @secret = secret + @accessed_at = accessed_at + end + + def self.from(map:) + ResourceToken.new( + id: map["$id"], + created_at: map["$createdAt"], + resource_id: map["resourceId"], + resource_type: map["resourceType"], + expire: map["expire"], + secret: map["secret"], + accessed_at: map["accessedAt"] + ) + end + + def to_map + { + "$id": @id, + "$createdAt": @created_at, + "resourceId": @resource_id, + "resourceType": @resource_type, + "expire": @expire, + "secret": @secret, + "accessedAt": @accessed_at + } + end + end + end +end diff --git a/lib/appwrite/models/resource_token_list.rb b/lib/appwrite/models/resource_token_list.rb new file mode 100644 index 0000000..c950a58 --- /dev/null +++ b/lib/appwrite/models/resource_token_list.rb @@ -0,0 +1,32 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class ResourceTokenList + attr_reader :total + attr_reader :tokens + + def initialize( + total:, + tokens: + ) + @total = total + @tokens = tokens + end + + def self.from(map:) + ResourceTokenList.new( + total: map["total"], + tokens: map["tokens"].map { |it| ResourceToken.from(map: it) } + ) + end + + def to_map + { + "total": @total, + "tokens": @tokens.map { |it| it.to_map } + } + end + end + end +end diff --git a/lib/appwrite/models/site.rb b/lib/appwrite/models/site.rb new file mode 100644 index 0000000..466fcbf --- /dev/null +++ b/lib/appwrite/models/site.rb @@ -0,0 +1,167 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class Site + attr_reader :id + attr_reader :created_at + attr_reader :updated_at + attr_reader :name + attr_reader :enabled + attr_reader :live + attr_reader :logging + attr_reader :framework + attr_reader :deployment_id + attr_reader :deployment_created_at + attr_reader :deployment_screenshot_light + attr_reader :deployment_screenshot_dark + attr_reader :latest_deployment_id + attr_reader :latest_deployment_created_at + attr_reader :latest_deployment_status + attr_reader :vars + attr_reader :timeout + attr_reader :install_command + attr_reader :build_command + attr_reader :output_directory + attr_reader :installation_id + attr_reader :provider_repository_id + attr_reader :provider_branch + attr_reader :provider_root_directory + attr_reader :provider_silent_mode + attr_reader :specification + attr_reader :build_runtime + attr_reader :adapter + attr_reader :fallback_file + + def initialize( + id:, + created_at:, + updated_at:, + name:, + enabled:, + live:, + logging:, + framework:, + deployment_id:, + deployment_created_at:, + deployment_screenshot_light:, + deployment_screenshot_dark:, + latest_deployment_id:, + latest_deployment_created_at:, + latest_deployment_status:, + vars:, + timeout:, + install_command:, + build_command:, + output_directory:, + installation_id:, + provider_repository_id:, + provider_branch:, + provider_root_directory:, + provider_silent_mode:, + specification:, + build_runtime:, + adapter:, + fallback_file: + ) + @id = id + @created_at = created_at + @updated_at = updated_at + @name = name + @enabled = enabled + @live = live + @logging = logging + @framework = framework + @deployment_id = deployment_id + @deployment_created_at = deployment_created_at + @deployment_screenshot_light = deployment_screenshot_light + @deployment_screenshot_dark = deployment_screenshot_dark + @latest_deployment_id = latest_deployment_id + @latest_deployment_created_at = latest_deployment_created_at + @latest_deployment_status = latest_deployment_status + @vars = vars + @timeout = timeout + @install_command = install_command + @build_command = build_command + @output_directory = output_directory + @installation_id = installation_id + @provider_repository_id = provider_repository_id + @provider_branch = provider_branch + @provider_root_directory = provider_root_directory + @provider_silent_mode = provider_silent_mode + @specification = specification + @build_runtime = build_runtime + @adapter = adapter + @fallback_file = fallback_file + end + + def self.from(map:) + Site.new( + id: map["$id"], + created_at: map["$createdAt"], + updated_at: map["$updatedAt"], + name: map["name"], + enabled: map["enabled"], + live: map["live"], + logging: map["logging"], + framework: map["framework"], + deployment_id: map["deploymentId"], + deployment_created_at: map["deploymentCreatedAt"], + deployment_screenshot_light: map["deploymentScreenshotLight"], + deployment_screenshot_dark: map["deploymentScreenshotDark"], + latest_deployment_id: map["latestDeploymentId"], + latest_deployment_created_at: map["latestDeploymentCreatedAt"], + latest_deployment_status: map["latestDeploymentStatus"], + vars: map["vars"].map { |it| Variable.from(map: it) }, + timeout: map["timeout"], + install_command: map["installCommand"], + build_command: map["buildCommand"], + output_directory: map["outputDirectory"], + installation_id: map["installationId"], + provider_repository_id: map["providerRepositoryId"], + provider_branch: map["providerBranch"], + provider_root_directory: map["providerRootDirectory"], + provider_silent_mode: map["providerSilentMode"], + specification: map["specification"], + build_runtime: map["buildRuntime"], + adapter: map["adapter"], + fallback_file: map["fallbackFile"] + ) + end + + def to_map + { + "$id": @id, + "$createdAt": @created_at, + "$updatedAt": @updated_at, + "name": @name, + "enabled": @enabled, + "live": @live, + "logging": @logging, + "framework": @framework, + "deploymentId": @deployment_id, + "deploymentCreatedAt": @deployment_created_at, + "deploymentScreenshotLight": @deployment_screenshot_light, + "deploymentScreenshotDark": @deployment_screenshot_dark, + "latestDeploymentId": @latest_deployment_id, + "latestDeploymentCreatedAt": @latest_deployment_created_at, + "latestDeploymentStatus": @latest_deployment_status, + "vars": @vars.map { |it| it.to_map }, + "timeout": @timeout, + "installCommand": @install_command, + "buildCommand": @build_command, + "outputDirectory": @output_directory, + "installationId": @installation_id, + "providerRepositoryId": @provider_repository_id, + "providerBranch": @provider_branch, + "providerRootDirectory": @provider_root_directory, + "providerSilentMode": @provider_silent_mode, + "specification": @specification, + "buildRuntime": @build_runtime, + "adapter": @adapter, + "fallbackFile": @fallback_file + } + end + end + end +end diff --git a/lib/appwrite/models/site_list.rb b/lib/appwrite/models/site_list.rb new file mode 100644 index 0000000..52efd19 --- /dev/null +++ b/lib/appwrite/models/site_list.rb @@ -0,0 +1,32 @@ +#frozen_string_literal: true + +module Appwrite + module Models + class SiteList + attr_reader :total + attr_reader :sites + + def initialize( + total:, + sites: + ) + @total = total + @sites = sites + end + + def self.from(map:) + SiteList.new( + total: map["total"], + sites: map["sites"].map { |it| Site.from(map: it) } + ) + end + + def to_map + { + "total": @total, + "sites": @sites.map { |it| it.to_map } + } + end + end + end +end diff --git a/lib/appwrite/models/variable.rb b/lib/appwrite/models/variable.rb index ce1f971..b6d33d7 100644 --- a/lib/appwrite/models/variable.rb +++ b/lib/appwrite/models/variable.rb @@ -8,6 +8,7 @@ class Variable attr_reader :updated_at attr_reader :key attr_reader :value + attr_reader :secret attr_reader :resource_type attr_reader :resource_id @@ -17,6 +18,7 @@ def initialize( updated_at:, key:, value:, + secret:, resource_type:, resource_id: ) @@ -25,6 +27,7 @@ def initialize( @updated_at = updated_at @key = key @value = value + @secret = secret @resource_type = resource_type @resource_id = resource_id end @@ -36,6 +39,7 @@ def self.from(map:) updated_at: map["$updatedAt"], key: map["key"], value: map["value"], + secret: map["secret"], resource_type: map["resourceType"], resource_id: map["resourceId"] ) @@ -48,6 +52,7 @@ def to_map "$updatedAt": @updated_at, "key": @key, "value": @value, + "secret": @secret, "resourceType": @resource_type, "resourceId": @resource_id } diff --git a/lib/appwrite/services/avatars.rb b/lib/appwrite/services/avatars.rb index 404eebc..7f1bc67 100644 --- a/lib/appwrite/services/avatars.rb +++ b/lib/appwrite/services/avatars.rb @@ -21,7 +21,7 @@ def initialize(client) # @param [Browser] code Browser Code. # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100. # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100. - # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100. + # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality. # # @return [] def get_browser(code:, width: nil, height: nil, quality: nil) @@ -63,7 +63,7 @@ def get_browser(code:, width: nil, height: nil, quality: nil) # @param [CreditCard] code Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay. # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100. # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100. - # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100. + # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality. # # @return [] def get_credit_card(code:, width: nil, height: nil, quality: nil) @@ -137,7 +137,7 @@ def get_favicon(url:) # @param [Flag] code Country Code. ISO Alpha-2 country code format. # @param [Integer] width Image width. Pass an integer between 0 to 2000. Defaults to 100. # @param [Integer] height Image height. Pass an integer between 0 to 2000. Defaults to 100. - # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to 100. + # @param [Integer] quality Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality. # # @return [] def get_flag(code:, width: nil, height: nil, quality: nil) diff --git a/lib/appwrite/services/databases.rb b/lib/appwrite/services/databases.rb index 48e3ab4..7f3fec2 100644 --- a/lib/appwrite/services/databases.rb +++ b/lib/appwrite/services/databases.rb @@ -1733,7 +1733,6 @@ def create_document(database_id:, collection_id:, document_id:, data:, permissio # collection resource using either a [server # integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) # API or directly from your database console. - # # # @param [String] database_id Database ID. # @param [String] collection_id Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents. @@ -2077,9 +2076,10 @@ def list_indexes(database_id:, collection_id:, queries: nil) # @param [IndexType] type Index type. # @param [Array] attributes Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long. # @param [Array] orders Array of index orders. Maximum of 100 orders are allowed. + # @param [Array] lengths Length of index. Maximum of 100 # # @return [Index] - def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil) + def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil, lengths: nil) api_path = '/databases/{databaseId}/collections/{collectionId}/indexes' .gsub('{databaseId}', database_id) .gsub('{collectionId}', collection_id) @@ -2109,6 +2109,7 @@ def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: type: type, attributes: attributes, orders: orders, + lengths: lengths, } api_headers = { diff --git a/lib/appwrite/services/functions.rb b/lib/appwrite/services/functions.rb index 69e17e0..91c90e3 100644 --- a/lib/appwrite/services/functions.rb +++ b/lib/appwrite/services/functions.rb @@ -10,7 +10,7 @@ def initialize(client) # Get a list of all the project's functions. You can use the query params to # filter your results. # - # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deployment, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId # @param [String] search Search term to filter your list results. Max length: 256 chars. # # @return [FunctionList] @@ -48,7 +48,7 @@ def list(queries: nil, search: nil) # @param [String] schedule Schedule CRON syntax. # @param [Integer] timeout Function maximum execution time in seconds. # @param [] enabled Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled. - # @param [] logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project. + # @param [] logging When disabled, executions will exclude logs and errors, and will be slightly faster. # @param [String] entrypoint Entrypoint File. This path is relative to the "providerRootDirectory". # @param [String] commands Build Commands. # @param [Array] scopes List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed. @@ -57,14 +57,10 @@ def list(queries: nil, search: nil) # @param [String] provider_branch Production branch for the repo linked to the function. # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests. # @param [String] provider_root_directory Path to function code in the linked repo. - # @param [String] template_repository Repository name of the template. - # @param [String] template_owner The name of the owner of the template. - # @param [String] template_root_directory Path to function code in the template repo. - # @param [String] template_version Version (tag) for the repo linked to the function template. # @param [String] specification Runtime specification for the function and builds. # # @return [Function] - def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, template_repository: nil, template_owner: nil, template_root_directory: nil, template_version: nil, specification: nil) + def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: nil, timeout: nil, enabled: nil, logging: nil, entrypoint: nil, commands: nil, scopes: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil) api_path = '/functions' if function_id.nil? @@ -97,10 +93,6 @@ def create(function_id:, name:, runtime:, execute: nil, events: nil, schedule: n providerBranch: provider_branch, providerSilentMode: provider_silent_mode, providerRootDirectory: provider_root_directory, - templateRepository: template_repository, - templateOwner: template_owner, - templateRootDirectory: template_root_directory, - templateVersion: template_version, specification: specification, } @@ -142,7 +134,6 @@ def list_runtimes() # List allowed function specifications for this instance. - # # # # @return [SpecificationList] @@ -204,7 +195,7 @@ def get(function_id:) # @param [String] schedule Schedule CRON syntax. # @param [Integer] timeout Maximum execution time in seconds. # @param [] enabled Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled. - # @param [] logging Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project. + # @param [] logging When disabled, executions will exclude logs and errors, and will be slightly faster. # @param [String] entrypoint Entrypoint File. This path is relative to the "providerRootDirectory". # @param [String] commands Build Commands. # @param [Array] scopes List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed. @@ -291,11 +282,48 @@ def delete(function_id:) end - # Get a list of all the project's code deployments. You can use the query + # Update the function active deployment. Use this endpoint to switch the code + # deployment that should be used when visitor opens your function. + # + # @param [String] function_id Function ID. + # @param [String] deployment_id Deployment ID. + # + # @return [Function] + def update_function_deployment(function_id:, deployment_id:) + api_path = '/functions/{functionId}/deployment' + .gsub('{functionId}', function_id) + + if function_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "functionId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + deploymentId: deployment_id, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PATCH', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Function + ) + end + + + # Get a list of all the function's code deployments. You can use the query # params to filter your results. # # @param [String] function_id Function ID. - # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: size, buildId, activate, entrypoint, commands, type, size + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type # @param [String] search Search term to filter your list results. Max length: 256 chars. # # @return [DeploymentList] @@ -385,16 +413,20 @@ def create_deployment(function_id:, code:, activate:, entrypoint: nil, commands: end - # Get a code deployment by its unique ID. + # Create a new build for an existing function deployment. This endpoint + # allows you to rebuild a deployment with the updated function configuration, + # including its entrypoint and build commands if they have been modified. The + # build process will be queued and executed asynchronously. The original + # deployment's code will be preserved and used for the new build. # # @param [String] function_id Function ID. # @param [String] deployment_id Deployment ID. + # @param [String] build_id Build unique ID. # # @return [Deployment] - def get_deployment(function_id:, deployment_id:) - api_path = '/functions/{functionId}/deployments/{deploymentId}' + def create_duplicate_deployment(function_id:, deployment_id:, build_id: nil) + api_path = '/functions/{functionId}/deployments/duplicate' .gsub('{functionId}', function_id) - .gsub('{deploymentId}', deployment_id) if function_id.nil? raise Appwrite::Exception.new('Missing required parameter: "functionId"') @@ -405,13 +437,16 @@ def get_deployment(function_id:, deployment_id:) end api_params = { + deploymentId: deployment_id, + buildId: build_id, } api_headers = { + "content-type": 'application/json', } @client.call( - method: 'GET', + method: 'POST', path: api_path, headers: api_headers, params: api_params, @@ -420,28 +455,50 @@ def get_deployment(function_id:, deployment_id:) end - # Update the function code deployment ID using the unique function ID. Use - # this endpoint to switch the code deployment that should be executed by the - # execution endpoint. + # Create a deployment based on a template. + # + # Use this endpoint with combination of + # [listTemplates](https://appwrite.io/docs/server/functions#listTemplates) to + # find the template details. # # @param [String] function_id Function ID. - # @param [String] deployment_id Deployment ID. + # @param [String] repository Repository name of the template. + # @param [String] owner The name of the owner of the template. + # @param [String] root_directory Path to function code in the template repo. + # @param [String] version Version (tag) for the repo linked to the function template. + # @param [] activate Automatically activate the deployment when it is finished building. # - # @return [Function] - def update_deployment(function_id:, deployment_id:) - api_path = '/functions/{functionId}/deployments/{deploymentId}' + # @return [Deployment] + def create_template_deployment(function_id:, repository:, owner:, root_directory:, version:, activate: nil) + api_path = '/functions/{functionId}/deployments/template' .gsub('{functionId}', function_id) - .gsub('{deploymentId}', deployment_id) if function_id.nil? raise Appwrite::Exception.new('Missing required parameter: "functionId"') end - if deployment_id.nil? - raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + if repository.nil? + raise Appwrite::Exception.new('Missing required parameter: "repository"') + end + + if owner.nil? + raise Appwrite::Exception.new('Missing required parameter: "owner"') + end + + if root_directory.nil? + raise Appwrite::Exception.new('Missing required parameter: "rootDirectory"') + end + + if version.nil? + raise Appwrite::Exception.new('Missing required parameter: "version"') end api_params = { + repository: repository, + owner: owner, + rootDirectory: root_directory, + version: version, + activate: activate, } api_headers = { @@ -449,22 +506,68 @@ def update_deployment(function_id:, deployment_id:) } @client.call( - method: 'PATCH', + method: 'POST', path: api_path, headers: api_headers, params: api_params, - response_type: Models::Function + response_type: Models::Deployment ) end - # Delete a code deployment by its unique ID. + # Create a deployment when a function is connected to VCS. + # + # This endpoint lets you create deployment from a branch, commit, or a tag. + # + # @param [String] function_id Function ID. + # @param [VCSDeploymentType] type Type of reference passed. Allowed values are: branch, commit + # @param [String] reference VCS reference to create deployment from. Depending on type this can be: branch name, commit hash + # @param [] activate Automatically activate the deployment when it is finished building. + # + # @return [Deployment] + def create_vcs_deployment(function_id:, type:, reference:, activate: nil) + api_path = '/functions/{functionId}/deployments/vcs' + .gsub('{functionId}', function_id) + + if function_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "functionId"') + end + + if type.nil? + raise Appwrite::Exception.new('Missing required parameter: "type"') + end + + if reference.nil? + raise Appwrite::Exception.new('Missing required parameter: "reference"') + end + + api_params = { + type: type, + reference: reference, + activate: activate, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Get a function deployment by its unique ID. # # @param [String] function_id Function ID. # @param [String] deployment_id Deployment ID. # - # @return [] - def delete_deployment(function_id:, deployment_id:) + # @return [Deployment] + def get_deployment(function_id:, deployment_id:) api_path = '/functions/{functionId}/deployments/{deploymentId}' .gsub('{functionId}', function_id) .gsub('{deploymentId}', deployment_id) @@ -481,31 +584,26 @@ def delete_deployment(function_id:, deployment_id:) } api_headers = { - "content-type": 'application/json', } @client.call( - method: 'DELETE', + method: 'GET', path: api_path, headers: api_headers, params: api_params, + response_type: Models::Deployment ) end - # Create a new build for an existing function deployment. This endpoint - # allows you to rebuild a deployment with the updated function configuration, - # including its entrypoint and build commands if they have been modified The - # build process will be queued and executed asynchronously. The original - # deployment's code will be preserved and used for the new build. + # Delete a code deployment by its unique ID. # # @param [String] function_id Function ID. # @param [String] deployment_id Deployment ID. - # @param [String] build_id Build unique ID. # # @return [] - def create_build(function_id:, deployment_id:, build_id: nil) - api_path = '/functions/{functionId}/deployments/{deploymentId}/build' + def delete_deployment(function_id:, deployment_id:) + api_path = '/functions/{functionId}/deployments/{deploymentId}' .gsub('{functionId}', function_id) .gsub('{deploymentId}', deployment_id) @@ -518,7 +616,6 @@ def create_build(function_id:, deployment_id:, build_id: nil) end api_params = { - buildId: build_id, } api_headers = { @@ -526,7 +623,7 @@ def create_build(function_id:, deployment_id:, build_id: nil) } @client.call( - method: 'POST', + method: 'DELETE', path: api_path, headers: api_headers, params: api_params, @@ -534,18 +631,17 @@ def create_build(function_id:, deployment_id:, build_id: nil) end - # Cancel an ongoing function deployment build. If the build is already in - # progress, it will be stopped and marked as canceled. If the build hasn't - # started yet, it will be marked as canceled without executing. You cannot - # cancel builds that have already completed (status 'ready') or failed. The - # response includes the final build status and details. + # Get a function deployment content by its unique ID. The endpoint response + # return with a 'Content-Disposition: attachment' header that tells the + # browser to start downloading the file to user downloads directory. # # @param [String] function_id Function ID. # @param [String] deployment_id Deployment ID. + # @param [DeploymentDownloadType] type Deployment file to download. Can be: "source", "output". # - # @return [Build] - def update_deployment_build(function_id:, deployment_id:) - api_path = '/functions/{functionId}/deployments/{deploymentId}/build' + # @return [] + def get_deployment_download(function_id:, deployment_id:, type: nil) + api_path = '/functions/{functionId}/deployments/{deploymentId}/download' .gsub('{functionId}', function_id) .gsub('{deploymentId}', deployment_id) @@ -558,31 +654,33 @@ def update_deployment_build(function_id:, deployment_id:) end api_params = { + type: type, } api_headers = { - "content-type": 'application/json', } @client.call( - method: 'PATCH', + method: 'GET', path: api_path, headers: api_headers, params: api_params, - response_type: Models::Build ) end - # Get a Deployment's contents by its unique ID. This endpoint supports range - # requests for partial or streaming file download. + # Cancel an ongoing function deployment build. If the build is already in + # progress, it will be stopped and marked as canceled. If the build hasn't + # started yet, it will be marked as canceled without executing. You cannot + # cancel builds that have already completed (status 'ready') or failed. The + # response includes the final build status and details. # # @param [String] function_id Function ID. # @param [String] deployment_id Deployment ID. # - # @return [] - def get_deployment_download(function_id:, deployment_id:) - api_path = '/functions/{functionId}/deployments/{deploymentId}/download' + # @return [Deployment] + def update_deployment_status(function_id:, deployment_id:) + api_path = '/functions/{functionId}/deployments/{deploymentId}/status' .gsub('{functionId}', function_id) .gsub('{deploymentId}', deployment_id) @@ -598,13 +696,15 @@ def get_deployment_download(function_id:, deployment_id:) } api_headers = { + "content-type": 'application/json', } @client.call( - method: 'GET', + method: 'PATCH', path: api_path, headers: api_headers, params: api_params, + response_type: Models::Deployment ) end @@ -614,10 +714,9 @@ def get_deployment_download(function_id:, deployment_id:) # # @param [String] function_id Function ID. # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId - # @param [String] search Search term to filter your list results. Max length: 256 chars. # # @return [ExecutionList] - def list_executions(function_id:, queries: nil, search: nil) + def list_executions(function_id:, queries: nil) api_path = '/functions/{functionId}/executions' .gsub('{functionId}', function_id) @@ -627,7 +726,6 @@ def list_executions(function_id:, queries: nil, search: nil) api_params = { queries: queries, - search: search, } api_headers = { @@ -724,7 +822,6 @@ def get_execution(function_id:, execution_id:) # Delete a function execution by its unique ID. - # # # @param [String] function_id Function ID. # @param [String] execution_id Execution ID. @@ -794,9 +891,10 @@ def list_variables(function_id:) # @param [String] function_id Function unique ID. # @param [String] key Variable key. Max length: 255 chars. # @param [String] value Variable value. Max length: 8192 chars. + # @param [] secret Secret variables can be updated or deleted, but only functions can read them during build and runtime. # # @return [Variable] - def create_variable(function_id:, key:, value:) + def create_variable(function_id:, key:, value:, secret: nil) api_path = '/functions/{functionId}/variables' .gsub('{functionId}', function_id) @@ -815,6 +913,7 @@ def create_variable(function_id:, key:, value:) api_params = { key: key, value: value, + secret: secret, } api_headers = { @@ -872,9 +971,10 @@ def get_variable(function_id:, variable_id:) # @param [String] variable_id Variable unique ID. # @param [String] key Variable key. Max length: 255 chars. # @param [String] value Variable value. Max length: 8192 chars. + # @param [] secret Secret variables can be updated or deleted, but only functions can read them during build and runtime. # # @return [Variable] - def update_variable(function_id:, variable_id:, key:, value: nil) + def update_variable(function_id:, variable_id:, key:, value: nil, secret: nil) api_path = '/functions/{functionId}/variables/{variableId}' .gsub('{functionId}', function_id) .gsub('{variableId}', variable_id) @@ -894,6 +994,7 @@ def update_variable(function_id:, variable_id:, key:, value: nil) api_params = { key: key, value: value, + secret: secret, } api_headers = { diff --git a/lib/appwrite/services/sites.rb b/lib/appwrite/services/sites.rb new file mode 100644 index 0000000..1c50389 --- /dev/null +++ b/lib/appwrite/services/sites.rb @@ -0,0 +1,1004 @@ +#frozen_string_literal: true + +module Appwrite + class Sites < Service + + def initialize(client) + @client = client + end + + # Get a list of all the project's sites. You can use the query params to + # filter your results. + # + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId + # @param [String] search Search term to filter your list results. Max length: 256 chars. + # + # @return [SiteList] + def list(queries: nil, search: nil) + api_path = '/sites' + + api_params = { + queries: queries, + search: search, + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::SiteList + ) + end + + + # Create a new site. + # + # @param [String] site_id Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. + # @param [String] name Site name. Max length: 128 chars. + # @param [Framework] framework Sites framework. + # @param [BuildRuntime] build_runtime Runtime to use during build step. + # @param [] enabled Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled. + # @param [] logging When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + # @param [Integer] timeout Maximum request time in seconds. + # @param [String] install_command Install Command. + # @param [String] build_command Build Command. + # @param [String] output_directory Output Directory for site. + # @param [Adapter] adapter Framework adapter defining rendering strategy. Allowed values are: static, ssr + # @param [String] installation_id Appwrite Installation ID for VCS (Version Control System) deployment. + # @param [String] fallback_file Fallback file for single page application sites. + # @param [String] provider_repository_id Repository ID of the repo linked to the site. + # @param [String] provider_branch Production branch for the repo linked to the site. + # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests. + # @param [String] provider_root_directory Path to site code in the linked repo. + # @param [String] specification Framework specification for the site and builds. + # + # @return [Site] + def create(site_id:, name:, framework:, build_runtime:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, output_directory: nil, adapter: nil, installation_id: nil, fallback_file: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil) + api_path = '/sites' + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if name.nil? + raise Appwrite::Exception.new('Missing required parameter: "name"') + end + + if framework.nil? + raise Appwrite::Exception.new('Missing required parameter: "framework"') + end + + if build_runtime.nil? + raise Appwrite::Exception.new('Missing required parameter: "buildRuntime"') + end + + api_params = { + siteId: site_id, + name: name, + framework: framework, + enabled: enabled, + logging: logging, + timeout: timeout, + installCommand: install_command, + buildCommand: build_command, + outputDirectory: output_directory, + buildRuntime: build_runtime, + adapter: adapter, + installationId: installation_id, + fallbackFile: fallback_file, + providerRepositoryId: provider_repository_id, + providerBranch: provider_branch, + providerSilentMode: provider_silent_mode, + providerRootDirectory: provider_root_directory, + specification: specification, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Site + ) + end + + + # Get a list of all frameworks that are currently available on the server + # instance. + # + # + # @return [FrameworkList] + def list_frameworks() + api_path = '/sites/frameworks' + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::FrameworkList + ) + end + + + # List allowed site specifications for this instance. + # + # + # @return [SpecificationList] + def list_specifications() + api_path = '/sites/specifications' + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::SpecificationList + ) + end + + + # Get a site by its unique ID. + # + # @param [String] site_id Site ID. + # + # @return [Site] + def get(site_id:) + api_path = '/sites/{siteId}' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Site + ) + end + + + # Update site by its unique ID. + # + # @param [String] site_id Site ID. + # @param [String] name Site name. Max length: 128 chars. + # @param [Framework] framework Sites framework. + # @param [] enabled Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled. + # @param [] logging When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + # @param [Integer] timeout Maximum request time in seconds. + # @param [String] install_command Install Command. + # @param [String] build_command Build Command. + # @param [String] output_directory Output Directory for site. + # @param [BuildRuntime] build_runtime Runtime to use during build step. + # @param [Adapter] adapter Framework adapter defining rendering strategy. Allowed values are: static, ssr + # @param [String] fallback_file Fallback file for single page application sites. + # @param [String] installation_id Appwrite Installation ID for VCS (Version Control System) deployment. + # @param [String] provider_repository_id Repository ID of the repo linked to the site. + # @param [String] provider_branch Production branch for the repo linked to the site. + # @param [] provider_silent_mode Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests. + # @param [String] provider_root_directory Path to site code in the linked repo. + # @param [String] specification Framework specification for the site and builds. + # + # @return [Site] + def update(site_id:, name:, framework:, enabled: nil, logging: nil, timeout: nil, install_command: nil, build_command: nil, output_directory: nil, build_runtime: nil, adapter: nil, fallback_file: nil, installation_id: nil, provider_repository_id: nil, provider_branch: nil, provider_silent_mode: nil, provider_root_directory: nil, specification: nil) + api_path = '/sites/{siteId}' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if name.nil? + raise Appwrite::Exception.new('Missing required parameter: "name"') + end + + if framework.nil? + raise Appwrite::Exception.new('Missing required parameter: "framework"') + end + + api_params = { + name: name, + framework: framework, + enabled: enabled, + logging: logging, + timeout: timeout, + installCommand: install_command, + buildCommand: build_command, + outputDirectory: output_directory, + buildRuntime: build_runtime, + adapter: adapter, + fallbackFile: fallback_file, + installationId: installation_id, + providerRepositoryId: provider_repository_id, + providerBranch: provider_branch, + providerSilentMode: provider_silent_mode, + providerRootDirectory: provider_root_directory, + specification: specification, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PUT', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Site + ) + end + + + # Delete a site by its unique ID. + # + # @param [String] site_id Site ID. + # + # @return [] + def delete(site_id:) + api_path = '/sites/{siteId}' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + # Update the site active deployment. Use this endpoint to switch the code + # deployment that should be used when visitor opens your site. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # + # @return [Site] + def update_site_deployment(site_id:, deployment_id:) + api_path = '/sites/{siteId}/deployment' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + deploymentId: deployment_id, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PATCH', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Site + ) + end + + + # Get a list of all the site's code deployments. You can use the query params + # to filter your results. + # + # @param [String] site_id Site ID. + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type + # @param [String] search Search term to filter your list results. Max length: 256 chars. + # + # @return [DeploymentList] + def list_deployments(site_id:, queries: nil, search: nil) + api_path = '/sites/{siteId}/deployments' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + api_params = { + queries: queries, + search: search, + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::DeploymentList + ) + end + + + # Create a new site code deployment. Use this endpoint to upload a new + # version of your site code. To activate your newly uploaded code, you'll + # need to update the function's deployment to use your new deployment ID. + # + # @param [String] site_id Site ID. + # @param [file] code Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory. + # @param [] activate Automatically activate the deployment when it is finished building. + # @param [String] install_command Install Commands. + # @param [String] build_command Build Commands. + # @param [String] output_directory Output Directory. + # + # @return [Deployment] + def create_deployment(site_id:, code:, activate:, install_command: nil, build_command: nil, output_directory: nil, on_progress: nil) + api_path = '/sites/{siteId}/deployments' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if code.nil? + raise Appwrite::Exception.new('Missing required parameter: "code"') + end + + if activate.nil? + raise Appwrite::Exception.new('Missing required parameter: "activate"') + end + + api_params = { + installCommand: install_command, + buildCommand: build_command, + outputDirectory: output_directory, + code: code, + activate: activate, + } + + api_headers = { + "content-type": 'multipart/form-data', + } + + id_param_name = nil + param_name = 'code' + + @client.chunked_upload( + path: api_path, + headers: api_headers, + params: api_params, + param_name: param_name, + id_param_name: id_param_name, + on_progress: on_progress, + response_type: Models::Deployment + ) + end + + + # Create a new build for an existing site deployment. This endpoint allows + # you to rebuild a deployment with the updated site configuration, including + # its commands and output directory if they have been modified. The build + # process will be queued and executed asynchronously. The original + # deployment's code will be preserved and used for the new build. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # + # @return [Deployment] + def create_duplicate_deployment(site_id:, deployment_id:) + api_path = '/sites/{siteId}/deployments/duplicate' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + deploymentId: deployment_id, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Create a deployment based on a template. + # + # Use this endpoint with combination of + # [listTemplates](https://appwrite.io/docs/server/sites#listTemplates) to + # find the template details. + # + # @param [String] site_id Site ID. + # @param [String] repository Repository name of the template. + # @param [String] owner The name of the owner of the template. + # @param [String] root_directory Path to site code in the template repo. + # @param [String] version Version (tag) for the repo linked to the site template. + # @param [] activate Automatically activate the deployment when it is finished building. + # + # @return [Deployment] + def create_template_deployment(site_id:, repository:, owner:, root_directory:, version:, activate: nil) + api_path = '/sites/{siteId}/deployments/template' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if repository.nil? + raise Appwrite::Exception.new('Missing required parameter: "repository"') + end + + if owner.nil? + raise Appwrite::Exception.new('Missing required parameter: "owner"') + end + + if root_directory.nil? + raise Appwrite::Exception.new('Missing required parameter: "rootDirectory"') + end + + if version.nil? + raise Appwrite::Exception.new('Missing required parameter: "version"') + end + + api_params = { + repository: repository, + owner: owner, + rootDirectory: root_directory, + version: version, + activate: activate, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Create a deployment when a site is connected to VCS. + # + # This endpoint lets you create deployment from a branch, commit, or a tag. + # + # @param [String] site_id Site ID. + # @param [VCSDeploymentType] type Type of reference passed. Allowed values are: branch, commit + # @param [String] reference VCS reference to create deployment from. Depending on type this can be: branch name, commit hash + # @param [] activate Automatically activate the deployment when it is finished building. + # + # @return [Deployment] + def create_vcs_deployment(site_id:, type:, reference:, activate: nil) + api_path = '/sites/{siteId}/deployments/vcs' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if type.nil? + raise Appwrite::Exception.new('Missing required parameter: "type"') + end + + if reference.nil? + raise Appwrite::Exception.new('Missing required parameter: "reference"') + end + + api_params = { + type: type, + reference: reference, + activate: activate, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Get a site deployment by its unique ID. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # + # @return [Deployment] + def get_deployment(site_id:, deployment_id:) + api_path = '/sites/{siteId}/deployments/{deploymentId}' + .gsub('{siteId}', site_id) + .gsub('{deploymentId}', deployment_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Delete a site deployment by its unique ID. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # + # @return [] + def delete_deployment(site_id:, deployment_id:) + api_path = '/sites/{siteId}/deployments/{deploymentId}' + .gsub('{siteId}', site_id) + .gsub('{deploymentId}', deployment_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + # Get a site deployment content by its unique ID. The endpoint response + # return with a 'Content-Disposition: attachment' header that tells the + # browser to start downloading the file to user downloads directory. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # @param [DeploymentDownloadType] type Deployment file to download. Can be: "source", "output". + # + # @return [] + def get_deployment_download(site_id:, deployment_id:, type: nil) + api_path = '/sites/{siteId}/deployments/{deploymentId}/download' + .gsub('{siteId}', site_id) + .gsub('{deploymentId}', deployment_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + type: type, + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + # Cancel an ongoing site deployment build. If the build is already in + # progress, it will be stopped and marked as canceled. If the build hasn't + # started yet, it will be marked as canceled without executing. You cannot + # cancel builds that have already completed (status 'ready') or failed. The + # response includes the final build status and details. + # + # @param [String] site_id Site ID. + # @param [String] deployment_id Deployment ID. + # + # @return [Deployment] + def update_deployment_status(site_id:, deployment_id:) + api_path = '/sites/{siteId}/deployments/{deploymentId}/status' + .gsub('{siteId}', site_id) + .gsub('{deploymentId}', deployment_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if deployment_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "deploymentId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PATCH', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Deployment + ) + end + + + # Get a list of all site logs. You can use the query params to filter your + # results. + # + # @param [String] site_id Site ID. + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId + # + # @return [ExecutionList] + def list_logs(site_id:, queries: nil) + api_path = '/sites/{siteId}/logs' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + api_params = { + queries: queries, + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::ExecutionList + ) + end + + + # Get a site request log by its unique ID. + # + # @param [String] site_id Site ID. + # @param [String] log_id Log ID. + # + # @return [Execution] + def get_log(site_id:, log_id:) + api_path = '/sites/{siteId}/logs/{logId}' + .gsub('{siteId}', site_id) + .gsub('{logId}', log_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if log_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "logId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Execution + ) + end + + + # Delete a site log by its unique ID. + # + # @param [String] site_id Site ID. + # @param [String] log_id Log ID. + # + # @return [] + def delete_log(site_id:, log_id:) + api_path = '/sites/{siteId}/logs/{logId}' + .gsub('{siteId}', site_id) + .gsub('{logId}', log_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if log_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "logId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + # Get a list of all variables of a specific site. + # + # @param [String] site_id Site unique ID. + # + # @return [VariableList] + def list_variables(site_id:) + api_path = '/sites/{siteId}/variables' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::VariableList + ) + end + + + # Create a new site variable. These variables can be accessed during build + # and runtime (server-side rendering) as environment variables. + # + # @param [String] site_id Site unique ID. + # @param [String] key Variable key. Max length: 255 chars. + # @param [String] value Variable value. Max length: 8192 chars. + # @param [] secret Secret variables can be updated or deleted, but only sites can read them during build and runtime. + # + # @return [Variable] + def create_variable(site_id:, key:, value:, secret: nil) + api_path = '/sites/{siteId}/variables' + .gsub('{siteId}', site_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if key.nil? + raise Appwrite::Exception.new('Missing required parameter: "key"') + end + + if value.nil? + raise Appwrite::Exception.new('Missing required parameter: "value"') + end + + api_params = { + key: key, + value: value, + secret: secret, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Variable + ) + end + + + # Get a variable by its unique ID. + # + # @param [String] site_id Site unique ID. + # @param [String] variable_id Variable unique ID. + # + # @return [Variable] + def get_variable(site_id:, variable_id:) + api_path = '/sites/{siteId}/variables/{variableId}' + .gsub('{siteId}', site_id) + .gsub('{variableId}', variable_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if variable_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "variableId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Variable + ) + end + + + # Update variable by its unique ID. + # + # @param [String] site_id Site unique ID. + # @param [String] variable_id Variable unique ID. + # @param [String] key Variable key. Max length: 255 chars. + # @param [String] value Variable value. Max length: 8192 chars. + # @param [] secret Secret variables can be updated or deleted, but only sites can read them during build and runtime. + # + # @return [Variable] + def update_variable(site_id:, variable_id:, key:, value: nil, secret: nil) + api_path = '/sites/{siteId}/variables/{variableId}' + .gsub('{siteId}', site_id) + .gsub('{variableId}', variable_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if variable_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "variableId"') + end + + if key.nil? + raise Appwrite::Exception.new('Missing required parameter: "key"') + end + + api_params = { + key: key, + value: value, + secret: secret, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PUT', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::Variable + ) + end + + + # Delete a variable by its unique ID. + # + # @param [String] site_id Site unique ID. + # @param [String] variable_id Variable unique ID. + # + # @return [] + def delete_variable(site_id:, variable_id:) + api_path = '/sites/{siteId}/variables/{variableId}' + .gsub('{siteId}', site_id) + .gsub('{variableId}', variable_id) + + if site_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "siteId"') + end + + if variable_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "variableId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + end +end \ No newline at end of file diff --git a/lib/appwrite/services/storage.rb b/lib/appwrite/services/storage.rb index 84f0199..84a9041 100644 --- a/lib/appwrite/services/storage.rb +++ b/lib/appwrite/services/storage.rb @@ -417,9 +417,10 @@ def delete_file(bucket_id:, file_id:) # # @param [String] bucket_id Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket). # @param [String] file_id File ID. + # @param [String] token File token for accessing this file. # # @return [] - def get_file_download(bucket_id:, file_id:) + def get_file_download(bucket_id:, file_id:, token: nil) api_path = '/storage/buckets/{bucketId}/files/{fileId}/download' .gsub('{bucketId}', bucket_id) .gsub('{fileId}', file_id) @@ -433,6 +434,7 @@ def get_file_download(bucket_id:, file_id:) end api_params = { + token: token, } api_headers = { @@ -458,7 +460,7 @@ def get_file_download(bucket_id:, file_id:) # @param [Integer] width Resize preview image width, Pass an integer between 0 to 4000. # @param [Integer] height Resize preview image height, Pass an integer between 0 to 4000. # @param [ImageGravity] gravity Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right - # @param [Integer] quality Preview image quality. Pass an integer between 0 to 100. Defaults to 100. + # @param [Integer] quality Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality. # @param [Integer] border_width Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0. # @param [String] border_color Preview image border color. Use a valid HEX color, no # is needed for prefix. # @param [Integer] border_radius Preview image border radius in pixels. Pass an integer between 0 to 4000. @@ -466,9 +468,10 @@ def get_file_download(bucket_id:, file_id:) # @param [Integer] rotation Preview image rotation in degrees. Pass an integer between -360 and 360. # @param [String] background Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix. # @param [ImageFormat] output Output format type (jpeg, jpg, png, gif and webp). + # @param [String] token File token for accessing this file. # # @return [] - def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil) + def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil, quality: nil, border_width: nil, border_color: nil, border_radius: nil, opacity: nil, rotation: nil, background: nil, output: nil, token: nil) api_path = '/storage/buckets/{bucketId}/files/{fileId}/preview' .gsub('{bucketId}', bucket_id) .gsub('{fileId}', file_id) @@ -493,6 +496,7 @@ def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil rotation: rotation, background: background, output: output, + token: token, } api_headers = { @@ -513,9 +517,10 @@ def get_file_preview(bucket_id:, file_id:, width: nil, height: nil, gravity: nil # # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket). # @param [String] file_id File ID. + # @param [String] token File token for accessing this file. # # @return [] - def get_file_view(bucket_id:, file_id:) + def get_file_view(bucket_id:, file_id:, token: nil) api_path = '/storage/buckets/{bucketId}/files/{fileId}/view' .gsub('{bucketId}', bucket_id) .gsub('{fileId}', file_id) @@ -529,6 +534,7 @@ def get_file_view(bucket_id:, file_id:) end api_params = { + token: token, } api_headers = { diff --git a/lib/appwrite/services/teams.rb b/lib/appwrite/services/teams.rb index ad1f66e..d1b749b 100644 --- a/lib/appwrite/services/teams.rb +++ b/lib/appwrite/services/teams.rb @@ -175,7 +175,7 @@ def delete(team_id:) # the response by toggling membership privacy in the Console. # # @param [String] team_id Team ID. - # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles # @param [String] search Search term to filter your list results. Max length: 256 chars. # # @return [MembershipList] diff --git a/lib/appwrite/services/tokens.rb b/lib/appwrite/services/tokens.rb new file mode 100644 index 0000000..acc1739 --- /dev/null +++ b/lib/appwrite/services/tokens.rb @@ -0,0 +1,179 @@ +#frozen_string_literal: true + +module Appwrite + class Tokens < Service + + def initialize(client) + @client = client + end + + # List all the tokens created for a specific file or bucket. You can use the + # query params to filter your results. + # + # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket). + # @param [String] file_id File unique ID. + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: expire + # + # @return [ResourceTokenList] + def list(bucket_id:, file_id:, queries: nil) + api_path = '/tokens/buckets/{bucketId}/files/{fileId}' + .gsub('{bucketId}', bucket_id) + .gsub('{fileId}', file_id) + + if bucket_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "bucketId"') + end + + if file_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "fileId"') + end + + api_params = { + queries: queries, + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::ResourceTokenList + ) + end + + + # Create a new token. A token is linked to a file. Token can be passed as a + # header or request get parameter. + # + # @param [String] bucket_id Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket). + # @param [String] file_id File unique ID. + # @param [String] expire Token expiry date + # + # @return [ResourceToken] + def create_file_token(bucket_id:, file_id:, expire: nil) + api_path = '/tokens/buckets/{bucketId}/files/{fileId}' + .gsub('{bucketId}', bucket_id) + .gsub('{fileId}', file_id) + + if bucket_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "bucketId"') + end + + if file_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "fileId"') + end + + api_params = { + expire: expire, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'POST', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::ResourceToken + ) + end + + + # Get a token by its unique ID. + # + # @param [String] token_id Token ID. + # + # @return [ResourceToken] + def get(token_id:) + api_path = '/tokens/{tokenId}' + .gsub('{tokenId}', token_id) + + if token_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "tokenId"') + end + + api_params = { + } + + api_headers = { + } + + @client.call( + method: 'GET', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::ResourceToken + ) + end + + + # Update a token by its unique ID. Use this endpoint to update a token's + # expiry date. + # + # @param [String] token_id Token unique ID. + # @param [String] expire File token expiry date + # + # @return [ResourceToken] + def update(token_id:, expire: nil) + api_path = '/tokens/{tokenId}' + .gsub('{tokenId}', token_id) + + if token_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "tokenId"') + end + + api_params = { + expire: expire, + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'PATCH', + path: api_path, + headers: api_headers, + params: api_params, + response_type: Models::ResourceToken + ) + end + + + # Delete a token by its unique ID. + # + # @param [String] token_id Token ID. + # + # @return [] + def delete(token_id:) + api_path = '/tokens/{tokenId}' + .gsub('{tokenId}', token_id) + + if token_id.nil? + raise Appwrite::Exception.new('Missing required parameter: "tokenId"') + end + + api_params = { + } + + api_headers = { + "content-type": 'application/json', + } + + @client.call( + method: 'DELETE', + path: api_path, + headers: api_headers, + params: api_params, + ) + end + + + end +end \ No newline at end of file diff --git a/lib/appwrite/services/users.rb b/lib/appwrite/services/users.rb index 9c1d85b..6bb2063 100644 --- a/lib/appwrite/services/users.rb +++ b/lib/appwrite/services/users.rb @@ -719,9 +719,11 @@ def list_logs(user_id:, queries: nil) # Get the user membership list by its unique ID. # # @param [String] user_id User ID. + # @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: userId, teamId, invited, joined, confirm, roles + # @param [String] search Search term to filter your list results. Max length: 256 chars. # # @return [MembershipList] - def list_memberships(user_id:) + def list_memberships(user_id:, queries: nil, search: nil) api_path = '/users/{userId}/memberships' .gsub('{userId}', user_id) @@ -730,6 +732,8 @@ def list_memberships(user_id:) end api_params = { + queries: queries, + search: search, } api_headers = { From 6661d6fab2fb879f2abeb01efec304f343770732 Mon Sep 17 00:00:00 2001 From: root Date: Sun, 18 May 2025 07:37:09 +0000 Subject: [PATCH 3/3] chore: bump to next major versions --- appwrite.gemspec | 2 +- lib/appwrite/client.rb | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/appwrite.gemspec b/appwrite.gemspec index 3864ac0..3c76b6b 100644 --- a/appwrite.gemspec +++ b/appwrite.gemspec @@ -1,7 +1,7 @@ Gem::Specification.new do |spec| spec.name = 'appwrite' - spec.version = '15.2.0' + spec.version = '16.0.0' spec.license = 'BSD-3-Clause' spec.summary = 'Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API' spec.author = 'Appwrite Team' diff --git a/lib/appwrite/client.rb b/lib/appwrite/client.rb index 5501cdf..2158e4c 100644 --- a/lib/appwrite/client.rb +++ b/lib/appwrite/client.rb @@ -15,7 +15,7 @@ def initialize 'x-sdk-name'=> 'Ruby', 'x-sdk-platform'=> 'server', 'x-sdk-language'=> 'ruby', - 'x-sdk-version'=> '15.2.0', + 'x-sdk-version'=> '16.0.0', 'X-Appwrite-Response-Format' => '1.7.0' } @endpoint = 'https://cloud.appwrite.io/v1'