From 20b0a0fac747318d0cb70d120e89020a5e900bd7 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Thu, 8 May 2025 23:29:03 +1200 Subject: [PATCH 1/7] Add bulk API methods --- README.md | 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 | 14 + .../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 | 14 + 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 | 15 + .../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 | 14 + 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/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 +++++++------- lib/services/avatars.dart | 434 ++- lib/services/databases.dart | 2416 +++++++-------- lib/services/functions.dart | 1264 ++++---- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 ++--- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 ++++++++--------- lib/services/storage.dart | 733 ++--- lib/services/teams.dart | 671 ++--- lib/services/users.dart | 2056 ++++++------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 125 +- lib/src/client_io.dart | 152 +- lib/src/client_mixin.dart | 71 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 +-- lib/src/enums/image_format.dart | 24 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 128 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/build.dart | 110 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 310 +- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/function.dart | 310 +- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 100 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 108 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- pubspec.yaml | 2 +- test/services/databases_test.dart | 77 + 406 files changed, 11215 insertions(+), 11881 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/README.md b/README.md index 555b377c..ec500daa 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file: ```yml dependencies: - dart_appwrite: ^15.0.0 + dart_appwrite: ^15.1.0-rc.1 ``` You can install packages from the command line: diff --git a/docs/examples/account/create-anonymous-session.md b/docs/examples/account/create-anonymous-session.md index 2363017b..7b1cc083 100644 --- a/docs/examples/account/create-anonymous-session.md +++ b/docs/examples/account/create-anonymous-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-email-password-session.md b/docs/examples/account/create-email-password-session.md index bd423de9..2305367d 100644 --- a/docs/examples/account/create-email-password-session.md +++ b/docs/examples/account/create-email-password-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-email-token.md b/docs/examples/account/create-email-token.md index b57a5f06..e9696f92 100644 --- a/docs/examples/account/create-email-token.md +++ b/docs/examples/account/create-email-token.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-j-w-t.md b/docs/examples/account/create-j-w-t.md index 205e2449..4288c71c 100644 --- a/docs/examples/account/create-j-w-t.md +++ b/docs/examples/account/create-j-w-t.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(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 3c071b82..791b9cbd 100644 --- a/docs/examples/account/create-magic-u-r-l-token.md +++ b/docs/examples/account/create-magic-u-r-l-token.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-mfa-authenticator.md b/docs/examples/account/create-mfa-authenticator.md index 38ffb363..87797fa6 100644 --- a/docs/examples/account/create-mfa-authenticator.md +++ b/docs/examples/account/create-mfa-authenticator.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 5578e32f..62f3eaf2 100644 --- a/docs/examples/account/create-mfa-challenge.md +++ b/docs/examples/account/create-mfa-challenge.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-mfa-recovery-codes.md b/docs/examples/account/create-mfa-recovery-codes.md index d89ccd1d..5ebe0e9e 100644 --- a/docs/examples/account/create-mfa-recovery-codes.md +++ b/docs/examples/account/create-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 a23fa723..4a26a9fd 100644 --- a/docs/examples/account/create-o-auth2token.md +++ b/docs/examples/account/create-o-auth2token.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-phone-token.md b/docs/examples/account/create-phone-token.md index e59ad503..7011b3cf 100644 --- a/docs/examples/account/create-phone-token.md +++ b/docs/examples/account/create-phone-token.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-phone-verification.md b/docs/examples/account/create-phone-verification.md index a47ad80f..8616834b 100644 --- a/docs/examples/account/create-phone-verification.md +++ b/docs/examples/account/create-phone-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/create-recovery.md b/docs/examples/account/create-recovery.md index 0479b71c..f56d4227 100644 --- a/docs/examples/account/create-recovery.md +++ b/docs/examples/account/create-recovery.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/create-session.md b/docs/examples/account/create-session.md index 209f5502..1e56fc71 100644 --- a/docs/examples/account/create-session.md +++ b/docs/examples/account/create-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/create-verification.md b/docs/examples/account/create-verification.md index 414a193a..150833cd 100644 --- a/docs/examples/account/create-verification.md +++ b/docs/examples/account/create-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/create.md b/docs/examples/account/create.md index 59523e62..f0384f46 100644 --- a/docs/examples/account/create.md +++ b/docs/examples/account/create.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/delete-identity.md b/docs/examples/account/delete-identity.md index a0db3ccc..124e6ada 100644 --- a/docs/examples/account/delete-identity.md +++ b/docs/examples/account/delete-identity.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 27a5883c..efd5263e 100644 --- a/docs/examples/account/delete-mfa-authenticator.md +++ b/docs/examples/account/delete-mfa-authenticator.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/delete-session.md b/docs/examples/account/delete-session.md index ffbe4160..d02808bb 100644 --- a/docs/examples/account/delete-session.md +++ b/docs/examples/account/delete-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/delete-sessions.md b/docs/examples/account/delete-sessions.md index ae93cf9b..9406ca39 100644 --- a/docs/examples/account/delete-sessions.md +++ b/docs/examples/account/delete-sessions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 2b201831..b073d402 100644 --- a/docs/examples/account/get-mfa-recovery-codes.md +++ b/docs/examples/account/get-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/get-prefs.md b/docs/examples/account/get-prefs.md index 355075c8..94e10db1 100644 --- a/docs/examples/account/get-prefs.md +++ b/docs/examples/account/get-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/get-session.md b/docs/examples/account/get-session.md index c4b4aced..3a81954b 100644 --- a/docs/examples/account/get-session.md +++ b/docs/examples/account/get-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/get.md b/docs/examples/account/get.md index 64c923ce..76a139a4 100644 --- a/docs/examples/account/get.md +++ b/docs/examples/account/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/list-identities.md b/docs/examples/account/list-identities.md index 28996370..a0b67851 100644 --- a/docs/examples/account/list-identities.md +++ b/docs/examples/account/list-identities.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/list-logs.md b/docs/examples/account/list-logs.md index 78f527ca..d3c50af1 100644 --- a/docs/examples/account/list-logs.md +++ b/docs/examples/account/list-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 1140e5c0..32b269fb 100644 --- a/docs/examples/account/list-mfa-factors.md +++ b/docs/examples/account/list-mfa-factors.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/list-sessions.md b/docs/examples/account/list-sessions.md index 0a512d43..73cf462a 100644 --- a/docs/examples/account/list-sessions.md +++ b/docs/examples/account/list-sessions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-email.md b/docs/examples/account/update-email.md index 91c701f8..cf6a56ed 100644 --- a/docs/examples/account/update-email.md +++ b/docs/examples/account/update-email.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 f029979e..947d862e 100644 --- a/docs/examples/account/update-m-f-a.md +++ b/docs/examples/account/update-m-f-a.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 e9f24349..475e464f 100644 --- a/docs/examples/account/update-magic-u-r-l-session.md +++ b/docs/examples/account/update-magic-u-r-l-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/update-mfa-authenticator.md b/docs/examples/account/update-mfa-authenticator.md index 3f5d6997..5a0f98f5 100644 --- a/docs/examples/account/update-mfa-authenticator.md +++ b/docs/examples/account/update-mfa-authenticator.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 2843d2f1..749c4cd6 100644 --- a/docs/examples/account/update-mfa-challenge.md +++ b/docs/examples/account/update-mfa-challenge.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 0ee6e92d..7e274f0e 100644 --- a/docs/examples/account/update-mfa-recovery-codes.md +++ b/docs/examples/account/update-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-name.md b/docs/examples/account/update-name.md index 4eb46121..82cc3358 100644 --- a/docs/examples/account/update-name.md +++ b/docs/examples/account/update-name.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-password.md b/docs/examples/account/update-password.md index d379268e..27d360ba 100644 --- a/docs/examples/account/update-password.md +++ b/docs/examples/account/update-password.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 0648c637..046dd0a7 100644 --- a/docs/examples/account/update-phone-session.md +++ b/docs/examples/account/update-phone-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject(''); // Your project ID Account account = Account(client); diff --git a/docs/examples/account/update-phone-verification.md b/docs/examples/account/update-phone-verification.md index bb7443dd..f4b0c6fe 100644 --- a/docs/examples/account/update-phone-verification.md +++ b/docs/examples/account/update-phone-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-phone.md b/docs/examples/account/update-phone.md index 996e057b..d861561b 100644 --- a/docs/examples/account/update-phone.md +++ b/docs/examples/account/update-phone.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-prefs.md b/docs/examples/account/update-prefs.md index 1c555085..f4533cbe 100644 --- a/docs/examples/account/update-prefs.md +++ b/docs/examples/account/update-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-recovery.md b/docs/examples/account/update-recovery.md index 5c4c0735..162ad58a 100644 --- a/docs/examples/account/update-recovery.md +++ b/docs/examples/account/update-recovery.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-session.md b/docs/examples/account/update-session.md index cb1930c1..a317a084 100644 --- a/docs/examples/account/update-session.md +++ b/docs/examples/account/update-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-status.md b/docs/examples/account/update-status.md index 502522ce..2ee15d60 100644 --- a/docs/examples/account/update-status.md +++ b/docs/examples/account/update-status.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/account/update-verification.md b/docs/examples/account/update-verification.md index 1f0d0c1a..61904fd3 100644 --- a/docs/examples/account/update-verification.md +++ b/docs/examples/account/update-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index ba298590..902c719a 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 e8495823..b242d271 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/avatars/get-favicon.md b/docs/examples/avatars/get-favicon.md index d6d8c654..d4cd8eae 100644 --- a/docs/examples/avatars/get-favicon.md +++ b/docs/examples/avatars/get-favicon.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/avatars/get-flag.md b/docs/examples/avatars/get-flag.md index cda8d0fd..5eaed135 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/avatars/get-image.md b/docs/examples/avatars/get-image.md index da2541f3..b6db1858 100644 --- a/docs/examples/avatars/get-image.md +++ b/docs/examples/avatars/get-image.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/avatars/get-initials.md b/docs/examples/avatars/get-initials.md index f1261d1c..7dc0989b 100644 --- a/docs/examples/avatars/get-initials.md +++ b/docs/examples/avatars/get-initials.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 1a9e906c..f64fe8a4 100644 --- a/docs/examples/avatars/get-q-r.md +++ b/docs/examples/avatars/get-q-r.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 65537bab..13ca9928 100644 --- a/docs/examples/databases/create-boolean-attribute.md +++ b/docs/examples/databases/create-boolean-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-collection.md b/docs/examples/databases/create-collection.md index 8b01aaad..61401761 100644 --- a/docs/examples/databases/create-collection.md +++ b/docs/examples/databases/create-collection.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-datetime-attribute.md b/docs/examples/databases/create-datetime-attribute.md index 6a53b045..25910114 100644 --- a/docs/examples/databases/create-datetime-attribute.md +++ b/docs/examples/databases/create-datetime-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-document.md b/docs/examples/databases/create-document.md index 10382e3a..1d58fc58 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 00000000..9faa4ebf --- /dev/null +++ b/docs/examples/databases/create-documents.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setSession(''); // The user session to authenticate with + +Databases databases = Databases(client); + +DocumentList result = await databases.createDocuments( + databaseId: '', + collectionId: '', + documents: [], +); diff --git a/docs/examples/databases/create-email-attribute.md b/docs/examples/databases/create-email-attribute.md index fe77148e..216d0202 100644 --- a/docs/examples/databases/create-email-attribute.md +++ b/docs/examples/databases/create-email-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-enum-attribute.md b/docs/examples/databases/create-enum-attribute.md index f0bdb6a6..d45ca447 100644 --- a/docs/examples/databases/create-enum-attribute.md +++ b/docs/examples/databases/create-enum-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-float-attribute.md b/docs/examples/databases/create-float-attribute.md index 29568ca0..75d47f44 100644 --- a/docs/examples/databases/create-float-attribute.md +++ b/docs/examples/databases/create-float-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index b7c0c04b..ff847a94 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-integer-attribute.md b/docs/examples/databases/create-integer-attribute.md index 35b60850..6511696f 100644 --- a/docs/examples/databases/create-integer-attribute.md +++ b/docs/examples/databases/create-integer-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-ip-attribute.md b/docs/examples/databases/create-ip-attribute.md index a7c3116b..10ddb47b 100644 --- a/docs/examples/databases/create-ip-attribute.md +++ b/docs/examples/databases/create-ip-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-relationship-attribute.md b/docs/examples/databases/create-relationship-attribute.md index 37ba8eb7..dcdf34fc 100644 --- a/docs/examples/databases/create-relationship-attribute.md +++ b/docs/examples/databases/create-relationship-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-string-attribute.md b/docs/examples/databases/create-string-attribute.md index 974c7dad..8785ea76 100644 --- a/docs/examples/databases/create-string-attribute.md +++ b/docs/examples/databases/create-string-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create-url-attribute.md b/docs/examples/databases/create-url-attribute.md index 034ee47d..9088f8df 100644 --- a/docs/examples/databases/create-url-attribute.md +++ b/docs/examples/databases/create-url-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/create.md b/docs/examples/databases/create.md index 199b982f..a2e978bd 100644 --- a/docs/examples/databases/create.md +++ b/docs/examples/databases/create.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/delete-attribute.md b/docs/examples/databases/delete-attribute.md index f0bcf3b0..f9cbbd42 100644 --- a/docs/examples/databases/delete-attribute.md +++ b/docs/examples/databases/delete-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/delete-collection.md b/docs/examples/databases/delete-collection.md index b97f2740..919e1789 100644 --- a/docs/examples/databases/delete-collection.md +++ b/docs/examples/databases/delete-collection.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/delete-document.md b/docs/examples/databases/delete-document.md index 89347017..dd04d899 100644 --- a/docs/examples/databases/delete-document.md +++ b/docs/examples/databases/delete-document.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 00000000..66bd5584 --- /dev/null +++ b/docs/examples/databases/delete-documents.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Databases databases = Databases(client); + +await databases.deleteDocuments( + databaseId: '', + collectionId: '', + queries: [], // (optional) +); diff --git a/docs/examples/databases/delete-index.md b/docs/examples/databases/delete-index.md index 9f0e92f6..f16c84b9 100644 --- a/docs/examples/databases/delete-index.md +++ b/docs/examples/databases/delete-index.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/delete.md b/docs/examples/databases/delete.md index 0d4853d6..5e9042e5 100644 --- a/docs/examples/databases/delete.md +++ b/docs/examples/databases/delete.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/get-attribute.md b/docs/examples/databases/get-attribute.md index 33e4a4a6..8329f8db 100644 --- a/docs/examples/databases/get-attribute.md +++ b/docs/examples/databases/get-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/get-collection.md b/docs/examples/databases/get-collection.md index 42dcea34..b6784201 100644 --- a/docs/examples/databases/get-collection.md +++ b/docs/examples/databases/get-collection.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/get-document.md b/docs/examples/databases/get-document.md index ecda80ef..45745186 100644 --- a/docs/examples/databases/get-document.md +++ b/docs/examples/databases/get-document.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/databases/get-index.md b/docs/examples/databases/get-index.md index 0bbf4f55..84825796 100644 --- a/docs/examples/databases/get-index.md +++ b/docs/examples/databases/get-index.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/get.md b/docs/examples/databases/get.md index b2c0a0a2..28d3d2bd 100644 --- a/docs/examples/databases/get.md +++ b/docs/examples/databases/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/list-attributes.md b/docs/examples/databases/list-attributes.md index 4bacaa97..64aaf331 100644 --- a/docs/examples/databases/list-attributes.md +++ b/docs/examples/databases/list-attributes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/list-collections.md b/docs/examples/databases/list-collections.md index e9bc5107..69c2a0fe 100644 --- a/docs/examples/databases/list-collections.md +++ b/docs/examples/databases/list-collections.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/list-documents.md b/docs/examples/databases/list-documents.md index 244d4a7d..cdecc59e 100644 --- a/docs/examples/databases/list-documents.md +++ b/docs/examples/databases/list-documents.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/databases/list-indexes.md b/docs/examples/databases/list-indexes.md index e9534e78..38b95d5d 100644 --- a/docs/examples/databases/list-indexes.md +++ b/docs/examples/databases/list-indexes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/list.md b/docs/examples/databases/list.md index 2678ede9..2de4e97c 100644 --- a/docs/examples/databases/list.md +++ b/docs/examples/databases/list.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-boolean-attribute.md b/docs/examples/databases/update-boolean-attribute.md index 489ce409..46e3ef4c 100644 --- a/docs/examples/databases/update-boolean-attribute.md +++ b/docs/examples/databases/update-boolean-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-collection.md b/docs/examples/databases/update-collection.md index a8d1593c..c3c565b2 100644 --- a/docs/examples/databases/update-collection.md +++ b/docs/examples/databases/update-collection.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-datetime-attribute.md b/docs/examples/databases/update-datetime-attribute.md index 73f61e26..ddc8f26a 100644 --- a/docs/examples/databases/update-datetime-attribute.md +++ b/docs/examples/databases/update-datetime-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-document.md b/docs/examples/databases/update-document.md index c25b23f2..47a1867c 100644 --- a/docs/examples/databases/update-document.md +++ b/docs/examples/databases/update-document.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 00000000..70b7cbf8 --- /dev/null +++ b/docs/examples/databases/update-documents.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Databases databases = Databases(client); + +DocumentList result = await databases.updateDocuments( + databaseId: '', + collectionId: '', + data: {}, // (optional) + queries: [], // (optional) +); diff --git a/docs/examples/databases/update-email-attribute.md b/docs/examples/databases/update-email-attribute.md index 37bcd4d7..ee0e0971 100644 --- a/docs/examples/databases/update-email-attribute.md +++ b/docs/examples/databases/update-email-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-enum-attribute.md b/docs/examples/databases/update-enum-attribute.md index f47078c8..61ef4d08 100644 --- a/docs/examples/databases/update-enum-attribute.md +++ b/docs/examples/databases/update-enum-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-float-attribute.md b/docs/examples/databases/update-float-attribute.md index b85ebf7a..36f360ee 100644 --- a/docs/examples/databases/update-float-attribute.md +++ b/docs/examples/databases/update-float-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-integer-attribute.md b/docs/examples/databases/update-integer-attribute.md index 486c1927..9089cc8b 100644 --- a/docs/examples/databases/update-integer-attribute.md +++ b/docs/examples/databases/update-integer-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-ip-attribute.md b/docs/examples/databases/update-ip-attribute.md index dc83bd00..e698a59e 100644 --- a/docs/examples/databases/update-ip-attribute.md +++ b/docs/examples/databases/update-ip-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-relationship-attribute.md b/docs/examples/databases/update-relationship-attribute.md index 6d14f52d..28aac964 100644 --- a/docs/examples/databases/update-relationship-attribute.md +++ b/docs/examples/databases/update-relationship-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-string-attribute.md b/docs/examples/databases/update-string-attribute.md index f9498aa3..7674f51c 100644 --- a/docs/examples/databases/update-string-attribute.md +++ b/docs/examples/databases/update-string-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update-url-attribute.md b/docs/examples/databases/update-url-attribute.md index 20c11faf..3aaa01b4 100644 --- a/docs/examples/databases/update-url-attribute.md +++ b/docs/examples/databases/update-url-attribute.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/databases/update.md b/docs/examples/databases/update.md index 0139f280..a46f1163 100644 --- a/docs/examples/databases/update.md +++ b/docs/examples/databases/update.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 00000000..46611b3b --- /dev/null +++ b/docs/examples/databases/upsert-documents.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Databases databases = Databases(client); + +DocumentList result = await databases.upsertDocuments( + databaseId: '', + collectionId: '', + documents: [], // (optional) +); diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-build.md index 2835f823..eb7ae5d0 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-build.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/create-deployment.md b/docs/examples/functions/create-deployment.md index 297bdc61..f459b3dd 100644 --- a/docs/examples/functions/create-deployment.md +++ b/docs/examples/functions/create-deployment.md @@ -2,7 +2,7 @@ import 'dart:io'; import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/create-execution.md b/docs/examples/functions/create-execution.md index 2bf146e2..2ae64bce 100644 --- a/docs/examples/functions/create-execution.md +++ b/docs/examples/functions/create-execution.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index 5333f88d..b46e5752 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index b4283a99..93c78a14 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/delete-deployment.md b/docs/examples/functions/delete-deployment.md index e7938124..8e4167f7 100644 --- a/docs/examples/functions/delete-deployment.md +++ b/docs/examples/functions/delete-deployment.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/delete-execution.md b/docs/examples/functions/delete-execution.md index a69267f6..d077bc93 100644 --- a/docs/examples/functions/delete-execution.md +++ b/docs/examples/functions/delete-execution.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/delete-variable.md b/docs/examples/functions/delete-variable.md index 1a52f916..d4b28328 100644 --- a/docs/examples/functions/delete-variable.md +++ b/docs/examples/functions/delete-variable.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/delete.md b/docs/examples/functions/delete.md index 9ee35f1a..38d360b7 100644 --- a/docs/examples/functions/delete.md +++ b/docs/examples/functions/delete.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md index bbf9561e..c1add89b 100644 --- a/docs/examples/functions/get-deployment-download.md +++ b/docs/examples/functions/get-deployment-download.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/get-deployment.md b/docs/examples/functions/get-deployment.md index e2438024..805ca0b6 100644 --- a/docs/examples/functions/get-deployment.md +++ b/docs/examples/functions/get-deployment.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/get-execution.md b/docs/examples/functions/get-execution.md index 3ba1795f..e0026e0c 100644 --- a/docs/examples/functions/get-execution.md +++ b/docs/examples/functions/get-execution.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/functions/get-variable.md b/docs/examples/functions/get-variable.md index e9ba9591..fe61cee5 100644 --- a/docs/examples/functions/get-variable.md +++ b/docs/examples/functions/get-variable.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/get.md b/docs/examples/functions/get.md index e81ac8d1..c92a4f74 100644 --- a/docs/examples/functions/get.md +++ b/docs/examples/functions/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/list-deployments.md b/docs/examples/functions/list-deployments.md index c2db9a76..d07d2b32 100644 --- a/docs/examples/functions/list-deployments.md +++ b/docs/examples/functions/list-deployments.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index 573634e7..54f66730 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/functions/list-runtimes.md b/docs/examples/functions/list-runtimes.md index d2316a96..a99f872b 100644 --- a/docs/examples/functions/list-runtimes.md +++ b/docs/examples/functions/list-runtimes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/list-specifications.md b/docs/examples/functions/list-specifications.md index 4a773169..bec5d5e6 100644 --- a/docs/examples/functions/list-specifications.md +++ b/docs/examples/functions/list-specifications.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/list-variables.md b/docs/examples/functions/list-variables.md index 6c882090..0fa3b002 100644 --- a/docs/examples/functions/list-variables.md +++ b/docs/examples/functions/list-variables.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/list.md b/docs/examples/functions/list.md index 96516e70..8eaeec06 100644 --- a/docs/examples/functions/list.md +++ b/docs/examples/functions/list.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/update-deployment-build.md b/docs/examples/functions/update-deployment-build.md index ecd4d37b..5b547595 100644 --- a/docs/examples/functions/update-deployment-build.md +++ b/docs/examples/functions/update-deployment-build.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-deployment.md index 61e4d22e..59db36b6 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-deployment.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index 570d4df3..df460fae 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/functions/update.md b/docs/examples/functions/update.md index 42aff7b8..ebe3be8c 100644 --- a/docs/examples/functions/update.md +++ b/docs/examples/functions/update.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/graphql/mutation.md b/docs/examples/graphql/mutation.md index 1eed406b..a8874985 100644 --- a/docs/examples/graphql/mutation.md +++ b/docs/examples/graphql/mutation.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/graphql/query.md b/docs/examples/graphql/query.md index 3e2700cd..2dca8f29 100644 --- a/docs/examples/graphql/query.md +++ b/docs/examples/graphql/query.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-antivirus.md b/docs/examples/health/get-antivirus.md index d492d0e3..395d1f84 100644 --- a/docs/examples/health/get-antivirus.md +++ b/docs/examples/health/get-antivirus.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-cache.md b/docs/examples/health/get-cache.md index 9a3ccbd0..6312e3cb 100644 --- a/docs/examples/health/get-cache.md +++ b/docs/examples/health/get-cache.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-certificate.md b/docs/examples/health/get-certificate.md index 2c1c60b7..eac30a6a 100644 --- a/docs/examples/health/get-certificate.md +++ b/docs/examples/health/get-certificate.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-d-b.md b/docs/examples/health/get-d-b.md index 201f787f..25ad9607 100644 --- a/docs/examples/health/get-d-b.md +++ b/docs/examples/health/get-d-b.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-failed-jobs.md b/docs/examples/health/get-failed-jobs.md index 324a6420..6f80718f 100644 --- a/docs/examples/health/get-failed-jobs.md +++ b/docs/examples/health/get-failed-jobs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-pub-sub.md b/docs/examples/health/get-pub-sub.md index dab221fb..d544fbfc 100644 --- a/docs/examples/health/get-pub-sub.md +++ b/docs/examples/health/get-pub-sub.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-builds.md b/docs/examples/health/get-queue-builds.md index 42b3913f..b48623ec 100644 --- a/docs/examples/health/get-queue-builds.md +++ b/docs/examples/health/get-queue-builds.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-certificates.md b/docs/examples/health/get-queue-certificates.md index bdd2913b..d72ac97b 100644 --- a/docs/examples/health/get-queue-certificates.md +++ b/docs/examples/health/get-queue-certificates.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-databases.md b/docs/examples/health/get-queue-databases.md index 66f58227..b9d8e8bc 100644 --- a/docs/examples/health/get-queue-databases.md +++ b/docs/examples/health/get-queue-databases.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-deletes.md b/docs/examples/health/get-queue-deletes.md index 1b3666d6..3074cbb8 100644 --- a/docs/examples/health/get-queue-deletes.md +++ b/docs/examples/health/get-queue-deletes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-functions.md b/docs/examples/health/get-queue-functions.md index 83689100..727fd239 100644 --- a/docs/examples/health/get-queue-functions.md +++ b/docs/examples/health/get-queue-functions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-logs.md b/docs/examples/health/get-queue-logs.md index 074d1a82..32d3e3bb 100644 --- a/docs/examples/health/get-queue-logs.md +++ b/docs/examples/health/get-queue-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-mails.md b/docs/examples/health/get-queue-mails.md index 5960e944..93ec9938 100644 --- a/docs/examples/health/get-queue-mails.md +++ b/docs/examples/health/get-queue-mails.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-messaging.md b/docs/examples/health/get-queue-messaging.md index 9b287116..4ffd769d 100644 --- a/docs/examples/health/get-queue-messaging.md +++ b/docs/examples/health/get-queue-messaging.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-migrations.md b/docs/examples/health/get-queue-migrations.md index 80ad6d25..fab19875 100644 --- a/docs/examples/health/get-queue-migrations.md +++ b/docs/examples/health/get-queue-migrations.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 d0b443e3..89a3d031 100644 --- a/docs/examples/health/get-queue-stats-resources.md +++ b/docs/examples/health/get-queue-stats-resources.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-usage.md b/docs/examples/health/get-queue-usage.md index a8990b1d..473dcd15 100644 --- a/docs/examples/health/get-queue-usage.md +++ b/docs/examples/health/get-queue-usage.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-queue-webhooks.md b/docs/examples/health/get-queue-webhooks.md index 10e5787e..523c1007 100644 --- a/docs/examples/health/get-queue-webhooks.md +++ b/docs/examples/health/get-queue-webhooks.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-storage-local.md b/docs/examples/health/get-storage-local.md index 34b8f7e3..c33cf555 100644 --- a/docs/examples/health/get-storage-local.md +++ b/docs/examples/health/get-storage-local.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-storage.md b/docs/examples/health/get-storage.md index d3745bca..cb6c5721 100644 --- a/docs/examples/health/get-storage.md +++ b/docs/examples/health/get-storage.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get-time.md b/docs/examples/health/get-time.md index 539e0984..f4439957 100644 --- a/docs/examples/health/get-time.md +++ b/docs/examples/health/get-time.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/health/get.md b/docs/examples/health/get.md index 6286018d..31344908 100644 --- a/docs/examples/health/get.md +++ b/docs/examples/health/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/locale/get.md b/docs/examples/locale/get.md index b5b6878b..dec6f068 100644 --- a/docs/examples/locale/get.md +++ b/docs/examples/locale/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/locale/list-codes.md b/docs/examples/locale/list-codes.md index 0b37c79f..9f9eac9f 100644 --- a/docs/examples/locale/list-codes.md +++ b/docs/examples/locale/list-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/locale/list-continents.md b/docs/examples/locale/list-continents.md index 9c8fb6d2..276738ea 100644 --- a/docs/examples/locale/list-continents.md +++ b/docs/examples/locale/list-continents.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 e114831e..59596c62 100644 --- a/docs/examples/locale/list-countries-e-u.md +++ b/docs/examples/locale/list-countries-e-u.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 6f73ed37..2a2d32ea 100644 --- a/docs/examples/locale/list-countries-phones.md +++ b/docs/examples/locale/list-countries-phones.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/locale/list-countries.md b/docs/examples/locale/list-countries.md index 404b9a12..6b8343c6 100644 --- a/docs/examples/locale/list-countries.md +++ b/docs/examples/locale/list-countries.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/locale/list-currencies.md b/docs/examples/locale/list-currencies.md index 8e74090b..48247d98 100644 --- a/docs/examples/locale/list-currencies.md +++ b/docs/examples/locale/list-currencies.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/locale/list-languages.md b/docs/examples/locale/list-languages.md index 3a2d54b6..2376f189 100644 --- a/docs/examples/locale/list-languages.md +++ b/docs/examples/locale/list-languages.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 fc7c30ef..82c1eb5d 100644 --- a/docs/examples/messaging/create-apns-provider.md +++ b/docs/examples/messaging/create-apns-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-email.md b/docs/examples/messaging/create-email.md index de06809f..78c695c7 100644 --- a/docs/examples/messaging/create-email.md +++ b/docs/examples/messaging/create-email.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-fcm-provider.md b/docs/examples/messaging/create-fcm-provider.md index 480a6ed5..25c2cb8c 100644 --- a/docs/examples/messaging/create-fcm-provider.md +++ b/docs/examples/messaging/create-fcm-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-mailgun-provider.md b/docs/examples/messaging/create-mailgun-provider.md index 6617ff8c..10d803d6 100644 --- a/docs/examples/messaging/create-mailgun-provider.md +++ b/docs/examples/messaging/create-mailgun-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-msg91provider.md b/docs/examples/messaging/create-msg91provider.md index 785c55ce..b283b753 100644 --- a/docs/examples/messaging/create-msg91provider.md +++ b/docs/examples/messaging/create-msg91provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-push.md b/docs/examples/messaging/create-push.md index e496de9d..58d82c7a 100644 --- a/docs/examples/messaging/create-push.md +++ b/docs/examples/messaging/create-push.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-sendgrid-provider.md b/docs/examples/messaging/create-sendgrid-provider.md index 2f6d51d2..e759a260 100644 --- a/docs/examples/messaging/create-sendgrid-provider.md +++ b/docs/examples/messaging/create-sendgrid-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-sms.md b/docs/examples/messaging/create-sms.md index 8d31dc63..04a71587 100644 --- a/docs/examples/messaging/create-sms.md +++ b/docs/examples/messaging/create-sms.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-smtp-provider.md b/docs/examples/messaging/create-smtp-provider.md index 352369a8..6201987f 100644 --- a/docs/examples/messaging/create-smtp-provider.md +++ b/docs/examples/messaging/create-smtp-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-subscriber.md b/docs/examples/messaging/create-subscriber.md index 5fdd4c84..5fd4859f 100644 --- a/docs/examples/messaging/create-subscriber.md +++ b/docs/examples/messaging/create-subscriber.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setJWT(''); // Your secret JSON Web Token diff --git a/docs/examples/messaging/create-telesign-provider.md b/docs/examples/messaging/create-telesign-provider.md index 4fef6312..5417b951 100644 --- a/docs/examples/messaging/create-telesign-provider.md +++ b/docs/examples/messaging/create-telesign-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-textmagic-provider.md b/docs/examples/messaging/create-textmagic-provider.md index b7b456de..4cf6463b 100644 --- a/docs/examples/messaging/create-textmagic-provider.md +++ b/docs/examples/messaging/create-textmagic-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-topic.md b/docs/examples/messaging/create-topic.md index 0e831032..67e47412 100644 --- a/docs/examples/messaging/create-topic.md +++ b/docs/examples/messaging/create-topic.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-twilio-provider.md b/docs/examples/messaging/create-twilio-provider.md index 1d9e4f44..8c3370ba 100644 --- a/docs/examples/messaging/create-twilio-provider.md +++ b/docs/examples/messaging/create-twilio-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/create-vonage-provider.md b/docs/examples/messaging/create-vonage-provider.md index 2bbad659..d625f382 100644 --- a/docs/examples/messaging/create-vonage-provider.md +++ b/docs/examples/messaging/create-vonage-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/delete-provider.md b/docs/examples/messaging/delete-provider.md index 189cdb31..361bacc2 100644 --- a/docs/examples/messaging/delete-provider.md +++ b/docs/examples/messaging/delete-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/delete-subscriber.md b/docs/examples/messaging/delete-subscriber.md index 7cfbdae0..e4a044c2 100644 --- a/docs/examples/messaging/delete-subscriber.md +++ b/docs/examples/messaging/delete-subscriber.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setJWT(''); // Your secret JSON Web Token diff --git a/docs/examples/messaging/delete-topic.md b/docs/examples/messaging/delete-topic.md index a64056fc..59c5592c 100644 --- a/docs/examples/messaging/delete-topic.md +++ b/docs/examples/messaging/delete-topic.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/delete.md b/docs/examples/messaging/delete.md index 0cbc89ab..14b680ae 100644 --- a/docs/examples/messaging/delete.md +++ b/docs/examples/messaging/delete.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/get-message.md b/docs/examples/messaging/get-message.md index b95babd1..ccc98961 100644 --- a/docs/examples/messaging/get-message.md +++ b/docs/examples/messaging/get-message.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/get-provider.md b/docs/examples/messaging/get-provider.md index 1ba21b81..a82ef157 100644 --- a/docs/examples/messaging/get-provider.md +++ b/docs/examples/messaging/get-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/get-subscriber.md b/docs/examples/messaging/get-subscriber.md index 9a6711ba..03f78b7f 100644 --- a/docs/examples/messaging/get-subscriber.md +++ b/docs/examples/messaging/get-subscriber.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/get-topic.md b/docs/examples/messaging/get-topic.md index 2418390f..204f8757 100644 --- a/docs/examples/messaging/get-topic.md +++ b/docs/examples/messaging/get-topic.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-message-logs.md b/docs/examples/messaging/list-message-logs.md index 09c669dd..1d2b1805 100644 --- a/docs/examples/messaging/list-message-logs.md +++ b/docs/examples/messaging/list-message-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-messages.md b/docs/examples/messaging/list-messages.md index e58ab7f7..2c0a142e 100644 --- a/docs/examples/messaging/list-messages.md +++ b/docs/examples/messaging/list-messages.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-provider-logs.md b/docs/examples/messaging/list-provider-logs.md index fb8b6296..9f40a5fa 100644 --- a/docs/examples/messaging/list-provider-logs.md +++ b/docs/examples/messaging/list-provider-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-providers.md b/docs/examples/messaging/list-providers.md index 5ff2ac53..df7a8a02 100644 --- a/docs/examples/messaging/list-providers.md +++ b/docs/examples/messaging/list-providers.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-subscriber-logs.md b/docs/examples/messaging/list-subscriber-logs.md index 8ccbe9c8..3a9593ca 100644 --- a/docs/examples/messaging/list-subscriber-logs.md +++ b/docs/examples/messaging/list-subscriber-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-subscribers.md b/docs/examples/messaging/list-subscribers.md index 81db0613..19d907cd 100644 --- a/docs/examples/messaging/list-subscribers.md +++ b/docs/examples/messaging/list-subscribers.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-targets.md b/docs/examples/messaging/list-targets.md index af02c235..5a327773 100644 --- a/docs/examples/messaging/list-targets.md +++ b/docs/examples/messaging/list-targets.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-topic-logs.md b/docs/examples/messaging/list-topic-logs.md index afb80a24..0ab02eaa 100644 --- a/docs/examples/messaging/list-topic-logs.md +++ b/docs/examples/messaging/list-topic-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/list-topics.md b/docs/examples/messaging/list-topics.md index 1516056c..c5fdb490 100644 --- a/docs/examples/messaging/list-topics.md +++ b/docs/examples/messaging/list-topics.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-apns-provider.md b/docs/examples/messaging/update-apns-provider.md index 72eb8744..edc0a1f7 100644 --- a/docs/examples/messaging/update-apns-provider.md +++ b/docs/examples/messaging/update-apns-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-email.md b/docs/examples/messaging/update-email.md index a53209ab..b725cee5 100644 --- a/docs/examples/messaging/update-email.md +++ b/docs/examples/messaging/update-email.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-fcm-provider.md b/docs/examples/messaging/update-fcm-provider.md index 4b2bf6bd..1e2d8a8c 100644 --- a/docs/examples/messaging/update-fcm-provider.md +++ b/docs/examples/messaging/update-fcm-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-mailgun-provider.md b/docs/examples/messaging/update-mailgun-provider.md index 6acc4950..c042a6fa 100644 --- a/docs/examples/messaging/update-mailgun-provider.md +++ b/docs/examples/messaging/update-mailgun-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-msg91provider.md b/docs/examples/messaging/update-msg91provider.md index 10a8aa16..24290e95 100644 --- a/docs/examples/messaging/update-msg91provider.md +++ b/docs/examples/messaging/update-msg91provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-push.md b/docs/examples/messaging/update-push.md index f5d75332..f7cc117b 100644 --- a/docs/examples/messaging/update-push.md +++ b/docs/examples/messaging/update-push.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-sendgrid-provider.md b/docs/examples/messaging/update-sendgrid-provider.md index ce00ee26..53b8c33d 100644 --- a/docs/examples/messaging/update-sendgrid-provider.md +++ b/docs/examples/messaging/update-sendgrid-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-sms.md b/docs/examples/messaging/update-sms.md index 795d03e9..f4356dee 100644 --- a/docs/examples/messaging/update-sms.md +++ b/docs/examples/messaging/update-sms.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-smtp-provider.md b/docs/examples/messaging/update-smtp-provider.md index c85e62ee..16530c01 100644 --- a/docs/examples/messaging/update-smtp-provider.md +++ b/docs/examples/messaging/update-smtp-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-telesign-provider.md b/docs/examples/messaging/update-telesign-provider.md index d313321a..4bf76fbc 100644 --- a/docs/examples/messaging/update-telesign-provider.md +++ b/docs/examples/messaging/update-telesign-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-textmagic-provider.md b/docs/examples/messaging/update-textmagic-provider.md index dc966ecc..86bb9857 100644 --- a/docs/examples/messaging/update-textmagic-provider.md +++ b/docs/examples/messaging/update-textmagic-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-topic.md b/docs/examples/messaging/update-topic.md index 8c149c57..5311fd5e 100644 --- a/docs/examples/messaging/update-topic.md +++ b/docs/examples/messaging/update-topic.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-twilio-provider.md b/docs/examples/messaging/update-twilio-provider.md index a246dd62..8ace9752 100644 --- a/docs/examples/messaging/update-twilio-provider.md +++ b/docs/examples/messaging/update-twilio-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/messaging/update-vonage-provider.md b/docs/examples/messaging/update-vonage-provider.md index d848a648..e0d95d1c 100644 --- a/docs/examples/messaging/update-vonage-provider.md +++ b/docs/examples/messaging/update-vonage-provider.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/create-bucket.md b/docs/examples/storage/create-bucket.md index e9b817f3..c09a4f2c 100644 --- a/docs/examples/storage/create-bucket.md +++ b/docs/examples/storage/create-bucket.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/create-file.md b/docs/examples/storage/create-file.md index 0e06f422..e631416e 100644 --- a/docs/examples/storage/create-file.md +++ b/docs/examples/storage/create-file.md @@ -2,7 +2,7 @@ import 'dart:io'; import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/storage/delete-bucket.md b/docs/examples/storage/delete-bucket.md index 51fa7aaf..1eb1b51c 100644 --- a/docs/examples/storage/delete-bucket.md +++ b/docs/examples/storage/delete-bucket.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/delete-file.md b/docs/examples/storage/delete-file.md index 25f74b68..26dd602c 100644 --- a/docs/examples/storage/delete-file.md +++ b/docs/examples/storage/delete-file.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/storage/get-bucket.md b/docs/examples/storage/get-bucket.md index 20dfac75..3464d223 100644 --- a/docs/examples/storage/get-bucket.md +++ b/docs/examples/storage/get-bucket.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index ddbc538b..09f06c04 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 0f9cada9..7fd69c56 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 d9854177..df5d3a20 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/storage/get-file.md b/docs/examples/storage/get-file.md index c79b608c..f765c623 100644 --- a/docs/examples/storage/get-file.md +++ b/docs/examples/storage/get-file.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/storage/list-buckets.md b/docs/examples/storage/list-buckets.md index 7d9afb7e..c20dac19 100644 --- a/docs/examples/storage/list-buckets.md +++ b/docs/examples/storage/list-buckets.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/list-files.md b/docs/examples/storage/list-files.md index 02e52ba4..28f85b09 100644 --- a/docs/examples/storage/list-files.md +++ b/docs/examples/storage/list-files.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/storage/update-bucket.md b/docs/examples/storage/update-bucket.md index 23bfdb73..b4e45e05 100644 --- a/docs/examples/storage/update-bucket.md +++ b/docs/examples/storage/update-bucket.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/storage/update-file.md b/docs/examples/storage/update-file.md index d03e6040..966883a1 100644 --- a/docs/examples/storage/update-file.md +++ b/docs/examples/storage/update-file.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/create-membership.md b/docs/examples/teams/create-membership.md index 96b037a1..f13a6e69 100644 --- a/docs/examples/teams/create-membership.md +++ b/docs/examples/teams/create-membership.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/create.md b/docs/examples/teams/create.md index f6575bc4..772f3cfa 100644 --- a/docs/examples/teams/create.md +++ b/docs/examples/teams/create.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/delete-membership.md b/docs/examples/teams/delete-membership.md index 6f495ef4..9d99cbbd 100644 --- a/docs/examples/teams/delete-membership.md +++ b/docs/examples/teams/delete-membership.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/delete.md b/docs/examples/teams/delete.md index 021368cb..1c08ab8e 100644 --- a/docs/examples/teams/delete.md +++ b/docs/examples/teams/delete.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/get-membership.md b/docs/examples/teams/get-membership.md index 1d5c3b35..0bdc63f8 100644 --- a/docs/examples/teams/get-membership.md +++ b/docs/examples/teams/get-membership.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/get-prefs.md b/docs/examples/teams/get-prefs.md index 1e89d0e2..e2063933 100644 --- a/docs/examples/teams/get-prefs.md +++ b/docs/examples/teams/get-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/get.md b/docs/examples/teams/get.md index 31d238ab..bb3bcaf7 100644 --- a/docs/examples/teams/get.md +++ b/docs/examples/teams/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/list-memberships.md b/docs/examples/teams/list-memberships.md index 1cb91dd4..3c01dec4 100644 --- a/docs/examples/teams/list-memberships.md +++ b/docs/examples/teams/list-memberships.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/list.md b/docs/examples/teams/list.md index e4c764c5..093a139f 100644 --- a/docs/examples/teams/list.md +++ b/docs/examples/teams/list.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // 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 71c34366..c947162f 100644 --- a/docs/examples/teams/update-membership-status.md +++ b/docs/examples/teams/update-membership-status.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/update-membership.md b/docs/examples/teams/update-membership.md index 256c0823..87a43258 100644 --- a/docs/examples/teams/update-membership.md +++ b/docs/examples/teams/update-membership.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/update-name.md b/docs/examples/teams/update-name.md index a1727ced..fe3a9faa 100644 --- a/docs/examples/teams/update-name.md +++ b/docs/examples/teams/update-name.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/teams/update-prefs.md b/docs/examples/teams/update-prefs.md index 1b3208b7..57518ada 100644 --- a/docs/examples/teams/update-prefs.md +++ b/docs/examples/teams/update-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setSession(''); // The user session to authenticate with diff --git a/docs/examples/users/create-argon2user.md b/docs/examples/users/create-argon2user.md index 68dd9884..38b0255e 100644 --- a/docs/examples/users/create-argon2user.md +++ b/docs/examples/users/create-argon2user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-bcrypt-user.md b/docs/examples/users/create-bcrypt-user.md index cb000391..aa898ba2 100644 --- a/docs/examples/users/create-bcrypt-user.md +++ b/docs/examples/users/create-bcrypt-user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 2a9c67be..6e8b7a2b 100644 --- a/docs/examples/users/create-j-w-t.md +++ b/docs/examples/users/create-j-w-t.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-m-d5user.md b/docs/examples/users/create-m-d5user.md index 4ade88bc..e08edd61 100644 --- a/docs/examples/users/create-m-d5user.md +++ b/docs/examples/users/create-m-d5user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 598cef49..c2b9562e 100644 --- a/docs/examples/users/create-mfa-recovery-codes.md +++ b/docs/examples/users/create-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 1c95cbe2..9f23baae 100644 --- a/docs/examples/users/create-p-h-pass-user.md +++ b/docs/examples/users/create-p-h-pass-user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 17122072..628cf329 100644 --- a/docs/examples/users/create-s-h-a-user.md +++ b/docs/examples/users/create-s-h-a-user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 063fc97d..34bfbf66 100644 --- a/docs/examples/users/create-scrypt-modified-user.md +++ b/docs/examples/users/create-scrypt-modified-user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-scrypt-user.md b/docs/examples/users/create-scrypt-user.md index 03717bd7..20cf911a 100644 --- a/docs/examples/users/create-scrypt-user.md +++ b/docs/examples/users/create-scrypt-user.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-session.md b/docs/examples/users/create-session.md index 013707bc..4293e7ed 100644 --- a/docs/examples/users/create-session.md +++ b/docs/examples/users/create-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-target.md b/docs/examples/users/create-target.md index 88c0c19e..354a8dbb 100644 --- a/docs/examples/users/create-target.md +++ b/docs/examples/users/create-target.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create-token.md b/docs/examples/users/create-token.md index 16040215..ab7acba3 100644 --- a/docs/examples/users/create-token.md +++ b/docs/examples/users/create-token.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/create.md b/docs/examples/users/create.md index a0f0c3fe..b4953748 100644 --- a/docs/examples/users/create.md +++ b/docs/examples/users/create.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete-identity.md b/docs/examples/users/delete-identity.md index 07ba4976..7ac2da90 100644 --- a/docs/examples/users/delete-identity.md +++ b/docs/examples/users/delete-identity.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete-mfa-authenticator.md b/docs/examples/users/delete-mfa-authenticator.md index d48ab6d4..eed7dbd4 100644 --- a/docs/examples/users/delete-mfa-authenticator.md +++ b/docs/examples/users/delete-mfa-authenticator.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete-session.md b/docs/examples/users/delete-session.md index a2c985a7..68d243e5 100644 --- a/docs/examples/users/delete-session.md +++ b/docs/examples/users/delete-session.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete-sessions.md b/docs/examples/users/delete-sessions.md index e86e0e29..07c3566a 100644 --- a/docs/examples/users/delete-sessions.md +++ b/docs/examples/users/delete-sessions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete-target.md b/docs/examples/users/delete-target.md index bae674cd..aa27b32d 100644 --- a/docs/examples/users/delete-target.md +++ b/docs/examples/users/delete-target.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/delete.md b/docs/examples/users/delete.md index dbee4e8c..93819b72 100644 --- a/docs/examples/users/delete.md +++ b/docs/examples/users/delete.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 1e8baf2b..cf66c676 100644 --- a/docs/examples/users/get-mfa-recovery-codes.md +++ b/docs/examples/users/get-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/get-prefs.md b/docs/examples/users/get-prefs.md index 9fa4c8bd..146cff68 100644 --- a/docs/examples/users/get-prefs.md +++ b/docs/examples/users/get-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/get-target.md b/docs/examples/users/get-target.md index 2a62d94e..9ddaafb5 100644 --- a/docs/examples/users/get-target.md +++ b/docs/examples/users/get-target.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/get.md b/docs/examples/users/get.md index 04dfcb6a..a171b795 100644 --- a/docs/examples/users/get.md +++ b/docs/examples/users/get.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-identities.md b/docs/examples/users/list-identities.md index aa20d3f6..2c14775e 100644 --- a/docs/examples/users/list-identities.md +++ b/docs/examples/users/list-identities.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-logs.md b/docs/examples/users/list-logs.md index 18b34a10..5885dcb8 100644 --- a/docs/examples/users/list-logs.md +++ b/docs/examples/users/list-logs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index 495ab938..22c64b15 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-mfa-factors.md b/docs/examples/users/list-mfa-factors.md index cca4df00..7134ee5d 100644 --- a/docs/examples/users/list-mfa-factors.md +++ b/docs/examples/users/list-mfa-factors.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-sessions.md b/docs/examples/users/list-sessions.md index 4e1a47bc..22a37c05 100644 --- a/docs/examples/users/list-sessions.md +++ b/docs/examples/users/list-sessions.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list-targets.md b/docs/examples/users/list-targets.md index 459d0cd4..971fbea0 100644 --- a/docs/examples/users/list-targets.md +++ b/docs/examples/users/list-targets.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/list.md b/docs/examples/users/list.md index b909d76e..6d34bb47 100644 --- a/docs/examples/users/list.md +++ b/docs/examples/users/list.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-email-verification.md b/docs/examples/users/update-email-verification.md index e350eb68..9930e30b 100644 --- a/docs/examples/users/update-email-verification.md +++ b/docs/examples/users/update-email-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-email.md b/docs/examples/users/update-email.md index af995fc5..129a8e24 100644 --- a/docs/examples/users/update-email.md +++ b/docs/examples/users/update-email.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-labels.md b/docs/examples/users/update-labels.md index 5cd609d2..d247bf5e 100644 --- a/docs/examples/users/update-labels.md +++ b/docs/examples/users/update-labels.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // 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 3fdfc7c5..3b7d81f5 100644 --- a/docs/examples/users/update-mfa-recovery-codes.md +++ b/docs/examples/users/update-mfa-recovery-codes.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-mfa.md b/docs/examples/users/update-mfa.md index e1efba91..f26b1055 100644 --- a/docs/examples/users/update-mfa.md +++ b/docs/examples/users/update-mfa.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-name.md b/docs/examples/users/update-name.md index 2a742bcc..905cee0e 100644 --- a/docs/examples/users/update-name.md +++ b/docs/examples/users/update-name.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-password.md b/docs/examples/users/update-password.md index 8650291b..14e27482 100644 --- a/docs/examples/users/update-password.md +++ b/docs/examples/users/update-password.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-phone-verification.md b/docs/examples/users/update-phone-verification.md index cb8efa4a..b57aafab 100644 --- a/docs/examples/users/update-phone-verification.md +++ b/docs/examples/users/update-phone-verification.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-phone.md b/docs/examples/users/update-phone.md index 5334986f..aa891d23 100644 --- a/docs/examples/users/update-phone.md +++ b/docs/examples/users/update-phone.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-prefs.md b/docs/examples/users/update-prefs.md index 2a1f0572..87fc2968 100644 --- a/docs/examples/users/update-prefs.md +++ b/docs/examples/users/update-prefs.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-status.md b/docs/examples/users/update-status.md index 2948e6e6..4d8dca03 100644 --- a/docs/examples/users/update-status.md +++ b/docs/examples/users/update-status.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/docs/examples/users/update-target.md b/docs/examples/users/update-target.md index c3e90717..f66f0b74 100644 --- a/docs/examples/users/update-target.md +++ b/docs/examples/users/update-target.md @@ -1,7 +1,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() - .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint .setProject('') // Your project ID .setKey(''); // Your secret API key diff --git a/lib/client_browser.dart b/lib/client_browser.dart index b9805a3a..09f110ea 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; +export 'src/client_browser.dart'; \ No newline at end of file diff --git a/lib/client_io.dart b/lib/client_io.dart index 42a0c0b6..4d85cbfa 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; +export 'src/client_io.dart'; \ No newline at end of file diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 26412fe3..21865e2e 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.6.x. +/// This SDK is compatible with Appwrite server version 1.6.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 28ff15e8..72e26a23 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,7 +10,8 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 9107a9a4..46882207 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,5 +1,6 @@ part of 'dart_appwrite.dart'; + /// Helper class to generate query strings. class Query { final String method; @@ -9,13 +10,15 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = {'method': method}; + final map = { + 'method': method, + }; - if (attribute != null) { + if(attribute != null) { map['attribute'] = attribute; } - - if (values != null) { + + if(values != null) { map['values'] = values is List ? values : [values]; } @@ -26,7 +29,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -58,12 +61,10 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => - Query._('isNull', attribute).toString(); + static String isNull(String attribute) => Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => - Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -83,52 +84,40 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._( - 'or', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); static String and(List queries) => - Query._( - 'and', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => - Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => - Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => - Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => - Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => - Query._('offset', null, offset).toString(); -} + static String offset(int offset) => Query._('offset', null, offset).toString(); + +} \ No newline at end of file diff --git a/lib/role.dart b/lib/role.dart index dafeb78d..6552df47 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); + + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if (status.isEmpty) { - return 'user:$id'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if(status.isEmpty) { + return 'user:$id'; + } + return 'user:$id/$status'; } - return 'user:$id/$status'; - } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if (status.isEmpty) { - return 'users'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if(status.isEmpty) { + return 'users'; + } + return 'users/$status'; } - return 'users/$status'; - } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if (role.isEmpty) { - return 'team:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if(role.isEmpty) { + return 'team:$id'; + } + return 'team:$id/$role'; } - return 'team:$id/$role'; - } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; - } + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} \ No newline at end of file diff --git a/lib/services/account.dart b/lib/services/account.dart index 90e1f03e..fdc8cc97 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1084 +2,1081 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/account'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({ - required String email, - required String password, - }) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({ - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaType.fromMap(res.data); - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({ - required enums.AuthenticatorType type, - required String otp, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {'otp': otp}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({ - required enums.AuthenticationFactor factor, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = {'factor': factor.value}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaChallenge.fromMap(res.data); - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({ - required String challengeId, - required String otp, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - 'challengeId': challengeId, - 'otp': otp, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({ - required String password, - String? oldPassword, - }) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - 'password': password, - 'oldPassword': oldPassword, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({ - required String phone, - required String password, - }) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - 'phone': phone, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({ - required String email, - required String url, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = {'email': email, 'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({ - required String userId, - required String secret, - required String password, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - 'userId': userId, - 'secret': secret, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({ - required String email, - required String password, - }) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({ - required String userId, - required String email, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({ - required String userId, - required String email, - String? url, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'url': url, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({ - required enums.OAuthProvider provider, - String? success, - String? failure, - List? scopes, - }) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( - '{provider}', - provider.value, - ); - - final Map params = { - 'success': success, - 'failure': failure, - 'scopes': scopes, - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add( - Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), - ); - } - } else if (value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri( - scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&'), - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({ - required String userId, - required String phone, - }) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = {'userId': userId, 'phone': phone}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } -} + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/account'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({required String email, required String password}) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaType.fromMap(res.data); + + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + 'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'factor': factor.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaChallenge.fromMap(res.data); + + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({required String challengeId, required String otp}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'challengeId': challengeId, +'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({required String password, String? oldPassword}) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + + 'password': password, +'oldPassword': oldPassword, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({required String phone, required String password}) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + + 'phone': phone, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({required String email, required String url}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'email': email, +'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({required String userId, required String secret, required String password}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({required String email, required String password}) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({required String userId, required String email, bool? phrase}) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'url': url, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); + + final Map params = { + 'success': success, +'failure': failure, +'scopes': scopes, + + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); + } + } else if(value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&') + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({required String userId, required String phone}) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = { + + 'userId': userId, +'phone': phone, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 8033f1cd..381146d4 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,253 +3,187 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({ - required enums.Browser code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({ - required enums.CreditCard code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({ - required enums.Flag code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({ - required String url, - int? width, - int? height, - }) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, - 'width': width, - 'height': height, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({ - String? name, - int? width, - int? height, - String? background, - }) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, - 'width': width, - 'height': height, - 'background': background, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({ - required String text, - int? size, - int? margin, - bool? download, - }) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, - 'size': size, - 'margin': margin, - 'download': download, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({required String url, int? width, int? height}) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, +'width': width, +'height': height, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({String? name, int? width, int? height, String? background}) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, +'width': width, +'height': height, +'background': background, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({required String text, int? size, int? margin, bool? download}) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, +'size': size, +'margin': margin, +'download': download, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 6727adbb..26dcc0b2 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1327 +3,1095 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DatabaseList.fromMap(res.data); - } - - /// Create a new Database. - /// - Future create({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'databaseId': databaseId, - 'name': name, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Update a database by its unique ID. - Future update({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {'name': name, 'enabled': enabled}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({ - required String databaseId, - List? queries, - String? search, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.CollectionList.fromMap(res.data); - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'collectionId': collectionId, - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Update a collection by its unique ID. - Future updateCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List attributes in the collection. - Future listAttributes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeList.fromMap(res.data); - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - bool? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required bool? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Create an email attribute. - /// - Future createEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - double? min, - double? max, - double? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required double? xdefault, - double? min, - double? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - int? min, - int? max, - int? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required int? xdefault, - int? min, - int? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Create IP address attribute. - /// - Future createIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String relatedCollectionId, - required enums.RelationshipType type, - bool? twoWay, - String? key, - String? twoWayKey, - enums.RelationMutate? onDelete, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'relatedCollectionId': relatedCollectionId, - 'type': type.value, - 'twoWay': twoWay, - 'key': key, - 'twoWayKey': twoWayKey, - 'onDelete': onDelete?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Create a string attribute. - /// - Future createStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required int size, - required bool xrequired, - String? xdefault, - bool? array, - bool? encrypt, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'size': size, - 'required': xrequired, - 'default': xdefault, - 'array': array, - 'encrypt': encrypt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - int? size, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'size': size, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Get attribute by ID. - Future getAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Deletes an attribute. - Future deleteAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String key, - enums.RelationMutate? onDelete, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'onDelete': onDelete?.value, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Create a new Document. 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. - /// - Future createDocument({ - required String databaseId, - required String collectionId, - required String documentId, - required Map data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'documentId': documentId, - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({ - required String databaseId, - required String collectionId, - required String documentId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({ - required String databaseId, - required String collectionId, - required String documentId, - Map? data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Delete a document by its unique ID. - Future deleteDocument({ - required String databaseId, - required String collectionId, - required String documentId, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List indexes in the collection. - Future listIndexes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IndexList.fromMap(res.data); - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({ - required String databaseId, - required String collectionId, - required String key, - required enums.IndexType type, - required List attributes, - List? orders, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'type': type.value, - 'attributes': attributes, - 'orders': orders, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Get index by ID. - Future getIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Delete an index. - Future deleteIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DatabaseList.fromMap(res.data); + + } + + /// Create a new Database. + /// + Future create({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + + 'databaseId': databaseId, +'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Update a database by its unique ID. + Future update({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({required String databaseId, List? queries, String? search}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CollectionList.fromMap(res.data); + + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'collectionId': collectionId, +'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Update a collection by its unique ID. + Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List attributes in the collection. + Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeList.fromMap(res.data); + + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Create an email attribute. + /// + Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'elements': elements, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'elements': elements, +'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Create IP address attribute. + /// + Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'relatedCollectionId': relatedCollectionId, +'type': type.value, +'twoWay': twoWay, +'key': key, +'twoWayKey': twoWayKey, +'onDelete': onDelete?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Create a string attribute. + /// + Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'size': size, +'required': xrequired, +'default': xdefault, +'array': array, +'encrypt': encrypt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'size': size, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Get attribute by ID. + Future getAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Deletes an attribute. + Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'onDelete': onDelete?.value, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Create a new Document. 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. + Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documentId': documentId, +'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// 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. + /// + Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + /// + Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'data': data, +'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + 'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Delete a document by its unique ID. + Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List indexes in the collection. + Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IndexList.fromMap(res.data); + + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'type': type.value, +'attributes': attributes, +'orders': orders, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Get index by ID. + Future getIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Delete an index. + Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/functions.dart b/lib/services/functions.dart index 60a5def9..d26ec3ad 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,699 +3,571 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FunctionList.fromMap(res.data); - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({ - required String functionId, - required String name, - required enums.Runtime runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? templateRepository, - String? templateOwner, - String? templateRootDirectory, - String? templateVersion, - String? specification, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'functionId': functionId, - 'name': name, - 'runtime': runtime.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'templateRepository': templateRepository, - 'templateOwner': templateOwner, - 'templateRootDirectory': templateRootDirectory, - 'templateVersion': templateVersion, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.RuntimeList.fromMap(res.data); - } - - /// List allowed function specifications for this instance. - /// - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SpecificationList.fromMap(res.data); - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Update function by its unique ID. - Future update({ - required String functionId, - required String name, - enums.Runtime? runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'name': name, - 'runtime': runtime?.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all the project's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({ - required String functionId, - List? queries, - String? search, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DeploymentList.fromMap(res.data); - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({ - required String functionId, - required InputFile code, - required bool activate, - String? entrypoint, - String? commands, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'entrypoint': entrypoint, - 'commands': commands, - 'code': code, - 'activate': activate, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a code deployment by its unique ID. - Future getDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future updateDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future createBuild({ - required String functionId, - required String deploymentId, - String? buildId, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/build' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {'buildId': buildId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future updateDeploymentBuild({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/build' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Build.fromMap(res.data); - } - - /// Get a Deployment's contents by its unique ID. This endpoint supports range - /// requests for partial or streaming file download. - Future getDeploymentDownload({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/download' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({ - required String functionId, - List? queries, - String? search, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ExecutionList.fromMap(res.data); - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({ - required String functionId, - String? body, - bool? xasync, - String? path, - enums.ExecutionMethod? method, - Map? headers, - String? scheduledAt, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'body': body, - 'async': xasync, - 'path': path, - 'method': method?.value, - 'headers': headers, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Get a function execution log by its unique ID. - Future getExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Delete a function execution by its unique ID. - /// - Future deleteExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all variables of a specific function. - Future listVariables({ - required String functionId, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.VariableList.fromMap(res.data); - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({ - required String functionId, - required String key, - required String value, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {'key': key, 'value': value}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Get a variable by its unique ID. - Future getVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Update variable by its unique ID. - Future updateVariable({ - required String functionId, - required String variableId, - required String key, - String? value, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {'key': key, 'value': value}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Delete a variable by its unique ID. - Future deleteVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FunctionList.fromMap(res.data); + + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? templateRepository, String? templateOwner, String? templateRootDirectory, String? templateVersion, String? specification}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + + 'functionId': functionId, +'name': name, +'runtime': runtime.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'templateRepository': templateRepository, +'templateOwner': templateOwner, +'templateRootDirectory': templateRootDirectory, +'templateVersion': templateVersion, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.RuntimeList.fromMap(res.data); + + } + + /// List allowed function specifications for this instance. + /// + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Update function by its unique ID. + Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'name': name, +'runtime': runtime?.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all the project's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({required String functionId, List? queries, String? search}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'entrypoint': entrypoint, +'commands': commands, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a code deployment by its unique ID. + Future getDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future updateDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future createBuild({required String functionId, required String deploymentId, String? buildId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + 'buildId': buildId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future updateDeploymentBuild({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Build.fromMap(res.data); + + } + + /// Get a Deployment's contents by its unique ID. This endpoint supports range + /// requests for partial or streaming file download. + Future getDeploymentDownload({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({required String functionId, List? queries, String? search}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'body': body, +'async': xasync, +'path': path, +'method': method?.value, +'headers': headers, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Get a function execution log by its unique ID. + Future getExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a function execution by its unique ID. + /// + Future deleteExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific function. + Future listVariables({required String functionId}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({required String functionId, required String key, required String value}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'key': key, +'value': value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String functionId, required String variableId, required String key, String? value}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 18eb54f1..92cc591f 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,47 +3,49 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/health.dart b/lib/services/health.dart index 5250c91d..3bfeba6b 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,434 +3,459 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + } - final Map apiParams = {}; + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthAntivirus.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + return models.HealthAntivirus.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'domain': domain}; + return models.HealthStatus.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthCertificate.fromMap(res.data); - } + final Map apiParams = { + 'domain': domain, - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthCertificate.fromMap(res.data); - return models.HealthStatus.fromMap(res.data); - } + } - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + } - final Map apiParams = {'threshold': threshold}; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthStatus.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({ - String? name, - int? threshold, - }) async { - final String apiPath = '/health/queue/databases'; + final Map apiHeaders = { + + }; - final Map apiParams = { - 'name': name, - 'threshold': threshold, - }; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; - - final Map apiParams = {'threshold': threshold}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.HealthQueue.fromMap(res.data); - } - - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({ - required enums.Name name, - int? threshold, - }) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll( - '{name}', - name.value, - ); + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } - - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({String? name, int? threshold}) async { + final String apiPath = '/health/queue/databases'; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiParams = { + 'name': name, +'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthQueue.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + } - final Map apiParams = {'threshold': threshold}; + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthQueue.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({required enums.Name name, int? threshold}) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); - return models.HealthQueue.fromMap(res.data); - } + final Map apiParams = { + 'threshold': threshold, - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + + }; - final Map apiParams = {'threshold': threshold}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthQueue.fromMap(res.data); - return models.HealthQueue.fromMap(res.data); - } + } - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - final Map apiParams = {'threshold': threshold}; + final Map apiParams = { + 'threshold': threshold, - final Map apiHeaders = {}; + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; + return models.HealthQueue.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; + final Map apiHeaders = { + + }; - final Map apiParams = {'threshold': threshold}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; + } - final Map apiParams = {}; + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - return models.HealthTime.fromMap(res.data); - } -} + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthTime.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/locale.dart b/lib/services/locale.dart index 4d3cc3e0..b75b4711 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,162 +3,170 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.Locale.fromMap(res.data); - } + return models.Locale.fromMap(res.data); - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + } - final Map apiParams = {}; + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LocaleCodeList.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + return models.LocaleCodeList.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.ContinentList.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.ContinentList.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.CountryList.fromMap(res.data); - } + final Map apiParams = { + + + }; - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + final Map apiHeaders = { + + }; - final Map apiParams = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.CountryList.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.CountryList.fromMap(res.data); - } + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + final Map apiParams = { + + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.CountryList.fromMap(res.data); - return models.PhoneList.fromMap(res.data); - } + } - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.CurrencyList.fromMap(res.data); - } + return models.PhoneList.fromMap(res.data); - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; + } - final Map apiParams = {}; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LanguageList.fromMap(res.data); - } -} + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CurrencyList.fromMap(res.data); + + } + + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LanguageList.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index afe3ee86..710bb6d4 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1476 +3,1158 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MessageList.fromMap(res.data); - } - - /// Create a new email message. - Future createEmail({ - required String messageId, - required String subject, - required String content, - List? topics, - List? users, - List? targets, - List? cc, - List? bcc, - List? attachments, - bool? draft, - bool? html, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - 'messageId': messageId, - 'subject': subject, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'cc': cc, - 'bcc': bcc, - 'attachments': attachments, - 'draft': draft, - 'html': html, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({ - required String messageId, - List? topics, - List? users, - List? targets, - String? subject, - String? content, - bool? draft, - bool? html, - List? cc, - List? bcc, - String? scheduledAt, - List? attachments, - }) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'subject': subject, - 'content': content, - 'draft': draft, - 'html': html, - 'cc': cc, - 'bcc': bcc, - 'scheduledAt': scheduledAt, - 'attachments': attachments, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new push notification. - Future createPush({ - required String messageId, - String? title, - String? body, - List? topics, - List? users, - List? targets, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - 'messageId': messageId, - 'title': title, - 'body': body, - 'topics': topics, - 'users': users, - 'targets': targets, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({ - required String messageId, - List? topics, - List? users, - List? targets, - String? title, - String? body, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'title': title, - 'body': body, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new SMS message. - Future createSms({ - required String messageId, - required String content, - List? topics, - List? users, - List? targets, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - 'messageId': messageId, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({ - required String messageId, - List? topics, - List? users, - List? targets, - String? content, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'content': content, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of the targets associated with a message. - Future listTargets({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ProviderList.fromMap(res.data); - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({ - required String providerId, - required String name, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({ - required String providerId, - String? name, - bool? enabled, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - }) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({ - required String providerId, - required String name, - Map? serviceAccountJSON, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'serviceAccountJSON': serviceAccountJSON, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({ - required String providerId, - String? name, - bool? enabled, - Map? serviceAccountJSON, - }) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'serviceAccountJSON': serviceAccountJSON, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({ - required String providerId, - required String name, - String? apiKey, - String? domain, - bool? isEuRegion, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({ - required String providerId, - String? name, - String? apiKey, - String? domain, - bool? isEuRegion, - bool? enabled, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'enabled': enabled, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({ - required String providerId, - required String name, - String? templateId, - String? senderId, - String? authKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({ - required String providerId, - String? name, - bool? enabled, - String? templateId, - String? senderId, - String? authKey, - }) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({ - required String providerId, - required String name, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new SMTP provider. - Future createSmtpProvider({ - required String providerId, - required String name, - required String host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({ - required String providerId, - String? name, - String? host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Telesign provider. - Future createTelesignProvider({ - required String providerId, - required String name, - String? from, - String? customerId, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'customerId': customerId, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({ - required String providerId, - String? name, - bool? enabled, - String? customerId, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/telesign/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'customerId': customerId, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({ - required String providerId, - required String name, - String? from, - String? username, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'username': username, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({ - required String providerId, - String? name, - bool? enabled, - String? username, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'username': username, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Twilio provider. - Future createTwilioProvider({ - required String providerId, - required String name, - String? from, - String? accountSid, - String? authToken, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'accountSid': accountSid, - 'authToken': authToken, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({ - required String providerId, - String? name, - bool? enabled, - String? accountSid, - String? authToken, - String? from, - }) async { - final String apiPath = '/messaging/providers/twilio/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'accountSid': accountSid, - 'authToken': authToken, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Vonage provider. - Future createVonageProvider({ - required String providerId, - required String name, - String? from, - String? apiKey, - String? apiSecret, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? apiSecret, - String? from, - }) async { - final String apiPath = '/messaging/providers/vonage/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({ - required String providerId, - List? queries, - }) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({ - required String subscriberId, - List? queries, - }) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs' - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TopicList.fromMap(res.data); - } - - /// Create a new topic. - Future createTopic({ - required String topicId, - required String name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'topicId': topicId, - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({ - required String topicId, - String? name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({ - required String topicId, - List? queries, - }) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({ - required String topicId, - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SubscriberList.fromMap(res.data); - } - - /// Create a new subscriber. - Future createSubscriber({ - required String topicId, - required String subscriberId, - required String targetId, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'subscriberId': subscriberId, - 'targetId': targetId, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({List? queries, String? search}) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MessageList.fromMap(res.data); + + } + + /// Create a new email message. + Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + + 'messageId': messageId, +'subject': subject, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'cc': cc, +'bcc': bcc, +'attachments': attachments, +'draft': draft, +'html': html, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'subject': subject, +'content': content, +'draft': draft, +'html': html, +'cc': cc, +'bcc': bcc, +'scheduledAt': scheduledAt, +'attachments': attachments, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new push notification. + Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + + 'messageId': messageId, +'title': title, +'body': body, +'topics': topics, +'users': users, +'targets': targets, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'title': title, +'body': body, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new SMS message. + Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + + 'messageId': messageId, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'content': content, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of the targets associated with a message. + Future listTargets({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({List? queries, String? search}) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ProviderList.fromMap(res.data); + + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'serviceAccountJSON': serviceAccountJSON, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'serviceAccountJSON': serviceAccountJSON, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'enabled': enabled, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new SMTP provider. + Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Telesign provider. + Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'customerId': customerId, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'customerId': customerId, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'username': username, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'username': username, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Twilio provider. + Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'accountSid': accountSid, +'authToken': authToken, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { + final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'accountSid': accountSid, +'authToken': authToken, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Vonage provider. + Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'apiKey': apiKey, +'apiSecret': apiSecret, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { + final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'apiSecret': apiSecret, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({required String providerId, List? queries}) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({required String subscriberId, List? queries}) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({List? queries, String? search}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TopicList.fromMap(res.data); + + } + + /// Create a new topic. + Future createTopic({required String topicId, required String name, List? subscribe}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + + 'topicId': topicId, +'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({required String topicId, String? name, List? subscribe}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({required String topicId, List? queries}) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({required String topicId, List? queries, String? search}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SubscriberList.fromMap(res.data); + + } + + /// Create a new subscriber. + Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'subscriberId': subscriberId, +'targetId': targetId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/storage.dart b/lib/services/storage.dart index 37641215..68f023ac 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,413 +2,326 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({ - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.BucketList.fromMap(res.data); - } - - /// Create a new storage bucket. - Future createBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'bucketId': bucketId, - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({ - required String bucketId, - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FileList.fromMap(res.data); - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({ - required String bucketId, - required String fileId, - required InputFile file, - List? permissions, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'fileId': fileId, - 'file': file, - 'permissions': permissions, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({ - required String bucketId, - required String fileId, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({ - required String bucketId, - required String fileId, - String? name, - List? permissions, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a file 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. - Future getFileDownload({ - required String bucketId, - required String fileId, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({ - required String bucketId, - required String fileId, - int? width, - int? height, - enums.ImageGravity? gravity, - int? quality, - int? borderWidth, - String? borderColor, - int? borderRadius, - double? opacity, - int? rotation, - String? background, - enums.ImageFormat? output, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, - 'height': height, - 'gravity': gravity?.value, - 'quality': quality, - 'borderWidth': borderWidth, - 'borderColor': borderColor, - 'borderRadius': borderRadius, - 'opacity': opacity, - 'rotation': rotation, - 'background': background, - 'output': output?.value, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({ - required String bucketId, - required String fileId, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({List? queries, String? search}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.BucketList.fromMap(res.data); + + } + + /// Create a new storage bucket. + Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + + 'bucketId': bucketId, +'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({required String bucketId, List? queries, String? search}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FileList.fromMap(res.data); + + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'fileId': fileId, +'file': file, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a file 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. + Future getFileDownload({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, +'height': height, +'gravity': gravity?.value, +'quality': quality, +'borderWidth': borderWidth, +'borderColor': borderColor, +'borderRadius': borderRadius, +'opacity': opacity, +'rotation': rotation, +'background': background, +'output': output?.value, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 5fd59641..2b492f27 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,356 +3,321 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TeamList.fromMap(res.data); - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({ - required String teamId, - required String name, - List? roles, - }) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'teamId': teamId, - 'name': name, - 'roles': roles, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Update the team's name by its unique ID. - Future updateName({ - required String teamId, - required String name, - }) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({ - required String teamId, - List? queries, - String? search, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({ - required String teamId, - required List roles, - String? email, - String? userId, - String? phone, - String? url, - String? name, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'email': email, - 'userId': userId, - 'phone': phone, - 'roles': roles, - 'url': url, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({ - required String teamId, - required String membershipId, - required List roles, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'roles': roles}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({ - required String teamId, - required String membershipId, - required String userId, - required String secret, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({ - required String teamId, - required Map prefs, - }) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } -} + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TeamList.fromMap(res.data); + + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({required String teamId, required String name, List? roles}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + + 'teamId': teamId, +'name': name, +'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Update the team's name by its unique ID. + Future updateName({required String teamId, required String name}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({required String teamId, List? queries, String? search}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'email': email, +'userId': userId, +'phone': phone, +'roles': roles, +'url': url, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({required String teamId, required String membershipId, required List roles}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({required String teamId, required Map prefs}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/users.dart b/lib/services/users.dart index f4d31233..0562476f 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,1102 +2,960 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.UserList.fromMap(res.data); - } - - /// Create a new user. - Future create({ - required String userId, - String? email, - String? phone, - String? password, - String? name, - }) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phone': phone, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get identities for all users. - Future listIdentities({ - List? queries, - String? search, - }) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required int passwordCpu, - required int passwordMemory, - required int passwordParallel, - required int passwordLength, - String? name, - }) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordCpu': passwordCpu, - 'passwordMemory': passwordMemory, - 'passwordParallel': passwordParallel, - 'passwordLength': passwordLength, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required String passwordSaltSeparator, - required String passwordSignerKey, - String? name, - }) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordSaltSeparator': passwordSaltSeparator, - 'passwordSignerKey': passwordSignerKey, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({ - required String userId, - required String email, - required String password, - enums.PasswordHash? passwordVersion, - String? name, - }) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordVersion': passwordVersion?.value, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user email by its unique ID. - Future updateEmail({ - required String userId, - required String email, - }) async { - final String apiPath = '/users/{userId}/email'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'email': email}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({ - required String userId, - String? sessionId, - int? duration, - }) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'sessionId': sessionId, - 'duration': duration, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({ - required String userId, - required List labels, - }) async { - final String apiPath = '/users/{userId}/labels'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'labels': labels}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/logs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the user membership list by its unique ID. - Future listMemberships({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Enable or disable MFA on a user account. - Future updateMfa({ - required String userId, - required bool mfa, - }) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({ - required String userId, - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}' - .replaceAll('{userId}', userId) - .replaceAll('{type}', type.value); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update the user name by its unique ID. - Future updateName({ - required String userId, - required String name, - }) async { - final String apiPath = '/users/{userId}/name'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user password by its unique ID. - Future updatePassword({ - required String userId, - required String password, - }) async { - final String apiPath = '/users/{userId}/password'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'password': password}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone by its unique ID. - Future updatePhone({ - required String userId, - required String number, - }) async { - final String apiPath = '/users/{userId}/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'number': number}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({ - required String userId, - required Map prefs, - }) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({ - required String userId, - required String sessionId, - }) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}' - .replaceAll('{userId}', userId) - .replaceAll('{sessionId}', sessionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({ - required String userId, - required bool status, - }) async { - final String apiPath = '/users/{userId}/status'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'status': status}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// List the messaging targets that are associated with a user. - Future listTargets({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Create a messaging target. - Future createTarget({ - required String userId, - required String targetId, - required enums.MessagingProviderType providerType, - required String identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'targetId': targetId, - 'providerType': providerType.value, - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Get a user's push notification target by ID. - Future getTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Update a messaging target. - Future updateTarget({ - required String userId, - required String targetId, - String? identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = { - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Delete a messaging target. - Future deleteTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({ - required String userId, - int? length, - int? expire, - }) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'length': length, 'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({ - required String userId, - required bool emailVerification, - }) async { - final String apiPath = '/users/{userId}/verification'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'emailVerification': emailVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({ - required String userId, - required bool phoneVerification, - }) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'phoneVerification': phoneVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } -} + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.UserList.fromMap(res.data); + + } + + /// Create a new user. + Future create({required String userId, String? email, String? phone, String? password, String? name}) async { + final String apiPath = '/users'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phone': phone, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get identities for all users. + Future listIdentities({List? queries, String? search}) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordCpu': passwordCpu, +'passwordMemory': passwordMemory, +'passwordParallel': passwordParallel, +'passwordLength': passwordLength, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordSaltSeparator': passwordSaltSeparator, +'passwordSignerKey': passwordSignerKey, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordVersion': passwordVersion?.value, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user email by its unique ID. + Future updateEmail({required String userId, required String email}) async { + final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'email': email, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({required String userId, String? sessionId, int? duration}) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'sessionId': sessionId, +'duration': duration, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({required String userId, required List labels}) async { + final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'labels': labels, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the user membership list by its unique ID. + Future listMemberships({required String userId}) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Enable or disable MFA on a user account. + Future updateMfa({required String userId, required bool mfa}) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update the user name by its unique ID. + Future updateName({required String userId, required String name}) async { + final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user password by its unique ID. + Future updatePassword({required String userId, required String password}) async { + final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone by its unique ID. + Future updatePhone({required String userId, required String number}) async { + final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'number': number, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({required String userId, required Map prefs}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({required String userId, required String sessionId}) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({required String userId, required bool status}) async { + final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'status': status, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// List the messaging targets that are associated with a user. + Future listTargets({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Create a messaging target. + Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'targetId': targetId, +'providerType': providerType.value, +'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Get a user's push notification target by ID. + Future getTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Update a messaging target. + Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + 'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Delete a messaging target. + Future deleteTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({required String userId, int? length, int? expire}) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'length': length, +'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({required String userId, required bool emailVerification}) async { + final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'emailVerification': emailVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'phoneVerification': phoneVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/src/client.dart b/lib/src/client.dart index d82d623a..2fc990a5 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client({ - String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false, - }) => createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client( + {String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false}) => + createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,8 +81,7 @@ abstract class Client { }); /// Send the API request. - Future call( - HttpMethod method, { + Future call(HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index 08d93b85..cd82d264 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,25 +2,21 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); - /// Your secret API key @override ClientBase setKey(value); - /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); - /// The user session to authenticate with @override ClientBase setSession(value); - /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index c473ab61..b708a420 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,11 +9,14 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -30,67 +33,60 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - 'x-sdk-version': '15.0.0', - 'X-Appwrite-Response-Format': '1.6.0', + 'x-sdk-version': '15.1.0-rc.1', + 'X-Appwrite-Response-Format' : '1.6.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -139,11 +135,7 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); return call( HttpMethod.post, path: path, @@ -170,19 +162,12 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 0496f7e7..44c2fb35 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,11 +10,17 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => - ClientIO(endPoint: endPoint, selfSigned: selfSigned); +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => + ClientIO( + endPoint: endPoint, + selfSigned: selfSigned, + ); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -26,10 +32,9 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = - HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -37,69 +42,61 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - 'x-sdk-version': '15.0.0', - 'user-agent': - 'AppwriteDartSDK/15.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format': '1.6.0', + 'x-sdk-version': '15.1.0-rc.1', + 'user-agent' : 'AppwriteDartSDK/15.1.0-rc.1 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format' : '1.6.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -154,16 +151,11 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, - file.path!, - filename: file.filename, - ); + paramName, file.path!, + filename: file.filename); } else { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, + filename: file.filename); } return call( HttpMethod.post, @@ -202,19 +194,12 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -259,7 +244,10 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse(res, responseType: responseType); + return prepareResponse( + res, + responseType: responseType, + ); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index cd8d3867..658b79b6 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest).fields.addAll({ - "$key[$i]": v.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({"$key[$i]": v.toString()}); }); } else { - (request as http.MultipartRequest).fields.addAll({ - key: value.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({key: value.toString()}); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value) { + params = params.map((key, value){ if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,22 +51,23 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port, - ); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); } - headers['User-Agent'] = Uri.encodeFull(headers['User-Agent'] ?? ''); - headers['X-Forwarded-User-Agent'] = Uri.encodeFull( - headers['X-Forwarded-User-Agent'] ?? '', - ); + if (headers['User-Agent'] != null) { + headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); + } + if (headers['X-Forwarded-User-Agent'] != null) { + headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); + } request.headers.addAll(headers); return request; @@ -112,26 +113,18 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse( - http.StreamedResponse streamedResponse, - ) async { - if (streamedResponse.statusCode == 204) { - return http.Response( - '', - streamedResponse.statusCode, - headers: streamedResponse.headers.map( - (k, v) => - k.toLowerCase() == 'content-type' - ? MapEntry(k, 'text/plain') - : MapEntry(k, v), - ), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse(http.StreamedResponse streamedResponse) async { + if(streamedResponse.statusCode == 204) { + return http.Response('', + streamedResponse.statusCode, + headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 2cb7727e..95e9d217 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,5 +3,4 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.', - ); + 'Cannot create a client without dart:html or dart:io.'); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 08fd6068..6566f2e1 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes, + bytes } diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 1d5271eb..00d12830 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({required this.value}); + const AuthenticationFactor({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index c1fe8584..10460393 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,11 +1,13 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({required this.value}); + const AuthenticatorType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 949f4c47..386fa11d 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,24 +1,26 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({required this.value}); + const Browser({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 768930d9..209acfb8 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({required this.value}); + const Compression({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index 1bae5c8a..cd45b6a1 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,27 +1,29 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({required this.value}); + const CreditCard({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 42954430..7d2d7016 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,16 +1,18 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({required this.value}); + const ExecutionMethod({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index a44cb81d..27c25cac 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,205 +1,207 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({required this.value}); + const Flag({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index 4d07af18..2e4e2204 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,17 +1,19 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - gif(value: 'gif'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + gif(value: 'gif'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({required this.value}); + const ImageFormat({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 88029044..79bc4d62 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,19 +1,21 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({required this.value}); + const ImageGravity({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index b101d35f..8d86530d 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({required this.value}); + const IndexType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index a07e6f76..375913e8 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({required this.value}); + const MessagePriority({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index c69bf01e..a6859648 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({required this.value}); + const MessagingProviderType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 74823feb..613bf5f1 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,22 +1,24 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({required this.value}); + const Name({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 383e45b1..076c1c50 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,50 +1,52 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({required this.value}); + const OAuthProvider({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 9d98c26a..510ee260 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,21 +1,23 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({required this.value}); + const PasswordHash({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index b215a8fa..9f4c1a85 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({required this.value}); + const RelationMutate({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 30efc944..301bc61d 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({required this.value}); + const RelationshipType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index a71f5a65..b7dbd129 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,69 +1,71 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'); - const Runtime({required this.value}); + const Runtime({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index cb6cee26..6c880ed6 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({required this.value}); + const SmtpEncryption({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 82229daa..93b6ee3d 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index 4145f701..f174d569 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index 4e901476..c9f67200 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({required this.type}); + AlgoBcrypt({ + required this.type, + }); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt(type: map['type'].toString()); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 35c7b767..2fabb416 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({required this.type}); + AlgoMd5({ + required this.type, + }); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5(type: map['type'].toString()); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index 7d27adba..fdcee07a 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({required this.type}); + AlgoPhpass({ + required this.type, + }); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass(type: map['type'].toString()); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index fec6f65a..120723df 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 0e80700f..504b5f8f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index bae6618f..5f3e1654 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({required this.type}); + AlgoSha({ + required this.type, + }); - factory AlgoSha.fromMap(Map map) { - return AlgoSha(type: map['type'].toString()); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 0ca54691..20dd7189 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index 1df01f19..a5b27b4f 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 21f8e9a3..96ce554b 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index 298c181a..a4953a0e 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index c6eecadd..03ba94c7 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 1ef48332..8a5aa89d 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index 8c8fcb73..d17f414a 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index c5fa6adc..4098a5a1 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({required this.total, required this.attributes}); + AttributeList({ + required this.total, + required this.attributes, + }); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return {"total": total, "attributes": attributes}; - } + Map toMap() { + return { + "total": total, + "attributes": attributes, + }; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 903c6290..050cbe14 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index d32b6829..89de3a57 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index f0bc295e..0c3ddf9e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index b8fb5e48..3bb374be 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 224c910d..366d80f9 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({required this.total, required this.buckets}); + BucketList({ + required this.total, + required this.buckets, + }); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "buckets": buckets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/build.dart b/lib/src/models/build.dart index ea4a3137..fdca3976 100644 --- a/lib/src/models/build.dart +++ b/lib/src/models/build.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Build class Build implements Model { - /// Build ID. - final String $id; + /// Build ID. + final String $id; - /// The deployment that created this build. - final String deploymentId; + /// The deployment that created this build. + final String deploymentId; - /// The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built - final String status; + /// The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built + final String status; - /// The stdout of the build. - final String stdout; + /// The stdout of the build. + final String stdout; - /// The stderr of the build. - final String stderr; + /// The stderr of the build. + final String stderr; - /// The deployment creation date in ISO 8601 format. - final String startTime; + /// The deployment creation date in ISO 8601 format. + final String startTime; - /// The time the build was finished in ISO 8601 format. - final String endTime; + /// The time the build was finished in ISO 8601 format. + final String endTime; - /// The build duration in seconds. - final int duration; + /// The build duration in seconds. + final int duration; - /// The code size in bytes. - final int size; + /// The code size in bytes. + final int size; - Build({ - required this.$id, - required this.deploymentId, - required this.status, - required this.stdout, - required this.stderr, - required this.startTime, - required this.endTime, - required this.duration, - required this.size, - }); + Build({ + required this.$id, + required this.deploymentId, + required this.status, + required this.stdout, + required this.stderr, + required this.startTime, + required this.endTime, + required this.duration, + required this.size, + }); - factory Build.fromMap(Map map) { - return Build( - $id: map['\$id'].toString(), - deploymentId: map['deploymentId'].toString(), - status: map['status'].toString(), - stdout: map['stdout'].toString(), - stderr: map['stderr'].toString(), - startTime: map['startTime'].toString(), - endTime: map['endTime'].toString(), - duration: map['duration'], - size: map['size'], - ); - } + factory Build.fromMap(Map map) { + return Build( + $id: map['\$id'].toString(), + deploymentId: map['deploymentId'].toString(), + status: map['status'].toString(), + stdout: map['stdout'].toString(), + stderr: map['stderr'].toString(), + startTime: map['startTime'].toString(), + endTime: map['endTime'].toString(), + duration: map['duration'], + size: map['size'], + ); + } - Map toMap() { - return { - "\$id": $id, - "deploymentId": deploymentId, - "status": status, - "stdout": stdout, - "stderr": stderr, - "startTime": startTime, - "endTime": endTime, - "duration": duration, - "size": size, - }; - } + Map toMap() { + return { + "\$id": $id, + "deploymentId": deploymentId, + "status": status, + "stdout": stdout, + "stderr": stderr, + "startTime": startTime, + "endTime": endTime, + "duration": duration, + "size": size, + }; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index 72de429d..c55110cf 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index 49785e2b..aad4d44a 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({required this.total, required this.collections}); + CollectionList({ + required this.total, + required this.collections, + }); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from( - map['collections'].map((p) => Collection.fromMap(p)), - ), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 7318b7ad..1a9c5038 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({required this.name, required this.code}); + Continent({ + required this.name, + required this.code, + }); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 2c605d3b..7a1eb84c 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({required this.total, required this.continents}); + ContinentList({ + required this.total, + required this.continents, + }); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from( - map['continents'].map((p) => Continent.fromMap(p)), - ), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index c52b50f2..565b1d66 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,19 +2,28 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({required this.name, required this.code}); + Country({ + required this.name, + required this.code, + }); - factory Country.fromMap(Map map) { - return Country(name: map['name'].toString(), code: map['code'].toString()); - } + factory Country.fromMap(Map map) { + return Country( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index 6ef8ec42..e0b8f29f 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({required this.total, required this.countries}); + CountryList({ + required this.total, + required this.countries, + }); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from( - map['countries'].map((p) => Country.fromMap(p)), - ), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from(map['countries'].map((p) => Country.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index 27eef0c1..deafffe3 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index acb515e3..f67049ae 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({required this.total, required this.currencies}); + CurrencyList({ + required this.total, + required this.currencies, + }); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from( - map['currencies'].map((p) => Currency.fromMap(p)), - ), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 298a46a3..09ee2aae 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 5b6df8d4..03b959db 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({required this.total, required this.databases}); + DatabaseList({ + required this.total, + required this.databases, + }); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from( - map['databases'].map((p) => Database.fromMap(p)), - ), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from(map['databases'].map((p) => Database.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index f01fb11e..5bff0299 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,160 +2,160 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; - - /// Deployment update date in ISO 8601 format. - final String $updatedAt; - - /// Type of deployment. - final String type; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int size; - - /// The build output size in bytes. - final int buildSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// The deployment status. Possible values are "processing", "building", "waiting", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildTime; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.size, - required this.buildSize, - required this.buildId, - required this.activate, - required this.status, - required this.buildLogs, - required this.buildTime, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - size: map['size'], - buildSize: map['buildSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildTime: map['buildTime'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "size": size, - "buildSize": buildSize, - "buildId": buildId, - "activate": activate, - "status": status, - "buildLogs": buildLogs, - "buildTime": buildTime, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Deployment creation date in ISO 8601 format. + final String $createdAt; + + /// Deployment update date in ISO 8601 format. + final String $updatedAt; + + /// Type of deployment. + final String type; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int size; + + /// The build output size in bytes. + final int buildSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// The deployment status. Possible values are "processing", "building", "waiting", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildTime; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.size, + required this.buildSize, + required this.buildId, + required this.activate, + required this.status, + required this.buildLogs, + required this.buildTime, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + size: map['size'], + buildSize: map['buildSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildTime: map['buildTime'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "size": size, + "buildSize": buildSize, + "buildId": buildId, + "activate": activate, + "status": status, + "buildLogs": buildLogs, + "buildTime": buildTime, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 15a93ef4..508bb705 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({required this.total, required this.deployments}); + DeploymentList({ + required this.total, + required this.deployments, + }); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from( - map['deployments'].map((p) => Deployment.fromMap(p)), - ), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index 37fb2b7b..b6454aae 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 126ad805..8af34256 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,30 +2,31 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({required this.total, required this.documents}); + DocumentList({ + required this.total, + required this.documents, + }); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from( - map['documents'].map((p) => Document.fromMap(p)), - ), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from(map['documents'].map((p) => Document.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 3a7a3535..62051159 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,122 +2,118 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Function execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from( - map['requestHeaders'].map((p) => Headers.fromMap(p)), - ), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from( - map['responseHeaders'].map((p) => Headers.fromMap(p)), - ), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Function execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 2a2ef056..0bcbad6a 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({required this.total, required this.executions}); + ExecutionList({ + required this.total, + required this.executions, + }); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from( - map['executions'].map((p) => Execution.fromMap(p)), - ), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index a6a9fa46..de8439ec 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 9f01530b..28bc6fcf 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({required this.total, required this.files}); + FileList({ + required this.total, + required this.files, + }); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "files": files.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "files": files.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index fccea87e..61ca45c4 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,160 +2,160 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; - - /// Function update date in ISO 8601 format. - final String $updatedAt; - - /// Execution permissions. - final List execute; - - /// Function name. - final String name; - - /// Function enabled. - final bool enabled; - - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project. - final bool logging; - - /// Function execution runtime. - final String runtime; - - /// Function's active deployment ID. - final String deployment; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deployment, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deployment: map['deployment'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deployment": deployment, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Function creation date in ISO 8601 format. + final String $createdAt; + + /// Function update date in ISO 8601 format. + final String $updatedAt; + + /// Execution permissions. + final List execute; + + /// Function name. + final String name; + + /// Function enabled. + final bool enabled; + + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project. + final bool logging; + + /// Function execution runtime. + final String runtime; + + /// Function's active deployment ID. + final String deployment; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deployment, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deployment: map['deployment'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deployment": deployment, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index c37f0615..8f0b8928 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,25 +2,28 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({required this.total, required this.functions}); + FunctionList({ + required this.total, + required this.functions, + }); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index 463cf696..ecf0a178 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({required this.name, required this.value}); + Headers({ + required this.name, + required this.value, + }); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return {"name": name, "value": value}; - } + Map toMap() { + return { + "name": name, + "value": value, + }; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index fa402e97..54c31e70 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({required this.version, required this.status}); + HealthAntivirus({ + required this.version, + required this.status, + }); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return {"version": version, "status": status}; - } + Map toMap() { + return { + "version": version, + "status": status, + }; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index d412eba9..0a5b6ce9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 5f06906b..95da1235 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({required this.size}); + HealthQueue({ + required this.size, + }); - factory HealthQueue.fromMap(Map map) { - return HealthQueue(size: map['size']); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue( + size: map['size'], + ); + } - Map toMap() { - return {"size": size}; - } + Map toMap() { + return { + "size": size, + }; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 59b7092c..0d6e7216 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({required this.name, required this.ping, required this.status}); + HealthStatus({ + required this.name, + required this.ping, + required this.status, + }); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return {"name": name, "ping": ping, "status": status}; - } + Map toMap() { + return { + "name": name, + "ping": ping, + "status": status, + }; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index dec2d54f..102dfe77 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,30 +2,34 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; - } + Map toMap() { + return { + "remoteTime": remoteTime, + "localTime": localTime, + "diff": diff, + }; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index 807bdfd0..c43c4d57 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index f38eaf66..e92e36cc 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({required this.total, required this.identities}); + IdentityList({ + required this.total, + required this.identities, + }); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from( - map['identities'].map((p) => Identity.fromMap(p)), - ), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index b24bf242..119fb5c7 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index dc759dfb..8eac7956 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({required this.total, required this.indexes}); + IndexList({ + required this.total, + required this.indexes, + }); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 490a1824..1b4ff7de 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({required this.jwt}); + Jwt({ + required this.jwt, + }); - factory Jwt.fromMap(Map map) { - return Jwt(jwt: map['jwt'].toString()); - } + factory Jwt.fromMap(Map map) { + return Jwt( + jwt: map['jwt'].toString(), + ); + } - Map toMap() { - return {"jwt": jwt}; - } + Map toMap() { + return { + "jwt": jwt, + }; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 9c45adb1..43eaad08 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({required this.name, required this.code, required this.nativeName}); + Language({ + required this.name, + required this.code, + required this.nativeName, + }); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code, "nativeName": nativeName}; - } + Map toMap() { + return { + "name": name, + "code": code, + "nativeName": nativeName, + }; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index 046b879e..fe271118 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({required this.total, required this.languages}); + LanguageList({ + required this.total, + required this.languages, + }); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from( - map['languages'].map((p) => Language.fromMap(p)), - ), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from(map['languages'].map((p) => Language.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index 084475bf..b5e9ad1a 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index cd5a1155..10499ef5 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({required this.code, required this.name}); + LocaleCode({ + required this.code, + required this.name, + }); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return {"code": code, "name": name}; - } + Map toMap() { + return { + "code": code, + "name": name, + }; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 662fee4f..839474d7 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({required this.total, required this.localeCodes}); + LocaleCodeList({ + required this.total, + required this.localeCodes, + }); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from( - map['localeCodes'].map((p) => LocaleCode.fromMap(p)), - ), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index 7fb3f364..cb567bd7 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 628237fa..91d024d0 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({required this.total, required this.logs}); + LogList({ + required this.total, + required this.logs, + }); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "logs": logs.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 8ee142ad..26610e46 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 46468a3a..409cdbfb 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({required this.total, required this.memberships}); + MembershipList({ + required this.total, + required this.memberships, + }); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from( - map['memberships'].map((p) => Membership.fromMap(p)), - ), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index 9b93b00d..c4e9e858 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 7bd0891f..702c912b 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({required this.total, required this.messages}); + MessageList({ + required this.total, + required this.messages, + }); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from( - map['messages'].map((p) => Message.fromMap(p)), - ), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from(map['messages'].map((p) => Message.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 96bf3c65..46c166fb 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index c930a23e..d49989d8 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 63411988..6c8b4e36 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,18 +2,22 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({required this.recoveryCodes}); + MfaRecoveryCodes({ + required this.recoveryCodes, + }); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return {"recoveryCodes": recoveryCodes}; - } + Map toMap() { + return { + "recoveryCodes": recoveryCodes, + }; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index fa57cb8b..01cf0857 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({required this.secret, required this.uri}); + MfaType({ + required this.secret, + required this.uri, + }); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return {"secret": secret, "uri": uri}; - } + Map toMap() { + return { + "secret": secret, + "uri": uri, + }; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index f810a35b..48e5b84a 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} +} \ No newline at end of file diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index 40f7bcd2..c8bbb95b 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index 18d2803d..beab76e8 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({required this.total, required this.phones}); + PhoneList({ + required this.total, + required this.phones, + }); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "phones": phones.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 48163dfc..3c62f86d 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,17 +2,23 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({required this.data}); + Preferences({ + required this.data, + }); - factory Preferences.fromMap(Map map) { - return Preferences(data: map); - } + factory Preferences.fromMap(Map map) { + return Preferences( + data: map, + ); + } - Map toMap() { - return {"data": data}; - } + Map toMap() { + return { + "data": data, + }; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 1a762f85..4295c486 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index aeb28ecd..7c09eb56 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({required this.total, required this.providers}); + ProviderList({ + required this.total, + required this.providers, + }); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from( - map['providers'].map((p) => Provider.fromMap(p)), - ), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 7c9677d8..35f82cfa 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 02c7b2e5..7615fd9e 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({required this.total, required this.runtimes}); + RuntimeList({ + required this.total, + required this.runtimes, + }); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from( - map['runtimes'].map((p) => Runtime.fromMap(p)), - ), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index d2fe4f64..3a1d955f 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 479272b9..6d26d6a8 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({required this.total, required this.sessions}); + SessionList({ + required this.total, + required this.sessions, + }); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from( - map['sessions'].map((p) => Session.fromMap(p)), - ), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e8fb8c75..e49d399c 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,35 +2,40 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; - } + Map toMap() { + return { + "memory": memory, + "cpus": cpus, + "enabled": enabled, + "slug": slug, + }; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index e4bef89b..72703f84 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({required this.total, required this.specifications}); + SpecificationList({ + required this.total, + required this.specifications, + }); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from( - map['specifications'].map((p) => Specification.fromMap(p)), - ), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 0c926297..36e18a7e 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index 7030fa0a..d7d3c3e3 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({required this.total, required this.subscribers}); + SubscriberList({ + required this.total, + required this.subscribers, + }); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from( - map['subscribers'].map((p) => Subscriber.fromMap(p)), - ), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index 4be8b545..f2b3b6b4 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 1042e5a2..2d38efe5 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({required this.total, required this.targets}); + TargetList({ + required this.total, + required this.targets, + }); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "targets": targets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index 43df33a8..e9058b5b 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index e604f192..2fb3611e 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({required this.total, required this.teams}); + TeamList({ + required this.total, + required this.teams, + }); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "teams": teams.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 35115467..4f6b8454 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 430d44ac..461d5694 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index a4d1f44f..e57ef05f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({required this.total, required this.topics}); + TopicList({ + required this.total, + required this.topics, + }); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "topics": topics.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index 50bfb3ce..effc397c 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 03e55cc6..55dfcf77 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({required this.total, required this.users}); + UserList({ + required this.total, + required this.users, + }); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "users": users.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "users": users.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index a233010a..8f05516d 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; - - /// Variable creation date in ISO 8601 format. - final String $createdAt; - - /// Variable creation date in ISO 8601 format. - final String $updatedAt; - - /// Variable key. - final String key; - - /// Variable value. - final String value; - - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; - - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; - - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.resourceType, - required this.resourceId, - }); - - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + /// Variable ID. + final String $id; + + /// Variable creation date in ISO 8601 format. + final String $createdAt; + + /// Variable creation date in ISO 8601 format. + final String $updatedAt; + + /// Variable key. + final String key; + + /// Variable value. + final String value; + + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; + + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; + + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.resourceType, + required this.resourceId, + }); + + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index 4ff3e189..b6da02cc 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({required this.total, required this.variables}); + VariableList({ + required this.total, + required this.variables, + }); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from( - map['variables'].map((p) => Variable.fromMap(p)), - ), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 5a19b0fc..44cde383 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, + "chunksUploaded": chunksUploaded }; } diff --git a/pubspec.yaml b/pubspec.yaml index ff0e463e..145d38dd 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: dart_appwrite -version: 15.0.0 +version: 15.1.0-rc.1 description: Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API homepage: https://appwrite.io repository: https://github.com/appwrite/sdk-for-dart diff --git a/test/services/databases_test.dart b/test/services/databases_test.dart index 176d50a6..2606c4ed 100644 --- a/test/services/databases_test.dart +++ b/test/services/databases_test.dart @@ -914,6 +914,83 @@ void main() { }); + test('test method createDocuments()', () async { + final Map data = { + 'total': 5, + 'documents': [],}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await databases.createDocuments( + databaseId: '', + collectionId: '', + documents: [], + ); + expect(response, isA()); + + }); + + test('test method upsertDocuments()', () async { + final Map data = { + 'total': 5, + 'documents': [],}; + + + when(client.call( + HttpMethod.put, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await databases.upsertDocuments( + databaseId: '', + collectionId: '', + ); + expect(response, isA()); + + }); + + test('test method updateDocuments()', () async { + final Map data = { + 'total': 5, + 'documents': [],}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await databases.updateDocuments( + databaseId: '', + collectionId: '', + ); + expect(response, isA()); + + }); + + test('test method deleteDocuments()', () async { + final Map data = { + 'total': 5, + 'documents': [],}; + + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await databases.deleteDocuments( + databaseId: '', + collectionId: '', + ); + expect(response, isA()); + + }); + test('test method getDocument()', () async { final Map data = { '\$id': '5e5ea5c16897e', From f72a08b6b1d421f1a86a4a1dac9b02f3c7075397 Mon Sep 17 00:00:00 2001 From: Jake Barnby Date: Sun, 18 May 2025 00:06:08 +1200 Subject: [PATCH 2/7] Add support for 1.7 --- README.md | 6 +- 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 | 5 +- docs/examples/databases/create-documents.md | 3 +- docs/examples/databases/create-index.md | 1 + ...uild.md => create-duplicate-deployment.md} | 2 +- .../functions/create-template-deployment.md | 17 + docs/examples/functions/create-variable.md | 1 + .../functions/create-vcs-deployment.md | 15 + docs/examples/functions/create.md | 4 - .../functions/get-deployment-download.md | 1 + docs/examples/functions/list-executions.md | 1 - ...loyment.md => update-deployment-status.md} | 2 +- ...build.md => update-function-deployment.md} | 2 +- docs/examples/functions/update-variable.md | 1 + docs/examples/sites/create-deployment.md | 18 + .../sites/create-duplicate-deployment.md | 13 + .../sites/create-template-deployment.md | 17 + docs/examples/sites/create-variable.md | 15 + docs/examples/sites/create-vcs-deployment.md | 15 + docs/examples/sites/create.md | 29 + docs/examples/sites/delete-deployment.md | 13 + docs/examples/sites/delete-log.md | 13 + docs/examples/sites/delete-variable.md | 13 + docs/examples/sites/delete.md | 12 + .../examples/sites/get-deployment-download.md | 14 + docs/examples/sites/get-deployment.md | 13 + docs/examples/sites/get-log.md | 13 + docs/examples/sites/get-variable.md | 13 + docs/examples/sites/get.md | 12 + docs/examples/sites/list-deployments.md | 14 + docs/examples/sites/list-frameworks.md | 10 + docs/examples/sites/list-logs.md | 13 + docs/examples/sites/list-specifications.md | 10 + docs/examples/sites/list-variables.md | 12 + docs/examples/sites/list.md | 13 + .../sites/update-deployment-status.md | 13 + docs/examples/sites/update-site-deployment.md | 13 + docs/examples/sites/update-variable.md | 16 + docs/examples/sites/update.md | 29 + docs/examples/storage/get-file-download.md | 1 + docs/examples/storage/get-file-preview.md | 3 +- docs/examples/storage/get-file-view.md | 1 + docs/examples/tokens/create-file-token.md | 14 + docs/examples/tokens/delete.md | 12 + docs/examples/tokens/get.md | 12 + docs/examples/tokens/list.md | 14 + docs/examples/tokens/update.md | 13 + docs/examples/users/list-memberships.md | 2 + lib/dart_appwrite.dart | 4 +- lib/enums.dart | 5 + lib/models.dart | 8 +- lib/services/databases.dart | 4 +- lib/services/functions.dart | 168 ++-- lib/services/sites.dart | 586 +++++++++++++ lib/services/storage.dart | 13 +- lib/services/tokens.dart | 109 +++ lib/services/users.dart | 6 +- lib/src/client_browser.dart | 4 +- lib/src/client_io.dart | 6 +- lib/src/enums/adapter.dart | 14 + lib/src/enums/build_runtime.dart | 75 ++ lib/src/enums/deployment_download_type.dart | 14 + lib/src/enums/framework.dart | 26 + lib/src/enums/image_format.dart | 1 - lib/src/enums/runtime.dart | 6 +- lib/src/enums/vcs_deployment_type.dart | 15 + lib/src/models/build.dart | 71 -- lib/src/models/deployment.dart | 36 +- lib/src/models/execution.dart | 2 +- lib/src/models/framework.dart | 47 + lib/src/models/framework_adapter.dart | 47 + lib/src/models/framework_list.dart | 29 + lib/src/models/function.dart | 36 +- lib/src/models/index.dart | 6 + lib/src/models/resource_token.dart | 59 ++ lib/src/models/resource_token_list.dart | 29 + lib/src/models/site.dart | 191 +++++ lib/src/models/site_list.dart | 29 + lib/src/models/variable.dart | 6 + pubspec.yaml | 2 +- test/services/databases_test.dart | 2 + test/services/functions_test.dart | 285 +++++-- test/services/sites_test.dart | 802 ++++++++++++++++++ test/services/tokens_test.dart | 160 ++++ test/src/models/build_test.dart | 34 - test/src/models/deployment_test.dart | 14 +- test/src/models/framework_adapter_test.dart | 26 + test/src/models/framework_list_test.dart | 20 + test/src/models/framework_test.dart | 26 + test/src/models/function_test.dart | 12 +- test/src/models/index_test.dart | 2 + test/src/models/resource_token_list_test.dart | 20 + test/src/models/resource_token_test.dart | 30 + test/src/models/site_list_test.dart | 20 + test/src/models/site_test.dart | 74 ++ test/src/models/variable_test.dart | 2 + 99 files changed, 3405 insertions(+), 283 deletions(-) rename docs/examples/functions/{create-build.md => create-duplicate-deployment.md} (87%) 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.md => update-deployment-status.md} (86%) rename docs/examples/functions/{update-deployment-build.md => update-function-deployment.md} (87%) 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/services/sites.dart create mode 100644 lib/services/tokens.dart create mode 100644 lib/src/enums/adapter.dart create mode 100644 lib/src/enums/build_runtime.dart create mode 100644 lib/src/enums/deployment_download_type.dart create mode 100644 lib/src/enums/framework.dart create mode 100644 lib/src/enums/vcs_deployment_type.dart delete mode 100644 lib/src/models/build.dart create mode 100644 lib/src/models/framework.dart create mode 100644 lib/src/models/framework_adapter.dart create mode 100644 lib/src/models/framework_list.dart create mode 100644 lib/src/models/resource_token.dart create mode 100644 lib/src/models/resource_token_list.dart create mode 100644 lib/src/models/site.dart create mode 100644 lib/src/models/site_list.dart create mode 100644 test/services/sites_test.dart create mode 100644 test/services/tokens_test.dart delete mode 100644 test/src/models/build_test.dart create mode 100644 test/src/models/framework_adapter_test.dart create mode 100644 test/src/models/framework_list_test.dart create mode 100644 test/src/models/framework_test.dart create mode 100644 test/src/models/resource_token_list_test.dart create mode 100644 test/src/models/resource_token_test.dart create mode 100644 test/src/models/site_list_test.dart create mode 100644 test/src/models/site_test.dart diff --git a/README.md b/README.md index ec500daa..4862f478 100644 --- a/README.md +++ b/README.md @@ -2,12 +2,12 @@ [![pub package](https://img.shields.io/pub/v/dart_appwrite.svg?style=flat-square)](https://pub.dartlang.org/packages/dart_appwrite) ![License](https://img.shields.io/github/license/appwrite/sdk-for-dart.svg?style=flat-square) -![Version](https://img.shields.io/badge/api%20version-1.6.x-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-1.7.x-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-dart/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-dart/releases).** > This is the Dart SDK for integrating with Appwrite from your Dart server-side code. If you're looking for the Flutter SDK you should check [appwrite/sdk-for-flutter](https://github.com/appwrite/sdk-for-flutter) @@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file: ```yml dependencies: - dart_appwrite: ^15.1.0-rc.1 + dart_appwrite: ^15.2.0 ``` You can install packages from the command line: diff --git a/docs/examples/avatars/get-browser.md b/docs/examples/avatars/get-browser.md index 902c719a..8d528751 100644 --- a/docs/examples/avatars/get-browser.md +++ b/docs/examples/avatars/get-browser.md @@ -11,5 +11,5 @@ UInt8List result = await avatars.getBrowser( code: Browser.avantBrowser, 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 b242d271..88fe35eb 100644 --- a/docs/examples/avatars/get-credit-card.md +++ b/docs/examples/avatars/get-credit-card.md @@ -11,5 +11,5 @@ UInt8List result = await avatars.getCreditCard( code: CreditCard.americanExpress, 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 5eaed135..56046681 100644 --- a/docs/examples/avatars/get-flag.md +++ b/docs/examples/avatars/get-flag.md @@ -11,5 +11,5 @@ UInt8List result = await avatars.getFlag( 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 1d58fc58..1c9af511 100644 --- a/docs/examples/databases/create-document.md +++ b/docs/examples/databases/create-document.md @@ -2,8 +2,9 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setSession('') // The user session to authenticate with + .setKey('') // Your secret API key + .setJWT(''); // Your secret JSON Web Token Databases databases = Databases(client); diff --git a/docs/examples/databases/create-documents.md b/docs/examples/databases/create-documents.md index 9faa4ebf..7b4409a0 100644 --- a/docs/examples/databases/create-documents.md +++ b/docs/examples/databases/create-documents.md @@ -2,8 +2,7 @@ import 'package:dart_appwrite/dart_appwrite.dart'; Client client = Client() .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setSession(''); // The user session to authenticate with + .setKey(''); // Your secret API key Databases databases = Databases(client); diff --git a/docs/examples/databases/create-index.md b/docs/examples/databases/create-index.md index ff847a94..c3fa1abd 100644 --- a/docs/examples/databases/create-index.md +++ b/docs/examples/databases/create-index.md @@ -14,4 +14,5 @@ Index result = await databases.createIndex( type: IndexType.key, attributes: [], orders: [], // (optional) + lengths: [], // (optional) ); diff --git a/docs/examples/functions/create-build.md b/docs/examples/functions/create-duplicate-deployment.md similarity index 87% rename from docs/examples/functions/create-build.md rename to docs/examples/functions/create-duplicate-deployment.md index eb7ae5d0..34ff5b20 100644 --- a/docs/examples/functions/create-build.md +++ b/docs/examples/functions/create-duplicate-deployment.md @@ -7,7 +7,7 @@ Client client = Client() Functions functions = Functions(client); - result = await functions.createBuild( +Deployment result = await functions.createDuplicateDeployment( functionId: '', deploymentId: '', buildId: '', // (optional) diff --git a/docs/examples/functions/create-template-deployment.md b/docs/examples/functions/create-template-deployment.md new file mode 100644 index 00000000..cc293b0c --- /dev/null +++ b/docs/examples/functions/create-template-deployment.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Functions functions = Functions(client); + +Deployment result = await functions.createTemplateDeployment( + functionId: '', + repository: '', + owner: '', + rootDirectory: '', + version: '', + activate: false, // (optional) +); diff --git a/docs/examples/functions/create-variable.md b/docs/examples/functions/create-variable.md index b46e5752..03e36d82 100644 --- a/docs/examples/functions/create-variable.md +++ b/docs/examples/functions/create-variable.md @@ -11,4 +11,5 @@ Variable result = await functions.createVariable( functionId: '', key: '', 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 00000000..ed315a54 --- /dev/null +++ b/docs/examples/functions/create-vcs-deployment.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Functions functions = Functions(client); + +Deployment result = await functions.createVcsDeployment( + functionId: '', + type: VCSDeploymentType.branch, + reference: '', + activate: false, // (optional) +); diff --git a/docs/examples/functions/create.md b/docs/examples/functions/create.md index 93c78a14..f3f26830 100644 --- a/docs/examples/functions/create.md +++ b/docs/examples/functions/create.md @@ -25,9 +25,5 @@ Func result = await functions.create( providerBranch: '', // (optional) providerSilentMode: false, // (optional) providerRootDirectory: '', // (optional) - templateRepository: '', // (optional) - templateOwner: '', // (optional) - templateRootDirectory: '', // (optional) - templateVersion: '', // (optional) specification: '', // (optional) ); diff --git a/docs/examples/functions/get-deployment-download.md b/docs/examples/functions/get-deployment-download.md index c1add89b..e7bbacf3 100644 --- a/docs/examples/functions/get-deployment-download.md +++ b/docs/examples/functions/get-deployment-download.md @@ -10,4 +10,5 @@ Functions functions = Functions(client); UInt8List result = await functions.getDeploymentDownload( functionId: '', deploymentId: '', + type: DeploymentDownloadType.source, // (optional) ); diff --git a/docs/examples/functions/list-executions.md b/docs/examples/functions/list-executions.md index 54f66730..1dfd3909 100644 --- a/docs/examples/functions/list-executions.md +++ b/docs/examples/functions/list-executions.md @@ -10,5 +10,4 @@ Functions functions = Functions(client); ExecutionList result = await functions.listExecutions( functionId: '', queries: [], // (optional) - search: '', // (optional) ); diff --git a/docs/examples/functions/update-deployment.md b/docs/examples/functions/update-deployment-status.md similarity index 86% rename from docs/examples/functions/update-deployment.md rename to docs/examples/functions/update-deployment-status.md index 59db36b6..2b068098 100644 --- a/docs/examples/functions/update-deployment.md +++ b/docs/examples/functions/update-deployment-status.md @@ -7,7 +7,7 @@ Client client = Client() Functions functions = Functions(client); -Func result = await functions.updateDeployment( +Deployment result = await functions.updateDeploymentStatus( functionId: '', deploymentId: '', ); diff --git a/docs/examples/functions/update-deployment-build.md b/docs/examples/functions/update-function-deployment.md similarity index 87% rename from docs/examples/functions/update-deployment-build.md rename to docs/examples/functions/update-function-deployment.md index 5b547595..0a5c09dd 100644 --- a/docs/examples/functions/update-deployment-build.md +++ b/docs/examples/functions/update-function-deployment.md @@ -7,7 +7,7 @@ Client client = Client() Functions functions = Functions(client); -Build result = await functions.updateDeploymentBuild( +Func result = await functions.updateFunctionDeployment( functionId: '', deploymentId: '', ); diff --git a/docs/examples/functions/update-variable.md b/docs/examples/functions/update-variable.md index df460fae..7330d9f8 100644 --- a/docs/examples/functions/update-variable.md +++ b/docs/examples/functions/update-variable.md @@ -12,4 +12,5 @@ Variable result = await functions.updateVariable( variableId: '', key: '', 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 00000000..93f9615b --- /dev/null +++ b/docs/examples/sites/create-deployment.md @@ -0,0 +1,18 @@ +import 'dart:io'; +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.createDeployment( + siteId: '', + code: InputFile(path: './path-to-files/image.jpg', filename: 'image.jpg'), + activate: false, + installCommand: '', // (optional) + buildCommand: '', // (optional) + outputDirectory: '', // (optional) +); diff --git a/docs/examples/sites/create-duplicate-deployment.md b/docs/examples/sites/create-duplicate-deployment.md new file mode 100644 index 00000000..1a3e84a3 --- /dev/null +++ b/docs/examples/sites/create-duplicate-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.createDuplicateDeployment( + siteId: '', + deploymentId: '', +); diff --git a/docs/examples/sites/create-template-deployment.md b/docs/examples/sites/create-template-deployment.md new file mode 100644 index 00000000..348b4652 --- /dev/null +++ b/docs/examples/sites/create-template-deployment.md @@ -0,0 +1,17 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.createTemplateDeployment( + siteId: '', + repository: '', + owner: '', + rootDirectory: '', + 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 00000000..aa3c8761 --- /dev/null +++ b/docs/examples/sites/create-variable.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Variable result = await sites.createVariable( + siteId: '', + 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 00000000..50f65b96 --- /dev/null +++ b/docs/examples/sites/create-vcs-deployment.md @@ -0,0 +1,15 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.createVcsDeployment( + siteId: '', + 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 00000000..448abab1 --- /dev/null +++ b/docs/examples/sites/create.md @@ -0,0 +1,29 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Site result = await sites.create( + siteId: '', + name: '', + framework: .analog, + buildRuntime: .node145, + enabled: false, // (optional) + logging: false, // (optional) + timeout: 1, // (optional) + installCommand: '', // (optional) + buildCommand: '', // (optional) + outputDirectory: '', // (optional) + adapter: .static, // (optional) + installationId: '', // (optional) + fallbackFile: '', // (optional) + providerRepositoryId: '', // (optional) + providerBranch: '', // (optional) + providerSilentMode: false, // (optional) + providerRootDirectory: '', // (optional) + specification: '', // (optional) +); diff --git a/docs/examples/sites/delete-deployment.md b/docs/examples/sites/delete-deployment.md new file mode 100644 index 00000000..ca93ac66 --- /dev/null +++ b/docs/examples/sites/delete-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +await sites.deleteDeployment( + siteId: '', + deploymentId: '', +); diff --git a/docs/examples/sites/delete-log.md b/docs/examples/sites/delete-log.md new file mode 100644 index 00000000..c11ecab7 --- /dev/null +++ b/docs/examples/sites/delete-log.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +await sites.deleteLog( + siteId: '', + logId: '', +); diff --git a/docs/examples/sites/delete-variable.md b/docs/examples/sites/delete-variable.md new file mode 100644 index 00000000..f04b9451 --- /dev/null +++ b/docs/examples/sites/delete-variable.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +await sites.deleteVariable( + siteId: '', + variableId: '', +); diff --git a/docs/examples/sites/delete.md b/docs/examples/sites/delete.md new file mode 100644 index 00000000..e81df372 --- /dev/null +++ b/docs/examples/sites/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +await sites.delete( + siteId: '', +); diff --git a/docs/examples/sites/get-deployment-download.md b/docs/examples/sites/get-deployment-download.md new file mode 100644 index 00000000..ad21070b --- /dev/null +++ b/docs/examples/sites/get-deployment-download.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +UInt8List result = await sites.getDeploymentDownload( + siteId: '', + deploymentId: '', + 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 00000000..9acc89b5 --- /dev/null +++ b/docs/examples/sites/get-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.getDeployment( + siteId: '', + deploymentId: '', +); diff --git a/docs/examples/sites/get-log.md b/docs/examples/sites/get-log.md new file mode 100644 index 00000000..195f8aad --- /dev/null +++ b/docs/examples/sites/get-log.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Execution result = await sites.getLog( + siteId: '', + logId: '', +); diff --git a/docs/examples/sites/get-variable.md b/docs/examples/sites/get-variable.md new file mode 100644 index 00000000..637e08a5 --- /dev/null +++ b/docs/examples/sites/get-variable.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Variable result = await sites.getVariable( + siteId: '', + variableId: '', +); diff --git a/docs/examples/sites/get.md b/docs/examples/sites/get.md new file mode 100644 index 00000000..32abcfcf --- /dev/null +++ b/docs/examples/sites/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Site result = await sites.get( + siteId: '', +); diff --git a/docs/examples/sites/list-deployments.md b/docs/examples/sites/list-deployments.md new file mode 100644 index 00000000..6f6c9ce3 --- /dev/null +++ b/docs/examples/sites/list-deployments.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +DeploymentList result = await sites.listDeployments( + siteId: '', + 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 00000000..72a600fa --- /dev/null +++ b/docs/examples/sites/list-frameworks.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +FrameworkList result = await sites.listFrameworks(); diff --git a/docs/examples/sites/list-logs.md b/docs/examples/sites/list-logs.md new file mode 100644 index 00000000..4ccf170f --- /dev/null +++ b/docs/examples/sites/list-logs.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +ExecutionList result = await sites.listLogs( + siteId: '', + queries: [], // (optional) +); diff --git a/docs/examples/sites/list-specifications.md b/docs/examples/sites/list-specifications.md new file mode 100644 index 00000000..b81faf0e --- /dev/null +++ b/docs/examples/sites/list-specifications.md @@ -0,0 +1,10 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +SpecificationList result = await sites.listSpecifications(); diff --git a/docs/examples/sites/list-variables.md b/docs/examples/sites/list-variables.md new file mode 100644 index 00000000..14be9662 --- /dev/null +++ b/docs/examples/sites/list-variables.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +VariableList result = await sites.listVariables( + siteId: '', +); diff --git a/docs/examples/sites/list.md b/docs/examples/sites/list.md new file mode 100644 index 00000000..0dd52262 --- /dev/null +++ b/docs/examples/sites/list.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +SiteList result = await 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 00000000..bd031cf2 --- /dev/null +++ b/docs/examples/sites/update-deployment-status.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Deployment result = await sites.updateDeploymentStatus( + siteId: '', + deploymentId: '', +); diff --git a/docs/examples/sites/update-site-deployment.md b/docs/examples/sites/update-site-deployment.md new file mode 100644 index 00000000..dbb4e27a --- /dev/null +++ b/docs/examples/sites/update-site-deployment.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Site result = await sites.updateSiteDeployment( + siteId: '', + deploymentId: '', +); diff --git a/docs/examples/sites/update-variable.md b/docs/examples/sites/update-variable.md new file mode 100644 index 00000000..af2123c9 --- /dev/null +++ b/docs/examples/sites/update-variable.md @@ -0,0 +1,16 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Variable result = await sites.updateVariable( + siteId: '', + variableId: '', + 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 00000000..c13acfb2 --- /dev/null +++ b/docs/examples/sites/update.md @@ -0,0 +1,29 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Sites sites = Sites(client); + +Site result = await sites.update( + siteId: '', + name: '', + framework: .analog, + enabled: false, // (optional) + logging: false, // (optional) + timeout: 1, // (optional) + installCommand: '', // (optional) + buildCommand: '', // (optional) + outputDirectory: '', // (optional) + buildRuntime: .node145, // (optional) + adapter: .static, // (optional) + fallbackFile: '', // (optional) + installationId: '', // (optional) + providerRepositoryId: '', // (optional) + providerBranch: '', // (optional) + providerSilentMode: false, // (optional) + providerRootDirectory: '', // (optional) + specification: '', // (optional) +); diff --git a/docs/examples/storage/get-file-download.md b/docs/examples/storage/get-file-download.md index 09f06c04..8c119c38 100644 --- a/docs/examples/storage/get-file-download.md +++ b/docs/examples/storage/get-file-download.md @@ -10,4 +10,5 @@ Storage storage = Storage(client); UInt8List result = await storage.getFileDownload( bucketId: '', fileId: '', + token: '', // (optional) ); diff --git a/docs/examples/storage/get-file-preview.md b/docs/examples/storage/get-file-preview.md index 7fd69c56..a1f3c09b 100644 --- a/docs/examples/storage/get-file-preview.md +++ b/docs/examples/storage/get-file-preview.md @@ -13,7 +13,7 @@ UInt8List result = await storage.getFilePreview( width: 0, // (optional) height: 0, // (optional) gravity: ImageGravity.center, // (optional) - quality: 0, // (optional) + quality: -1, // (optional) borderWidth: 0, // (optional) borderColor: '', // (optional) borderRadius: 0, // (optional) @@ -21,4 +21,5 @@ UInt8List result = await storage.getFilePreview( rotation: -360, // (optional) background: '', // (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 df5d3a20..d48b51c1 100644 --- a/docs/examples/storage/get-file-view.md +++ b/docs/examples/storage/get-file-view.md @@ -10,4 +10,5 @@ Storage storage = Storage(client); UInt8List result = await storage.getFileView( bucketId: '', fileId: '', + 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 00000000..cc75a917 --- /dev/null +++ b/docs/examples/tokens/create-file-token.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Tokens tokens = Tokens(client); + +ResourceToken result = await tokens.createFileToken( + bucketId: '', + fileId: '', + expire: '', // (optional) +); diff --git a/docs/examples/tokens/delete.md b/docs/examples/tokens/delete.md new file mode 100644 index 00000000..ce95e7b7 --- /dev/null +++ b/docs/examples/tokens/delete.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Tokens tokens = Tokens(client); + +await tokens.delete( + tokenId: '', +); diff --git a/docs/examples/tokens/get.md b/docs/examples/tokens/get.md new file mode 100644 index 00000000..3112b5e1 --- /dev/null +++ b/docs/examples/tokens/get.md @@ -0,0 +1,12 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Tokens tokens = Tokens(client); + +ResourceToken result = await tokens.get( + tokenId: '', +); diff --git a/docs/examples/tokens/list.md b/docs/examples/tokens/list.md new file mode 100644 index 00000000..5331e44d --- /dev/null +++ b/docs/examples/tokens/list.md @@ -0,0 +1,14 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Tokens tokens = Tokens(client); + +ResourceTokenList result = await tokens.list( + bucketId: '', + fileId: '', + queries: [], // (optional) +); diff --git a/docs/examples/tokens/update.md b/docs/examples/tokens/update.md new file mode 100644 index 00000000..47e910d5 --- /dev/null +++ b/docs/examples/tokens/update.md @@ -0,0 +1,13 @@ +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint + .setProject('') // Your project ID + .setKey(''); // Your secret API key + +Tokens tokens = Tokens(client); + +ResourceToken result = await tokens.update( + tokenId: '', + expire: '', // (optional) +); diff --git a/docs/examples/users/list-memberships.md b/docs/examples/users/list-memberships.md index 22c64b15..dabe5a12 100644 --- a/docs/examples/users/list-memberships.md +++ b/docs/examples/users/list-memberships.md @@ -9,4 +9,6 @@ Users users = Users(client); MembershipList result = await users.listMemberships( userId: '', + queries: [], // (optional) + search: '', // (optional) ); diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 21865e2e..5f5ffe9d 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.6.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; @@ -35,6 +35,8 @@ part 'services/graphql.dart'; part 'services/health.dart'; part 'services/locale.dart'; part 'services/messaging.dart'; +part 'services/sites.dart'; part 'services/storage.dart'; part 'services/teams.dart'; +part 'services/tokens.dart'; part 'services/users.dart'; diff --git a/lib/enums.dart b/lib/enums.dart index 313d70c2..dd69b671 100644 --- a/lib/enums.dart +++ b/lib/enums.dart @@ -11,10 +11,15 @@ part 'src/enums/relationship_type.dart'; part 'src/enums/relation_mutate.dart'; part 'src/enums/index_type.dart'; part 'src/enums/runtime.dart'; +part 'src/enums/vcs_deployment_type.dart'; +part 'src/enums/deployment_download_type.dart'; part 'src/enums/execution_method.dart'; part 'src/enums/name.dart'; part 'src/enums/message_priority.dart'; part 'src/enums/smtp_encryption.dart'; +part 'src/enums/framework.dart'; +part 'src/enums/build_runtime.dart'; +part 'src/enums/adapter.dart'; part 'src/enums/compression.dart'; part 'src/enums/image_gravity.dart'; part 'src/enums/image_format.dart'; diff --git a/lib/models.dart b/lib/models.dart index 98fd7d19..59b862d5 100644 --- a/lib/models.dart +++ b/lib/models.dart @@ -12,9 +12,12 @@ part 'src/models/identity_list.dart'; part 'src/models/log_list.dart'; part 'src/models/file_list.dart'; part 'src/models/bucket_list.dart'; +part 'src/models/resource_token_list.dart'; part 'src/models/team_list.dart'; part 'src/models/membership_list.dart'; +part 'src/models/site_list.dart'; part 'src/models/function_list.dart'; +part 'src/models/framework_list.dart'; part 'src/models/runtime_list.dart'; part 'src/models/deployment_list.dart'; part 'src/models/execution_list.dart'; @@ -64,13 +67,16 @@ part 'src/models/locale.dart'; part 'src/models/locale_code.dart'; part 'src/models/file.dart'; part 'src/models/bucket.dart'; +part 'src/models/resource_token.dart'; part 'src/models/team.dart'; part 'src/models/membership.dart'; +part 'src/models/site.dart'; part 'src/models/function.dart'; part 'src/models/runtime.dart'; +part 'src/models/framework.dart'; +part 'src/models/framework_adapter.dart'; part 'src/models/deployment.dart'; part 'src/models/execution.dart'; -part 'src/models/build.dart'; part 'src/models/variable.dart'; part 'src/models/country.dart'; part 'src/models/continent.dart'; diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 26dcc0b2..49e2bbc2 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -854,7 +854,6 @@ class Databases extends Service { /// collection resource using either a [server /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) /// API or directly from your database console. - /// Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); @@ -1033,7 +1032,7 @@ class Databases extends Service { /// Creates an index on the attributes listed. Your index should include all /// the attributes you will query in a single request. /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders}) async { + Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); final Map apiParams = { @@ -1042,6 +1041,7 @@ class Databases extends Service { 'type': type.value, 'attributes': attributes, 'orders': orders, +'lengths': lengths, }; diff --git a/lib/services/functions.dart b/lib/services/functions.dart index d26ec3ad..ad261abf 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -31,7 +31,7 @@ class Functions extends Service { /// [permissions](https://appwrite.io/docs/permissions) to allow different /// project users or team with access to execute the function using the client /// API. - Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? templateRepository, String? templateOwner, String? templateRootDirectory, String? templateVersion, String? specification}) async { + Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { final String apiPath = '/functions'; final Map apiParams = { @@ -53,10 +53,6 @@ class Functions extends Service { 'providerBranch': providerBranch, 'providerSilentMode': providerSilentMode, 'providerRootDirectory': providerRootDirectory, -'templateRepository': templateRepository, -'templateOwner': templateOwner, -'templateRootDirectory': templateRootDirectory, -'templateVersion': templateVersion, 'specification': specification, }; @@ -92,7 +88,6 @@ class Functions extends Service { } /// List allowed function specifications for this instance. - /// Future listSpecifications() async { final String apiPath = '/functions/specifications'; @@ -187,7 +182,29 @@ class Functions extends Service { } - /// 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. + Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all the function's code deployments. You can use the query /// params to filter your results. Future listDeployments({required String functionId, List? queries, String? search}) async { final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); @@ -251,34 +268,48 @@ class Functions extends Service { } - /// Get a code deployment by its unique ID. - Future getDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + /// 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. + Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); final Map apiParams = { - + 'deploymentId': deploymentId, +'buildId': buildId, + }; final Map apiHeaders = { - + 'content-type': 'application/json', + }; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); return models.Deployment.fromMap(res.data); } - /// 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. - Future updateDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + /// 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. + Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); final Map apiParams = { - + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + }; final Map apiHeaders = { @@ -286,19 +317,24 @@ class Functions extends Service { }; - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - return models.Func.fromMap(res.data); + return models.Deployment.fromMap(res.data); } - /// Delete a code deployment by its unique ID. - Future deleteDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); final Map apiParams = { - + 'type': type.value, +'reference': reference, +'activate': activate, + }; final Map apiHeaders = { @@ -306,44 +342,34 @@ class Functions extends Service { }; - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - return res.data; + return models.Deployment.fromMap(res.data); } - /// 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. - Future createBuild({required String functionId, required String deploymentId, String? buildId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + /// Get a function deployment by its unique ID. + Future getDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); final Map apiParams = { - 'buildId': buildId, - + }; final Map apiHeaders = { - 'content-type': 'application/json', - + }; - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return res.data; + return models.Deployment.fromMap(res.data); } - /// 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. - Future updateDeploymentBuild({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/build'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + /// Delete a code deployment by its unique ID. + Future deleteDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); final Map apiParams = { @@ -355,19 +381,21 @@ class Functions extends Service { }; - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - return models.Build.fromMap(res.data); + return res.data; } - /// Get a Deployment's contents by its unique ID. This endpoint supports range - /// requests for partial or streaming file download. - Future getDeploymentDownload({required String functionId, required String deploymentId}) async { + /// 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. + Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); final Map params = { - + 'type': type?.value, + 'project': client.config['project'], 'key': client.config['key'], @@ -377,14 +405,37 @@ class Functions extends Service { return res.data; } + /// 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. + Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + /// Get a list of all the current user function execution logs. You can use the /// query params to filter your results. - Future listExecutions({required String functionId, List? queries, String? search}) async { + Future listExecutions({required String functionId, List? queries}) async { final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); final Map apiParams = { 'queries': queries, -'search': search, }; @@ -448,7 +499,6 @@ class Functions extends Service { } /// Delete a function execution by its unique ID. - /// Future deleteExecution({required String functionId, required String executionId}) async { final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); @@ -489,13 +539,14 @@ class Functions extends Service { /// Create a new function environment variable. These variables can be accessed /// in the function at runtime as environment variables. - Future createVariable({required String functionId, required String key, required String value}) async { + Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); final Map apiParams = { 'key': key, 'value': value, +'secret': secret, }; @@ -530,13 +581,14 @@ class Functions extends Service { } /// Update variable by its unique ID. - Future updateVariable({required String functionId, required String variableId, required String key, String? value}) async { + Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); final Map apiParams = { 'key': key, 'value': value, +'secret': secret, }; diff --git a/lib/services/sites.dart b/lib/services/sites.dart new file mode 100644 index 00000000..90511473 --- /dev/null +++ b/lib/services/sites.dart @@ -0,0 +1,586 @@ +part of '../dart_appwrite.dart'; + +/// The Sites Service allows you view, create and manage your web applications. +class Sites extends Service { + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SiteList.fromMap(res.data); + + } + + /// Create a new site. + Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + + 'siteId': siteId, +'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime.value, +'adapter': adapter?.value, +'installationId': installationId, +'fallbackFile': fallbackFile, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FrameworkList.fromMap(res.data); + + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Update site by its unique ID. + Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime?.value, +'adapter': adapter?.value, +'fallbackFile': fallbackFile, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({required String siteId, List? queries, String? search}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// 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. + Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'type': type.value, +'reference': reference, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a site deployment by its unique ID. + Future getDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({required String siteId, List? queries}) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Get a site request log by its unique ID. + Future getLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/storage.dart b/lib/services/storage.dart index 68f023ac..9165e91b 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -264,11 +264,12 @@ class Storage extends Service { /// Get a file 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. - Future getFileDownload({required String bucketId, required String fileId}) async { + Future getFileDownload({required String bucketId, required String fileId, String? token}) async { final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); final Map params = { - + 'token': token, + 'project': client.config['project'], 'session': client.config['session'], @@ -283,7 +284,7 @@ class Storage extends Service { /// and spreadsheets, will return the file icon image. You can also pass query /// string arguments for cutting and resizing your preview image. Preview is /// supported only for image files smaller than 10MB. - Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output}) async { + Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); final Map params = { @@ -298,6 +299,7 @@ class Storage extends Service { 'rotation': rotation, 'background': background, 'output': output?.value, +'token': token, 'project': client.config['project'], @@ -311,11 +313,12 @@ class Storage extends Service { /// Get a file content by its unique ID. This endpoint is similar to the /// download method but returns with no 'Content-Disposition: attachment' /// header. - Future getFileView({required String bucketId, required String fileId}) async { + Future getFileView({required String bucketId, required String fileId, String? token}) async { final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); final Map params = { - + 'token': token, + 'project': client.config['project'], 'session': client.config['session'], diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart new file mode 100644 index 00000000..a9b8f78a --- /dev/null +++ b/lib/services/tokens.dart @@ -0,0 +1,109 @@ +part of '../dart_appwrite.dart'; + +class Tokens extends Service { + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({required String bucketId, required String fileId, List? queries}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceTokenList.fromMap(res.data); + + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({required String bucketId, required String fileId, String? expire}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({required String tokenId, String? expire}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/users.dart b/lib/services/users.dart index 0562476f..765ec3e6 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -427,11 +427,13 @@ class Users extends Service { } /// Get the user membership list by its unique ID. - Future listMemberships({required String userId}) async { + Future listMemberships({required String userId, List? queries, String? search}) async { final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); final Map apiParams = { - + 'queries': queries, +'search': search, + }; diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index b708a420..2528cc1a 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -33,8 +33,8 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - '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', }; config = {}; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 44c2fb35..29991ba7 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -42,9 +42,9 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - 'x-sdk-version': '15.1.0-rc.1', - 'user-agent' : 'AppwriteDartSDK/15.1.0-rc.1 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format' : '1.6.0', + 'x-sdk-version': '15.2.0', + 'user-agent' : 'AppwriteDartSDK/15.2.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format' : '1.7.0', }; config = {}; diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart new file mode 100644 index 00000000..053080ef --- /dev/null +++ b/lib/src/enums/adapter.dart @@ -0,0 +1,14 @@ +part of '../../enums.dart'; + +enum Adapter { + static(value: 'static'), + ssr(value: 'ssr'); + + const Adapter({ + required this.value + }); + + final String value; + + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart new file mode 100644 index 00000000..fdccfcbb --- /dev/null +++ b/lib/src/enums/build_runtime.dart @@ -0,0 +1,75 @@ +part of '../../enums.dart'; + +enum BuildRuntime { + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); + + const BuildRuntime({ + required this.value + }); + + final String value; + + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart new file mode 100644 index 00000000..782b30c7 --- /dev/null +++ b/lib/src/enums/deployment_download_type.dart @@ -0,0 +1,14 @@ +part of '../../enums.dart'; + +enum DeploymentDownloadType { + source(value: 'source'), + output(value: 'output'); + + const DeploymentDownloadType({ + required this.value + }); + + final String value; + + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart new file mode 100644 index 00000000..af5ebaad --- /dev/null +++ b/lib/src/enums/framework.dart @@ -0,0 +1,26 @@ +part of '../../enums.dart'; + +enum Framework { + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); + + const Framework({ + required this.value + }); + + final String value; + + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index 2e4e2204..dbf6825e 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -3,7 +3,6 @@ part of '../../enums.dart'; enum ImageFormat { jpg(value: 'jpg'), jpeg(value: 'jpeg'), - gif(value: 'gif'), png(value: 'png'), webp(value: 'webp'), heic(value: 'heic'), diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index b7dbd129..a0ff38c8 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -22,6 +22,7 @@ enum Runtime { python311(value: 'python-3.11'), python312(value: 'python-3.12'), pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), deno121(value: 'deno-1.21'), deno124(value: 'deno-1.24'), deno135(value: 'deno-1.35'), @@ -32,6 +33,7 @@ enum Runtime { dart216(value: 'dart-2.16'), dart217(value: 'dart-2.17'), dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), dart30(value: 'dart-3.0'), dart31(value: 'dart-3.1'), dart33(value: 'dart-3.3'), @@ -59,7 +61,9 @@ enum Runtime { bun11(value: 'bun-1.1'), go123(value: 'go-1.23'), static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'); + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); const Runtime({ required this.value diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart new file mode 100644 index 00000000..0bf8e2ad --- /dev/null +++ b/lib/src/enums/vcs_deployment_type.dart @@ -0,0 +1,15 @@ +part of '../../enums.dart'; + +enum VCSDeploymentType { + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); + + const VCSDeploymentType({ + required this.value + }); + + final String value; + + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/models/build.dart b/lib/src/models/build.dart deleted file mode 100644 index fdca3976..00000000 --- a/lib/src/models/build.dart +++ /dev/null @@ -1,71 +0,0 @@ -part of '../../models.dart'; - -/// Build -class Build implements Model { - /// Build ID. - final String $id; - - /// The deployment that created this build. - final String deploymentId; - - /// The build status. There are a few different types and each one means something different. \nFailed - The deployment build has failed. More details can usually be found in buildStderr\nReady - The deployment build was successful and the deployment is ready to be deployed\nProcessing - The deployment is currently waiting to have a build triggered\nBuilding - The deployment is currently being built - final String status; - - /// The stdout of the build. - final String stdout; - - /// The stderr of the build. - final String stderr; - - /// The deployment creation date in ISO 8601 format. - final String startTime; - - /// The time the build was finished in ISO 8601 format. - final String endTime; - - /// The build duration in seconds. - final int duration; - - /// The code size in bytes. - final int size; - - Build({ - required this.$id, - required this.deploymentId, - required this.status, - required this.stdout, - required this.stderr, - required this.startTime, - required this.endTime, - required this.duration, - required this.size, - }); - - factory Build.fromMap(Map map) { - return Build( - $id: map['\$id'].toString(), - deploymentId: map['deploymentId'].toString(), - status: map['status'].toString(), - stdout: map['stdout'].toString(), - stderr: map['stderr'].toString(), - startTime: map['startTime'].toString(), - endTime: map['endTime'].toString(), - duration: map['duration'], - size: map['size'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "deploymentId": deploymentId, - "status": status, - "stdout": stdout, - "stderr": stderr, - "startTime": startTime, - "endTime": endTime, - "duration": duration, - "size": size, - }; - } -} diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index 5bff0299..ecf7e791 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -24,25 +24,34 @@ class Deployment implements Model { final String entrypoint; /// The code size in bytes. - final int size; + final int sourceSize; /// The build output size in bytes. final int buildSize; + /// The total size in bytes (source and build output). + final int totalSize; + /// The current build ID. final String buildId; /// Whether the deployment should be automatically activated. final bool activate; - /// The deployment status. Possible values are "processing", "building", "waiting", "ready", and "failed". + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". final String status; /// The build logs. final String buildLogs; /// The current build time in seconds. - final int buildTime; + final int buildDuration; /// The name of the vcs provider repository final String providerRepositoryName; @@ -82,13 +91,16 @@ class Deployment implements Model { required this.resourceId, required this.resourceType, required this.entrypoint, - required this.size, + required this.sourceSize, required this.buildSize, + required this.totalSize, required this.buildId, required this.activate, + required this.screenshotLight, + required this.screenshotDark, required this.status, required this.buildLogs, - required this.buildTime, + required this.buildDuration, required this.providerRepositoryName, required this.providerRepositoryOwner, required this.providerRepositoryUrl, @@ -110,13 +122,16 @@ class Deployment implements Model { resourceId: map['resourceId'].toString(), resourceType: map['resourceType'].toString(), entrypoint: map['entrypoint'].toString(), - size: map['size'], + sourceSize: map['sourceSize'], buildSize: map['buildSize'], + totalSize: map['totalSize'], buildId: map['buildId'].toString(), activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), status: map['status'].toString(), buildLogs: map['buildLogs'].toString(), - buildTime: map['buildTime'], + buildDuration: map['buildDuration'], providerRepositoryName: map['providerRepositoryName'].toString(), providerRepositoryOwner: map['providerRepositoryOwner'].toString(), providerRepositoryUrl: map['providerRepositoryUrl'].toString(), @@ -139,13 +154,16 @@ class Deployment implements Model { "resourceId": resourceId, "resourceType": resourceType, "entrypoint": entrypoint, - "size": size, + "sourceSize": sourceSize, "buildSize": buildSize, + "totalSize": totalSize, "buildId": buildId, "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, "status": status, "buildLogs": buildLogs, - "buildTime": buildTime, + "buildDuration": buildDuration, "providerRepositoryName": providerRepositoryName, "providerRepositoryOwner": providerRepositoryOwner, "providerRepositoryUrl": providerRepositoryUrl, diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 62051159..0cfdbb4e 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -47,7 +47,7 @@ class Execution implements Model { /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. final String errors; - /// Function execution duration in seconds. + /// Resource(function/site) execution duration in seconds. final double duration; /// The scheduled time for execution. If left empty, execution will be queued immediately. diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart new file mode 100644 index 00000000..ea6b601a --- /dev/null +++ b/lib/src/models/framework.dart @@ -0,0 +1,47 @@ +part of '../../models.dart'; + +/// Framework +class Framework implements Model { + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } +} diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart new file mode 100644 index 00000000..7614616a --- /dev/null +++ b/lib/src/models/framework_adapter.dart @@ -0,0 +1,47 @@ +part of '../../models.dart'; + +/// Framework Adapter +class FrameworkAdapter implements Model { + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } +} diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart new file mode 100644 index 00000000..deb19e62 --- /dev/null +++ b/lib/src/models/framework_list.dart @@ -0,0 +1,29 @@ +part of '../../models.dart'; + +/// Frameworks List +class FrameworkList implements Model { + /// Total number of frameworks documents that matched your query. + final int total; + + /// List of frameworks. + final List frameworks; + + FrameworkList({ + required this.total, + required this.frameworks, + }); + + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), + ); + } + + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } +} diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 61ca45c4..64401c3f 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -23,14 +23,26 @@ class Func implements Model { /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. final bool live; - /// Whether executions will be logged. When set to false, executions will not be logged, but will reduce resource used by your Appwrite project. + /// When disabled, executions will exclude logs and errors, and will be slightly faster. final bool logging; - /// Function execution runtime. + /// Function execution and build runtime. final String runtime; /// Function's active deployment ID. - final String deployment; + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; /// Allowed permission scopes. final List scopes; @@ -84,7 +96,11 @@ class Func implements Model { required this.live, required this.logging, required this.runtime, - required this.deployment, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, required this.scopes, required this.vars, required this.events, @@ -112,7 +128,11 @@ class Func implements Model { live: map['live'], logging: map['logging'], runtime: map['runtime'].toString(), - deployment: map['deployment'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), scopes: List.from(map['scopes'] ?? []), vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), events: List.from(map['events'] ?? []), @@ -141,7 +161,11 @@ class Func implements Model { "live": live, "logging": logging, "runtime": runtime, - "deployment": deployment, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, "scopes": scopes, "vars": vars.map((p) => p.toMap()).toList(), "events": events, diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 119fb5c7..07d22743 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -17,6 +17,9 @@ class Index implements Model { /// Index attributes. final List attributes; + /// Index attributes length. + final List lengths; + /// Index orders. final List? orders; @@ -32,6 +35,7 @@ class Index implements Model { required this.status, required this.error, required this.attributes, + required this.lengths, this.orders, required this.$createdAt, required this.$updatedAt, @@ -44,6 +48,7 @@ class Index implements Model { status: map['status'].toString(), error: map['error'].toString(), attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), orders: List.from(map['orders'] ?? []), $createdAt: map['\$createdAt'].toString(), $updatedAt: map['\$updatedAt'].toString(), @@ -57,6 +62,7 @@ class Index implements Model { "status": status, "error": error, "attributes": attributes, + "lengths": lengths, "orders": orders, "\$createdAt": $createdAt, "\$updatedAt": $updatedAt, diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart new file mode 100644 index 00000000..ed520cc4 --- /dev/null +++ b/lib/src/models/resource_token.dart @@ -0,0 +1,59 @@ +part of '../../models.dart'; + +/// ResourceToken +class ResourceToken implements Model { + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } +} diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart new file mode 100644 index 00000000..ba8f0d89 --- /dev/null +++ b/lib/src/models/resource_token_list.dart @@ -0,0 +1,29 @@ +part of '../../models.dart'; + +/// Resource Tokens List +class ResourceTokenList implements Model { + /// Total number of tokens documents that matched your query. + final int total; + + /// List of tokens. + final List tokens; + + ResourceTokenList({ + required this.total, + required this.tokens, + }); + + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), + ); + } + + Map toMap() { + return { + "total": total, + "tokens": tokens.map((p) => p.toMap()).toList(), + }; + } +} diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart new file mode 100644 index 00000000..5cda6acc --- /dev/null +++ b/lib/src/models/site.dart @@ -0,0 +1,191 @@ +part of '../../models.dart'; + +/// Site +class Site implements Model { + /// Site ID. + final String $id; + + /// Site creation date in ISO 8601 format. + final String $createdAt; + + /// Site update date in ISO 8601 format. + final String $updatedAt; + + /// Site name. + final String name; + + /// Site enabled. + final bool enabled; + + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; + + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; + + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } +} diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart new file mode 100644 index 00000000..02a6a2be --- /dev/null +++ b/lib/src/models/site_list.dart @@ -0,0 +1,29 @@ +part of '../../models.dart'; + +/// Sites List +class SiteList implements Model { + /// Total number of sites documents that matched your query. + final int total; + + /// List of sites. + final List sites; + + SiteList({ + required this.total, + required this.sites, + }); + + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } + + Map toMap() { + return { + "total": total, + "sites": sites.map((p) => p.toMap()).toList(), + }; + } +} diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 8f05516d..58882a9f 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -17,6 +17,9 @@ class Variable implements Model { /// Variable value. final String value; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; + /// Service to which the variable belongs. Possible values are "project", "function" final String resourceType; @@ -29,6 +32,7 @@ class Variable implements Model { required this.$updatedAt, required this.key, required this.value, + required this.secret, required this.resourceType, required this.resourceId, }); @@ -40,6 +44,7 @@ class Variable implements Model { $updatedAt: map['\$updatedAt'].toString(), key: map['key'].toString(), value: map['value'].toString(), + secret: map['secret'], resourceType: map['resourceType'].toString(), resourceId: map['resourceId'].toString(), ); @@ -52,6 +57,7 @@ class Variable implements Model { "\$updatedAt": $updatedAt, "key": key, "value": value, + "secret": secret, "resourceType": resourceType, "resourceId": resourceId, }; diff --git a/pubspec.yaml b/pubspec.yaml index 145d38dd..cd0506f1 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: dart_appwrite -version: 15.1.0-rc.1 +version: 15.2.0 description: Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API homepage: https://appwrite.io repository: https://github.com/appwrite/sdk-for-dart diff --git a/test/services/databases_test.dart b/test/services/databases_test.dart index 2606c4ed..4d8e74e1 100644 --- a/test/services/databases_test.dart +++ b/test/services/databases_test.dart @@ -1080,6 +1080,7 @@ void main() { 'status': 'available', 'error': 'string', 'attributes': [], + 'lengths': [], '\$createdAt': '2020-10-15T06:38:00.000+00:00', '\$updatedAt': '2020-10-15T06:38:00.000+00:00',}; @@ -1107,6 +1108,7 @@ void main() { 'status': 'available', 'error': 'string', 'attributes': [], + 'lengths': [], '\$createdAt': '2020-10-15T06:38:00.000+00:00', '\$updatedAt': '2020-10-15T06:38:00.000+00:00',}; diff --git a/test/services/functions_test.dart b/test/services/functions_test.dart index 77e721c9..f42bd078 100644 --- a/test/services/functions_test.dart +++ b/test/services/functions_test.dart @@ -82,7 +82,11 @@ void main() { 'live': true, 'logging': true, 'runtime': 'python-3.8', - 'deployment': '5e5ea5c16897e', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', 'scopes': [], 'vars': [], 'events': [], @@ -158,7 +162,11 @@ void main() { 'live': true, 'logging': true, 'runtime': 'python-3.8', - 'deployment': '5e5ea5c16897e', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', 'scopes': [], 'vars': [], 'events': [], @@ -198,7 +206,11 @@ void main() { 'live': true, 'logging': true, 'runtime': 'python-3.8', - 'deployment': '5e5ea5c16897e', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', 'scopes': [], 'vars': [], 'events': [], @@ -241,6 +253,51 @@ void main() { ); }); + test('test method updateFunctionDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'execute': [], + 'name': 'My Function', + 'enabled': true, + 'live': true, + 'logging': true, + 'runtime': 'python-3.8', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', + 'scopes': [], + 'vars': [], + 'events': [], + 'schedule': '5 4 * * *', + 'timeout': 300, + 'entrypoint': 'index.js', + 'commands': 'npm install', + 'version': 'v2', + 'installationId': '6m40at4ejk5h2u9s1hboo', + 'providerRepositoryId': 'appwrite', + 'providerBranch': 'main', + 'providerRootDirectory': 'functions/helloWorld', + 'providerSilentMode': true, + 'specification': 's-1vcpu-512mb',}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await functions.updateFunctionDeployment( + functionId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + test('test method listDeployments()', () async { final Map data = { 'total': 5, @@ -268,13 +325,16 @@ void main() { 'resourceId': '5e5ea6g16897e', 'resourceType': 'functions', 'entrypoint': 'index.js', - 'size': 128, + 'sourceSize': 128, 'buildSize': 128, + 'totalSize': 128, 'buildId': '5e5ea5c16897e', 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', 'status': 'ready', 'buildLogs': 'Compiling source files...', - 'buildTime': 128, + 'buildDuration': 128, 'providerRepositoryName': 'database', 'providerRepositoryOwner': 'utopia', 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', @@ -305,7 +365,7 @@ void main() { }); - test('test method getDeployment()', () async { + test('test method createDuplicateDeployment()', () async { final Map data = { '\$id': '5e5ea5c16897e', '\$createdAt': '2020-10-15T06:38:00.000+00:00', @@ -314,13 +374,16 @@ void main() { 'resourceId': '5e5ea6g16897e', 'resourceType': 'functions', 'entrypoint': 'index.js', - 'size': 128, + 'sourceSize': 128, 'buildSize': 128, + 'totalSize': 128, 'buildId': '5e5ea5c16897e', 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', 'status': 'ready', 'buildLogs': 'Compiling source files...', - 'buildTime': 128, + 'buildDuration': 128, 'providerRepositoryName': 'database', 'providerRepositoryOwner': 'utopia', 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', @@ -334,11 +397,11 @@ void main() { when(client.call( - HttpMethod.get, + HttpMethod.post, )).thenAnswer((_) async => Response(data: data)); - final response = await functions.getDeployment( + final response = await functions.createDuplicateDeployment( functionId: '', deploymentId: '', ); @@ -346,99 +409,154 @@ void main() { }); - test('test method updateDeployment()', () async { + test('test method createTemplateDeployment()', () async { final Map data = { '\$id': '5e5ea5c16897e', '\$createdAt': '2020-10-15T06:38:00.000+00:00', '\$updatedAt': '2020-10-15T06:38:00.000+00:00', - 'execute': [], - 'name': 'My Function', - 'enabled': true, - 'live': true, - 'logging': true, - 'runtime': 'python-3.8', - 'deployment': '5e5ea5c16897e', - 'scopes': [], - 'vars': [], - 'events': [], - 'schedule': '5 4 * * *', - 'timeout': 300, + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', 'entrypoint': 'index.js', - 'commands': 'npm install', - 'version': 'v2', - 'installationId': '6m40at4ejk5h2u9s1hboo', - 'providerRepositoryId': 'appwrite', - 'providerBranch': 'main', - 'providerRootDirectory': 'functions/helloWorld', - 'providerSilentMode': true, - 'specification': 's-1vcpu-512mb',}; + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; when(client.call( - HttpMethod.patch, + HttpMethod.post, )).thenAnswer((_) async => Response(data: data)); - final response = await functions.updateDeployment( + final response = await functions.createTemplateDeployment( functionId: '', - deploymentId: '', + repository: '', + owner: '', + rootDirectory: '', + version: '', ); - expect(response, isA()); + expect(response, isA()); }); - test('test method deleteDeployment()', () async { - final data = ''; + test('test method createVcsDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + when(client.call( - HttpMethod.delete, + HttpMethod.post, )).thenAnswer((_) async => Response(data: data)); - final response = await functions.deleteDeployment( + final response = await functions.createVcsDeployment( functionId: '', - deploymentId: '', + type: 'branch', + reference: '', ); + expect(response, isA()); + }); - test('test method createBuild()', () async { - final data = ''; + test('test method getDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + when(client.call( - HttpMethod.post, + HttpMethod.get, )).thenAnswer((_) async => Response(data: data)); - final response = await functions.createBuild( + final response = await functions.getDeployment( functionId: '', deploymentId: '', ); - }); + expect(response, isA()); - test('test method updateDeploymentBuild()', () async { - final Map data = { - '\$id': '5e5ea5c16897e', - 'deploymentId': '5e5ea5c16897e', - 'status': 'ready', - 'stdout': '', - 'stderr': '', - 'startTime': '2020-10-15T06:38:00.000+00:00', - 'endTime': '2020-10-15T06:38:00.000+00:00', - 'duration': 0, - 'size': 128,}; + }); + test('test method deleteDeployment()', () async { + final data = ''; when(client.call( - HttpMethod.patch, + HttpMethod.delete, )).thenAnswer((_) async => Response(data: data)); - final response = await functions.updateDeploymentBuild( + final response = await functions.deleteDeployment( functionId: '', deploymentId: '', ); - expect(response, isA()); - }); test('test method getDeploymentDownload()', () async {final Uint8List data = Uint8List.fromList([]); @@ -456,6 +574,50 @@ void main() { }); + test('test method updateDeploymentStatus()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await functions.updateDeploymentStatus( + functionId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + test('test method listExecutions()', () async { final Map data = { 'total': 5, @@ -578,6 +740,7 @@ void main() { '\$updatedAt': '2020-10-15T06:38:00.000+00:00', 'key': 'API_KEY', 'value': 'myPa\$\$word1', + 'secret': true, 'resourceType': 'function', 'resourceId': 'myAwesomeFunction',}; @@ -603,6 +766,7 @@ void main() { '\$updatedAt': '2020-10-15T06:38:00.000+00:00', 'key': 'API_KEY', 'value': 'myPa\$\$word1', + 'secret': true, 'resourceType': 'function', 'resourceId': 'myAwesomeFunction',}; @@ -627,6 +791,7 @@ void main() { '\$updatedAt': '2020-10-15T06:38:00.000+00:00', 'key': 'API_KEY', 'value': 'myPa\$\$word1', + 'secret': true, 'resourceType': 'function', 'resourceId': 'myAwesomeFunction',}; diff --git a/test/services/sites_test.dart b/test/services/sites_test.dart new file mode 100644 index 00000000..be65bbf9 --- /dev/null +++ b/test/services/sites_test.dart @@ -0,0 +1,802 @@ +import 'package:test/test.dart'; +import 'package:mockito/mockito.dart'; +import 'package:dart_appwrite/models.dart' as models; +import 'package:dart_appwrite/src/enums.dart'; +import 'package:dart_appwrite/src/response.dart'; +import 'dart:typed_data'; +import 'package:dart_appwrite/dart_appwrite.dart'; + +class MockClient extends Mock implements Client { + Map config = {'project': 'testproject'}; + String endPoint = 'https://localhost/v1'; + @override + Future call( + HttpMethod? method, { + String path = '', + Map headers = const {}, + Map params = const {}, + ResponseType? responseType, + }) async { + return super.noSuchMethod(Invocation.method(#call, [method]), + returnValue: Response()); + } + + @override + Future webAuth( + Uri? url, + { + String? callbackUrlScheme, + } + ) async { + return super.noSuchMethod(Invocation.method(#webAuth, [url]), returnValue: 'done'); + } + + @override + Future chunkedUpload({ + String? path, + Map? params, + String? paramName, + String? idParamName, + Map? headers, + Function(UploadProgress)? onProgress, + }) async { + return super.noSuchMethod(Invocation.method(#chunkedUpload, [path, params, paramName, idParamName, headers]), returnValue: Response(data: {})); + } +} + +void main() { + group('Sites test', () { + late MockClient client; + late Sites sites; + + setUp(() { + client = MockClient(); + sites = Sites(client); + }); + + test('test method list()', () async { + final Map data = { + 'total': 5, + 'sites': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.list( + ); + expect(response, isA()); + + }); + + test('test method create()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'name': 'My Site', + 'enabled': true, + 'live': true, + 'logging': true, + 'framework': 'react', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'deploymentScreenshotLight': '5e5ea5c16897e', + 'deploymentScreenshotDark': '5e5ea5c16897e', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', + 'vars': [], + 'timeout': 300, + 'installCommand': 'npm install', + 'buildCommand': 'npm run build', + 'outputDirectory': 'build', + 'installationId': '6m40at4ejk5h2u9s1hboo', + 'providerRepositoryId': 'appwrite', + 'providerBranch': 'main', + 'providerRootDirectory': 'sites/helloWorld', + 'providerSilentMode': true, + 'specification': 's-1vcpu-512mb', + 'buildRuntime': 'node-22', + 'adapter': 'static', + 'fallbackFile': 'index.html',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.create( + siteId: '', + name: '', + framework: 'analog', + buildRuntime: 'node-14.5', + ); + expect(response, isA()); + + }); + + test('test method listFrameworks()', () async { + final Map data = { + 'total': 5, + 'frameworks': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.listFrameworks( + ); + expect(response, isA()); + + }); + + test('test method listSpecifications()', () async { + final Map data = { + 'total': 5, + 'specifications': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.listSpecifications( + ); + expect(response, isA()); + + }); + + test('test method get()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'name': 'My Site', + 'enabled': true, + 'live': true, + 'logging': true, + 'framework': 'react', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'deploymentScreenshotLight': '5e5ea5c16897e', + 'deploymentScreenshotDark': '5e5ea5c16897e', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', + 'vars': [], + 'timeout': 300, + 'installCommand': 'npm install', + 'buildCommand': 'npm run build', + 'outputDirectory': 'build', + 'installationId': '6m40at4ejk5h2u9s1hboo', + 'providerRepositoryId': 'appwrite', + 'providerBranch': 'main', + 'providerRootDirectory': 'sites/helloWorld', + 'providerSilentMode': true, + 'specification': 's-1vcpu-512mb', + 'buildRuntime': 'node-22', + 'adapter': 'static', + 'fallbackFile': 'index.html',}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.get( + siteId: '', + ); + expect(response, isA()); + + }); + + test('test method update()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'name': 'My Site', + 'enabled': true, + 'live': true, + 'logging': true, + 'framework': 'react', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'deploymentScreenshotLight': '5e5ea5c16897e', + 'deploymentScreenshotDark': '5e5ea5c16897e', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', + 'vars': [], + 'timeout': 300, + 'installCommand': 'npm install', + 'buildCommand': 'npm run build', + 'outputDirectory': 'build', + 'installationId': '6m40at4ejk5h2u9s1hboo', + 'providerRepositoryId': 'appwrite', + 'providerBranch': 'main', + 'providerRootDirectory': 'sites/helloWorld', + 'providerSilentMode': true, + 'specification': 's-1vcpu-512mb', + 'buildRuntime': 'node-22', + 'adapter': 'static', + 'fallbackFile': 'index.html',}; + + + when(client.call( + HttpMethod.put, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.update( + siteId: '', + name: '', + framework: 'analog', + ); + expect(response, isA()); + + }); + + test('test method delete()', () async { + final data = ''; + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.delete( + siteId: '', + ); + }); + + test('test method updateSiteDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'name': 'My Site', + 'enabled': true, + 'live': true, + 'logging': true, + 'framework': 'react', + 'deploymentId': '5e5ea5c16897e', + 'deploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'deploymentScreenshotLight': '5e5ea5c16897e', + 'deploymentScreenshotDark': '5e5ea5c16897e', + 'latestDeploymentId': '5e5ea5c16897e', + 'latestDeploymentCreatedAt': '2020-10-15T06:38:00.000+00:00', + 'latestDeploymentStatus': 'ready', + 'vars': [], + 'timeout': 300, + 'installCommand': 'npm install', + 'buildCommand': 'npm run build', + 'outputDirectory': 'build', + 'installationId': '6m40at4ejk5h2u9s1hboo', + 'providerRepositoryId': 'appwrite', + 'providerBranch': 'main', + 'providerRootDirectory': 'sites/helloWorld', + 'providerSilentMode': true, + 'specification': 's-1vcpu-512mb', + 'buildRuntime': 'node-22', + 'adapter': 'static', + 'fallbackFile': 'index.html',}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.updateSiteDeployment( + siteId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + + test('test method listDeployments()', () async { + final Map data = { + 'total': 5, + 'deployments': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.listDeployments( + siteId: '', + ); + expect(response, isA()); + + }); + + test('test method createDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.chunkedUpload( + path: argThat(isNotNull), + params: argThat(isNotNull), + paramName: argThat(isNotNull), + idParamName: argThat(isNotNull), + headers: argThat(isNotNull), + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.createDeployment( + siteId: '', + code: InputFile.fromPath(path: './image.png'), + activate: true, + ); + expect(response, isA()); + + }); + + test('test method createDuplicateDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.createDuplicateDeployment( + siteId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + + test('test method createTemplateDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.createTemplateDeployment( + siteId: '', + repository: '', + owner: '', + rootDirectory: '', + version: '', + ); + expect(response, isA()); + + }); + + test('test method createVcsDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.createVcsDeployment( + siteId: '', + type: 'branch', + reference: '', + ); + expect(response, isA()); + + }); + + test('test method getDeployment()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.getDeployment( + siteId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + + test('test method deleteDeployment()', () async { + final data = ''; + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.deleteDeployment( + siteId: '', + deploymentId: '', + ); + }); + + test('test method getDeploymentDownload()', () async {final Uint8List data = Uint8List.fromList([]); + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.getDeploymentDownload( + siteId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + + test('test method updateDeploymentStatus()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'type': 'vcs', + 'resourceId': '5e5ea6g16897e', + 'resourceType': 'functions', + 'entrypoint': 'index.js', + 'sourceSize': 128, + 'buildSize': 128, + 'totalSize': 128, + 'buildId': '5e5ea5c16897e', + 'activate': true, + 'screenshotLight': '5e5ea5c16897e', + 'screenshotDark': '5e5ea5c16897e', + 'status': 'ready', + 'buildLogs': 'Compiling source files...', + 'buildDuration': 128, + 'providerRepositoryName': 'database', + 'providerRepositoryOwner': 'utopia', + 'providerRepositoryUrl': 'https://github.com/vermakhushboo/g4-node-function', + 'providerBranch': '0.7.x', + 'providerCommitHash': '7c3f25d', + 'providerCommitAuthorUrl': 'https://github.com/vermakhushboo', + 'providerCommitAuthor': 'Khushboo Verma', + 'providerCommitMessage': 'Update index.js', + 'providerCommitUrl': 'https://github.com/vermakhushboo/g4-node-function/commit/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb', + 'providerBranchUrl': 'https://github.com/vermakhushboo/appwrite/tree/0.7.x',}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.updateDeploymentStatus( + siteId: '', + deploymentId: '', + ); + expect(response, isA()); + + }); + + test('test method listLogs()', () async { + final Map data = { + 'total': 5, + 'executions': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.listLogs( + siteId: '', + ); + expect(response, isA()); + + }); + + test('test method getLog()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + '\$permissions': [], + 'functionId': '5e5ea6g16897e', + 'trigger': 'http', + 'status': 'processing', + 'requestMethod': 'GET', + 'requestPath': '/articles?id=5', + 'requestHeaders': [], + 'responseStatusCode': 200, + 'responseBody': '', + 'responseHeaders': [], + 'logs': '', + 'errors': '', + 'duration': 0.4,}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.getLog( + siteId: '', + logId: '', + ); + expect(response, isA()); + + }); + + test('test method deleteLog()', () async { + final data = ''; + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.deleteLog( + siteId: '', + logId: '', + ); + }); + + test('test method listVariables()', () async { + final Map data = { + 'total': 5, + 'variables': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.listVariables( + siteId: '', + ); + expect(response, isA()); + + }); + + test('test method createVariable()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'key': 'API_KEY', + 'value': 'myPa\$\$word1', + 'secret': true, + 'resourceType': 'function', + 'resourceId': 'myAwesomeFunction',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.createVariable( + siteId: '', + key: '', + value: '', + ); + expect(response, isA()); + + }); + + test('test method getVariable()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'key': 'API_KEY', + 'value': 'myPa\$\$word1', + 'secret': true, + 'resourceType': 'function', + 'resourceId': 'myAwesomeFunction',}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.getVariable( + siteId: '', + variableId: '', + ); + expect(response, isA()); + + }); + + test('test method updateVariable()', () async { + final Map data = { + '\$id': '5e5ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + '\$updatedAt': '2020-10-15T06:38:00.000+00:00', + 'key': 'API_KEY', + 'value': 'myPa\$\$word1', + 'secret': true, + 'resourceType': 'function', + 'resourceId': 'myAwesomeFunction',}; + + + when(client.call( + HttpMethod.put, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.updateVariable( + siteId: '', + variableId: '', + key: '', + ); + expect(response, isA()); + + }); + + test('test method deleteVariable()', () async { + final data = ''; + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await sites.deleteVariable( + siteId: '', + variableId: '', + ); + }); + + }); +} \ No newline at end of file diff --git a/test/services/tokens_test.dart b/test/services/tokens_test.dart new file mode 100644 index 00000000..66aec103 --- /dev/null +++ b/test/services/tokens_test.dart @@ -0,0 +1,160 @@ +import 'package:test/test.dart'; +import 'package:mockito/mockito.dart'; +import 'package:dart_appwrite/models.dart' as models; +import 'package:dart_appwrite/src/enums.dart'; +import 'package:dart_appwrite/src/response.dart'; +import 'dart:typed_data'; +import 'package:dart_appwrite/dart_appwrite.dart'; + +class MockClient extends Mock implements Client { + Map config = {'project': 'testproject'}; + String endPoint = 'https://localhost/v1'; + @override + Future call( + HttpMethod? method, { + String path = '', + Map headers = const {}, + Map params = const {}, + ResponseType? responseType, + }) async { + return super.noSuchMethod(Invocation.method(#call, [method]), + returnValue: Response()); + } + + @override + Future webAuth( + Uri? url, + { + String? callbackUrlScheme, + } + ) async { + return super.noSuchMethod(Invocation.method(#webAuth, [url]), returnValue: 'done'); + } + + @override + Future chunkedUpload({ + String? path, + Map? params, + String? paramName, + String? idParamName, + Map? headers, + Function(UploadProgress)? onProgress, + }) async { + return super.noSuchMethod(Invocation.method(#chunkedUpload, [path, params, paramName, idParamName, headers]), returnValue: Response(data: {})); + } +} + +void main() { + group('Tokens test', () { + late MockClient client; + late Tokens tokens; + + setUp(() { + client = MockClient(); + tokens = Tokens(client); + }); + + test('test method list()', () async { + final Map data = { + 'total': 5, + 'tokens': [],}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await tokens.list( + bucketId: '', + fileId: '', + ); + expect(response, isA()); + + }); + + test('test method createFileToken()', () async { + final Map data = { + '\$id': 'bb8ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + 'resourceId': '5e5ea5c168bb8:5e5ea5c168bb8', + 'resourceType': 'files', + 'expire': '2020-10-15T06:38:00.000+00:00', + 'secret': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c', + 'accessedAt': '2020-10-15T06:38:00.000+00:00',}; + + + when(client.call( + HttpMethod.post, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await tokens.createFileToken( + bucketId: '', + fileId: '', + ); + expect(response, isA()); + + }); + + test('test method get()', () async { + final Map data = { + '\$id': 'bb8ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + 'resourceId': '5e5ea5c168bb8:5e5ea5c168bb8', + 'resourceType': 'files', + 'expire': '2020-10-15T06:38:00.000+00:00', + 'secret': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c', + 'accessedAt': '2020-10-15T06:38:00.000+00:00',}; + + + when(client.call( + HttpMethod.get, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await tokens.get( + tokenId: '', + ); + expect(response, isA()); + + }); + + test('test method update()', () async { + final Map data = { + '\$id': 'bb8ea5c16897e', + '\$createdAt': '2020-10-15T06:38:00.000+00:00', + 'resourceId': '5e5ea5c168bb8:5e5ea5c168bb8', + 'resourceType': 'files', + 'expire': '2020-10-15T06:38:00.000+00:00', + 'secret': 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c', + 'accessedAt': '2020-10-15T06:38:00.000+00:00',}; + + + when(client.call( + HttpMethod.patch, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await tokens.update( + tokenId: '', + ); + expect(response, isA()); + + }); + + test('test method delete()', () async { + final data = ''; + + when(client.call( + HttpMethod.delete, + )).thenAnswer((_) async => Response(data: data)); + + + final response = await tokens.delete( + tokenId: '', + ); + }); + + }); +} \ No newline at end of file diff --git a/test/src/models/build_test.dart b/test/src/models/build_test.dart deleted file mode 100644 index ed8fbac9..00000000 --- a/test/src/models/build_test.dart +++ /dev/null @@ -1,34 +0,0 @@ -import 'package:dart_appwrite/models.dart'; -import 'package:test/test.dart'; - -void main() { - group('Build', () { - - test('model', () { - final model = Build( - $id: '5e5ea5c16897e', - deploymentId: '5e5ea5c16897e', - status: 'ready', - stdout: '', - stderr: '', - startTime: '2020-10-15T06:38:00.000+00:00', - endTime: '2020-10-15T06:38:00.000+00:00', - duration: 0, - size: 128, - ); - - final map = model.toMap(); - final result = Build.fromMap(map); - - expect(result.$id, '5e5ea5c16897e'); - expect(result.deploymentId, '5e5ea5c16897e'); - expect(result.status, 'ready'); - expect(result.stdout, ''); - expect(result.stderr, ''); - expect(result.startTime, '2020-10-15T06:38:00.000+00:00'); - expect(result.endTime, '2020-10-15T06:38:00.000+00:00'); - expect(result.duration, 0); - expect(result.size, 128); - }); - }); -} diff --git a/test/src/models/deployment_test.dart b/test/src/models/deployment_test.dart index 2f9b3582..46d7200c 100644 --- a/test/src/models/deployment_test.dart +++ b/test/src/models/deployment_test.dart @@ -13,13 +13,16 @@ void main() { resourceId: '5e5ea6g16897e', resourceType: 'functions', entrypoint: 'index.js', - size: 128, + sourceSize: 128, buildSize: 128, + totalSize: 128, buildId: '5e5ea5c16897e', activate: true, + screenshotLight: '5e5ea5c16897e', + screenshotDark: '5e5ea5c16897e', status: 'ready', buildLogs: 'Compiling source files...', - buildTime: 128, + buildDuration: 128, providerRepositoryName: 'database', providerRepositoryOwner: 'utopia', providerRepositoryUrl: 'https://github.com/vermakhushboo/g4-node-function', @@ -42,13 +45,16 @@ void main() { expect(result.resourceId, '5e5ea6g16897e'); expect(result.resourceType, 'functions'); expect(result.entrypoint, 'index.js'); - expect(result.size, 128); + expect(result.sourceSize, 128); expect(result.buildSize, 128); + expect(result.totalSize, 128); expect(result.buildId, '5e5ea5c16897e'); expect(result.activate, true); + expect(result.screenshotLight, '5e5ea5c16897e'); + expect(result.screenshotDark, '5e5ea5c16897e'); expect(result.status, 'ready'); expect(result.buildLogs, 'Compiling source files...'); - expect(result.buildTime, 128); + expect(result.buildDuration, 128); expect(result.providerRepositoryName, 'database'); expect(result.providerRepositoryOwner, 'utopia'); expect(result.providerRepositoryUrl, 'https://github.com/vermakhushboo/g4-node-function'); diff --git a/test/src/models/framework_adapter_test.dart b/test/src/models/framework_adapter_test.dart new file mode 100644 index 00000000..bf7e3ff3 --- /dev/null +++ b/test/src/models/framework_adapter_test.dart @@ -0,0 +1,26 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('FrameworkAdapter', () { + + test('model', () { + final model = FrameworkAdapter( + key: 'static', + installCommand: 'npm install', + buildCommand: 'npm run build', + outputDirectory: './dist', + fallbackFile: 'index.html', + ); + + final map = model.toMap(); + final result = FrameworkAdapter.fromMap(map); + + expect(result.key, 'static'); + expect(result.installCommand, 'npm install'); + expect(result.buildCommand, 'npm run build'); + expect(result.outputDirectory, './dist'); + expect(result.fallbackFile, 'index.html'); + }); + }); +} diff --git a/test/src/models/framework_list_test.dart b/test/src/models/framework_list_test.dart new file mode 100644 index 00000000..aeade175 --- /dev/null +++ b/test/src/models/framework_list_test.dart @@ -0,0 +1,20 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('FrameworkList', () { + + test('model', () { + final model = FrameworkList( + total: 5, + frameworks: [], + ); + + final map = model.toMap(); + final result = FrameworkList.fromMap(map); + + expect(result.total, 5); + expect(result.frameworks, []); + }); + }); +} diff --git a/test/src/models/framework_test.dart b/test/src/models/framework_test.dart new file mode 100644 index 00000000..48ea96d2 --- /dev/null +++ b/test/src/models/framework_test.dart @@ -0,0 +1,26 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('Framework', () { + + test('model', () { + final model = Framework( + key: 'sveltekit', + name: 'SvelteKit', + buildRuntime: 'node-22', + runtimes: [], + adapters: [], + ); + + final map = model.toMap(); + final result = Framework.fromMap(map); + + expect(result.key, 'sveltekit'); + expect(result.name, 'SvelteKit'); + expect(result.buildRuntime, 'node-22'); + expect(result.runtimes, []); + expect(result.adapters, []); + }); + }); +} diff --git a/test/src/models/function_test.dart b/test/src/models/function_test.dart index 7b4e983f..653aadce 100644 --- a/test/src/models/function_test.dart +++ b/test/src/models/function_test.dart @@ -15,7 +15,11 @@ void main() { live: true, logging: true, runtime: 'python-3.8', - deployment: '5e5ea5c16897e', + deploymentId: '5e5ea5c16897e', + deploymentCreatedAt: '2020-10-15T06:38:00.000+00:00', + latestDeploymentId: '5e5ea5c16897e', + latestDeploymentCreatedAt: '2020-10-15T06:38:00.000+00:00', + latestDeploymentStatus: 'ready', scopes: [], vars: [], events: [], @@ -44,7 +48,11 @@ void main() { expect(result.live, true); expect(result.logging, true); expect(result.runtime, 'python-3.8'); - expect(result.deployment, '5e5ea5c16897e'); + expect(result.deploymentId, '5e5ea5c16897e'); + expect(result.deploymentCreatedAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.latestDeploymentId, '5e5ea5c16897e'); + expect(result.latestDeploymentCreatedAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.latestDeploymentStatus, 'ready'); expect(result.scopes, []); expect(result.vars, []); expect(result.events, []); diff --git a/test/src/models/index_test.dart b/test/src/models/index_test.dart index 8c45dee4..fd8b9fc9 100644 --- a/test/src/models/index_test.dart +++ b/test/src/models/index_test.dart @@ -11,6 +11,7 @@ void main() { status: 'available', error: 'string', attributes: [], + lengths: [], $createdAt: '2020-10-15T06:38:00.000+00:00', $updatedAt: '2020-10-15T06:38:00.000+00:00', ); @@ -23,6 +24,7 @@ void main() { expect(result.status, 'available'); expect(result.error, 'string'); expect(result.attributes, []); + expect(result.lengths, []); expect(result.$createdAt, '2020-10-15T06:38:00.000+00:00'); expect(result.$updatedAt, '2020-10-15T06:38:00.000+00:00'); }); diff --git a/test/src/models/resource_token_list_test.dart b/test/src/models/resource_token_list_test.dart new file mode 100644 index 00000000..1c1cd293 --- /dev/null +++ b/test/src/models/resource_token_list_test.dart @@ -0,0 +1,20 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('ResourceTokenList', () { + + test('model', () { + final model = ResourceTokenList( + total: 5, + tokens: [], + ); + + final map = model.toMap(); + final result = ResourceTokenList.fromMap(map); + + expect(result.total, 5); + expect(result.tokens, []); + }); + }); +} diff --git a/test/src/models/resource_token_test.dart b/test/src/models/resource_token_test.dart new file mode 100644 index 00000000..1334f1e0 --- /dev/null +++ b/test/src/models/resource_token_test.dart @@ -0,0 +1,30 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('ResourceToken', () { + + test('model', () { + final model = ResourceToken( + $id: 'bb8ea5c16897e', + $createdAt: '2020-10-15T06:38:00.000+00:00', + resourceId: '5e5ea5c168bb8:5e5ea5c168bb8', + resourceType: 'files', + expire: '2020-10-15T06:38:00.000+00:00', + secret: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c', + accessedAt: '2020-10-15T06:38:00.000+00:00', + ); + + final map = model.toMap(); + final result = ResourceToken.fromMap(map); + + expect(result.$id, 'bb8ea5c16897e'); + expect(result.$createdAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.resourceId, '5e5ea5c168bb8:5e5ea5c168bb8'); + expect(result.resourceType, 'files'); + expect(result.expire, '2020-10-15T06:38:00.000+00:00'); + expect(result.secret, 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'); + expect(result.accessedAt, '2020-10-15T06:38:00.000+00:00'); + }); + }); +} diff --git a/test/src/models/site_list_test.dart b/test/src/models/site_list_test.dart new file mode 100644 index 00000000..8aa8e225 --- /dev/null +++ b/test/src/models/site_list_test.dart @@ -0,0 +1,20 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('SiteList', () { + + test('model', () { + final model = SiteList( + total: 5, + sites: [], + ); + + final map = model.toMap(); + final result = SiteList.fromMap(map); + + expect(result.total, 5); + expect(result.sites, []); + }); + }); +} diff --git a/test/src/models/site_test.dart b/test/src/models/site_test.dart new file mode 100644 index 00000000..234eef88 --- /dev/null +++ b/test/src/models/site_test.dart @@ -0,0 +1,74 @@ +import 'package:dart_appwrite/models.dart'; +import 'package:test/test.dart'; + +void main() { + group('Site', () { + + test('model', () { + final model = Site( + $id: '5e5ea5c16897e', + $createdAt: '2020-10-15T06:38:00.000+00:00', + $updatedAt: '2020-10-15T06:38:00.000+00:00', + name: 'My Site', + enabled: true, + live: true, + logging: true, + framework: 'react', + deploymentId: '5e5ea5c16897e', + deploymentCreatedAt: '2020-10-15T06:38:00.000+00:00', + deploymentScreenshotLight: '5e5ea5c16897e', + deploymentScreenshotDark: '5e5ea5c16897e', + latestDeploymentId: '5e5ea5c16897e', + latestDeploymentCreatedAt: '2020-10-15T06:38:00.000+00:00', + latestDeploymentStatus: 'ready', + vars: [], + timeout: 300, + installCommand: 'npm install', + buildCommand: 'npm run build', + outputDirectory: 'build', + installationId: '6m40at4ejk5h2u9s1hboo', + providerRepositoryId: 'appwrite', + providerBranch: 'main', + providerRootDirectory: 'sites/helloWorld', + providerSilentMode: true, + specification: 's-1vcpu-512mb', + buildRuntime: 'node-22', + adapter: 'static', + fallbackFile: 'index.html', + ); + + final map = model.toMap(); + final result = Site.fromMap(map); + + expect(result.$id, '5e5ea5c16897e'); + expect(result.$createdAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.$updatedAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.name, 'My Site'); + expect(result.enabled, true); + expect(result.live, true); + expect(result.logging, true); + expect(result.framework, 'react'); + expect(result.deploymentId, '5e5ea5c16897e'); + expect(result.deploymentCreatedAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.deploymentScreenshotLight, '5e5ea5c16897e'); + expect(result.deploymentScreenshotDark, '5e5ea5c16897e'); + expect(result.latestDeploymentId, '5e5ea5c16897e'); + expect(result.latestDeploymentCreatedAt, '2020-10-15T06:38:00.000+00:00'); + expect(result.latestDeploymentStatus, 'ready'); + expect(result.vars, []); + expect(result.timeout, 300); + expect(result.installCommand, 'npm install'); + expect(result.buildCommand, 'npm run build'); + expect(result.outputDirectory, 'build'); + expect(result.installationId, '6m40at4ejk5h2u9s1hboo'); + expect(result.providerRepositoryId, 'appwrite'); + expect(result.providerBranch, 'main'); + expect(result.providerRootDirectory, 'sites/helloWorld'); + expect(result.providerSilentMode, true); + expect(result.specification, 's-1vcpu-512mb'); + expect(result.buildRuntime, 'node-22'); + expect(result.adapter, 'static'); + expect(result.fallbackFile, 'index.html'); + }); + }); +} diff --git a/test/src/models/variable_test.dart b/test/src/models/variable_test.dart index ccfcc793..0d86ef00 100644 --- a/test/src/models/variable_test.dart +++ b/test/src/models/variable_test.dart @@ -11,6 +11,7 @@ void main() { $updatedAt: '2020-10-15T06:38:00.000+00:00', key: 'API_KEY', value: 'myPa\$\$word1', + secret: true, resourceType: 'function', resourceId: 'myAwesomeFunction', ); @@ -23,6 +24,7 @@ void main() { expect(result.$updatedAt, '2020-10-15T06:38:00.000+00:00'); expect(result.key, 'API_KEY'); expect(result.value, 'myPa\$\$word1'); + expect(result.secret, true); expect(result.resourceType, 'function'); expect(result.resourceId, 'myAwesomeFunction'); }); From aacbc0a1c3747e5c07a3e4c457d54f7fc68d3862 Mon Sep 17 00:00:00 2001 From: abnegate Date: Sat, 17 May 2025 14:09:27 +0000 Subject: [PATCH 3/7] Commit from GitHub Actions (Format and push) --- lib/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 +++++++-------- lib/services/avatars.dart | 434 +-- lib/services/databases.dart | 2528 ++++++++++-------- lib/services/functions.dart | 1385 +++++----- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 +++-- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 +++++++++++-------- lib/services/sites.dart | 1282 +++++---- lib/services/storage.dart | 744 +++--- lib/services/teams.dart | 671 ++--- lib/services/tokens.dart | 216 +- lib/services/users.dart | 2063 ++++++++------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 123 +- lib/src/client_io.dart | 150 +- lib/src/client_mixin.dart | 65 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/adapter.dart | 14 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/build_runtime.dart | 136 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/deployment_download_type.dart | 14 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 ++- lib/src/enums/framework.dart | 38 +- lib/src/enums/image_format.dart | 22 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 136 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/enums/vcs_deployment_type.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 338 +-- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/framework.dart | 86 +- lib/src/models/framework_adapter.dart | 84 +- lib/src/models/framework_list.dart | 39 +- lib/src/models/function.dart | 348 +-- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 110 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/resource_token.dart | 108 +- lib/src/models/resource_token_list.dart | 36 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/site.dart | 358 +-- lib/src/models/site_list.dart | 34 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 100 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- 150 files changed, 13072 insertions(+), 12028 deletions(-) diff --git a/lib/client_browser.dart b/lib/client_browser.dart index 09f110ea..b9805a3a 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; \ No newline at end of file +export 'src/client_browser.dart'; diff --git a/lib/client_io.dart b/lib/client_io.dart index 4d85cbfa..42a0c0b6 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; \ No newline at end of file +export 'src/client_io.dart'; diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 5f5ffe9d..0848a050 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.7.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 72e26a23..28ff15e8 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,8 +10,7 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + - usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 46882207..9107a9a4 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,6 +1,5 @@ part of 'dart_appwrite.dart'; - /// Helper class to generate query strings. class Query { final String method; @@ -10,15 +9,13 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = { - 'method': method, - }; + final map = {'method': method}; - if(attribute != null) { + if (attribute != null) { map['attribute'] = attribute; } - - if(values != null) { + + if (values != null) { map['values'] = values is List ? values : [values]; } @@ -29,7 +26,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -61,10 +58,12 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => Query._('isNull', attribute).toString(); + static String isNull(String attribute) => + Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => + Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -84,40 +83,52 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'or', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); static String and(List queries) => - Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'and', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => + Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => + Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => + Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => + Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => Query._('offset', null, offset).toString(); - -} \ No newline at end of file + static String offset(int offset) => + Query._('offset', null, offset).toString(); +} diff --git a/lib/role.dart b/lib/role.dart index 6552df47..dafeb78d 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if(status.isEmpty) { - return 'user:$id'; - } - return 'user:$id/$status'; - } + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if(status.isEmpty) { - return 'users'; - } - return 'users/$status'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if (status.isEmpty) { + return 'user:$id'; } + return 'user:$id/$status'; + } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if (status.isEmpty) { + return 'users'; } + return 'users/$status'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if(role.isEmpty) { - return 'team:$id'; - } - return 'team:$id/$role'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if (role.isEmpty) { + return 'team:$id'; } + return 'team:$id/$role'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} \ No newline at end of file + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } + + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} diff --git a/lib/services/account.dart b/lib/services/account.dart index fdc8cc97..90e1f03e 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1081 +2,1084 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/account'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({required String email, required String password}) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaType.fromMap(res.data); - - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - 'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'factor': factor.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaChallenge.fromMap(res.data); - - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({required String challengeId, required String otp}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'challengeId': challengeId, -'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({required String password, String? oldPassword}) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - - 'password': password, -'oldPassword': oldPassword, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({required String phone, required String password}) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - - 'phone': phone, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({required String email, required String url}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'email': email, -'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({required String userId, required String secret, required String password}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({required String email, required String password}) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({required String userId, required String email, bool? phrase}) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'url': url, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); - - final Map params = { - 'success': success, -'failure': failure, -'scopes': scopes, - - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); - } - } else if(value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri(scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&') - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({required String userId, required String phone}) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = { - - 'userId': userId, -'phone': phone, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } -} \ No newline at end of file + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/account'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({ + required String email, + required String password, + }) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({ + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaType.fromMap(res.data); + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({ + required enums.AuthenticatorType type, + required String otp, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {'otp': otp}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({ + required enums.AuthenticationFactor factor, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = {'factor': factor.value}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaChallenge.fromMap(res.data); + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({ + required String challengeId, + required String otp, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + 'challengeId': challengeId, + 'otp': otp, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({ + required String password, + String? oldPassword, + }) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + 'password': password, + 'oldPassword': oldPassword, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({ + required String phone, + required String password, + }) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + 'phone': phone, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({ + required String email, + required String url, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = {'email': email, 'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({ + required String userId, + required String secret, + required String password, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + 'userId': userId, + 'secret': secret, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({ + required String email, + required String password, + }) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({ + required String userId, + required String email, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({ + required String userId, + required String email, + String? url, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'url': url, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({ + required enums.OAuthProvider provider, + String? success, + String? failure, + List? scopes, + }) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( + '{provider}', + provider.value, + ); + + final Map params = { + 'success': success, + 'failure': failure, + 'scopes': scopes, + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add( + Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), + ); + } + } else if (value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri( + scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&'), + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({ + required String userId, + required String phone, + }) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = {'userId': userId, 'phone': phone}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } +} diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 381146d4..8033f1cd 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,187 +3,253 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({required String url, int? width, int? height}) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, -'width': width, -'height': height, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({String? name, int? width, int? height, String? background}) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, -'width': width, -'height': height, -'background': background, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({required String text, int? size, int? margin, bool? download}) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, -'size': size, -'margin': margin, -'download': download, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({ + required enums.Browser code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({ + required enums.CreditCard code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({ + required enums.Flag code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({ + required String url, + int? width, + int? height, + }) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, + 'width': width, + 'height': height, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({ + String? name, + int? width, + int? height, + String? background, + }) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, + 'width': width, + 'height': height, + 'background': background, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({ + required String text, + int? size, + int? margin, + bool? download, + }) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, + 'size': size, + 'margin': margin, + 'download': download, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 49e2bbc2..4b26a220 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1095 +3,1439 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DatabaseList.fromMap(res.data); - - } - - /// Create a new Database. - /// - Future create({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - - 'databaseId': databaseId, -'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Update a database by its unique ID. - Future update({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({required String databaseId, List? queries, String? search}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CollectionList.fromMap(res.data); - - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'collectionId': collectionId, -'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Update a collection by its unique ID. - Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List attributes in the collection. - Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeList.fromMap(res.data); - - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Create an email attribute. - /// - Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'elements': elements, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'elements': elements, -'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Create IP address attribute. - /// - Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'relatedCollectionId': relatedCollectionId, -'type': type.value, -'twoWay': twoWay, -'key': key, -'twoWayKey': twoWayKey, -'onDelete': onDelete?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Create a string attribute. - /// - Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'size': size, -'required': xrequired, -'default': xdefault, -'array': array, -'encrypt': encrypt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'size': size, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Get attribute by ID. - Future getAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Deletes an attribute. - Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'onDelete': onDelete?.value, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Create a new Document. 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. - Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documentId': documentId, -'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// 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. - Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - /// - Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'data': data, -'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Bulk delete documents using queries, if no queries are passed then all - /// documents are deleted. - Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - 'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Delete a document by its unique ID. - Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List indexes in the collection. - Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IndexList.fromMap(res.data); - - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'type': type.value, -'attributes': attributes, -'orders': orders, -'lengths': lengths, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Get index by ID. - Future getIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Delete an index. - Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DatabaseList.fromMap(res.data); + } + + /// Create a new Database. + /// + Future create({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'databaseId': databaseId, + 'name': name, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Update a database by its unique ID. + Future update({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {'name': name, 'enabled': enabled}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({ + required String databaseId, + List? queries, + String? search, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.CollectionList.fromMap(res.data); + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'collectionId': collectionId, + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Update a collection by its unique ID. + Future updateCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List attributes in the collection. + Future listAttributes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeList.fromMap(res.data); + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + bool? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required bool? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Create an email attribute. + /// + Future createEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + double? min, + double? max, + double? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required double? xdefault, + double? min, + double? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + int? min, + int? max, + int? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required int? xdefault, + int? min, + int? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Create IP address attribute. + /// + Future createIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String relatedCollectionId, + required enums.RelationshipType type, + bool? twoWay, + String? key, + String? twoWayKey, + enums.RelationMutate? onDelete, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'relatedCollectionId': relatedCollectionId, + 'type': type.value, + 'twoWay': twoWay, + 'key': key, + 'twoWayKey': twoWayKey, + 'onDelete': onDelete?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Create a string attribute. + /// + Future createStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required int size, + required bool xrequired, + String? xdefault, + bool? array, + bool? encrypt, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'size': size, + 'required': xrequired, + 'default': xdefault, + 'array': array, + 'encrypt': encrypt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + int? size, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'size': size, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Get attribute by ID. + Future getAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Deletes an attribute. + Future deleteAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String key, + enums.RelationMutate? onDelete, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'onDelete': onDelete?.value, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Create a new Document. 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. + Future createDocument({ + required String databaseId, + required String collectionId, + required String documentId, + required Map data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'documentId': documentId, + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// 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. + Future createDocuments({ + required String databaseId, + required String collectionId, + required List documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + /// + Future upsertDocuments({ + required String databaseId, + required String collectionId, + List? documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + Future updateDocuments({ + required String databaseId, + required String collectionId, + Map? data, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'data': data, 'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({ + required String databaseId, + required String collectionId, + required String documentId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({ + required String databaseId, + required String collectionId, + required String documentId, + Map? data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Delete a document by its unique ID. + Future deleteDocument({ + required String databaseId, + required String collectionId, + required String documentId, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List indexes in the collection. + Future listIndexes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IndexList.fromMap(res.data); + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({ + required String databaseId, + required String collectionId, + required String key, + required enums.IndexType type, + required List attributes, + List? orders, + List? lengths, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'type': type.value, + 'attributes': attributes, + 'orders': orders, + 'lengths': lengths, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Get index by ID. + Future getIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Delete an index. + Future deleteIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/functions.dart b/lib/services/functions.dart index ad261abf..e86f1afe 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,623 +3,768 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FunctionList.fromMap(res.data); - - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - - 'functionId': functionId, -'name': name, -'runtime': runtime.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.RuntimeList.fromMap(res.data); - - } - - /// List allowed function specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Update function by its unique ID. - Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'name': name, -'runtime': runtime?.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the function active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your function. - Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all the function's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({required String functionId, List? queries, String? search}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'entrypoint': entrypoint, -'commands': commands, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { - final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, -'buildId': buildId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a function is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a function deployment by its unique ID. - Future getDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({required String functionId, List? queries}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'body': body, -'async': xasync, -'path': path, -'method': method?.value, -'headers': headers, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Get a function execution log by its unique ID. - Future getExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a function execution by its unique ID. - Future deleteExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific function. - Future listVariables({required String functionId}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FunctionList.fromMap(res.data); + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({ + required String functionId, + required String name, + required enums.Runtime runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'functionId': functionId, + 'name': name, + 'runtime': runtime.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.RuntimeList.fromMap(res.data); + } + + /// List allowed function specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Update function by its unique ID. + Future update({ + required String functionId, + required String name, + enums.Runtime? runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'name': name, + 'runtime': runtime?.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the function active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your function. + Future updateFunctionDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all the function's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({ + required String functionId, + List? queries, + String? search, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({ + required String functionId, + required InputFile code, + required bool activate, + String? entrypoint, + String? commands, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'entrypoint': entrypoint, + 'commands': commands, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String functionId, + required String deploymentId, + String? buildId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'deploymentId': deploymentId, + 'buildId': buildId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String functionId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/template' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String functionId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a function deployment by its unique ID. + Future getDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String functionId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/download' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/status' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({ + required String functionId, + List? queries, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({ + required String functionId, + String? body, + bool? xasync, + String? path, + enums.ExecutionMethod? method, + Map? headers, + String? scheduledAt, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'body': body, + 'async': xasync, + 'path': path, + 'method': method?.value, + 'headers': headers, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Get a function execution log by its unique ID. + Future getExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a function execution by its unique ID. + Future deleteExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific function. + Future listVariables({ + required String functionId, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({ + required String functionId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String functionId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 92cc591f..18eb54f1 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,49 +3,47 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/health.dart b/lib/services/health.dart index 3bfeba6b..5250c91d 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,459 +3,434 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthAntivirus.fromMap(res.data); + } - return models.HealthAntivirus.fromMap(res.data); + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - } + final Map apiParams = {}; - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthStatus.fromMap(res.data); + final Map apiParams = {'domain': domain}; - } + final Map apiHeaders = {}; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'domain': domain, + return models.HealthCertificate.fromMap(res.data); + } - - }; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthCertificate.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthStatus.fromMap(res.data); + } - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthStatus.fromMap(res.data); + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({ + String? name, + int? threshold, + }) async { + final String apiPath = '/health/queue/databases'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = { + 'name': name, + 'threshold': threshold, + }; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; + + final Map apiParams = {'threshold': threshold}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.HealthQueue.fromMap(res.data); + } + + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({ + required enums.Name name, + int? threshold, + }) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll( + '{name}', + name.value, + ); - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } + + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({String? name, int? threshold}) async { - final String apiPath = '/health/queue/databases'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'name': name, -'threshold': threshold, + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthQueue.fromMap(res.data); + } - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthQueue.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({required enums.Name name, int? threshold}) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, + return models.HealthQueue.fromMap(res.data); + } - - }; + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - final Map apiHeaders = { - - }; + final Map apiParams = {'threshold': threshold}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthQueue.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthQueue.fromMap(res.data); + } - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; - final Map apiParams = { - 'threshold': threshold, + final Map apiParams = {'threshold': threshold}; - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthQueue.fromMap(res.data); + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {'threshold': threshold}; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final Map apiParams = {}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthTime.fromMap(res.data); - - } -} \ No newline at end of file + return models.HealthTime.fromMap(res.data); + } +} diff --git a/lib/services/locale.dart b/lib/services/locale.dart index b75b4711..4d3cc3e0 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,170 +3,162 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.Locale.fromMap(res.data); + return models.Locale.fromMap(res.data); + } - } + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.LocaleCodeList.fromMap(res.data); + } - return models.LocaleCodeList.fromMap(res.data); + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - } + final Map apiParams = {}; - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.ContinentList.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.ContinentList.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - - - }; + return models.CountryList.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {}; - return models.CountryList.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + return models.CountryList.fromMap(res.data); + } - final Map apiParams = { - - - }; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.CountryList.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.PhoneList.fromMap(res.data); + } - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.PhoneList.fromMap(res.data); + return models.CurrencyList.fromMap(res.data); + } - } + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CurrencyList.fromMap(res.data); - - } - - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LanguageList.fromMap(res.data); - - } -} \ No newline at end of file + return models.LanguageList.fromMap(res.data); + } +} diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index 710bb6d4..afe3ee86 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1158 +3,1476 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({List? queries, String? search}) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MessageList.fromMap(res.data); - - } - - /// Create a new email message. - Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - - 'messageId': messageId, -'subject': subject, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'cc': cc, -'bcc': bcc, -'attachments': attachments, -'draft': draft, -'html': html, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'subject': subject, -'content': content, -'draft': draft, -'html': html, -'cc': cc, -'bcc': bcc, -'scheduledAt': scheduledAt, -'attachments': attachments, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new push notification. - Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - - 'messageId': messageId, -'title': title, -'body': body, -'topics': topics, -'users': users, -'targets': targets, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'title': title, -'body': body, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new SMS message. - Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - - 'messageId': messageId, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'content': content, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of the targets associated with a message. - Future listTargets({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({List? queries, String? search}) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ProviderList.fromMap(res.data); - - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'serviceAccountJSON': serviceAccountJSON, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'serviceAccountJSON': serviceAccountJSON, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'enabled': enabled, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new SMTP provider. - Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Telesign provider. - Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'customerId': customerId, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'customerId': customerId, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'username': username, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'username': username, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Twilio provider. - Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'accountSid': accountSid, -'authToken': authToken, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { - final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'accountSid': accountSid, -'authToken': authToken, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Vonage provider. - Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'apiKey': apiKey, -'apiSecret': apiSecret, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { - final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'apiSecret': apiSecret, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({required String providerId, List? queries}) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({required String subscriberId, List? queries}) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({List? queries, String? search}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TopicList.fromMap(res.data); - - } - - /// Create a new topic. - Future createTopic({required String topicId, required String name, List? subscribe}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - - 'topicId': topicId, -'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({required String topicId, String? name, List? subscribe}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({required String topicId, List? queries}) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({required String topicId, List? queries, String? search}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SubscriberList.fromMap(res.data); - - } - - /// Create a new subscriber. - Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'subscriberId': subscriberId, -'targetId': targetId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MessageList.fromMap(res.data); + } + + /// Create a new email message. + Future createEmail({ + required String messageId, + required String subject, + required String content, + List? topics, + List? users, + List? targets, + List? cc, + List? bcc, + List? attachments, + bool? draft, + bool? html, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + 'messageId': messageId, + 'subject': subject, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'cc': cc, + 'bcc': bcc, + 'attachments': attachments, + 'draft': draft, + 'html': html, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({ + required String messageId, + List? topics, + List? users, + List? targets, + String? subject, + String? content, + bool? draft, + bool? html, + List? cc, + List? bcc, + String? scheduledAt, + List? attachments, + }) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'subject': subject, + 'content': content, + 'draft': draft, + 'html': html, + 'cc': cc, + 'bcc': bcc, + 'scheduledAt': scheduledAt, + 'attachments': attachments, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new push notification. + Future createPush({ + required String messageId, + String? title, + String? body, + List? topics, + List? users, + List? targets, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + 'messageId': messageId, + 'title': title, + 'body': body, + 'topics': topics, + 'users': users, + 'targets': targets, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({ + required String messageId, + List? topics, + List? users, + List? targets, + String? title, + String? body, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'title': title, + 'body': body, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new SMS message. + Future createSms({ + required String messageId, + required String content, + List? topics, + List? users, + List? targets, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + 'messageId': messageId, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({ + required String messageId, + List? topics, + List? users, + List? targets, + String? content, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'content': content, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of the targets associated with a message. + Future listTargets({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ProviderList.fromMap(res.data); + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({ + required String providerId, + required String name, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({ + required String providerId, + String? name, + bool? enabled, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + }) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({ + required String providerId, + required String name, + Map? serviceAccountJSON, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'serviceAccountJSON': serviceAccountJSON, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({ + required String providerId, + String? name, + bool? enabled, + Map? serviceAccountJSON, + }) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'serviceAccountJSON': serviceAccountJSON, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({ + required String providerId, + required String name, + String? apiKey, + String? domain, + bool? isEuRegion, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({ + required String providerId, + String? name, + String? apiKey, + String? domain, + bool? isEuRegion, + bool? enabled, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'enabled': enabled, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({ + required String providerId, + required String name, + String? templateId, + String? senderId, + String? authKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({ + required String providerId, + String? name, + bool? enabled, + String? templateId, + String? senderId, + String? authKey, + }) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({ + required String providerId, + required String name, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new SMTP provider. + Future createSmtpProvider({ + required String providerId, + required String name, + required String host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({ + required String providerId, + String? name, + String? host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Telesign provider. + Future createTelesignProvider({ + required String providerId, + required String name, + String? from, + String? customerId, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'customerId': customerId, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({ + required String providerId, + String? name, + bool? enabled, + String? customerId, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/telesign/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'customerId': customerId, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({ + required String providerId, + required String name, + String? from, + String? username, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'username': username, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({ + required String providerId, + String? name, + bool? enabled, + String? username, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'username': username, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Twilio provider. + Future createTwilioProvider({ + required String providerId, + required String name, + String? from, + String? accountSid, + String? authToken, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'accountSid': accountSid, + 'authToken': authToken, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({ + required String providerId, + String? name, + bool? enabled, + String? accountSid, + String? authToken, + String? from, + }) async { + final String apiPath = '/messaging/providers/twilio/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'accountSid': accountSid, + 'authToken': authToken, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Vonage provider. + Future createVonageProvider({ + required String providerId, + required String name, + String? from, + String? apiKey, + String? apiSecret, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? apiSecret, + String? from, + }) async { + final String apiPath = '/messaging/providers/vonage/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({ + required String providerId, + List? queries, + }) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({ + required String subscriberId, + List? queries, + }) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs' + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TopicList.fromMap(res.data); + } + + /// Create a new topic. + Future createTopic({ + required String topicId, + required String name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'topicId': topicId, + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({ + required String topicId, + String? name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({ + required String topicId, + List? queries, + }) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({ + required String topicId, + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SubscriberList.fromMap(res.data); + } + + /// Create a new subscriber. + Future createSubscriber({ + required String topicId, + required String subscriberId, + required String targetId, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'subscriberId': subscriberId, + 'targetId': targetId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/sites.dart b/lib/services/sites.dart index 90511473..d89f2192 100644 --- a/lib/services/sites.dart +++ b/lib/services/sites.dart @@ -2,585 +2,703 @@ part of '../dart_appwrite.dart'; /// The Sites Service allows you view, create and manage your web applications. class Sites extends Service { - Sites(super.client); - - /// Get a list of all the project's sites. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SiteList.fromMap(res.data); - - } - - /// Create a new site. - Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - - 'siteId': siteId, -'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime.value, -'adapter': adapter?.value, -'installationId': installationId, -'fallbackFile': fallbackFile, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all frameworks that are currently available on the server - /// instance. - Future listFrameworks() async { - final String apiPath = '/sites/frameworks'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FrameworkList.fromMap(res.data); - - } - - /// List allowed site specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/sites/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a site by its unique ID. - Future get({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Update site by its unique ID. - Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime?.value, -'adapter': adapter?.value, -'fallbackFile': fallbackFile, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Delete a site by its unique ID. - Future delete({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the site active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your site. - Future updateSiteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all the site's code deployments. You can use the query params - /// to filter your results. - Future listDeployments({required String siteId, List? queries, String? search}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// 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. - Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a site is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a site deployment by its unique ID. - Future getDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a site deployment by its unique ID. - Future deleteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all site logs. You can use the query params to filter your - /// results. - Future listLogs({required String siteId, List? queries}) async { - final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Get a site request log by its unique ID. - Future getLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a site log by its unique ID. - Future deleteLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific site. - Future listVariables({required String siteId}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new site variable. These variables can be accessed during build - /// and runtime (server-side rendering) as environment variables. - Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SiteList.fromMap(res.data); + } + + /// Create a new site. + Future create({ + required String siteId, + required String name, + required enums.Framework framework, + required enums.BuildRuntime buildRuntime, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.Adapter? adapter, + String? installationId, + String? fallbackFile, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'siteId': siteId, + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime.value, + 'adapter': adapter?.value, + 'installationId': installationId, + 'fallbackFile': fallbackFile, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FrameworkList.fromMap(res.data); + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Update site by its unique ID. + Future update({ + required String siteId, + required String name, + required enums.Framework framework, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.BuildRuntime? buildRuntime, + enums.Adapter? adapter, + String? fallbackFile, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime?.value, + 'adapter': adapter?.value, + 'fallbackFile': fallbackFile, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({ + required String siteId, + List? queries, + String? search, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// 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. + Future createDeployment({ + required String siteId, + required InputFile code, + required bool activate, + String? installCommand, + String? buildCommand, + String? outputDirectory, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String siteId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String siteId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a site deployment by its unique ID. + Future getDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String siteId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({ + required String siteId, + List? queries, + }) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Get a site request log by its unique ID. + Future getLog({ + required String siteId, + required String logId, + }) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({ + required String siteId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String siteId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/storage.dart b/lib/services/storage.dart index 9165e91b..ee630883 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,329 +2,421 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({List? queries, String? search}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.BucketList.fromMap(res.data); - - } - - /// Create a new storage bucket. - Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - - 'bucketId': bucketId, -'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({required String bucketId, List? queries, String? search}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FileList.fromMap(res.data); - - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'fileId': fileId, -'file': file, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a file 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. - Future getFileDownload({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, -'height': height, -'gravity': gravity?.value, -'quality': quality, -'borderWidth': borderWidth, -'borderColor': borderColor, -'borderRadius': borderRadius, -'opacity': opacity, -'rotation': rotation, -'background': background, -'output': output?.value, -'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({ + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.BucketList.fromMap(res.data); + } + + /// Create a new storage bucket. + Future createBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'bucketId': bucketId, + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({ + required String bucketId, + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FileList.fromMap(res.data); + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({ + required String bucketId, + required String fileId, + required InputFile file, + List? permissions, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'fileId': fileId, + 'file': file, + 'permissions': permissions, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({ + required String bucketId, + required String fileId, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({ + required String bucketId, + required String fileId, + String? name, + List? permissions, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a file 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. + Future getFileDownload({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({ + required String bucketId, + required String fileId, + int? width, + int? height, + enums.ImageGravity? gravity, + int? quality, + int? borderWidth, + String? borderColor, + int? borderRadius, + double? opacity, + int? rotation, + String? background, + enums.ImageFormat? output, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, + 'height': height, + 'gravity': gravity?.value, + 'quality': quality, + 'borderWidth': borderWidth, + 'borderColor': borderColor, + 'borderRadius': borderRadius, + 'opacity': opacity, + 'rotation': rotation, + 'background': background, + 'output': output?.value, + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 2b492f27..5fd59641 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,321 +3,356 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TeamList.fromMap(res.data); - - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({required String teamId, required String name, List? roles}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - - 'teamId': teamId, -'name': name, -'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Update the team's name by its unique ID. - Future updateName({required String teamId, required String name}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({required String teamId, List? queries, String? search}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'email': email, -'userId': userId, -'phone': phone, -'roles': roles, -'url': url, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({required String teamId, required String membershipId, required List roles}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({required String teamId, required Map prefs}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } -} \ No newline at end of file + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TeamList.fromMap(res.data); + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({ + required String teamId, + required String name, + List? roles, + }) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'teamId': teamId, + 'name': name, + 'roles': roles, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Update the team's name by its unique ID. + Future updateName({ + required String teamId, + required String name, + }) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({ + required String teamId, + List? queries, + String? search, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({ + required String teamId, + required List roles, + String? email, + String? userId, + String? phone, + String? url, + String? name, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'email': email, + 'userId': userId, + 'phone': phone, + 'roles': roles, + 'url': url, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({ + required String teamId, + required String membershipId, + required List roles, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'roles': roles}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({ + required String teamId, + required String membershipId, + required String userId, + required String secret, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({ + required String teamId, + required Map prefs, + }) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } +} diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart index a9b8f78a..0224b0a5 100644 --- a/lib/services/tokens.dart +++ b/lib/services/tokens.dart @@ -1,109 +1,113 @@ part of '../dart_appwrite.dart'; class Tokens extends Service { - Tokens(super.client); - - /// List all the tokens created for a specific file or bucket. You can use the - /// query params to filter your results. - Future list({required String bucketId, required String fileId, List? queries}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceTokenList.fromMap(res.data); - - } - - /// Create a new token. A token is linked to a file. Token can be passed as a - /// header or request get parameter. - Future createFileToken({required String bucketId, required String fileId, String? expire}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Get a token by its unique ID. - Future get({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Update a token by its unique ID. Use this endpoint to update a token's - /// expiry date. - Future update({required String tokenId, String? expire}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Delete a token by its unique ID. - Future delete({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({ + required String bucketId, + required String fileId, + List? queries, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceTokenList.fromMap(res.data); + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({ + required String bucketId, + required String fileId, + String? expire, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({ + required String tokenId, + String? expire, + }) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/users.dart b/lib/services/users.dart index 765ec3e6..c98182b7 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,962 +2,1107 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.UserList.fromMap(res.data); - - } - - /// Create a new user. - Future create({required String userId, String? email, String? phone, String? password, String? name}) async { - final String apiPath = '/users'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phone': phone, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get identities for all users. - Future listIdentities({List? queries, String? search}) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordCpu': passwordCpu, -'passwordMemory': passwordMemory, -'passwordParallel': passwordParallel, -'passwordLength': passwordLength, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordSaltSeparator': passwordSaltSeparator, -'passwordSignerKey': passwordSignerKey, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordVersion': passwordVersion?.value, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user email by its unique ID. - Future updateEmail({required String userId, required String email}) async { - final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'email': email, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({required String userId, String? sessionId, int? duration}) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'sessionId': sessionId, -'duration': duration, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({required String userId, required List labels}) async { - final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'labels': labels, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the user membership list by its unique ID. - Future listMemberships({required String userId, List? queries, String? search}) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Enable or disable MFA on a user account. - Future updateMfa({required String userId, required bool mfa}) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update the user name by its unique ID. - Future updateName({required String userId, required String name}) async { - final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user password by its unique ID. - Future updatePassword({required String userId, required String password}) async { - final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone by its unique ID. - Future updatePhone({required String userId, required String number}) async { - final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'number': number, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({required String userId, required Map prefs}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({required String userId, required String sessionId}) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({required String userId, required bool status}) async { - final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'status': status, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// List the messaging targets that are associated with a user. - Future listTargets({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Create a messaging target. - Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'targetId': targetId, -'providerType': providerType.value, -'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Get a user's push notification target by ID. - Future getTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Update a messaging target. - Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - 'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Delete a messaging target. - Future deleteTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({required String userId, int? length, int? expire}) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'length': length, -'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({required String userId, required bool emailVerification}) async { - final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'emailVerification': emailVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'phoneVerification': phoneVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } -} \ No newline at end of file + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.UserList.fromMap(res.data); + } + + /// Create a new user. + Future create({ + required String userId, + String? email, + String? phone, + String? password, + String? name, + }) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phone': phone, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get identities for all users. + Future listIdentities({ + List? queries, + String? search, + }) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required int passwordCpu, + required int passwordMemory, + required int passwordParallel, + required int passwordLength, + String? name, + }) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordCpu': passwordCpu, + 'passwordMemory': passwordMemory, + 'passwordParallel': passwordParallel, + 'passwordLength': passwordLength, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required String passwordSaltSeparator, + required String passwordSignerKey, + String? name, + }) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordSaltSeparator': passwordSaltSeparator, + 'passwordSignerKey': passwordSignerKey, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({ + required String userId, + required String email, + required String password, + enums.PasswordHash? passwordVersion, + String? name, + }) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordVersion': passwordVersion?.value, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user email by its unique ID. + Future updateEmail({ + required String userId, + required String email, + }) async { + final String apiPath = '/users/{userId}/email'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'email': email}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({ + required String userId, + String? sessionId, + int? duration, + }) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'sessionId': sessionId, + 'duration': duration, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({ + required String userId, + required List labels, + }) async { + final String apiPath = '/users/{userId}/labels'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'labels': labels}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/logs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the user membership list by its unique ID. + Future listMemberships({ + required String userId, + List? queries, + String? search, + }) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Enable or disable MFA on a user account. + Future updateMfa({ + required String userId, + required bool mfa, + }) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({ + required String userId, + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}' + .replaceAll('{userId}', userId) + .replaceAll('{type}', type.value); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update the user name by its unique ID. + Future updateName({ + required String userId, + required String name, + }) async { + final String apiPath = '/users/{userId}/name'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user password by its unique ID. + Future updatePassword({ + required String userId, + required String password, + }) async { + final String apiPath = '/users/{userId}/password'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'password': password}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone by its unique ID. + Future updatePhone({ + required String userId, + required String number, + }) async { + final String apiPath = '/users/{userId}/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'number': number}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({ + required String userId, + required Map prefs, + }) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({ + required String userId, + required String sessionId, + }) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}' + .replaceAll('{userId}', userId) + .replaceAll('{sessionId}', sessionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({ + required String userId, + required bool status, + }) async { + final String apiPath = '/users/{userId}/status'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'status': status}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// List the messaging targets that are associated with a user. + Future listTargets({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Create a messaging target. + Future createTarget({ + required String userId, + required String targetId, + required enums.MessagingProviderType providerType, + required String identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'targetId': targetId, + 'providerType': providerType.value, + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Get a user's push notification target by ID. + Future getTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Update a messaging target. + Future updateTarget({ + required String userId, + required String targetId, + String? identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = { + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Delete a messaging target. + Future deleteTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({ + required String userId, + int? length, + int? expire, + }) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'length': length, 'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({ + required String userId, + required bool emailVerification, + }) async { + final String apiPath = '/users/{userId}/verification'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'emailVerification': emailVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({ + required String userId, + required bool phoneVerification, + }) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'phoneVerification': phoneVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } +} diff --git a/lib/src/client.dart b/lib/src/client.dart index 2fc990a5..d82d623a 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client( - {String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false}) => - createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client({ + String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false, + }) => createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,7 +81,8 @@ abstract class Client { }); /// Send the API request. - Future call(HttpMethod method, { + Future call( + HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index cd82d264..08d93b85 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,21 +2,25 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); + /// Your secret API key @override ClientBase setKey(value); + /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); + /// The user session to authenticate with @override ClientBase setSession(value); + /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index 2528cc1a..1ba611e8 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,14 +9,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => +ClientBase createClient({required String endPoint, required bool selfSigned}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -34,59 +31,66 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '15.2.0', - 'X-Appwrite-Response-Format' : '1.7.0', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -135,7 +139,11 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); return call( HttpMethod.post, path: path, @@ -162,12 +170,19 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 29991ba7..74232a8d 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,17 +10,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => - ClientIO( - endPoint: endPoint, - selfSigned: selfSigned, - ); +ClientBase createClient({required String endPoint, required bool selfSigned}) => + ClientIO(endPoint: endPoint, selfSigned: selfSigned); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -32,9 +26,10 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = + HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -43,60 +38,68 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '15.2.0', - 'user-agent' : 'AppwriteDartSDK/15.2.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format' : '1.7.0', + 'user-agent': + 'AppwriteDartSDK/15.2.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -151,11 +154,16 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, file.path!, - filename: file.filename); + paramName, + file.path!, + filename: file.filename, + ); } else { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, - filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); } return call( HttpMethod.post, @@ -194,12 +202,19 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -244,10 +259,7 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse( - res, - responseType: responseType, - ); + return prepareResponse(res, responseType: responseType); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index 658b79b6..310bc3ca 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest) - .fields - .addAll({"$key[$i]": v.toString()}); + (request as http.MultipartRequest).fields.addAll({ + "$key[$i]": v.toString(), + }); }); } else { - (request as http.MultipartRequest) - .fields - .addAll({key: value.toString()}); + (request as http.MultipartRequest).fields.addAll({ + key: value.toString(), + }); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value){ + params = params.map((key, value) { if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,12 +51,13 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port, + ); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); @@ -66,7 +67,9 @@ mixin ClientMixin { headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); } if (headers['X-Forwarded-User-Agent'] != null) { - headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); + headers['X-Forwarded-User-Agent'] = Uri.encodeFull( + headers['X-Forwarded-User-Agent']!, + ); } request.headers.addAll(headers); @@ -113,18 +116,26 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse(http.StreamedResponse streamedResponse) async { - if(streamedResponse.statusCode == 204) { - return http.Response('', - streamedResponse.statusCode, - headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse( + http.StreamedResponse streamedResponse, + ) async { + if (streamedResponse.statusCode == 204) { + return http.Response( + '', + streamedResponse.statusCode, + headers: streamedResponse.headers.map( + (k, v) => + k.toLowerCase() == 'content-type' + ? MapEntry(k, 'text/plain') + : MapEntry(k, v), + ), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 95e9d217..2cb7727e 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,4 +3,5 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.'); + 'Cannot create a client without dart:html or dart:io.', + ); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 6566f2e1..08fd6068 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes + bytes, } diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart index 053080ef..d1af0722 100644 --- a/lib/src/enums/adapter.dart +++ b/lib/src/enums/adapter.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum Adapter { - static(value: 'static'), - ssr(value: 'ssr'); + static(value: 'static'), + ssr(value: 'ssr'); - const Adapter({ - required this.value - }); + const Adapter({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 00d12830..1d5271eb 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({ - required this.value - }); + const AuthenticationFactor({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index 10460393..c1fe8584 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,13 +1,11 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({ - required this.value - }); + const AuthenticatorType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 386fa11d..949f4c47 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({ - required this.value - }); + const Browser({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart index fdccfcbb..88ffbfa6 100644 --- a/lib/src/enums/build_runtime.dart +++ b/lib/src/enums/build_runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum BuildRuntime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const BuildRuntime({ - required this.value - }); + const BuildRuntime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 209acfb8..768930d9 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({ - required this.value - }); + const Compression({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index cd45b6a1..1bae5c8a 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,29 +1,27 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({ - required this.value - }); + const CreditCard({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart index 782b30c7..1788f892 100644 --- a/lib/src/enums/deployment_download_type.dart +++ b/lib/src/enums/deployment_download_type.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum DeploymentDownloadType { - source(value: 'source'), - output(value: 'output'); + source(value: 'source'), + output(value: 'output'); - const DeploymentDownloadType({ - required this.value - }); + const DeploymentDownloadType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 7d2d7016..42954430 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({ - required this.value - }); + const ExecutionMethod({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index 27c25cac..a44cb81d 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,207 +1,205 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({ - required this.value - }); + const Flag({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart index af5ebaad..e20f48c6 100644 --- a/lib/src/enums/framework.dart +++ b/lib/src/enums/framework.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Framework { - analog(value: 'analog'), - angular(value: 'angular'), - nextjs(value: 'nextjs'), - react(value: 'react'), - nuxt(value: 'nuxt'), - vue(value: 'vue'), - sveltekit(value: 'sveltekit'), - astro(value: 'astro'), - remix(value: 'remix'), - lynx(value: 'lynx'), - flutter(value: 'flutter'), - reactNative(value: 'react-native'), - vite(value: 'vite'), - other(value: 'other'); + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); - const Framework({ - required this.value - }); + const Framework({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index dbf6825e..120c93f4 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({ - required this.value - }); + const ImageFormat({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 79bc4d62..88029044 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,21 +1,19 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({ - required this.value - }); + const ImageGravity({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index 8d86530d..b101d35f 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({ - required this.value - }); + const IndexType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index 375913e8..a07e6f76 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({ - required this.value - }); + const MessagePriority({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index a6859648..c69bf01e 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({ - required this.value - }); + const MessagingProviderType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 613bf5f1..74823feb 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,24 +1,22 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({ - required this.value - }); + const Name({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 076c1c50..383e45b1 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,52 +1,50 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({ - required this.value - }); + const OAuthProvider({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 510ee260..9d98c26a 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,23 +1,21 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({ - required this.value - }); + const PasswordHash({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index 9f4c1a85..b215a8fa 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({ - required this.value - }); + const RelationMutate({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 301bc61d..30efc944 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({ - required this.value - }); + const RelationshipType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index a0ff38c8..fec56a9b 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const Runtime({ - required this.value - }); + const Runtime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index 6c880ed6..cb6cee26 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({ - required this.value - }); + const SmtpEncryption({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart index 0bf8e2ad..f01fcb01 100644 --- a/lib/src/enums/vcs_deployment_type.dart +++ b/lib/src/enums/vcs_deployment_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum VCSDeploymentType { - branch(value: 'branch'), - commit(value: 'commit'), - tag(value: 'tag'); + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); - const VCSDeploymentType({ - required this.value - }); + const VCSDeploymentType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 93b6ee3d..82229daa 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index f174d569..4145f701 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index c9f67200..4e901476 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({ - required this.type, - }); + AlgoBcrypt({required this.type}); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt( - type: map['type'].toString(), - ); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 2fabb416..35c7b767 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({ - required this.type, - }); + AlgoMd5({required this.type}); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5( - type: map['type'].toString(), - ); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index fdcee07a..7d27adba 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({ - required this.type, - }); + AlgoPhpass({required this.type}); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass( - type: map['type'].toString(), - ); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index 120723df..fec6f65a 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 504b5f8f..0e80700f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index 5f3e1654..bae6618f 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({ - required this.type, - }); + AlgoSha({required this.type}); - factory AlgoSha.fromMap(Map map) { - return AlgoSha( - type: map['type'].toString(), - ); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 20dd7189..0ca54691 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index a5b27b4f..1df01f19 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 96ce554b..21f8e9a3 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index a4953a0e..298c181a 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index 03ba94c7..c6eecadd 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 8a5aa89d..1ef48332 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index d17f414a..8c8fcb73 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index 4098a5a1..c5fa6adc 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({ - required this.total, - required this.attributes, - }); + AttributeList({required this.total, required this.attributes}); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return { - "total": total, - "attributes": attributes, - }; - } + Map toMap() { + return {"total": total, "attributes": attributes}; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 050cbe14..903c6290 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index 89de3a57..d32b6829 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index 0c3ddf9e..f0bc295e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index 3bb374be..b8fb5e48 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 366d80f9..224c910d 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({ - required this.total, - required this.buckets, - }); + BucketList({required this.total, required this.buckets}); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "buckets": buckets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index c55110cf..72de429d 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index aad4d44a..49785e2b 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({ - required this.total, - required this.collections, - }); + CollectionList({required this.total, required this.collections}); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from( + map['collections'].map((p) => Collection.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 1a9c5038..7318b7ad 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({ - required this.name, - required this.code, - }); + Continent({required this.name, required this.code}); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 7a1eb84c..2c605d3b 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({ - required this.total, - required this.continents, - }); + ContinentList({required this.total, required this.continents}); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from( + map['continents'].map((p) => Continent.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index 565b1d66..c52b50f2 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,28 +2,19 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({ - required this.name, - required this.code, - }); + Country({required this.name, required this.code}); - factory Country.fromMap(Map map) { - return Country( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Country.fromMap(Map map) { + return Country(name: map['name'].toString(), code: map['code'].toString()); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index e0b8f29f..6ef8ec42 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({ - required this.total, - required this.countries, - }); + CountryList({required this.total, required this.countries}); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from(map['countries'].map((p) => Country.fromMap(p))), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from( + map['countries'].map((p) => Country.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index deafffe3..27eef0c1 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index f67049ae..acb515e3 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({ - required this.total, - required this.currencies, - }); + CurrencyList({required this.total, required this.currencies}); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from( + map['currencies'].map((p) => Currency.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 09ee2aae..298a46a3 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 03b959db..5b6df8d4 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({ - required this.total, - required this.databases, - }); + DatabaseList({required this.total, required this.databases}); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from(map['databases'].map((p) => Database.fromMap(p))), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from( + map['databases'].map((p) => Database.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index ecf7e791..448c62c7 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,178 +2,178 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; + /// Deployment creation date in ISO 8601 format. + final String $createdAt; - /// Deployment update date in ISO 8601 format. - final String $updatedAt; + /// Deployment update date in ISO 8601 format. + final String $updatedAt; - /// Type of deployment. - final String type; + /// Type of deployment. + final String type; - /// Resource ID. - final String resourceId; + /// Resource ID. + final String resourceId; - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int sourceSize; - - /// The build output size in bytes. - final int buildSize; - - /// The total size in bytes (source and build output). - final int totalSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// Screenshot with light theme preference file ID. - final String screenshotLight; - - /// Screenshot with dark theme preference file ID. - final String screenshotDark; - - /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildDuration; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.sourceSize, - required this.buildSize, - required this.totalSize, - required this.buildId, - required this.activate, - required this.screenshotLight, - required this.screenshotDark, - required this.status, - required this.buildLogs, - required this.buildDuration, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - sourceSize: map['sourceSize'], - buildSize: map['buildSize'], - totalSize: map['totalSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - screenshotLight: map['screenshotLight'].toString(), - screenshotDark: map['screenshotDark'].toString(), - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildDuration: map['buildDuration'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "sourceSize": sourceSize, - "buildSize": buildSize, - "totalSize": totalSize, - "buildId": buildId, - "activate": activate, - "screenshotLight": screenshotLight, - "screenshotDark": screenshotDark, - "status": status, - "buildLogs": buildLogs, - "buildDuration": buildDuration, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int sourceSize; + + /// The build output size in bytes. + final int buildSize; + + /// The total size in bytes (source and build output). + final int totalSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildDuration; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.sourceSize, + required this.buildSize, + required this.totalSize, + required this.buildId, + required this.activate, + required this.screenshotLight, + required this.screenshotDark, + required this.status, + required this.buildLogs, + required this.buildDuration, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + sourceSize: map['sourceSize'], + buildSize: map['buildSize'], + totalSize: map['totalSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildDuration: map['buildDuration'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "sourceSize": sourceSize, + "buildSize": buildSize, + "totalSize": totalSize, + "buildId": buildId, + "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, + "status": status, + "buildLogs": buildLogs, + "buildDuration": buildDuration, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 508bb705..15a93ef4 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({ - required this.total, - required this.deployments, - }); + DeploymentList({required this.total, required this.deployments}); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from( + map['deployments'].map((p) => Deployment.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index b6454aae..37fb2b7b 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 8af34256..126ad805 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,31 +2,30 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({ - required this.total, - required this.documents, - }); + DocumentList({required this.total, required this.documents}); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from(map['documents'].map((p) => Document.fromMap(p))), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from( + map['documents'].map((p) => Document.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 0cfdbb4e..8618bcd6 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,118 +2,122 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Resource(function/site) execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Resource(function/site) execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from( + map['requestHeaders'].map((p) => Headers.fromMap(p)), + ), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from( + map['responseHeaders'].map((p) => Headers.fromMap(p)), + ), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 0bcbad6a..2a2ef056 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({ - required this.total, - required this.executions, - }); + ExecutionList({required this.total, required this.executions}); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from( + map['executions'].map((p) => Execution.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index de8439ec..a6a9fa46 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 28bc6fcf..9f01530b 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({ - required this.total, - required this.files, - }); + FileList({required this.total, required this.files}); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "files": files.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "files": files.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart index ea6b601a..693c9b07 100644 --- a/lib/src/models/framework.dart +++ b/lib/src/models/framework.dart @@ -2,46 +2,48 @@ part of '../../models.dart'; /// Framework class Framework implements Model { - /// Framework key. - final String key; - - /// Framework Name. - final String name; - - /// Default runtime version. - final String buildRuntime; - - /// List of supported runtime versions. - final List runtimes; - - /// List of supported adapters. - final List adapters; - - Framework({ - required this.key, - required this.name, - required this.buildRuntime, - required this.runtimes, - required this.adapters, - }); - - factory Framework.fromMap(Map map) { - return Framework( - key: map['key'].toString(), - name: map['name'].toString(), - buildRuntime: map['buildRuntime'].toString(), - runtimes: List.from(map['runtimes'] ?? []), - adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), - ); - } - - Map toMap() { - return { - "key": key, - "name": name, - "buildRuntime": buildRuntime, - "runtimes": runtimes, - "adapters": adapters.map((p) => p.toMap()).toList(), - }; - } + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from( + map['adapters'].map((p) => FrameworkAdapter.fromMap(p)), + ), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart index 7614616a..0b908240 100644 --- a/lib/src/models/framework_adapter.dart +++ b/lib/src/models/framework_adapter.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Framework Adapter class FrameworkAdapter implements Model { - /// Adapter key. - final String key; - - /// Default command to download dependencies. - final String installCommand; - - /// Default command to build site into output directory. - final String buildCommand; - - /// Default output directory of build. - final String outputDirectory; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - FrameworkAdapter({ - required this.key, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.fallbackFile, - }); - - factory FrameworkAdapter.fromMap(Map map) { - return FrameworkAdapter( - key: map['key'].toString(), - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "fallbackFile": fallbackFile, - }; - } + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart index deb19e62..266d8edf 100644 --- a/lib/src/models/framework_list.dart +++ b/lib/src/models/framework_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Frameworks List class FrameworkList implements Model { - /// Total number of frameworks documents that matched your query. - final int total; + /// Total number of frameworks documents that matched your query. + final int total; - /// List of frameworks. - final List frameworks; + /// List of frameworks. + final List frameworks; - FrameworkList({ - required this.total, - required this.frameworks, - }); + FrameworkList({required this.total, required this.frameworks}); - factory FrameworkList.fromMap(Map map) { - return FrameworkList( - total: map['total'], - frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), - ); - } + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from( + map['frameworks'].map((p) => Framework.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "frameworks": frameworks.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 64401c3f..56c2eded 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,184 +2,184 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; + /// Function creation date in ISO 8601 format. + final String $createdAt; - /// Function update date in ISO 8601 format. - final String $updatedAt; + /// Function update date in ISO 8601 format. + final String $updatedAt; - /// Execution permissions. - final List execute; + /// Execution permissions. + final List execute; - /// Function name. - final String name; + /// Function name. + final String name; - /// Function enabled. - final bool enabled; + /// Function enabled. + final bool enabled; - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// When disabled, executions will exclude logs and errors, and will be slightly faster. - final bool logging; - - /// Function execution and build runtime. - final String runtime; - - /// Function's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Function's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// When disabled, executions will exclude logs and errors, and will be slightly faster. + final bool logging; + + /// Function execution and build runtime. + final String runtime; + + /// Function's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index 8f0b8928..c37f0615 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,28 +2,25 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({ - required this.total, - required this.functions, - }); + FunctionList({required this.total, required this.functions}); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index ecf0a178..463cf696 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({ - required this.name, - required this.value, - }); + Headers({required this.name, required this.value}); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "value": value, - }; - } + Map toMap() { + return {"name": name, "value": value}; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index 54c31e70..fa402e97 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({ - required this.version, - required this.status, - }); + HealthAntivirus({required this.version, required this.status}); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "version": version, - "status": status, - }; - } + Map toMap() { + return {"version": version, "status": status}; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index 0a5b6ce9..d412eba9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 95da1235..5f06906b 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({ - required this.size, - }); + HealthQueue({required this.size}); - factory HealthQueue.fromMap(Map map) { - return HealthQueue( - size: map['size'], - ); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue(size: map['size']); + } - Map toMap() { - return { - "size": size, - }; - } + Map toMap() { + return {"size": size}; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 0d6e7216..59b7092c 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({ - required this.name, - required this.ping, - required this.status, - }); + HealthStatus({required this.name, required this.ping, required this.status}); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "ping": ping, - "status": status, - }; - } + Map toMap() { + return {"name": name, "ping": ping, "status": status}; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index 102dfe77..dec2d54f 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,34 +2,30 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return { - "remoteTime": remoteTime, - "localTime": localTime, - "diff": diff, - }; - } + Map toMap() { + return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index c43c4d57..807bdfd0 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index e92e36cc..f38eaf66 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({ - required this.total, - required this.identities, - }); + IdentityList({required this.total, required this.identities}); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from( + map['identities'].map((p) => Identity.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 07d22743..961b9e5e 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index attributes length. - final List lengths; + /// Index attributes length. + final List lengths; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - required this.lengths, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + required this.lengths, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - lengths: List.from(map['lengths'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "lengths": lengths, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "lengths": lengths, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index 8eac7956..dc759dfb 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({ - required this.total, - required this.indexes, - }); + IndexList({required this.total, required this.indexes}); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 1b4ff7de..490a1824 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({ - required this.jwt, - }); + Jwt({required this.jwt}); - factory Jwt.fromMap(Map map) { - return Jwt( - jwt: map['jwt'].toString(), - ); - } + factory Jwt.fromMap(Map map) { + return Jwt(jwt: map['jwt'].toString()); + } - Map toMap() { - return { - "jwt": jwt, - }; - } + Map toMap() { + return {"jwt": jwt}; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 43eaad08..9c45adb1 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({ - required this.name, - required this.code, - required this.nativeName, - }); + Language({required this.name, required this.code, required this.nativeName}); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - "nativeName": nativeName, - }; - } + Map toMap() { + return {"name": name, "code": code, "nativeName": nativeName}; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index fe271118..046b879e 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({ - required this.total, - required this.languages, - }); + LanguageList({required this.total, required this.languages}); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from(map['languages'].map((p) => Language.fromMap(p))), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from( + map['languages'].map((p) => Language.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index b5e9ad1a..084475bf 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index 10499ef5..cd5a1155 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({ - required this.code, - required this.name, - }); + LocaleCode({required this.code, required this.name}); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "name": name, - }; - } + Map toMap() { + return {"code": code, "name": name}; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 839474d7..662fee4f 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({ - required this.total, - required this.localeCodes, - }); + LocaleCodeList({required this.total, required this.localeCodes}); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from( + map['localeCodes'].map((p) => LocaleCode.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index cb567bd7..7fb3f364 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 91d024d0..628237fa 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({ - required this.total, - required this.logs, - }); + LogList({required this.total, required this.logs}); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "logs": logs.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 26610e46..8ee142ad 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 409cdbfb..46468a3a 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({ - required this.total, - required this.memberships, - }); + MembershipList({required this.total, required this.memberships}); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from( + map['memberships'].map((p) => Membership.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index c4e9e858..9b93b00d 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 702c912b..7bd0891f 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({ - required this.total, - required this.messages, - }); + MessageList({required this.total, required this.messages}); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from(map['messages'].map((p) => Message.fromMap(p))), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from( + map['messages'].map((p) => Message.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 46c166fb..96bf3c65 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index d49989d8..c930a23e 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 6c8b4e36..63411988 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,22 +2,18 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({ - required this.recoveryCodes, - }); + MfaRecoveryCodes({required this.recoveryCodes}); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return { - "recoveryCodes": recoveryCodes, - }; - } + Map toMap() { + return {"recoveryCodes": recoveryCodes}; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index 01cf0857..fa57cb8b 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({ - required this.secret, - required this.uri, - }); + MfaType({required this.secret, required this.uri}); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return { - "secret": secret, - "uri": uri, - }; - } + Map toMap() { + return {"secret": secret, "uri": uri}; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index 48e5b84a..f810a35b 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} \ No newline at end of file +} diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index c8bbb95b..40f7bcd2 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index beab76e8..18d2803d 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({ - required this.total, - required this.phones, - }); + PhoneList({required this.total, required this.phones}); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "phones": phones.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 3c62f86d..48163dfc 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,23 +2,17 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({ - required this.data, - }); + Preferences({required this.data}); - factory Preferences.fromMap(Map map) { - return Preferences( - data: map, - ); - } + factory Preferences.fromMap(Map map) { + return Preferences(data: map); + } - Map toMap() { - return { - "data": data, - }; - } + Map toMap() { + return {"data": data}; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 4295c486..1a762f85 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index 7c09eb56..aeb28ecd 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({ - required this.total, - required this.providers, - }); + ProviderList({required this.total, required this.providers}); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from( + map['providers'].map((p) => Provider.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart index ed520cc4..dad35dcc 100644 --- a/lib/src/models/resource_token.dart +++ b/lib/src/models/resource_token.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// ResourceToken class ResourceToken implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// JWT encoded string. - final String secret; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - ResourceToken({ - required this.$id, - required this.$createdAt, - required this.resourceId, - required this.resourceType, - required this.expire, - required this.secret, - required this.accessedAt, - }); - - factory ResourceToken.fromMap(Map map) { - return ResourceToken( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - expire: map['expire'].toString(), - secret: map['secret'].toString(), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "resourceId": resourceId, - "resourceType": resourceType, - "expire": expire, - "secret": secret, - "accessedAt": accessedAt, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart index ba8f0d89..f30531f4 100644 --- a/lib/src/models/resource_token_list.dart +++ b/lib/src/models/resource_token_list.dart @@ -2,28 +2,24 @@ part of '../../models.dart'; /// Resource Tokens List class ResourceTokenList implements Model { - /// Total number of tokens documents that matched your query. - final int total; + /// Total number of tokens documents that matched your query. + final int total; - /// List of tokens. - final List tokens; + /// List of tokens. + final List tokens; - ResourceTokenList({ - required this.total, - required this.tokens, - }); + ResourceTokenList({required this.total, required this.tokens}); - factory ResourceTokenList.fromMap(Map map) { - return ResourceTokenList( - total: map['total'], - tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), - ); - } + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from( + map['tokens'].map((p) => ResourceToken.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "tokens": tokens.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "tokens": tokens.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 35f82cfa..7c9677d8 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 7615fd9e..02c7b2e5 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({ - required this.total, - required this.runtimes, - }); + RuntimeList({required this.total, required this.runtimes}); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from( + map['runtimes'].map((p) => Runtime.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index 3a1d955f..d2fe4f64 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 6d26d6a8..479272b9 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({ - required this.total, - required this.sessions, - }); + SessionList({required this.total, required this.sessions}); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from( + map['sessions'].map((p) => Session.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart index 5cda6acc..1449f8bd 100644 --- a/lib/src/models/site.dart +++ b/lib/src/models/site.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Site class Site implements Model { - /// Site ID. - final String $id; + /// Site ID. + final String $id; - /// Site creation date in ISO 8601 format. - final String $createdAt; + /// Site creation date in ISO 8601 format. + final String $createdAt; - /// Site update date in ISO 8601 format. - final String $updatedAt; + /// Site update date in ISO 8601 format. + final String $updatedAt; - /// Site name. - final String name; + /// Site name. + final String name; - /// Site enabled. - final bool enabled; + /// Site enabled. + final bool enabled; - /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. - final bool live; + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; - /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. - final bool logging; + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; - /// Site framework. - final String framework; - - /// Site's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Screenshot of active deployment with light theme preference file ID. - final String deploymentScreenshotLight; - - /// Screenshot of active deployment with dark theme preference file ID. - final String deploymentScreenshotDark; - - /// Site's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Site variables. - final List vars; - - /// Site request timeout in seconds. - final int timeout; - - /// The install command used to install the site dependencies. - final String installCommand; - - /// The build command used to build the site. - final String buildCommand; - - /// The directory where the site build output is located. - final String outputDirectory; - - /// Site VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to site in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - /// Site build runtime. - final String buildRuntime; - - /// Site framework adapter. - final String adapter; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - Site({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.framework, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.deploymentScreenshotLight, - required this.deploymentScreenshotDark, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.vars, - required this.timeout, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - required this.buildRuntime, - required this.adapter, - required this.fallbackFile, - }); - - factory Site.fromMap(Map map) { - return Site( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - framework: map['framework'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), - deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - timeout: map['timeout'], - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - buildRuntime: map['buildRuntime'].toString(), - adapter: map['adapter'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "framework": framework, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "deploymentScreenshotLight": deploymentScreenshotLight, - "deploymentScreenshotDark": deploymentScreenshotDark, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "vars": vars.map((p) => p.toMap()).toList(), - "timeout": timeout, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - "buildRuntime": buildRuntime, - "adapter": adapter, - "fallbackFile": fallbackFile, - }; - } + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart index 02a6a2be..a403dd5b 100644 --- a/lib/src/models/site_list.dart +++ b/lib/src/models/site_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Sites List class SiteList implements Model { - /// Total number of sites documents that matched your query. - final int total; + /// Total number of sites documents that matched your query. + final int total; - /// List of sites. - final List sites; + /// List of sites. + final List sites; - SiteList({ - required this.total, - required this.sites, - }); + SiteList({required this.total, required this.sites}); - factory SiteList.fromMap(Map map) { - return SiteList( - total: map['total'], - sites: List.from(map['sites'].map((p) => Site.fromMap(p))), - ); - } + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sites": sites.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "sites": sites.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e49d399c..e8fb8c75 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,40 +2,35 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return { - "memory": memory, - "cpus": cpus, - "enabled": enabled, - "slug": slug, - }; - } + Map toMap() { + return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index 72703f84..e4bef89b 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({ - required this.total, - required this.specifications, - }); + SpecificationList({required this.total, required this.specifications}); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from( + map['specifications'].map((p) => Specification.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 36e18a7e..0c926297 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index d7d3c3e3..7030fa0a 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({ - required this.total, - required this.subscribers, - }); + SubscriberList({required this.total, required this.subscribers}); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from( + map['subscribers'].map((p) => Subscriber.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index f2b3b6b4..4be8b545 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 2d38efe5..1042e5a2 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({ - required this.total, - required this.targets, - }); + TargetList({required this.total, required this.targets}); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "targets": targets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index e9058b5b..43df33a8 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index 2fb3611e..e604f192 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({ - required this.total, - required this.teams, - }); + TeamList({required this.total, required this.teams}); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "teams": teams.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 4f6b8454..35115467 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 461d5694..430d44ac 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index e57ef05f..a4d1f44f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({ - required this.total, - required this.topics, - }); + TopicList({required this.total, required this.topics}); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "topics": topics.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index effc397c..50bfb3ce 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 55dfcf77..03e55cc6 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({ - required this.total, - required this.users, - }); + UserList({required this.total, required this.users}); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "users": users.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "users": users.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 58882a9f..2a8e276a 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; + /// Variable ID. + final String $id; - /// Variable creation date in ISO 8601 format. - final String $createdAt; + /// Variable creation date in ISO 8601 format. + final String $createdAt; - /// Variable creation date in ISO 8601 format. - final String $updatedAt; + /// Variable creation date in ISO 8601 format. + final String $updatedAt; - /// Variable key. - final String key; + /// Variable key. + final String key; - /// Variable value. - final String value; + /// Variable value. + final String value; - /// Variable secret flag. Secret variables can only be updated or deleted, but never read. - final bool secret; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.secret, - required this.resourceType, - required this.resourceId, - }); + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.secret, + required this.resourceType, + required this.resourceId, + }); - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - secret: map['secret'], - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + secret: map['secret'], + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "secret": secret, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "secret": secret, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index b6da02cc..4ff3e189 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({ - required this.total, - required this.variables, - }); + VariableList({required this.total, required this.variables}); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from( + map['variables'].map((p) => Variable.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 44cde383..5a19b0fc 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded + "chunksUploaded": chunksUploaded, }; } From 3073acee31599cd469a9aea209bd781fb54156d9 Mon Sep 17 00:00:00 2001 From: root Date: Sun, 18 May 2025 07:37:33 +0000 Subject: [PATCH 4/7] chore: bump to next major versions --- README.md | 2 +- lib/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 ++++++++------- lib/services/avatars.dart | 434 ++- lib/services/databases.dart | 2528 ++++++++---------- lib/services/functions.dart | 1385 +++++----- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 ++--- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 ++++++++----------- lib/services/sites.dart | 1282 ++++----- lib/services/storage.dart | 744 +++--- lib/services/teams.dart | 671 +++-- lib/services/tokens.dart | 216 +- lib/services/users.dart | 2063 +++++++-------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 125 +- lib/src/client_io.dart | 152 +- lib/src/client_mixin.dart | 65 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/adapter.dart | 14 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/build_runtime.dart | 136 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/deployment_download_type.dart | 14 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 +-- lib/src/enums/framework.dart | 38 +- lib/src/enums/image_format.dart | 22 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 136 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/enums/vcs_deployment_type.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 338 +-- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/framework.dart | 86 +- lib/src/models/framework_adapter.dart | 84 +- lib/src/models/framework_list.dart | 39 +- lib/src/models/function.dart | 348 +-- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 110 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/resource_token.dart | 108 +- lib/src/models/resource_token_list.dart | 36 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/site.dart | 358 +-- lib/src/models/site_list.dart | 34 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 100 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- pubspec.yaml | 2 +- 152 files changed, 12032 insertions(+), 13076 deletions(-) diff --git a/README.md b/README.md index 4862f478..f859780e 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file: ```yml dependencies: - dart_appwrite: ^15.2.0 + dart_appwrite: ^16.0.0 ``` You can install packages from the command line: diff --git a/lib/client_browser.dart b/lib/client_browser.dart index b9805a3a..09f110ea 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; +export 'src/client_browser.dart'; \ No newline at end of file diff --git a/lib/client_io.dart b/lib/client_io.dart index 42a0c0b6..4d85cbfa 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; +export 'src/client_io.dart'; \ No newline at end of file diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 0848a050..5f5ffe9d 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.7.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 28ff15e8..72e26a23 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,7 +10,8 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 9107a9a4..46882207 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,5 +1,6 @@ part of 'dart_appwrite.dart'; + /// Helper class to generate query strings. class Query { final String method; @@ -9,13 +10,15 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = {'method': method}; + final map = { + 'method': method, + }; - if (attribute != null) { + if(attribute != null) { map['attribute'] = attribute; } - - if (values != null) { + + if(values != null) { map['values'] = values is List ? values : [values]; } @@ -26,7 +29,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -58,12 +61,10 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => - Query._('isNull', attribute).toString(); + static String isNull(String attribute) => Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => - Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -83,52 +84,40 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._( - 'or', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); static String and(List queries) => - Query._( - 'and', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => - Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => - Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => - Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => - Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => - Query._('offset', null, offset).toString(); -} + static String offset(int offset) => Query._('offset', null, offset).toString(); + +} \ No newline at end of file diff --git a/lib/role.dart b/lib/role.dart index dafeb78d..6552df47 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); + + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if (status.isEmpty) { - return 'user:$id'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if(status.isEmpty) { + return 'user:$id'; + } + return 'user:$id/$status'; } - return 'user:$id/$status'; - } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if (status.isEmpty) { - return 'users'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if(status.isEmpty) { + return 'users'; + } + return 'users/$status'; } - return 'users/$status'; - } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if (role.isEmpty) { - return 'team:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if(role.isEmpty) { + return 'team:$id'; + } + return 'team:$id/$role'; } - return 'team:$id/$role'; - } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; - } + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} \ No newline at end of file diff --git a/lib/services/account.dart b/lib/services/account.dart index 90e1f03e..fdc8cc97 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1084 +2,1081 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/account'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({ - required String email, - required String password, - }) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({ - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaType.fromMap(res.data); - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({ - required enums.AuthenticatorType type, - required String otp, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {'otp': otp}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({ - required enums.AuthenticationFactor factor, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = {'factor': factor.value}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaChallenge.fromMap(res.data); - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({ - required String challengeId, - required String otp, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - 'challengeId': challengeId, - 'otp': otp, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({ - required String password, - String? oldPassword, - }) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - 'password': password, - 'oldPassword': oldPassword, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({ - required String phone, - required String password, - }) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - 'phone': phone, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({ - required String email, - required String url, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = {'email': email, 'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({ - required String userId, - required String secret, - required String password, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - 'userId': userId, - 'secret': secret, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({ - required String email, - required String password, - }) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({ - required String userId, - required String email, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({ - required String userId, - required String email, - String? url, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'url': url, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({ - required enums.OAuthProvider provider, - String? success, - String? failure, - List? scopes, - }) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( - '{provider}', - provider.value, - ); - - final Map params = { - 'success': success, - 'failure': failure, - 'scopes': scopes, - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add( - Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), - ); - } - } else if (value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri( - scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&'), - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({ - required String userId, - required String phone, - }) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = {'userId': userId, 'phone': phone}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } -} + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/account'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({required String email, required String password}) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaType.fromMap(res.data); + + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + 'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'factor': factor.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaChallenge.fromMap(res.data); + + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({required String challengeId, required String otp}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'challengeId': challengeId, +'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({required String password, String? oldPassword}) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + + 'password': password, +'oldPassword': oldPassword, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({required String phone, required String password}) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + + 'phone': phone, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({required String email, required String url}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'email': email, +'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({required String userId, required String secret, required String password}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({required String email, required String password}) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({required String userId, required String email, bool? phrase}) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'url': url, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); + + final Map params = { + 'success': success, +'failure': failure, +'scopes': scopes, + + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); + } + } else if(value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&') + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({required String userId, required String phone}) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = { + + 'userId': userId, +'phone': phone, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 8033f1cd..381146d4 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,253 +3,187 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({ - required enums.Browser code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({ - required enums.CreditCard code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({ - required enums.Flag code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({ - required String url, - int? width, - int? height, - }) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, - 'width': width, - 'height': height, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({ - String? name, - int? width, - int? height, - String? background, - }) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, - 'width': width, - 'height': height, - 'background': background, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({ - required String text, - int? size, - int? margin, - bool? download, - }) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, - 'size': size, - 'margin': margin, - 'download': download, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({required String url, int? width, int? height}) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, +'width': width, +'height': height, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({String? name, int? width, int? height, String? background}) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, +'width': width, +'height': height, +'background': background, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({required String text, int? size, int? margin, bool? download}) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, +'size': size, +'margin': margin, +'download': download, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 4b26a220..49e2bbc2 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1439 +3,1095 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DatabaseList.fromMap(res.data); - } - - /// Create a new Database. - /// - Future create({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'databaseId': databaseId, - 'name': name, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Update a database by its unique ID. - Future update({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {'name': name, 'enabled': enabled}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({ - required String databaseId, - List? queries, - String? search, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.CollectionList.fromMap(res.data); - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'collectionId': collectionId, - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Update a collection by its unique ID. - Future updateCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List attributes in the collection. - Future listAttributes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeList.fromMap(res.data); - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - bool? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required bool? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Create an email attribute. - /// - Future createEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - double? min, - double? max, - double? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required double? xdefault, - double? min, - double? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - int? min, - int? max, - int? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required int? xdefault, - int? min, - int? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Create IP address attribute. - /// - Future createIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String relatedCollectionId, - required enums.RelationshipType type, - bool? twoWay, - String? key, - String? twoWayKey, - enums.RelationMutate? onDelete, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'relatedCollectionId': relatedCollectionId, - 'type': type.value, - 'twoWay': twoWay, - 'key': key, - 'twoWayKey': twoWayKey, - 'onDelete': onDelete?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Create a string attribute. - /// - Future createStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required int size, - required bool xrequired, - String? xdefault, - bool? array, - bool? encrypt, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'size': size, - 'required': xrequired, - 'default': xdefault, - 'array': array, - 'encrypt': encrypt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - int? size, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'size': size, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Get attribute by ID. - Future getAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Deletes an attribute. - Future deleteAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String key, - enums.RelationMutate? onDelete, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'onDelete': onDelete?.value, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Create a new Document. 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. - Future createDocument({ - required String databaseId, - required String collectionId, - required String documentId, - required Map data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'documentId': documentId, - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// 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. - Future createDocuments({ - required String databaseId, - required String collectionId, - required List documents, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'documents': documents}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// 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. - /// - Future upsertDocuments({ - required String databaseId, - required String collectionId, - List? documents, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'documents': documents}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// 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. - Future updateDocuments({ - required String databaseId, - required String collectionId, - Map? data, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'data': data, 'queries': queries}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Bulk delete documents using queries, if no queries are passed then all - /// documents are deleted. - Future deleteDocuments({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({ - required String databaseId, - required String collectionId, - required String documentId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({ - required String databaseId, - required String collectionId, - required String documentId, - Map? data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Delete a document by its unique ID. - Future deleteDocument({ - required String databaseId, - required String collectionId, - required String documentId, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List indexes in the collection. - Future listIndexes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IndexList.fromMap(res.data); - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({ - required String databaseId, - required String collectionId, - required String key, - required enums.IndexType type, - required List attributes, - List? orders, - List? lengths, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'type': type.value, - 'attributes': attributes, - 'orders': orders, - 'lengths': lengths, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Get index by ID. - Future getIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Delete an index. - Future deleteIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DatabaseList.fromMap(res.data); + + } + + /// Create a new Database. + /// + Future create({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + + 'databaseId': databaseId, +'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Update a database by its unique ID. + Future update({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({required String databaseId, List? queries, String? search}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CollectionList.fromMap(res.data); + + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'collectionId': collectionId, +'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Update a collection by its unique ID. + Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List attributes in the collection. + Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeList.fromMap(res.data); + + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Create an email attribute. + /// + Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'elements': elements, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'elements': elements, +'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Create IP address attribute. + /// + Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'relatedCollectionId': relatedCollectionId, +'type': type.value, +'twoWay': twoWay, +'key': key, +'twoWayKey': twoWayKey, +'onDelete': onDelete?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Create a string attribute. + /// + Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'size': size, +'required': xrequired, +'default': xdefault, +'array': array, +'encrypt': encrypt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'size': size, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Get attribute by ID. + Future getAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Deletes an attribute. + Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'onDelete': onDelete?.value, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Create a new Document. 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. + Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documentId': documentId, +'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// 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. + Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + /// + Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'data': data, +'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + 'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Delete a document by its unique ID. + Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List indexes in the collection. + Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IndexList.fromMap(res.data); + + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'type': type.value, +'attributes': attributes, +'orders': orders, +'lengths': lengths, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Get index by ID. + Future getIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Delete an index. + Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/functions.dart b/lib/services/functions.dart index e86f1afe..ad261abf 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,768 +3,623 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FunctionList.fromMap(res.data); - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({ - required String functionId, - required String name, - required enums.Runtime runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'functionId': functionId, - 'name': name, - 'runtime': runtime.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.RuntimeList.fromMap(res.data); - } - - /// List allowed function specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SpecificationList.fromMap(res.data); - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Update function by its unique ID. - Future update({ - required String functionId, - required String name, - enums.Runtime? runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'name': name, - 'runtime': runtime?.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the function active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your function. - Future updateFunctionDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployment'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Get a list of all the function's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({ - required String functionId, - List? queries, - String? search, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DeploymentList.fromMap(res.data); - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({ - required String functionId, - required InputFile code, - required bool activate, - String? entrypoint, - String? commands, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'entrypoint': entrypoint, - 'commands': commands, - 'code': code, - 'activate': activate, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createDuplicateDeployment({ - required String functionId, - required String deploymentId, - String? buildId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/duplicate' - .replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'deploymentId': deploymentId, - 'buildId': buildId, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createTemplateDeployment({ - required String functionId, - required String repository, - required String owner, - required String rootDirectory, - required String version, - bool? activate, - }) async { - final String apiPath = '/functions/{functionId}/deployments/template' - .replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'repository': repository, - 'owner': owner, - 'rootDirectory': rootDirectory, - 'version': version, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Create a deployment when a function is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({ - required String functionId, - required enums.VCSDeploymentType type, - required String reference, - bool? activate, - }) async { - final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'type': type.value, - 'reference': reference, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a function deployment by its unique ID. - Future getDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future getDeploymentDownload({ - required String functionId, - required String deploymentId, - enums.DeploymentDownloadType? type, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/download' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/status' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({ - required String functionId, - List? queries, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ExecutionList.fromMap(res.data); - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({ - required String functionId, - String? body, - bool? xasync, - String? path, - enums.ExecutionMethod? method, - Map? headers, - String? scheduledAt, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'body': body, - 'async': xasync, - 'path': path, - 'method': method?.value, - 'headers': headers, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Get a function execution log by its unique ID. - Future getExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Delete a function execution by its unique ID. - Future deleteExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all variables of a specific function. - Future listVariables({ - required String functionId, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.VariableList.fromMap(res.data); - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({ - required String functionId, - required String key, - required String value, - bool? secret, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Get a variable by its unique ID. - Future getVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Update variable by its unique ID. - Future updateVariable({ - required String functionId, - required String variableId, - required String key, - String? value, - bool? secret, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Delete a variable by its unique ID. - Future deleteVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FunctionList.fromMap(res.data); + + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + + 'functionId': functionId, +'name': name, +'runtime': runtime.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.RuntimeList.fromMap(res.data); + + } + + /// List allowed function specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Update function by its unique ID. + Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'name': name, +'runtime': runtime?.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the function active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your function. + Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all the function's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({required String functionId, List? queries, String? search}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'entrypoint': entrypoint, +'commands': commands, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'deploymentId': deploymentId, +'buildId': buildId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'type': type.value, +'reference': reference, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a function deployment by its unique ID. + Future getDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({required String functionId, List? queries}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'body': body, +'async': xasync, +'path': path, +'method': method?.value, +'headers': headers, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Get a function execution log by its unique ID. + Future getExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a function execution by its unique ID. + Future deleteExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific function. + Future listVariables({required String functionId}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 18eb54f1..92cc591f 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,47 +3,49 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/health.dart b/lib/services/health.dart index 5250c91d..3bfeba6b 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,434 +3,459 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + } - final Map apiParams = {}; + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthAntivirus.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + return models.HealthAntivirus.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'domain': domain}; + return models.HealthStatus.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthCertificate.fromMap(res.data); - } + final Map apiParams = { + 'domain': domain, - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthCertificate.fromMap(res.data); - return models.HealthStatus.fromMap(res.data); - } + } - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + } - final Map apiParams = {'threshold': threshold}; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthStatus.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({ - String? name, - int? threshold, - }) async { - final String apiPath = '/health/queue/databases'; + final Map apiHeaders = { + + }; - final Map apiParams = { - 'name': name, - 'threshold': threshold, - }; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; - - final Map apiParams = {'threshold': threshold}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.HealthQueue.fromMap(res.data); - } - - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({ - required enums.Name name, - int? threshold, - }) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll( - '{name}', - name.value, - ); + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } - - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({String? name, int? threshold}) async { + final String apiPath = '/health/queue/databases'; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiParams = { + 'name': name, +'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthQueue.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + } - final Map apiParams = {'threshold': threshold}; + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthQueue.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({required enums.Name name, int? threshold}) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); - return models.HealthQueue.fromMap(res.data); - } + final Map apiParams = { + 'threshold': threshold, - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + + }; - final Map apiParams = {'threshold': threshold}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthQueue.fromMap(res.data); - return models.HealthQueue.fromMap(res.data); - } + } - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - final Map apiParams = {'threshold': threshold}; + final Map apiParams = { + 'threshold': threshold, - final Map apiHeaders = {}; + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; + return models.HealthQueue.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; + final Map apiHeaders = { + + }; - final Map apiParams = {'threshold': threshold}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; + } - final Map apiParams = {}; + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - return models.HealthTime.fromMap(res.data); - } -} + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthTime.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/locale.dart b/lib/services/locale.dart index 4d3cc3e0..b75b4711 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,162 +3,170 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.Locale.fromMap(res.data); - } + return models.Locale.fromMap(res.data); - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + } - final Map apiParams = {}; + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LocaleCodeList.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + return models.LocaleCodeList.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.ContinentList.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.ContinentList.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.CountryList.fromMap(res.data); - } + final Map apiParams = { + + + }; - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + final Map apiHeaders = { + + }; - final Map apiParams = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.CountryList.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.CountryList.fromMap(res.data); - } + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + final Map apiParams = { + + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.CountryList.fromMap(res.data); - return models.PhoneList.fromMap(res.data); - } + } - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.CurrencyList.fromMap(res.data); - } + return models.PhoneList.fromMap(res.data); - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; + } - final Map apiParams = {}; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LanguageList.fromMap(res.data); - } -} + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CurrencyList.fromMap(res.data); + + } + + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LanguageList.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index afe3ee86..710bb6d4 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1476 +3,1158 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MessageList.fromMap(res.data); - } - - /// Create a new email message. - Future createEmail({ - required String messageId, - required String subject, - required String content, - List? topics, - List? users, - List? targets, - List? cc, - List? bcc, - List? attachments, - bool? draft, - bool? html, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - 'messageId': messageId, - 'subject': subject, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'cc': cc, - 'bcc': bcc, - 'attachments': attachments, - 'draft': draft, - 'html': html, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({ - required String messageId, - List? topics, - List? users, - List? targets, - String? subject, - String? content, - bool? draft, - bool? html, - List? cc, - List? bcc, - String? scheduledAt, - List? attachments, - }) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'subject': subject, - 'content': content, - 'draft': draft, - 'html': html, - 'cc': cc, - 'bcc': bcc, - 'scheduledAt': scheduledAt, - 'attachments': attachments, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new push notification. - Future createPush({ - required String messageId, - String? title, - String? body, - List? topics, - List? users, - List? targets, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - 'messageId': messageId, - 'title': title, - 'body': body, - 'topics': topics, - 'users': users, - 'targets': targets, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({ - required String messageId, - List? topics, - List? users, - List? targets, - String? title, - String? body, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'title': title, - 'body': body, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new SMS message. - Future createSms({ - required String messageId, - required String content, - List? topics, - List? users, - List? targets, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - 'messageId': messageId, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({ - required String messageId, - List? topics, - List? users, - List? targets, - String? content, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'content': content, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of the targets associated with a message. - Future listTargets({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ProviderList.fromMap(res.data); - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({ - required String providerId, - required String name, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({ - required String providerId, - String? name, - bool? enabled, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - }) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({ - required String providerId, - required String name, - Map? serviceAccountJSON, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'serviceAccountJSON': serviceAccountJSON, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({ - required String providerId, - String? name, - bool? enabled, - Map? serviceAccountJSON, - }) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'serviceAccountJSON': serviceAccountJSON, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({ - required String providerId, - required String name, - String? apiKey, - String? domain, - bool? isEuRegion, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({ - required String providerId, - String? name, - String? apiKey, - String? domain, - bool? isEuRegion, - bool? enabled, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'enabled': enabled, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({ - required String providerId, - required String name, - String? templateId, - String? senderId, - String? authKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({ - required String providerId, - String? name, - bool? enabled, - String? templateId, - String? senderId, - String? authKey, - }) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({ - required String providerId, - required String name, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new SMTP provider. - Future createSmtpProvider({ - required String providerId, - required String name, - required String host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({ - required String providerId, - String? name, - String? host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Telesign provider. - Future createTelesignProvider({ - required String providerId, - required String name, - String? from, - String? customerId, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'customerId': customerId, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({ - required String providerId, - String? name, - bool? enabled, - String? customerId, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/telesign/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'customerId': customerId, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({ - required String providerId, - required String name, - String? from, - String? username, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'username': username, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({ - required String providerId, - String? name, - bool? enabled, - String? username, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'username': username, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Twilio provider. - Future createTwilioProvider({ - required String providerId, - required String name, - String? from, - String? accountSid, - String? authToken, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'accountSid': accountSid, - 'authToken': authToken, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({ - required String providerId, - String? name, - bool? enabled, - String? accountSid, - String? authToken, - String? from, - }) async { - final String apiPath = '/messaging/providers/twilio/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'accountSid': accountSid, - 'authToken': authToken, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Vonage provider. - Future createVonageProvider({ - required String providerId, - required String name, - String? from, - String? apiKey, - String? apiSecret, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? apiSecret, - String? from, - }) async { - final String apiPath = '/messaging/providers/vonage/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({ - required String providerId, - List? queries, - }) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({ - required String subscriberId, - List? queries, - }) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs' - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TopicList.fromMap(res.data); - } - - /// Create a new topic. - Future createTopic({ - required String topicId, - required String name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'topicId': topicId, - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({ - required String topicId, - String? name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({ - required String topicId, - List? queries, - }) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({ - required String topicId, - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SubscriberList.fromMap(res.data); - } - - /// Create a new subscriber. - Future createSubscriber({ - required String topicId, - required String subscriberId, - required String targetId, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'subscriberId': subscriberId, - 'targetId': targetId, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({List? queries, String? search}) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MessageList.fromMap(res.data); + + } + + /// Create a new email message. + Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + + 'messageId': messageId, +'subject': subject, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'cc': cc, +'bcc': bcc, +'attachments': attachments, +'draft': draft, +'html': html, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'subject': subject, +'content': content, +'draft': draft, +'html': html, +'cc': cc, +'bcc': bcc, +'scheduledAt': scheduledAt, +'attachments': attachments, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new push notification. + Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + + 'messageId': messageId, +'title': title, +'body': body, +'topics': topics, +'users': users, +'targets': targets, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'title': title, +'body': body, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new SMS message. + Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + + 'messageId': messageId, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'content': content, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of the targets associated with a message. + Future listTargets({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({List? queries, String? search}) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ProviderList.fromMap(res.data); + + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'serviceAccountJSON': serviceAccountJSON, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'serviceAccountJSON': serviceAccountJSON, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'enabled': enabled, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new SMTP provider. + Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Telesign provider. + Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'customerId': customerId, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'customerId': customerId, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'username': username, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'username': username, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Twilio provider. + Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'accountSid': accountSid, +'authToken': authToken, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { + final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'accountSid': accountSid, +'authToken': authToken, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Vonage provider. + Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'apiKey': apiKey, +'apiSecret': apiSecret, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { + final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'apiSecret': apiSecret, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({required String providerId, List? queries}) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({required String subscriberId, List? queries}) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({List? queries, String? search}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TopicList.fromMap(res.data); + + } + + /// Create a new topic. + Future createTopic({required String topicId, required String name, List? subscribe}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + + 'topicId': topicId, +'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({required String topicId, String? name, List? subscribe}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({required String topicId, List? queries}) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({required String topicId, List? queries, String? search}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SubscriberList.fromMap(res.data); + + } + + /// Create a new subscriber. + Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'subscriberId': subscriberId, +'targetId': targetId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/sites.dart b/lib/services/sites.dart index d89f2192..90511473 100644 --- a/lib/services/sites.dart +++ b/lib/services/sites.dart @@ -2,703 +2,585 @@ part of '../dart_appwrite.dart'; /// The Sites Service allows you view, create and manage your web applications. class Sites extends Service { - Sites(super.client); - - /// Get a list of all the project's sites. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SiteList.fromMap(res.data); - } - - /// Create a new site. - Future create({ - required String siteId, - required String name, - required enums.Framework framework, - required enums.BuildRuntime buildRuntime, - bool? enabled, - bool? logging, - int? timeout, - String? installCommand, - String? buildCommand, - String? outputDirectory, - enums.Adapter? adapter, - String? installationId, - String? fallbackFile, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'siteId': siteId, - 'name': name, - 'framework': framework.value, - 'enabled': enabled, - 'logging': logging, - 'timeout': timeout, - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'buildRuntime': buildRuntime.value, - 'adapter': adapter?.value, - 'installationId': installationId, - 'fallbackFile': fallbackFile, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Get a list of all frameworks that are currently available on the server - /// instance. - Future listFrameworks() async { - final String apiPath = '/sites/frameworks'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FrameworkList.fromMap(res.data); - } - - /// List allowed site specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/sites/specifications'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SpecificationList.fromMap(res.data); - } - - /// Get a site by its unique ID. - Future get({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Update site by its unique ID. - Future update({ - required String siteId, - required String name, - required enums.Framework framework, - bool? enabled, - bool? logging, - int? timeout, - String? installCommand, - String? buildCommand, - String? outputDirectory, - enums.BuildRuntime? buildRuntime, - enums.Adapter? adapter, - String? fallbackFile, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'name': name, - 'framework': framework.value, - 'enabled': enabled, - 'logging': logging, - 'timeout': timeout, - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'buildRuntime': buildRuntime?.value, - 'adapter': adapter?.value, - 'fallbackFile': fallbackFile, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Delete a site by its unique ID. - Future delete({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the site active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your site. - Future updateSiteDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployment'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Get a list of all the site's code deployments. You can use the query params - /// to filter your results. - Future listDeployments({ - required String siteId, - List? queries, - String? search, - }) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DeploymentList.fromMap(res.data); - } - - /// 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. - Future createDeployment({ - required String siteId, - required InputFile code, - required bool activate, - String? installCommand, - String? buildCommand, - String? outputDirectory, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'code': code, - 'activate': activate, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createDuplicateDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createTemplateDeployment({ - required String siteId, - required String repository, - required String owner, - required String rootDirectory, - required String version, - bool? activate, - }) async { - final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'repository': repository, - 'owner': owner, - 'rootDirectory': rootDirectory, - 'version': version, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Create a deployment when a site is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({ - required String siteId, - required enums.VCSDeploymentType type, - required String reference, - bool? activate, - }) async { - final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'type': type.value, - 'reference': reference, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a site deployment by its unique ID. - Future getDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Delete a site deployment by its unique ID. - Future deleteDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future getDeploymentDownload({ - required String siteId, - required String deploymentId, - enums.DeploymentDownloadType? type, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a list of all site logs. You can use the query params to filter your - /// results. - Future listLogs({ - required String siteId, - List? queries, - }) async { - final String apiPath = '/sites/{siteId}/logs'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ExecutionList.fromMap(res.data); - } - - /// Get a site request log by its unique ID. - Future getLog({ - required String siteId, - required String logId, - }) async { - final String apiPath = '/sites/{siteId}/logs/{logId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{logId}', logId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Delete a site log by its unique ID. - Future deleteLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{logId}', logId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all variables of a specific site. - Future listVariables({required String siteId}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.VariableList.fromMap(res.data); - } - - /// Create a new site variable. These variables can be accessed during build - /// and runtime (server-side rendering) as environment variables. - Future createVariable({ - required String siteId, - required String key, - required String value, - bool? secret, - }) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Get a variable by its unique ID. - Future getVariable({ - required String siteId, - required String variableId, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Update variable by its unique ID. - Future updateVariable({ - required String siteId, - required String variableId, - required String key, - String? value, - bool? secret, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Delete a variable by its unique ID. - Future deleteVariable({ - required String siteId, - required String variableId, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SiteList.fromMap(res.data); + + } + + /// Create a new site. + Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + + 'siteId': siteId, +'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime.value, +'adapter': adapter?.value, +'installationId': installationId, +'fallbackFile': fallbackFile, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FrameworkList.fromMap(res.data); + + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Update site by its unique ID. + Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime?.value, +'adapter': adapter?.value, +'fallbackFile': fallbackFile, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({required String siteId, List? queries, String? search}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// 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. + Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'type': type.value, +'reference': reference, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a site deployment by its unique ID. + Future getDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({required String siteId, List? queries}) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Get a site request log by its unique ID. + Future getLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/storage.dart b/lib/services/storage.dart index ee630883..9165e91b 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,421 +2,329 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({ - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.BucketList.fromMap(res.data); - } - - /// Create a new storage bucket. - Future createBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'bucketId': bucketId, - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({ - required String bucketId, - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FileList.fromMap(res.data); - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({ - required String bucketId, - required String fileId, - required InputFile file, - List? permissions, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'fileId': fileId, - 'file': file, - 'permissions': permissions, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({ - required String bucketId, - required String fileId, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({ - required String bucketId, - required String fileId, - String? name, - List? permissions, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a file 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. - Future getFileDownload({ - required String bucketId, - required String fileId, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({ - required String bucketId, - required String fileId, - int? width, - int? height, - enums.ImageGravity? gravity, - int? quality, - int? borderWidth, - String? borderColor, - int? borderRadius, - double? opacity, - int? rotation, - String? background, - enums.ImageFormat? output, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, - 'height': height, - 'gravity': gravity?.value, - 'quality': quality, - 'borderWidth': borderWidth, - 'borderColor': borderColor, - 'borderRadius': borderRadius, - 'opacity': opacity, - 'rotation': rotation, - 'background': background, - 'output': output?.value, - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({ - required String bucketId, - required String fileId, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({List? queries, String? search}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.BucketList.fromMap(res.data); + + } + + /// Create a new storage bucket. + Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + + 'bucketId': bucketId, +'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({required String bucketId, List? queries, String? search}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FileList.fromMap(res.data); + + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'fileId': fileId, +'file': file, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a file 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. + Future getFileDownload({required String bucketId, required String fileId, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, +'height': height, +'gravity': gravity?.value, +'quality': quality, +'borderWidth': borderWidth, +'borderColor': borderColor, +'borderRadius': borderRadius, +'opacity': opacity, +'rotation': rotation, +'background': background, +'output': output?.value, +'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({required String bucketId, required String fileId, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 5fd59641..2b492f27 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,356 +3,321 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TeamList.fromMap(res.data); - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({ - required String teamId, - required String name, - List? roles, - }) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'teamId': teamId, - 'name': name, - 'roles': roles, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Update the team's name by its unique ID. - Future updateName({ - required String teamId, - required String name, - }) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({ - required String teamId, - List? queries, - String? search, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({ - required String teamId, - required List roles, - String? email, - String? userId, - String? phone, - String? url, - String? name, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'email': email, - 'userId': userId, - 'phone': phone, - 'roles': roles, - 'url': url, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({ - required String teamId, - required String membershipId, - required List roles, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'roles': roles}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({ - required String teamId, - required String membershipId, - required String userId, - required String secret, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({ - required String teamId, - required Map prefs, - }) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } -} + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TeamList.fromMap(res.data); + + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({required String teamId, required String name, List? roles}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + + 'teamId': teamId, +'name': name, +'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Update the team's name by its unique ID. + Future updateName({required String teamId, required String name}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({required String teamId, List? queries, String? search}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'email': email, +'userId': userId, +'phone': phone, +'roles': roles, +'url': url, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({required String teamId, required String membershipId, required List roles}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({required String teamId, required Map prefs}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart index 0224b0a5..a9b8f78a 100644 --- a/lib/services/tokens.dart +++ b/lib/services/tokens.dart @@ -1,113 +1,109 @@ part of '../dart_appwrite.dart'; class Tokens extends Service { - Tokens(super.client); - - /// List all the tokens created for a specific file or bucket. You can use the - /// query params to filter your results. - Future list({ - required String bucketId, - required String fileId, - List? queries, - }) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceTokenList.fromMap(res.data); - } - - /// Create a new token. A token is linked to a file. Token can be passed as a - /// header or request get parameter. - Future createFileToken({ - required String bucketId, - required String fileId, - String? expire, - }) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Get a token by its unique ID. - Future get({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Update a token by its unique ID. Use this endpoint to update a token's - /// expiry date. - Future update({ - required String tokenId, - String? expire, - }) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Delete a token by its unique ID. - Future delete({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({required String bucketId, required String fileId, List? queries}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceTokenList.fromMap(res.data); + + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({required String bucketId, required String fileId, String? expire}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({required String tokenId, String? expire}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/users.dart b/lib/services/users.dart index c98182b7..765ec3e6 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,1107 +2,962 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.UserList.fromMap(res.data); - } - - /// Create a new user. - Future create({ - required String userId, - String? email, - String? phone, - String? password, - String? name, - }) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phone': phone, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get identities for all users. - Future listIdentities({ - List? queries, - String? search, - }) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required int passwordCpu, - required int passwordMemory, - required int passwordParallel, - required int passwordLength, - String? name, - }) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordCpu': passwordCpu, - 'passwordMemory': passwordMemory, - 'passwordParallel': passwordParallel, - 'passwordLength': passwordLength, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required String passwordSaltSeparator, - required String passwordSignerKey, - String? name, - }) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordSaltSeparator': passwordSaltSeparator, - 'passwordSignerKey': passwordSignerKey, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({ - required String userId, - required String email, - required String password, - enums.PasswordHash? passwordVersion, - String? name, - }) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordVersion': passwordVersion?.value, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user email by its unique ID. - Future updateEmail({ - required String userId, - required String email, - }) async { - final String apiPath = '/users/{userId}/email'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'email': email}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({ - required String userId, - String? sessionId, - int? duration, - }) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'sessionId': sessionId, - 'duration': duration, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({ - required String userId, - required List labels, - }) async { - final String apiPath = '/users/{userId}/labels'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'labels': labels}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/logs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the user membership list by its unique ID. - Future listMemberships({ - required String userId, - List? queries, - String? search, - }) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Enable or disable MFA on a user account. - Future updateMfa({ - required String userId, - required bool mfa, - }) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({ - required String userId, - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}' - .replaceAll('{userId}', userId) - .replaceAll('{type}', type.value); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update the user name by its unique ID. - Future updateName({ - required String userId, - required String name, - }) async { - final String apiPath = '/users/{userId}/name'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user password by its unique ID. - Future updatePassword({ - required String userId, - required String password, - }) async { - final String apiPath = '/users/{userId}/password'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'password': password}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone by its unique ID. - Future updatePhone({ - required String userId, - required String number, - }) async { - final String apiPath = '/users/{userId}/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'number': number}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({ - required String userId, - required Map prefs, - }) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({ - required String userId, - required String sessionId, - }) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}' - .replaceAll('{userId}', userId) - .replaceAll('{sessionId}', sessionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({ - required String userId, - required bool status, - }) async { - final String apiPath = '/users/{userId}/status'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'status': status}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// List the messaging targets that are associated with a user. - Future listTargets({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Create a messaging target. - Future createTarget({ - required String userId, - required String targetId, - required enums.MessagingProviderType providerType, - required String identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'targetId': targetId, - 'providerType': providerType.value, - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Get a user's push notification target by ID. - Future getTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Update a messaging target. - Future updateTarget({ - required String userId, - required String targetId, - String? identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = { - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Delete a messaging target. - Future deleteTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({ - required String userId, - int? length, - int? expire, - }) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'length': length, 'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({ - required String userId, - required bool emailVerification, - }) async { - final String apiPath = '/users/{userId}/verification'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'emailVerification': emailVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({ - required String userId, - required bool phoneVerification, - }) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'phoneVerification': phoneVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } -} + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.UserList.fromMap(res.data); + + } + + /// Create a new user. + Future create({required String userId, String? email, String? phone, String? password, String? name}) async { + final String apiPath = '/users'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phone': phone, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get identities for all users. + Future listIdentities({List? queries, String? search}) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordCpu': passwordCpu, +'passwordMemory': passwordMemory, +'passwordParallel': passwordParallel, +'passwordLength': passwordLength, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordSaltSeparator': passwordSaltSeparator, +'passwordSignerKey': passwordSignerKey, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordVersion': passwordVersion?.value, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user email by its unique ID. + Future updateEmail({required String userId, required String email}) async { + final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'email': email, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({required String userId, String? sessionId, int? duration}) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'sessionId': sessionId, +'duration': duration, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({required String userId, required List labels}) async { + final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'labels': labels, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the user membership list by its unique ID. + Future listMemberships({required String userId, List? queries, String? search}) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Enable or disable MFA on a user account. + Future updateMfa({required String userId, required bool mfa}) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update the user name by its unique ID. + Future updateName({required String userId, required String name}) async { + final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user password by its unique ID. + Future updatePassword({required String userId, required String password}) async { + final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone by its unique ID. + Future updatePhone({required String userId, required String number}) async { + final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'number': number, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({required String userId, required Map prefs}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({required String userId, required String sessionId}) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({required String userId, required bool status}) async { + final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'status': status, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// List the messaging targets that are associated with a user. + Future listTargets({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Create a messaging target. + Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'targetId': targetId, +'providerType': providerType.value, +'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Get a user's push notification target by ID. + Future getTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Update a messaging target. + Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + 'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Delete a messaging target. + Future deleteTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({required String userId, int? length, int? expire}) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'length': length, +'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({required String userId, required bool emailVerification}) async { + final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'emailVerification': emailVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'phoneVerification': phoneVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/src/client.dart b/lib/src/client.dart index d82d623a..2fc990a5 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client({ - String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false, - }) => createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client( + {String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false}) => + createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,8 +81,7 @@ abstract class Client { }); /// Send the API request. - Future call( - HttpMethod method, { + Future call(HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index 08d93b85..cd82d264 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,25 +2,21 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); - /// Your secret API key @override ClientBase setKey(value); - /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); - /// The user session to authenticate with @override ClientBase setSession(value); - /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index 1ba611e8..7b2cb4e8 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,11 +9,14 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -30,67 +33,60 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - 'x-sdk-version': '15.2.0', - 'X-Appwrite-Response-Format': '1.7.0', + 'x-sdk-version': '16.0.0', + 'X-Appwrite-Response-Format' : '1.7.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -139,11 +135,7 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); return call( HttpMethod.post, path: path, @@ -170,19 +162,12 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 74232a8d..88663581 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,11 +10,17 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => - ClientIO(endPoint: endPoint, selfSigned: selfSigned); +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => + ClientIO( + endPoint: endPoint, + selfSigned: selfSigned, + ); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -26,10 +32,9 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = - HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -37,69 +42,61 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-name': 'Dart', 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', - 'x-sdk-version': '15.2.0', - 'user-agent': - 'AppwriteDartSDK/15.2.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format': '1.7.0', + 'x-sdk-version': '16.0.0', + 'user-agent' : 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format' : '1.7.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -154,16 +151,11 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, - file.path!, - filename: file.filename, - ); + paramName, file.path!, + filename: file.filename); } else { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, + filename: file.filename); } return call( HttpMethod.post, @@ -202,19 +194,12 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -259,7 +244,10 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse(res, responseType: responseType); + return prepareResponse( + res, + responseType: responseType, + ); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index 310bc3ca..658b79b6 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest).fields.addAll({ - "$key[$i]": v.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({"$key[$i]": v.toString()}); }); } else { - (request as http.MultipartRequest).fields.addAll({ - key: value.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({key: value.toString()}); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value) { + params = params.map((key, value){ if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,13 +51,12 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port, - ); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); @@ -67,9 +66,7 @@ mixin ClientMixin { headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); } if (headers['X-Forwarded-User-Agent'] != null) { - headers['X-Forwarded-User-Agent'] = Uri.encodeFull( - headers['X-Forwarded-User-Agent']!, - ); + headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); } request.headers.addAll(headers); @@ -116,26 +113,18 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse( - http.StreamedResponse streamedResponse, - ) async { - if (streamedResponse.statusCode == 204) { - return http.Response( - '', - streamedResponse.statusCode, - headers: streamedResponse.headers.map( - (k, v) => - k.toLowerCase() == 'content-type' - ? MapEntry(k, 'text/plain') - : MapEntry(k, v), - ), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse(http.StreamedResponse streamedResponse) async { + if(streamedResponse.statusCode == 204) { + return http.Response('', + streamedResponse.statusCode, + headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 2cb7727e..95e9d217 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,5 +3,4 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.', - ); + 'Cannot create a client without dart:html or dart:io.'); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 08fd6068..6566f2e1 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes, + bytes } diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart index d1af0722..053080ef 100644 --- a/lib/src/enums/adapter.dart +++ b/lib/src/enums/adapter.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum Adapter { - static(value: 'static'), - ssr(value: 'ssr'); + static(value: 'static'), + ssr(value: 'ssr'); - const Adapter({required this.value}); + const Adapter({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 1d5271eb..00d12830 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({required this.value}); + const AuthenticationFactor({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index c1fe8584..10460393 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,11 +1,13 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({required this.value}); + const AuthenticatorType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 949f4c47..386fa11d 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,24 +1,26 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({required this.value}); + const Browser({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart index 88ffbfa6..fdccfcbb 100644 --- a/lib/src/enums/build_runtime.dart +++ b/lib/src/enums/build_runtime.dart @@ -1,73 +1,75 @@ part of '../../enums.dart'; enum BuildRuntime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const BuildRuntime({required this.value}); + const BuildRuntime({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 768930d9..209acfb8 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({required this.value}); + const Compression({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index 1bae5c8a..cd45b6a1 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,27 +1,29 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({required this.value}); + const CreditCard({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart index 1788f892..782b30c7 100644 --- a/lib/src/enums/deployment_download_type.dart +++ b/lib/src/enums/deployment_download_type.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum DeploymentDownloadType { - source(value: 'source'), - output(value: 'output'); + source(value: 'source'), + output(value: 'output'); - const DeploymentDownloadType({required this.value}); + const DeploymentDownloadType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 42954430..7d2d7016 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,16 +1,18 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({required this.value}); + const ExecutionMethod({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index a44cb81d..27c25cac 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,205 +1,207 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({required this.value}); + const Flag({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart index e20f48c6..af5ebaad 100644 --- a/lib/src/enums/framework.dart +++ b/lib/src/enums/framework.dart @@ -1,24 +1,26 @@ part of '../../enums.dart'; enum Framework { - analog(value: 'analog'), - angular(value: 'angular'), - nextjs(value: 'nextjs'), - react(value: 'react'), - nuxt(value: 'nuxt'), - vue(value: 'vue'), - sveltekit(value: 'sveltekit'), - astro(value: 'astro'), - remix(value: 'remix'), - lynx(value: 'lynx'), - flutter(value: 'flutter'), - reactNative(value: 'react-native'), - vite(value: 'vite'), - other(value: 'other'); + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); - const Framework({required this.value}); + const Framework({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index 120c93f4..dbf6825e 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,16 +1,18 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({required this.value}); + const ImageFormat({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 88029044..79bc4d62 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,19 +1,21 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({required this.value}); + const ImageGravity({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index b101d35f..8d86530d 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({required this.value}); + const IndexType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index a07e6f76..375913e8 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({required this.value}); + const MessagePriority({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index c69bf01e..a6859648 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({required this.value}); + const MessagingProviderType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 74823feb..613bf5f1 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,22 +1,24 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({required this.value}); + const Name({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 383e45b1..076c1c50 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,50 +1,52 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({required this.value}); + const OAuthProvider({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 9d98c26a..510ee260 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,21 +1,23 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({required this.value}); + const PasswordHash({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index b215a8fa..9f4c1a85 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({required this.value}); + const RelationMutate({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 30efc944..301bc61d 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({required this.value}); + const RelationshipType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index fec56a9b..a0ff38c8 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,73 +1,75 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const Runtime({required this.value}); + const Runtime({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index cb6cee26..6c880ed6 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({required this.value}); + const SmtpEncryption({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart index f01fcb01..0bf8e2ad 100644 --- a/lib/src/enums/vcs_deployment_type.dart +++ b/lib/src/enums/vcs_deployment_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum VCSDeploymentType { - branch(value: 'branch'), - commit(value: 'commit'), - tag(value: 'tag'); + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); - const VCSDeploymentType({required this.value}); + const VCSDeploymentType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 82229daa..93b6ee3d 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index 4145f701..f174d569 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index 4e901476..c9f67200 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({required this.type}); + AlgoBcrypt({ + required this.type, + }); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt(type: map['type'].toString()); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 35c7b767..2fabb416 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({required this.type}); + AlgoMd5({ + required this.type, + }); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5(type: map['type'].toString()); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index 7d27adba..fdcee07a 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({required this.type}); + AlgoPhpass({ + required this.type, + }); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass(type: map['type'].toString()); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index fec6f65a..120723df 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 0e80700f..504b5f8f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index bae6618f..5f3e1654 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({required this.type}); + AlgoSha({ + required this.type, + }); - factory AlgoSha.fromMap(Map map) { - return AlgoSha(type: map['type'].toString()); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 0ca54691..20dd7189 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index 1df01f19..a5b27b4f 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 21f8e9a3..96ce554b 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index 298c181a..a4953a0e 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index c6eecadd..03ba94c7 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 1ef48332..8a5aa89d 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index 8c8fcb73..d17f414a 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index c5fa6adc..4098a5a1 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({required this.total, required this.attributes}); + AttributeList({ + required this.total, + required this.attributes, + }); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return {"total": total, "attributes": attributes}; - } + Map toMap() { + return { + "total": total, + "attributes": attributes, + }; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 903c6290..050cbe14 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index d32b6829..89de3a57 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index f0bc295e..0c3ddf9e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index b8fb5e48..3bb374be 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 224c910d..366d80f9 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({required this.total, required this.buckets}); + BucketList({ + required this.total, + required this.buckets, + }); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "buckets": buckets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index 72de429d..c55110cf 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index 49785e2b..aad4d44a 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({required this.total, required this.collections}); + CollectionList({ + required this.total, + required this.collections, + }); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from( - map['collections'].map((p) => Collection.fromMap(p)), - ), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 7318b7ad..1a9c5038 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({required this.name, required this.code}); + Continent({ + required this.name, + required this.code, + }); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 2c605d3b..7a1eb84c 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({required this.total, required this.continents}); + ContinentList({ + required this.total, + required this.continents, + }); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from( - map['continents'].map((p) => Continent.fromMap(p)), - ), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index c52b50f2..565b1d66 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,19 +2,28 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({required this.name, required this.code}); + Country({ + required this.name, + required this.code, + }); - factory Country.fromMap(Map map) { - return Country(name: map['name'].toString(), code: map['code'].toString()); - } + factory Country.fromMap(Map map) { + return Country( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index 6ef8ec42..e0b8f29f 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({required this.total, required this.countries}); + CountryList({ + required this.total, + required this.countries, + }); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from( - map['countries'].map((p) => Country.fromMap(p)), - ), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from(map['countries'].map((p) => Country.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index 27eef0c1..deafffe3 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index acb515e3..f67049ae 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({required this.total, required this.currencies}); + CurrencyList({ + required this.total, + required this.currencies, + }); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from( - map['currencies'].map((p) => Currency.fromMap(p)), - ), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 298a46a3..09ee2aae 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 5b6df8d4..03b959db 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({required this.total, required this.databases}); + DatabaseList({ + required this.total, + required this.databases, + }); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from( - map['databases'].map((p) => Database.fromMap(p)), - ), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from(map['databases'].map((p) => Database.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index 448c62c7..ecf7e791 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,178 +2,178 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; + /// Deployment creation date in ISO 8601 format. + final String $createdAt; - /// Deployment update date in ISO 8601 format. - final String $updatedAt; + /// Deployment update date in ISO 8601 format. + final String $updatedAt; - /// Type of deployment. - final String type; + /// Type of deployment. + final String type; - /// Resource ID. - final String resourceId; + /// Resource ID. + final String resourceId; - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int sourceSize; - - /// The build output size in bytes. - final int buildSize; - - /// The total size in bytes (source and build output). - final int totalSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// Screenshot with light theme preference file ID. - final String screenshotLight; - - /// Screenshot with dark theme preference file ID. - final String screenshotDark; - - /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildDuration; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.sourceSize, - required this.buildSize, - required this.totalSize, - required this.buildId, - required this.activate, - required this.screenshotLight, - required this.screenshotDark, - required this.status, - required this.buildLogs, - required this.buildDuration, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - sourceSize: map['sourceSize'], - buildSize: map['buildSize'], - totalSize: map['totalSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - screenshotLight: map['screenshotLight'].toString(), - screenshotDark: map['screenshotDark'].toString(), - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildDuration: map['buildDuration'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "sourceSize": sourceSize, - "buildSize": buildSize, - "totalSize": totalSize, - "buildId": buildId, - "activate": activate, - "screenshotLight": screenshotLight, - "screenshotDark": screenshotDark, - "status": status, - "buildLogs": buildLogs, - "buildDuration": buildDuration, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int sourceSize; + + /// The build output size in bytes. + final int buildSize; + + /// The total size in bytes (source and build output). + final int totalSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildDuration; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.sourceSize, + required this.buildSize, + required this.totalSize, + required this.buildId, + required this.activate, + required this.screenshotLight, + required this.screenshotDark, + required this.status, + required this.buildLogs, + required this.buildDuration, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + sourceSize: map['sourceSize'], + buildSize: map['buildSize'], + totalSize: map['totalSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildDuration: map['buildDuration'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "sourceSize": sourceSize, + "buildSize": buildSize, + "totalSize": totalSize, + "buildId": buildId, + "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, + "status": status, + "buildLogs": buildLogs, + "buildDuration": buildDuration, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 15a93ef4..508bb705 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({required this.total, required this.deployments}); + DeploymentList({ + required this.total, + required this.deployments, + }); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from( - map['deployments'].map((p) => Deployment.fromMap(p)), - ), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index 37fb2b7b..b6454aae 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 126ad805..8af34256 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,30 +2,31 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({required this.total, required this.documents}); + DocumentList({ + required this.total, + required this.documents, + }); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from( - map['documents'].map((p) => Document.fromMap(p)), - ), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from(map['documents'].map((p) => Document.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 8618bcd6..0cfdbb4e 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,122 +2,118 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Resource(function/site) execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from( - map['requestHeaders'].map((p) => Headers.fromMap(p)), - ), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from( - map['responseHeaders'].map((p) => Headers.fromMap(p)), - ), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Resource(function/site) execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 2a2ef056..0bcbad6a 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({required this.total, required this.executions}); + ExecutionList({ + required this.total, + required this.executions, + }); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from( - map['executions'].map((p) => Execution.fromMap(p)), - ), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index a6a9fa46..de8439ec 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 9f01530b..28bc6fcf 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({required this.total, required this.files}); + FileList({ + required this.total, + required this.files, + }); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "files": files.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "files": files.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart index 693c9b07..ea6b601a 100644 --- a/lib/src/models/framework.dart +++ b/lib/src/models/framework.dart @@ -2,48 +2,46 @@ part of '../../models.dart'; /// Framework class Framework implements Model { - /// Framework key. - final String key; - - /// Framework Name. - final String name; - - /// Default runtime version. - final String buildRuntime; - - /// List of supported runtime versions. - final List runtimes; - - /// List of supported adapters. - final List adapters; - - Framework({ - required this.key, - required this.name, - required this.buildRuntime, - required this.runtimes, - required this.adapters, - }); - - factory Framework.fromMap(Map map) { - return Framework( - key: map['key'].toString(), - name: map['name'].toString(), - buildRuntime: map['buildRuntime'].toString(), - runtimes: List.from(map['runtimes'] ?? []), - adapters: List.from( - map['adapters'].map((p) => FrameworkAdapter.fromMap(p)), - ), - ); - } - - Map toMap() { - return { - "key": key, - "name": name, - "buildRuntime": buildRuntime, - "runtimes": runtimes, - "adapters": adapters.map((p) => p.toMap()).toList(), - }; - } + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart index 0b908240..7614616a 100644 --- a/lib/src/models/framework_adapter.dart +++ b/lib/src/models/framework_adapter.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Framework Adapter class FrameworkAdapter implements Model { - /// Adapter key. - final String key; - - /// Default command to download dependencies. - final String installCommand; - - /// Default command to build site into output directory. - final String buildCommand; - - /// Default output directory of build. - final String outputDirectory; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - FrameworkAdapter({ - required this.key, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.fallbackFile, - }); - - factory FrameworkAdapter.fromMap(Map map) { - return FrameworkAdapter( - key: map['key'].toString(), - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "fallbackFile": fallbackFile, - }; - } + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart index 266d8edf..deb19e62 100644 --- a/lib/src/models/framework_list.dart +++ b/lib/src/models/framework_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Frameworks List class FrameworkList implements Model { - /// Total number of frameworks documents that matched your query. - final int total; + /// Total number of frameworks documents that matched your query. + final int total; - /// List of frameworks. - final List frameworks; + /// List of frameworks. + final List frameworks; - FrameworkList({required this.total, required this.frameworks}); + FrameworkList({ + required this.total, + required this.frameworks, + }); - factory FrameworkList.fromMap(Map map) { - return FrameworkList( - total: map['total'], - frameworks: List.from( - map['frameworks'].map((p) => Framework.fromMap(p)), - ), - ); - } + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "frameworks": frameworks.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 56c2eded..64401c3f 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,184 +2,184 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; + /// Function creation date in ISO 8601 format. + final String $createdAt; - /// Function update date in ISO 8601 format. - final String $updatedAt; + /// Function update date in ISO 8601 format. + final String $updatedAt; - /// Execution permissions. - final List execute; + /// Execution permissions. + final List execute; - /// Function name. - final String name; + /// Function name. + final String name; - /// Function enabled. - final bool enabled; + /// Function enabled. + final bool enabled; - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// When disabled, executions will exclude logs and errors, and will be slightly faster. - final bool logging; - - /// Function execution and build runtime. - final String runtime; - - /// Function's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Function's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// When disabled, executions will exclude logs and errors, and will be slightly faster. + final bool logging; + + /// Function execution and build runtime. + final String runtime; + + /// Function's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index c37f0615..8f0b8928 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,25 +2,28 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({required this.total, required this.functions}); + FunctionList({ + required this.total, + required this.functions, + }); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index 463cf696..ecf0a178 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({required this.name, required this.value}); + Headers({ + required this.name, + required this.value, + }); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return {"name": name, "value": value}; - } + Map toMap() { + return { + "name": name, + "value": value, + }; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index fa402e97..54c31e70 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({required this.version, required this.status}); + HealthAntivirus({ + required this.version, + required this.status, + }); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return {"version": version, "status": status}; - } + Map toMap() { + return { + "version": version, + "status": status, + }; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index d412eba9..0a5b6ce9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 5f06906b..95da1235 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({required this.size}); + HealthQueue({ + required this.size, + }); - factory HealthQueue.fromMap(Map map) { - return HealthQueue(size: map['size']); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue( + size: map['size'], + ); + } - Map toMap() { - return {"size": size}; - } + Map toMap() { + return { + "size": size, + }; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 59b7092c..0d6e7216 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({required this.name, required this.ping, required this.status}); + HealthStatus({ + required this.name, + required this.ping, + required this.status, + }); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return {"name": name, "ping": ping, "status": status}; - } + Map toMap() { + return { + "name": name, + "ping": ping, + "status": status, + }; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index dec2d54f..102dfe77 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,30 +2,34 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; - } + Map toMap() { + return { + "remoteTime": remoteTime, + "localTime": localTime, + "diff": diff, + }; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index 807bdfd0..c43c4d57 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index f38eaf66..e92e36cc 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({required this.total, required this.identities}); + IdentityList({ + required this.total, + required this.identities, + }); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from( - map['identities'].map((p) => Identity.fromMap(p)), - ), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 961b9e5e..07d22743 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index attributes length. - final List lengths; + /// Index attributes length. + final List lengths; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - required this.lengths, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + required this.lengths, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - lengths: List.from(map['lengths'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "lengths": lengths, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "lengths": lengths, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index dc759dfb..8eac7956 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({required this.total, required this.indexes}); + IndexList({ + required this.total, + required this.indexes, + }); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 490a1824..1b4ff7de 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({required this.jwt}); + Jwt({ + required this.jwt, + }); - factory Jwt.fromMap(Map map) { - return Jwt(jwt: map['jwt'].toString()); - } + factory Jwt.fromMap(Map map) { + return Jwt( + jwt: map['jwt'].toString(), + ); + } - Map toMap() { - return {"jwt": jwt}; - } + Map toMap() { + return { + "jwt": jwt, + }; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 9c45adb1..43eaad08 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({required this.name, required this.code, required this.nativeName}); + Language({ + required this.name, + required this.code, + required this.nativeName, + }); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code, "nativeName": nativeName}; - } + Map toMap() { + return { + "name": name, + "code": code, + "nativeName": nativeName, + }; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index 046b879e..fe271118 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({required this.total, required this.languages}); + LanguageList({ + required this.total, + required this.languages, + }); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from( - map['languages'].map((p) => Language.fromMap(p)), - ), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from(map['languages'].map((p) => Language.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index 084475bf..b5e9ad1a 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index cd5a1155..10499ef5 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({required this.code, required this.name}); + LocaleCode({ + required this.code, + required this.name, + }); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return {"code": code, "name": name}; - } + Map toMap() { + return { + "code": code, + "name": name, + }; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 662fee4f..839474d7 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({required this.total, required this.localeCodes}); + LocaleCodeList({ + required this.total, + required this.localeCodes, + }); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from( - map['localeCodes'].map((p) => LocaleCode.fromMap(p)), - ), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index 7fb3f364..cb567bd7 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 628237fa..91d024d0 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({required this.total, required this.logs}); + LogList({ + required this.total, + required this.logs, + }); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "logs": logs.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 8ee142ad..26610e46 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 46468a3a..409cdbfb 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({required this.total, required this.memberships}); + MembershipList({ + required this.total, + required this.memberships, + }); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from( - map['memberships'].map((p) => Membership.fromMap(p)), - ), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index 9b93b00d..c4e9e858 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 7bd0891f..702c912b 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({required this.total, required this.messages}); + MessageList({ + required this.total, + required this.messages, + }); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from( - map['messages'].map((p) => Message.fromMap(p)), - ), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from(map['messages'].map((p) => Message.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 96bf3c65..46c166fb 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index c930a23e..d49989d8 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 63411988..6c8b4e36 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,18 +2,22 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({required this.recoveryCodes}); + MfaRecoveryCodes({ + required this.recoveryCodes, + }); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return {"recoveryCodes": recoveryCodes}; - } + Map toMap() { + return { + "recoveryCodes": recoveryCodes, + }; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index fa57cb8b..01cf0857 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({required this.secret, required this.uri}); + MfaType({ + required this.secret, + required this.uri, + }); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return {"secret": secret, "uri": uri}; - } + Map toMap() { + return { + "secret": secret, + "uri": uri, + }; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index f810a35b..48e5b84a 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} +} \ No newline at end of file diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index 40f7bcd2..c8bbb95b 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index 18d2803d..beab76e8 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({required this.total, required this.phones}); + PhoneList({ + required this.total, + required this.phones, + }); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "phones": phones.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 48163dfc..3c62f86d 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,17 +2,23 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({required this.data}); + Preferences({ + required this.data, + }); - factory Preferences.fromMap(Map map) { - return Preferences(data: map); - } + factory Preferences.fromMap(Map map) { + return Preferences( + data: map, + ); + } - Map toMap() { - return {"data": data}; - } + Map toMap() { + return { + "data": data, + }; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 1a762f85..4295c486 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index aeb28ecd..7c09eb56 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({required this.total, required this.providers}); + ProviderList({ + required this.total, + required this.providers, + }); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from( - map['providers'].map((p) => Provider.fromMap(p)), - ), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart index dad35dcc..ed520cc4 100644 --- a/lib/src/models/resource_token.dart +++ b/lib/src/models/resource_token.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// ResourceToken class ResourceToken implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// JWT encoded string. - final String secret; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - ResourceToken({ - required this.$id, - required this.$createdAt, - required this.resourceId, - required this.resourceType, - required this.expire, - required this.secret, - required this.accessedAt, - }); - - factory ResourceToken.fromMap(Map map) { - return ResourceToken( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - expire: map['expire'].toString(), - secret: map['secret'].toString(), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "resourceId": resourceId, - "resourceType": resourceType, - "expire": expire, - "secret": secret, - "accessedAt": accessedAt, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart index f30531f4..ba8f0d89 100644 --- a/lib/src/models/resource_token_list.dart +++ b/lib/src/models/resource_token_list.dart @@ -2,24 +2,28 @@ part of '../../models.dart'; /// Resource Tokens List class ResourceTokenList implements Model { - /// Total number of tokens documents that matched your query. - final int total; + /// Total number of tokens documents that matched your query. + final int total; - /// List of tokens. - final List tokens; + /// List of tokens. + final List tokens; - ResourceTokenList({required this.total, required this.tokens}); + ResourceTokenList({ + required this.total, + required this.tokens, + }); - factory ResourceTokenList.fromMap(Map map) { - return ResourceTokenList( - total: map['total'], - tokens: List.from( - map['tokens'].map((p) => ResourceToken.fromMap(p)), - ), - ); - } + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "tokens": tokens.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "tokens": tokens.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 7c9677d8..35f82cfa 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 02c7b2e5..7615fd9e 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({required this.total, required this.runtimes}); + RuntimeList({ + required this.total, + required this.runtimes, + }); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from( - map['runtimes'].map((p) => Runtime.fromMap(p)), - ), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index d2fe4f64..3a1d955f 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 479272b9..6d26d6a8 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({required this.total, required this.sessions}); + SessionList({ + required this.total, + required this.sessions, + }); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from( - map['sessions'].map((p) => Session.fromMap(p)), - ), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart index 1449f8bd..5cda6acc 100644 --- a/lib/src/models/site.dart +++ b/lib/src/models/site.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Site class Site implements Model { - /// Site ID. - final String $id; + /// Site ID. + final String $id; - /// Site creation date in ISO 8601 format. - final String $createdAt; + /// Site creation date in ISO 8601 format. + final String $createdAt; - /// Site update date in ISO 8601 format. - final String $updatedAt; + /// Site update date in ISO 8601 format. + final String $updatedAt; - /// Site name. - final String name; + /// Site name. + final String name; - /// Site enabled. - final bool enabled; + /// Site enabled. + final bool enabled; - /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. - final bool live; + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; - /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. - final bool logging; + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; - /// Site framework. - final String framework; - - /// Site's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Screenshot of active deployment with light theme preference file ID. - final String deploymentScreenshotLight; - - /// Screenshot of active deployment with dark theme preference file ID. - final String deploymentScreenshotDark; - - /// Site's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Site variables. - final List vars; - - /// Site request timeout in seconds. - final int timeout; - - /// The install command used to install the site dependencies. - final String installCommand; - - /// The build command used to build the site. - final String buildCommand; - - /// The directory where the site build output is located. - final String outputDirectory; - - /// Site VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to site in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - /// Site build runtime. - final String buildRuntime; - - /// Site framework adapter. - final String adapter; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - Site({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.framework, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.deploymentScreenshotLight, - required this.deploymentScreenshotDark, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.vars, - required this.timeout, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - required this.buildRuntime, - required this.adapter, - required this.fallbackFile, - }); - - factory Site.fromMap(Map map) { - return Site( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - framework: map['framework'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), - deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - timeout: map['timeout'], - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - buildRuntime: map['buildRuntime'].toString(), - adapter: map['adapter'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "framework": framework, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "deploymentScreenshotLight": deploymentScreenshotLight, - "deploymentScreenshotDark": deploymentScreenshotDark, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "vars": vars.map((p) => p.toMap()).toList(), - "timeout": timeout, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - "buildRuntime": buildRuntime, - "adapter": adapter, - "fallbackFile": fallbackFile, - }; - } + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart index a403dd5b..02a6a2be 100644 --- a/lib/src/models/site_list.dart +++ b/lib/src/models/site_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Sites List class SiteList implements Model { - /// Total number of sites documents that matched your query. - final int total; + /// Total number of sites documents that matched your query. + final int total; - /// List of sites. - final List sites; + /// List of sites. + final List sites; - SiteList({required this.total, required this.sites}); + SiteList({ + required this.total, + required this.sites, + }); - factory SiteList.fromMap(Map map) { - return SiteList( - total: map['total'], - sites: List.from(map['sites'].map((p) => Site.fromMap(p))), - ); - } + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "sites": sites.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "sites": sites.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e8fb8c75..e49d399c 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,35 +2,40 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; - } + Map toMap() { + return { + "memory": memory, + "cpus": cpus, + "enabled": enabled, + "slug": slug, + }; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index e4bef89b..72703f84 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({required this.total, required this.specifications}); + SpecificationList({ + required this.total, + required this.specifications, + }); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from( - map['specifications'].map((p) => Specification.fromMap(p)), - ), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 0c926297..36e18a7e 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index 7030fa0a..d7d3c3e3 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({required this.total, required this.subscribers}); + SubscriberList({ + required this.total, + required this.subscribers, + }); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from( - map['subscribers'].map((p) => Subscriber.fromMap(p)), - ), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index 4be8b545..f2b3b6b4 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 1042e5a2..2d38efe5 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({required this.total, required this.targets}); + TargetList({ + required this.total, + required this.targets, + }); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "targets": targets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index 43df33a8..e9058b5b 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index e604f192..2fb3611e 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({required this.total, required this.teams}); + TeamList({ + required this.total, + required this.teams, + }); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "teams": teams.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 35115467..4f6b8454 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 430d44ac..461d5694 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index a4d1f44f..e57ef05f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({required this.total, required this.topics}); + TopicList({ + required this.total, + required this.topics, + }); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "topics": topics.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index 50bfb3ce..effc397c 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 03e55cc6..55dfcf77 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({required this.total, required this.users}); + UserList({ + required this.total, + required this.users, + }); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "users": users.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "users": users.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 2a8e276a..58882a9f 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; + /// Variable ID. + final String $id; - /// Variable creation date in ISO 8601 format. - final String $createdAt; + /// Variable creation date in ISO 8601 format. + final String $createdAt; - /// Variable creation date in ISO 8601 format. - final String $updatedAt; + /// Variable creation date in ISO 8601 format. + final String $updatedAt; - /// Variable key. - final String key; + /// Variable key. + final String key; - /// Variable value. - final String value; + /// Variable value. + final String value; - /// Variable secret flag. Secret variables can only be updated or deleted, but never read. - final bool secret; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.secret, - required this.resourceType, - required this.resourceId, - }); + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.secret, + required this.resourceType, + required this.resourceId, + }); - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - secret: map['secret'], - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + secret: map['secret'], + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "secret": secret, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "secret": secret, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index 4ff3e189..b6da02cc 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({required this.total, required this.variables}); + VariableList({ + required this.total, + required this.variables, + }); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from( - map['variables'].map((p) => Variable.fromMap(p)), - ), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 5a19b0fc..44cde383 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, + "chunksUploaded": chunksUploaded }; } diff --git a/pubspec.yaml b/pubspec.yaml index cd0506f1..4a465625 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,5 +1,5 @@ name: dart_appwrite -version: 15.2.0 +version: 16.0.0 description: Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API homepage: https://appwrite.io repository: https://github.com/appwrite/sdk-for-dart From 0a337da6e06bef01ba3dea5040246b8e78a6e526 Mon Sep 17 00:00:00 2001 From: ChiragAgg5k Date: Sun, 18 May 2025 07:37:59 +0000 Subject: [PATCH 5/7] Commit from GitHub Actions (Format and push) --- lib/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 +++++++-------- lib/services/avatars.dart | 434 +-- lib/services/databases.dart | 2528 ++++++++++-------- lib/services/functions.dart | 1385 +++++----- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 +++-- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 +++++++++++-------- lib/services/sites.dart | 1282 +++++---- lib/services/storage.dart | 744 +++--- lib/services/teams.dart | 671 ++--- lib/services/tokens.dart | 216 +- lib/services/users.dart | 2063 ++++++++------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 123 +- lib/src/client_io.dart | 150 +- lib/src/client_mixin.dart | 65 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/adapter.dart | 14 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/build_runtime.dart | 136 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/deployment_download_type.dart | 14 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 ++- lib/src/enums/framework.dart | 38 +- lib/src/enums/image_format.dart | 22 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 136 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/enums/vcs_deployment_type.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 338 +-- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/framework.dart | 86 +- lib/src/models/framework_adapter.dart | 84 +- lib/src/models/framework_list.dart | 39 +- lib/src/models/function.dart | 348 +-- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 110 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/resource_token.dart | 108 +- lib/src/models/resource_token_list.dart | 36 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/site.dart | 358 +-- lib/src/models/site_list.dart | 34 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 100 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- 150 files changed, 13072 insertions(+), 12028 deletions(-) diff --git a/lib/client_browser.dart b/lib/client_browser.dart index 09f110ea..b9805a3a 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; \ No newline at end of file +export 'src/client_browser.dart'; diff --git a/lib/client_io.dart b/lib/client_io.dart index 4d85cbfa..42a0c0b6 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; \ No newline at end of file +export 'src/client_io.dart'; diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 5f5ffe9d..0848a050 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.7.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 72e26a23..28ff15e8 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,8 +10,7 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + - usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 46882207..9107a9a4 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,6 +1,5 @@ part of 'dart_appwrite.dart'; - /// Helper class to generate query strings. class Query { final String method; @@ -10,15 +9,13 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = { - 'method': method, - }; + final map = {'method': method}; - if(attribute != null) { + if (attribute != null) { map['attribute'] = attribute; } - - if(values != null) { + + if (values != null) { map['values'] = values is List ? values : [values]; } @@ -29,7 +26,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -61,10 +58,12 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => Query._('isNull', attribute).toString(); + static String isNull(String attribute) => + Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => + Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -84,40 +83,52 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'or', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); static String and(List queries) => - Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'and', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => + Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => + Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => + Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => + Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => Query._('offset', null, offset).toString(); - -} \ No newline at end of file + static String offset(int offset) => + Query._('offset', null, offset).toString(); +} diff --git a/lib/role.dart b/lib/role.dart index 6552df47..dafeb78d 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if(status.isEmpty) { - return 'user:$id'; - } - return 'user:$id/$status'; - } + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if(status.isEmpty) { - return 'users'; - } - return 'users/$status'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if (status.isEmpty) { + return 'user:$id'; } + return 'user:$id/$status'; + } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if (status.isEmpty) { + return 'users'; } + return 'users/$status'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if(role.isEmpty) { - return 'team:$id'; - } - return 'team:$id/$role'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if (role.isEmpty) { + return 'team:$id'; } + return 'team:$id/$role'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} \ No newline at end of file + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } + + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} diff --git a/lib/services/account.dart b/lib/services/account.dart index fdc8cc97..90e1f03e 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1081 +2,1084 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/account'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({required String email, required String password}) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaType.fromMap(res.data); - - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - 'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'factor': factor.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaChallenge.fromMap(res.data); - - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({required String challengeId, required String otp}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'challengeId': challengeId, -'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({required String password, String? oldPassword}) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - - 'password': password, -'oldPassword': oldPassword, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({required String phone, required String password}) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - - 'phone': phone, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({required String email, required String url}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'email': email, -'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({required String userId, required String secret, required String password}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({required String email, required String password}) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({required String userId, required String email, bool? phrase}) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'url': url, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); - - final Map params = { - 'success': success, -'failure': failure, -'scopes': scopes, - - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); - } - } else if(value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri(scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&') - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({required String userId, required String phone}) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = { - - 'userId': userId, -'phone': phone, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } -} \ No newline at end of file + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/account'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({ + required String email, + required String password, + }) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({ + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaType.fromMap(res.data); + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({ + required enums.AuthenticatorType type, + required String otp, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {'otp': otp}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({ + required enums.AuthenticationFactor factor, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = {'factor': factor.value}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaChallenge.fromMap(res.data); + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({ + required String challengeId, + required String otp, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + 'challengeId': challengeId, + 'otp': otp, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({ + required String password, + String? oldPassword, + }) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + 'password': password, + 'oldPassword': oldPassword, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({ + required String phone, + required String password, + }) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + 'phone': phone, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({ + required String email, + required String url, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = {'email': email, 'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({ + required String userId, + required String secret, + required String password, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + 'userId': userId, + 'secret': secret, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({ + required String email, + required String password, + }) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({ + required String userId, + required String email, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({ + required String userId, + required String email, + String? url, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'url': url, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({ + required enums.OAuthProvider provider, + String? success, + String? failure, + List? scopes, + }) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( + '{provider}', + provider.value, + ); + + final Map params = { + 'success': success, + 'failure': failure, + 'scopes': scopes, + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add( + Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), + ); + } + } else if (value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri( + scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&'), + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({ + required String userId, + required String phone, + }) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = {'userId': userId, 'phone': phone}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } +} diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 381146d4..8033f1cd 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,187 +3,253 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({required String url, int? width, int? height}) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, -'width': width, -'height': height, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({String? name, int? width, int? height, String? background}) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, -'width': width, -'height': height, -'background': background, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({required String text, int? size, int? margin, bool? download}) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, -'size': size, -'margin': margin, -'download': download, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({ + required enums.Browser code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({ + required enums.CreditCard code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({ + required enums.Flag code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({ + required String url, + int? width, + int? height, + }) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, + 'width': width, + 'height': height, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({ + String? name, + int? width, + int? height, + String? background, + }) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, + 'width': width, + 'height': height, + 'background': background, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({ + required String text, + int? size, + int? margin, + bool? download, + }) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, + 'size': size, + 'margin': margin, + 'download': download, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 49e2bbc2..4b26a220 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1095 +3,1439 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DatabaseList.fromMap(res.data); - - } - - /// Create a new Database. - /// - Future create({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - - 'databaseId': databaseId, -'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Update a database by its unique ID. - Future update({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({required String databaseId, List? queries, String? search}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CollectionList.fromMap(res.data); - - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'collectionId': collectionId, -'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Update a collection by its unique ID. - Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List attributes in the collection. - Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeList.fromMap(res.data); - - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Create an email attribute. - /// - Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'elements': elements, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'elements': elements, -'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Create IP address attribute. - /// - Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'relatedCollectionId': relatedCollectionId, -'type': type.value, -'twoWay': twoWay, -'key': key, -'twoWayKey': twoWayKey, -'onDelete': onDelete?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Create a string attribute. - /// - Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'size': size, -'required': xrequired, -'default': xdefault, -'array': array, -'encrypt': encrypt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'size': size, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Get attribute by ID. - Future getAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Deletes an attribute. - Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'onDelete': onDelete?.value, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Create a new Document. 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. - Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documentId': documentId, -'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// 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. - Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - /// - Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'data': data, -'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Bulk delete documents using queries, if no queries are passed then all - /// documents are deleted. - Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - 'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Delete a document by its unique ID. - Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List indexes in the collection. - Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IndexList.fromMap(res.data); - - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'type': type.value, -'attributes': attributes, -'orders': orders, -'lengths': lengths, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Get index by ID. - Future getIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Delete an index. - Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DatabaseList.fromMap(res.data); + } + + /// Create a new Database. + /// + Future create({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'databaseId': databaseId, + 'name': name, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Update a database by its unique ID. + Future update({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {'name': name, 'enabled': enabled}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({ + required String databaseId, + List? queries, + String? search, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.CollectionList.fromMap(res.data); + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'collectionId': collectionId, + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Update a collection by its unique ID. + Future updateCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List attributes in the collection. + Future listAttributes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeList.fromMap(res.data); + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + bool? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required bool? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Create an email attribute. + /// + Future createEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + double? min, + double? max, + double? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required double? xdefault, + double? min, + double? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + int? min, + int? max, + int? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required int? xdefault, + int? min, + int? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Create IP address attribute. + /// + Future createIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String relatedCollectionId, + required enums.RelationshipType type, + bool? twoWay, + String? key, + String? twoWayKey, + enums.RelationMutate? onDelete, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'relatedCollectionId': relatedCollectionId, + 'type': type.value, + 'twoWay': twoWay, + 'key': key, + 'twoWayKey': twoWayKey, + 'onDelete': onDelete?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Create a string attribute. + /// + Future createStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required int size, + required bool xrequired, + String? xdefault, + bool? array, + bool? encrypt, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'size': size, + 'required': xrequired, + 'default': xdefault, + 'array': array, + 'encrypt': encrypt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + int? size, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'size': size, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Get attribute by ID. + Future getAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Deletes an attribute. + Future deleteAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String key, + enums.RelationMutate? onDelete, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'onDelete': onDelete?.value, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Create a new Document. 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. + Future createDocument({ + required String databaseId, + required String collectionId, + required String documentId, + required Map data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'documentId': documentId, + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// 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. + Future createDocuments({ + required String databaseId, + required String collectionId, + required List documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + /// + Future upsertDocuments({ + required String databaseId, + required String collectionId, + List? documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + Future updateDocuments({ + required String databaseId, + required String collectionId, + Map? data, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'data': data, 'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({ + required String databaseId, + required String collectionId, + required String documentId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({ + required String databaseId, + required String collectionId, + required String documentId, + Map? data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Delete a document by its unique ID. + Future deleteDocument({ + required String databaseId, + required String collectionId, + required String documentId, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List indexes in the collection. + Future listIndexes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IndexList.fromMap(res.data); + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({ + required String databaseId, + required String collectionId, + required String key, + required enums.IndexType type, + required List attributes, + List? orders, + List? lengths, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'type': type.value, + 'attributes': attributes, + 'orders': orders, + 'lengths': lengths, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Get index by ID. + Future getIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Delete an index. + Future deleteIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/functions.dart b/lib/services/functions.dart index ad261abf..e86f1afe 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,623 +3,768 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FunctionList.fromMap(res.data); - - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - - 'functionId': functionId, -'name': name, -'runtime': runtime.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.RuntimeList.fromMap(res.data); - - } - - /// List allowed function specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Update function by its unique ID. - Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'name': name, -'runtime': runtime?.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the function active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your function. - Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all the function's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({required String functionId, List? queries, String? search}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'entrypoint': entrypoint, -'commands': commands, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { - final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, -'buildId': buildId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a function is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a function deployment by its unique ID. - Future getDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({required String functionId, List? queries}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'body': body, -'async': xasync, -'path': path, -'method': method?.value, -'headers': headers, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Get a function execution log by its unique ID. - Future getExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a function execution by its unique ID. - Future deleteExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific function. - Future listVariables({required String functionId}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FunctionList.fromMap(res.data); + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({ + required String functionId, + required String name, + required enums.Runtime runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'functionId': functionId, + 'name': name, + 'runtime': runtime.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.RuntimeList.fromMap(res.data); + } + + /// List allowed function specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Update function by its unique ID. + Future update({ + required String functionId, + required String name, + enums.Runtime? runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'name': name, + 'runtime': runtime?.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the function active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your function. + Future updateFunctionDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all the function's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({ + required String functionId, + List? queries, + String? search, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({ + required String functionId, + required InputFile code, + required bool activate, + String? entrypoint, + String? commands, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'entrypoint': entrypoint, + 'commands': commands, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String functionId, + required String deploymentId, + String? buildId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'deploymentId': deploymentId, + 'buildId': buildId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String functionId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/template' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String functionId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a function deployment by its unique ID. + Future getDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String functionId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/download' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/status' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({ + required String functionId, + List? queries, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({ + required String functionId, + String? body, + bool? xasync, + String? path, + enums.ExecutionMethod? method, + Map? headers, + String? scheduledAt, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'body': body, + 'async': xasync, + 'path': path, + 'method': method?.value, + 'headers': headers, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Get a function execution log by its unique ID. + Future getExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a function execution by its unique ID. + Future deleteExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific function. + Future listVariables({ + required String functionId, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({ + required String functionId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String functionId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 92cc591f..18eb54f1 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,49 +3,47 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/health.dart b/lib/services/health.dart index 3bfeba6b..5250c91d 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,459 +3,434 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthAntivirus.fromMap(res.data); + } - return models.HealthAntivirus.fromMap(res.data); + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - } + final Map apiParams = {}; - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthStatus.fromMap(res.data); + final Map apiParams = {'domain': domain}; - } + final Map apiHeaders = {}; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'domain': domain, + return models.HealthCertificate.fromMap(res.data); + } - - }; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthCertificate.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthStatus.fromMap(res.data); + } - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthStatus.fromMap(res.data); + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({ + String? name, + int? threshold, + }) async { + final String apiPath = '/health/queue/databases'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = { + 'name': name, + 'threshold': threshold, + }; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; + + final Map apiParams = {'threshold': threshold}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.HealthQueue.fromMap(res.data); + } + + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({ + required enums.Name name, + int? threshold, + }) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll( + '{name}', + name.value, + ); - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } + + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({String? name, int? threshold}) async { - final String apiPath = '/health/queue/databases'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'name': name, -'threshold': threshold, + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthQueue.fromMap(res.data); + } - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthQueue.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({required enums.Name name, int? threshold}) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, + return models.HealthQueue.fromMap(res.data); + } - - }; + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - final Map apiHeaders = { - - }; + final Map apiParams = {'threshold': threshold}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthQueue.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthQueue.fromMap(res.data); + } - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; - final Map apiParams = { - 'threshold': threshold, + final Map apiParams = {'threshold': threshold}; - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthQueue.fromMap(res.data); + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {'threshold': threshold}; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final Map apiParams = {}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthTime.fromMap(res.data); - - } -} \ No newline at end of file + return models.HealthTime.fromMap(res.data); + } +} diff --git a/lib/services/locale.dart b/lib/services/locale.dart index b75b4711..4d3cc3e0 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,170 +3,162 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.Locale.fromMap(res.data); + return models.Locale.fromMap(res.data); + } - } + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.LocaleCodeList.fromMap(res.data); + } - return models.LocaleCodeList.fromMap(res.data); + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - } + final Map apiParams = {}; - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.ContinentList.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.ContinentList.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - - - }; + return models.CountryList.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {}; - return models.CountryList.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + return models.CountryList.fromMap(res.data); + } - final Map apiParams = { - - - }; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.CountryList.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.PhoneList.fromMap(res.data); + } - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.PhoneList.fromMap(res.data); + return models.CurrencyList.fromMap(res.data); + } - } + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CurrencyList.fromMap(res.data); - - } - - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LanguageList.fromMap(res.data); - - } -} \ No newline at end of file + return models.LanguageList.fromMap(res.data); + } +} diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index 710bb6d4..afe3ee86 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1158 +3,1476 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({List? queries, String? search}) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MessageList.fromMap(res.data); - - } - - /// Create a new email message. - Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - - 'messageId': messageId, -'subject': subject, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'cc': cc, -'bcc': bcc, -'attachments': attachments, -'draft': draft, -'html': html, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'subject': subject, -'content': content, -'draft': draft, -'html': html, -'cc': cc, -'bcc': bcc, -'scheduledAt': scheduledAt, -'attachments': attachments, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new push notification. - Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - - 'messageId': messageId, -'title': title, -'body': body, -'topics': topics, -'users': users, -'targets': targets, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'title': title, -'body': body, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new SMS message. - Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - - 'messageId': messageId, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'content': content, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of the targets associated with a message. - Future listTargets({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({List? queries, String? search}) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ProviderList.fromMap(res.data); - - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'serviceAccountJSON': serviceAccountJSON, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'serviceAccountJSON': serviceAccountJSON, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'enabled': enabled, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new SMTP provider. - Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Telesign provider. - Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'customerId': customerId, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'customerId': customerId, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'username': username, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'username': username, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Twilio provider. - Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'accountSid': accountSid, -'authToken': authToken, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { - final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'accountSid': accountSid, -'authToken': authToken, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Vonage provider. - Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'apiKey': apiKey, -'apiSecret': apiSecret, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { - final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'apiSecret': apiSecret, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({required String providerId, List? queries}) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({required String subscriberId, List? queries}) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({List? queries, String? search}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TopicList.fromMap(res.data); - - } - - /// Create a new topic. - Future createTopic({required String topicId, required String name, List? subscribe}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - - 'topicId': topicId, -'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({required String topicId, String? name, List? subscribe}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({required String topicId, List? queries}) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({required String topicId, List? queries, String? search}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SubscriberList.fromMap(res.data); - - } - - /// Create a new subscriber. - Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'subscriberId': subscriberId, -'targetId': targetId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MessageList.fromMap(res.data); + } + + /// Create a new email message. + Future createEmail({ + required String messageId, + required String subject, + required String content, + List? topics, + List? users, + List? targets, + List? cc, + List? bcc, + List? attachments, + bool? draft, + bool? html, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + 'messageId': messageId, + 'subject': subject, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'cc': cc, + 'bcc': bcc, + 'attachments': attachments, + 'draft': draft, + 'html': html, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({ + required String messageId, + List? topics, + List? users, + List? targets, + String? subject, + String? content, + bool? draft, + bool? html, + List? cc, + List? bcc, + String? scheduledAt, + List? attachments, + }) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'subject': subject, + 'content': content, + 'draft': draft, + 'html': html, + 'cc': cc, + 'bcc': bcc, + 'scheduledAt': scheduledAt, + 'attachments': attachments, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new push notification. + Future createPush({ + required String messageId, + String? title, + String? body, + List? topics, + List? users, + List? targets, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + 'messageId': messageId, + 'title': title, + 'body': body, + 'topics': topics, + 'users': users, + 'targets': targets, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({ + required String messageId, + List? topics, + List? users, + List? targets, + String? title, + String? body, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'title': title, + 'body': body, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new SMS message. + Future createSms({ + required String messageId, + required String content, + List? topics, + List? users, + List? targets, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + 'messageId': messageId, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({ + required String messageId, + List? topics, + List? users, + List? targets, + String? content, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'content': content, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of the targets associated with a message. + Future listTargets({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ProviderList.fromMap(res.data); + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({ + required String providerId, + required String name, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({ + required String providerId, + String? name, + bool? enabled, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + }) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({ + required String providerId, + required String name, + Map? serviceAccountJSON, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'serviceAccountJSON': serviceAccountJSON, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({ + required String providerId, + String? name, + bool? enabled, + Map? serviceAccountJSON, + }) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'serviceAccountJSON': serviceAccountJSON, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({ + required String providerId, + required String name, + String? apiKey, + String? domain, + bool? isEuRegion, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({ + required String providerId, + String? name, + String? apiKey, + String? domain, + bool? isEuRegion, + bool? enabled, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'enabled': enabled, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({ + required String providerId, + required String name, + String? templateId, + String? senderId, + String? authKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({ + required String providerId, + String? name, + bool? enabled, + String? templateId, + String? senderId, + String? authKey, + }) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({ + required String providerId, + required String name, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new SMTP provider. + Future createSmtpProvider({ + required String providerId, + required String name, + required String host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({ + required String providerId, + String? name, + String? host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Telesign provider. + Future createTelesignProvider({ + required String providerId, + required String name, + String? from, + String? customerId, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'customerId': customerId, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({ + required String providerId, + String? name, + bool? enabled, + String? customerId, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/telesign/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'customerId': customerId, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({ + required String providerId, + required String name, + String? from, + String? username, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'username': username, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({ + required String providerId, + String? name, + bool? enabled, + String? username, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'username': username, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Twilio provider. + Future createTwilioProvider({ + required String providerId, + required String name, + String? from, + String? accountSid, + String? authToken, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'accountSid': accountSid, + 'authToken': authToken, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({ + required String providerId, + String? name, + bool? enabled, + String? accountSid, + String? authToken, + String? from, + }) async { + final String apiPath = '/messaging/providers/twilio/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'accountSid': accountSid, + 'authToken': authToken, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Vonage provider. + Future createVonageProvider({ + required String providerId, + required String name, + String? from, + String? apiKey, + String? apiSecret, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? apiSecret, + String? from, + }) async { + final String apiPath = '/messaging/providers/vonage/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({ + required String providerId, + List? queries, + }) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({ + required String subscriberId, + List? queries, + }) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs' + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TopicList.fromMap(res.data); + } + + /// Create a new topic. + Future createTopic({ + required String topicId, + required String name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'topicId': topicId, + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({ + required String topicId, + String? name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({ + required String topicId, + List? queries, + }) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({ + required String topicId, + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SubscriberList.fromMap(res.data); + } + + /// Create a new subscriber. + Future createSubscriber({ + required String topicId, + required String subscriberId, + required String targetId, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'subscriberId': subscriberId, + 'targetId': targetId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/sites.dart b/lib/services/sites.dart index 90511473..d89f2192 100644 --- a/lib/services/sites.dart +++ b/lib/services/sites.dart @@ -2,585 +2,703 @@ part of '../dart_appwrite.dart'; /// The Sites Service allows you view, create and manage your web applications. class Sites extends Service { - Sites(super.client); - - /// Get a list of all the project's sites. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SiteList.fromMap(res.data); - - } - - /// Create a new site. - Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - - 'siteId': siteId, -'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime.value, -'adapter': adapter?.value, -'installationId': installationId, -'fallbackFile': fallbackFile, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all frameworks that are currently available on the server - /// instance. - Future listFrameworks() async { - final String apiPath = '/sites/frameworks'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FrameworkList.fromMap(res.data); - - } - - /// List allowed site specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/sites/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a site by its unique ID. - Future get({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Update site by its unique ID. - Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime?.value, -'adapter': adapter?.value, -'fallbackFile': fallbackFile, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Delete a site by its unique ID. - Future delete({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the site active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your site. - Future updateSiteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all the site's code deployments. You can use the query params - /// to filter your results. - Future listDeployments({required String siteId, List? queries, String? search}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// 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. - Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a site is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a site deployment by its unique ID. - Future getDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a site deployment by its unique ID. - Future deleteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all site logs. You can use the query params to filter your - /// results. - Future listLogs({required String siteId, List? queries}) async { - final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Get a site request log by its unique ID. - Future getLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a site log by its unique ID. - Future deleteLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific site. - Future listVariables({required String siteId}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new site variable. These variables can be accessed during build - /// and runtime (server-side rendering) as environment variables. - Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SiteList.fromMap(res.data); + } + + /// Create a new site. + Future create({ + required String siteId, + required String name, + required enums.Framework framework, + required enums.BuildRuntime buildRuntime, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.Adapter? adapter, + String? installationId, + String? fallbackFile, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'siteId': siteId, + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime.value, + 'adapter': adapter?.value, + 'installationId': installationId, + 'fallbackFile': fallbackFile, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FrameworkList.fromMap(res.data); + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Update site by its unique ID. + Future update({ + required String siteId, + required String name, + required enums.Framework framework, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.BuildRuntime? buildRuntime, + enums.Adapter? adapter, + String? fallbackFile, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime?.value, + 'adapter': adapter?.value, + 'fallbackFile': fallbackFile, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({ + required String siteId, + List? queries, + String? search, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// 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. + Future createDeployment({ + required String siteId, + required InputFile code, + required bool activate, + String? installCommand, + String? buildCommand, + String? outputDirectory, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String siteId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String siteId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a site deployment by its unique ID. + Future getDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String siteId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({ + required String siteId, + List? queries, + }) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Get a site request log by its unique ID. + Future getLog({ + required String siteId, + required String logId, + }) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({ + required String siteId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String siteId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/storage.dart b/lib/services/storage.dart index 9165e91b..ee630883 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,329 +2,421 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({List? queries, String? search}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.BucketList.fromMap(res.data); - - } - - /// Create a new storage bucket. - Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - - 'bucketId': bucketId, -'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({required String bucketId, List? queries, String? search}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FileList.fromMap(res.data); - - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'fileId': fileId, -'file': file, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a file 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. - Future getFileDownload({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, -'height': height, -'gravity': gravity?.value, -'quality': quality, -'borderWidth': borderWidth, -'borderColor': borderColor, -'borderRadius': borderRadius, -'opacity': opacity, -'rotation': rotation, -'background': background, -'output': output?.value, -'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({ + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.BucketList.fromMap(res.data); + } + + /// Create a new storage bucket. + Future createBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'bucketId': bucketId, + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({ + required String bucketId, + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FileList.fromMap(res.data); + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({ + required String bucketId, + required String fileId, + required InputFile file, + List? permissions, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'fileId': fileId, + 'file': file, + 'permissions': permissions, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({ + required String bucketId, + required String fileId, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({ + required String bucketId, + required String fileId, + String? name, + List? permissions, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a file 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. + Future getFileDownload({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({ + required String bucketId, + required String fileId, + int? width, + int? height, + enums.ImageGravity? gravity, + int? quality, + int? borderWidth, + String? borderColor, + int? borderRadius, + double? opacity, + int? rotation, + String? background, + enums.ImageFormat? output, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, + 'height': height, + 'gravity': gravity?.value, + 'quality': quality, + 'borderWidth': borderWidth, + 'borderColor': borderColor, + 'borderRadius': borderRadius, + 'opacity': opacity, + 'rotation': rotation, + 'background': background, + 'output': output?.value, + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 2b492f27..5fd59641 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,321 +3,356 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TeamList.fromMap(res.data); - - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({required String teamId, required String name, List? roles}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - - 'teamId': teamId, -'name': name, -'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Update the team's name by its unique ID. - Future updateName({required String teamId, required String name}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({required String teamId, List? queries, String? search}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'email': email, -'userId': userId, -'phone': phone, -'roles': roles, -'url': url, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({required String teamId, required String membershipId, required List roles}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({required String teamId, required Map prefs}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } -} \ No newline at end of file + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TeamList.fromMap(res.data); + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({ + required String teamId, + required String name, + List? roles, + }) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'teamId': teamId, + 'name': name, + 'roles': roles, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Update the team's name by its unique ID. + Future updateName({ + required String teamId, + required String name, + }) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({ + required String teamId, + List? queries, + String? search, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({ + required String teamId, + required List roles, + String? email, + String? userId, + String? phone, + String? url, + String? name, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'email': email, + 'userId': userId, + 'phone': phone, + 'roles': roles, + 'url': url, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({ + required String teamId, + required String membershipId, + required List roles, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'roles': roles}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({ + required String teamId, + required String membershipId, + required String userId, + required String secret, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({ + required String teamId, + required Map prefs, + }) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } +} diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart index a9b8f78a..0224b0a5 100644 --- a/lib/services/tokens.dart +++ b/lib/services/tokens.dart @@ -1,109 +1,113 @@ part of '../dart_appwrite.dart'; class Tokens extends Service { - Tokens(super.client); - - /// List all the tokens created for a specific file or bucket. You can use the - /// query params to filter your results. - Future list({required String bucketId, required String fileId, List? queries}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceTokenList.fromMap(res.data); - - } - - /// Create a new token. A token is linked to a file. Token can be passed as a - /// header or request get parameter. - Future createFileToken({required String bucketId, required String fileId, String? expire}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Get a token by its unique ID. - Future get({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Update a token by its unique ID. Use this endpoint to update a token's - /// expiry date. - Future update({required String tokenId, String? expire}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Delete a token by its unique ID. - Future delete({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({ + required String bucketId, + required String fileId, + List? queries, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceTokenList.fromMap(res.data); + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({ + required String bucketId, + required String fileId, + String? expire, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({ + required String tokenId, + String? expire, + }) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/users.dart b/lib/services/users.dart index 765ec3e6..c98182b7 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,962 +2,1107 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.UserList.fromMap(res.data); - - } - - /// Create a new user. - Future create({required String userId, String? email, String? phone, String? password, String? name}) async { - final String apiPath = '/users'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phone': phone, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get identities for all users. - Future listIdentities({List? queries, String? search}) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordCpu': passwordCpu, -'passwordMemory': passwordMemory, -'passwordParallel': passwordParallel, -'passwordLength': passwordLength, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordSaltSeparator': passwordSaltSeparator, -'passwordSignerKey': passwordSignerKey, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordVersion': passwordVersion?.value, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user email by its unique ID. - Future updateEmail({required String userId, required String email}) async { - final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'email': email, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({required String userId, String? sessionId, int? duration}) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'sessionId': sessionId, -'duration': duration, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({required String userId, required List labels}) async { - final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'labels': labels, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the user membership list by its unique ID. - Future listMemberships({required String userId, List? queries, String? search}) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Enable or disable MFA on a user account. - Future updateMfa({required String userId, required bool mfa}) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update the user name by its unique ID. - Future updateName({required String userId, required String name}) async { - final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user password by its unique ID. - Future updatePassword({required String userId, required String password}) async { - final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone by its unique ID. - Future updatePhone({required String userId, required String number}) async { - final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'number': number, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({required String userId, required Map prefs}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({required String userId, required String sessionId}) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({required String userId, required bool status}) async { - final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'status': status, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// List the messaging targets that are associated with a user. - Future listTargets({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Create a messaging target. - Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'targetId': targetId, -'providerType': providerType.value, -'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Get a user's push notification target by ID. - Future getTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Update a messaging target. - Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - 'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Delete a messaging target. - Future deleteTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({required String userId, int? length, int? expire}) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'length': length, -'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({required String userId, required bool emailVerification}) async { - final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'emailVerification': emailVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'phoneVerification': phoneVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } -} \ No newline at end of file + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.UserList.fromMap(res.data); + } + + /// Create a new user. + Future create({ + required String userId, + String? email, + String? phone, + String? password, + String? name, + }) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phone': phone, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get identities for all users. + Future listIdentities({ + List? queries, + String? search, + }) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required int passwordCpu, + required int passwordMemory, + required int passwordParallel, + required int passwordLength, + String? name, + }) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordCpu': passwordCpu, + 'passwordMemory': passwordMemory, + 'passwordParallel': passwordParallel, + 'passwordLength': passwordLength, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required String passwordSaltSeparator, + required String passwordSignerKey, + String? name, + }) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordSaltSeparator': passwordSaltSeparator, + 'passwordSignerKey': passwordSignerKey, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({ + required String userId, + required String email, + required String password, + enums.PasswordHash? passwordVersion, + String? name, + }) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordVersion': passwordVersion?.value, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user email by its unique ID. + Future updateEmail({ + required String userId, + required String email, + }) async { + final String apiPath = '/users/{userId}/email'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'email': email}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({ + required String userId, + String? sessionId, + int? duration, + }) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'sessionId': sessionId, + 'duration': duration, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({ + required String userId, + required List labels, + }) async { + final String apiPath = '/users/{userId}/labels'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'labels': labels}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/logs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the user membership list by its unique ID. + Future listMemberships({ + required String userId, + List? queries, + String? search, + }) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Enable or disable MFA on a user account. + Future updateMfa({ + required String userId, + required bool mfa, + }) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({ + required String userId, + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}' + .replaceAll('{userId}', userId) + .replaceAll('{type}', type.value); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update the user name by its unique ID. + Future updateName({ + required String userId, + required String name, + }) async { + final String apiPath = '/users/{userId}/name'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user password by its unique ID. + Future updatePassword({ + required String userId, + required String password, + }) async { + final String apiPath = '/users/{userId}/password'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'password': password}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone by its unique ID. + Future updatePhone({ + required String userId, + required String number, + }) async { + final String apiPath = '/users/{userId}/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'number': number}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({ + required String userId, + required Map prefs, + }) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({ + required String userId, + required String sessionId, + }) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}' + .replaceAll('{userId}', userId) + .replaceAll('{sessionId}', sessionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({ + required String userId, + required bool status, + }) async { + final String apiPath = '/users/{userId}/status'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'status': status}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// List the messaging targets that are associated with a user. + Future listTargets({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Create a messaging target. + Future createTarget({ + required String userId, + required String targetId, + required enums.MessagingProviderType providerType, + required String identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'targetId': targetId, + 'providerType': providerType.value, + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Get a user's push notification target by ID. + Future getTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Update a messaging target. + Future updateTarget({ + required String userId, + required String targetId, + String? identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = { + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Delete a messaging target. + Future deleteTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({ + required String userId, + int? length, + int? expire, + }) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'length': length, 'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({ + required String userId, + required bool emailVerification, + }) async { + final String apiPath = '/users/{userId}/verification'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'emailVerification': emailVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({ + required String userId, + required bool phoneVerification, + }) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'phoneVerification': phoneVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } +} diff --git a/lib/src/client.dart b/lib/src/client.dart index 2fc990a5..d82d623a 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client( - {String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false}) => - createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client({ + String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false, + }) => createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,7 +81,8 @@ abstract class Client { }); /// Send the API request. - Future call(HttpMethod method, { + Future call( + HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index cd82d264..08d93b85 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,21 +2,25 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); + /// Your secret API key @override ClientBase setKey(value); + /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); + /// The user session to authenticate with @override ClientBase setSession(value); + /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index 7b2cb4e8..aa59d03e 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,14 +9,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => +ClientBase createClient({required String endPoint, required bool selfSigned}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -34,59 +31,66 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'X-Appwrite-Response-Format' : '1.7.0', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -135,7 +139,11 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); return call( HttpMethod.post, path: path, @@ -162,12 +170,19 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 88663581..b942cfe4 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,17 +10,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => - ClientIO( - endPoint: endPoint, - selfSigned: selfSigned, - ); +ClientBase createClient({required String endPoint, required bool selfSigned}) => + ClientIO(endPoint: endPoint, selfSigned: selfSigned); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -32,9 +26,10 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = + HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -43,60 +38,68 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'user-agent' : 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format' : '1.7.0', + 'user-agent': + 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -151,11 +154,16 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, file.path!, - filename: file.filename); + paramName, + file.path!, + filename: file.filename, + ); } else { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, - filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); } return call( HttpMethod.post, @@ -194,12 +202,19 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -244,10 +259,7 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse( - res, - responseType: responseType, - ); + return prepareResponse(res, responseType: responseType); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index 658b79b6..310bc3ca 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest) - .fields - .addAll({"$key[$i]": v.toString()}); + (request as http.MultipartRequest).fields.addAll({ + "$key[$i]": v.toString(), + }); }); } else { - (request as http.MultipartRequest) - .fields - .addAll({key: value.toString()}); + (request as http.MultipartRequest).fields.addAll({ + key: value.toString(), + }); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value){ + params = params.map((key, value) { if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,12 +51,13 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port, + ); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); @@ -66,7 +67,9 @@ mixin ClientMixin { headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); } if (headers['X-Forwarded-User-Agent'] != null) { - headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); + headers['X-Forwarded-User-Agent'] = Uri.encodeFull( + headers['X-Forwarded-User-Agent']!, + ); } request.headers.addAll(headers); @@ -113,18 +116,26 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse(http.StreamedResponse streamedResponse) async { - if(streamedResponse.statusCode == 204) { - return http.Response('', - streamedResponse.statusCode, - headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse( + http.StreamedResponse streamedResponse, + ) async { + if (streamedResponse.statusCode == 204) { + return http.Response( + '', + streamedResponse.statusCode, + headers: streamedResponse.headers.map( + (k, v) => + k.toLowerCase() == 'content-type' + ? MapEntry(k, 'text/plain') + : MapEntry(k, v), + ), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 95e9d217..2cb7727e 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,4 +3,5 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.'); + 'Cannot create a client without dart:html or dart:io.', + ); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 6566f2e1..08fd6068 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes + bytes, } diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart index 053080ef..d1af0722 100644 --- a/lib/src/enums/adapter.dart +++ b/lib/src/enums/adapter.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum Adapter { - static(value: 'static'), - ssr(value: 'ssr'); + static(value: 'static'), + ssr(value: 'ssr'); - const Adapter({ - required this.value - }); + const Adapter({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 00d12830..1d5271eb 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({ - required this.value - }); + const AuthenticationFactor({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index 10460393..c1fe8584 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,13 +1,11 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({ - required this.value - }); + const AuthenticatorType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 386fa11d..949f4c47 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({ - required this.value - }); + const Browser({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart index fdccfcbb..88ffbfa6 100644 --- a/lib/src/enums/build_runtime.dart +++ b/lib/src/enums/build_runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum BuildRuntime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const BuildRuntime({ - required this.value - }); + const BuildRuntime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 209acfb8..768930d9 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({ - required this.value - }); + const Compression({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index cd45b6a1..1bae5c8a 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,29 +1,27 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({ - required this.value - }); + const CreditCard({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart index 782b30c7..1788f892 100644 --- a/lib/src/enums/deployment_download_type.dart +++ b/lib/src/enums/deployment_download_type.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum DeploymentDownloadType { - source(value: 'source'), - output(value: 'output'); + source(value: 'source'), + output(value: 'output'); - const DeploymentDownloadType({ - required this.value - }); + const DeploymentDownloadType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 7d2d7016..42954430 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({ - required this.value - }); + const ExecutionMethod({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index 27c25cac..a44cb81d 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,207 +1,205 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({ - required this.value - }); + const Flag({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart index af5ebaad..e20f48c6 100644 --- a/lib/src/enums/framework.dart +++ b/lib/src/enums/framework.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Framework { - analog(value: 'analog'), - angular(value: 'angular'), - nextjs(value: 'nextjs'), - react(value: 'react'), - nuxt(value: 'nuxt'), - vue(value: 'vue'), - sveltekit(value: 'sveltekit'), - astro(value: 'astro'), - remix(value: 'remix'), - lynx(value: 'lynx'), - flutter(value: 'flutter'), - reactNative(value: 'react-native'), - vite(value: 'vite'), - other(value: 'other'); + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); - const Framework({ - required this.value - }); + const Framework({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index dbf6825e..120c93f4 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({ - required this.value - }); + const ImageFormat({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 79bc4d62..88029044 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,21 +1,19 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({ - required this.value - }); + const ImageGravity({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index 8d86530d..b101d35f 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({ - required this.value - }); + const IndexType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index 375913e8..a07e6f76 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({ - required this.value - }); + const MessagePriority({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index a6859648..c69bf01e 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({ - required this.value - }); + const MessagingProviderType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 613bf5f1..74823feb 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,24 +1,22 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({ - required this.value - }); + const Name({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 076c1c50..383e45b1 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,52 +1,50 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({ - required this.value - }); + const OAuthProvider({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 510ee260..9d98c26a 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,23 +1,21 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({ - required this.value - }); + const PasswordHash({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index 9f4c1a85..b215a8fa 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({ - required this.value - }); + const RelationMutate({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 301bc61d..30efc944 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({ - required this.value - }); + const RelationshipType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index a0ff38c8..fec56a9b 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const Runtime({ - required this.value - }); + const Runtime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index 6c880ed6..cb6cee26 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({ - required this.value - }); + const SmtpEncryption({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart index 0bf8e2ad..f01fcb01 100644 --- a/lib/src/enums/vcs_deployment_type.dart +++ b/lib/src/enums/vcs_deployment_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum VCSDeploymentType { - branch(value: 'branch'), - commit(value: 'commit'), - tag(value: 'tag'); + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); - const VCSDeploymentType({ - required this.value - }); + const VCSDeploymentType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 93b6ee3d..82229daa 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index f174d569..4145f701 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index c9f67200..4e901476 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({ - required this.type, - }); + AlgoBcrypt({required this.type}); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt( - type: map['type'].toString(), - ); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 2fabb416..35c7b767 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({ - required this.type, - }); + AlgoMd5({required this.type}); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5( - type: map['type'].toString(), - ); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index fdcee07a..7d27adba 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({ - required this.type, - }); + AlgoPhpass({required this.type}); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass( - type: map['type'].toString(), - ); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index 120723df..fec6f65a 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 504b5f8f..0e80700f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index 5f3e1654..bae6618f 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({ - required this.type, - }); + AlgoSha({required this.type}); - factory AlgoSha.fromMap(Map map) { - return AlgoSha( - type: map['type'].toString(), - ); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 20dd7189..0ca54691 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index a5b27b4f..1df01f19 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 96ce554b..21f8e9a3 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index a4953a0e..298c181a 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index 03ba94c7..c6eecadd 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 8a5aa89d..1ef48332 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index d17f414a..8c8fcb73 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index 4098a5a1..c5fa6adc 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({ - required this.total, - required this.attributes, - }); + AttributeList({required this.total, required this.attributes}); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return { - "total": total, - "attributes": attributes, - }; - } + Map toMap() { + return {"total": total, "attributes": attributes}; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 050cbe14..903c6290 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index 89de3a57..d32b6829 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index 0c3ddf9e..f0bc295e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index 3bb374be..b8fb5e48 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 366d80f9..224c910d 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({ - required this.total, - required this.buckets, - }); + BucketList({required this.total, required this.buckets}); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "buckets": buckets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index c55110cf..72de429d 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index aad4d44a..49785e2b 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({ - required this.total, - required this.collections, - }); + CollectionList({required this.total, required this.collections}); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from( + map['collections'].map((p) => Collection.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 1a9c5038..7318b7ad 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({ - required this.name, - required this.code, - }); + Continent({required this.name, required this.code}); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 7a1eb84c..2c605d3b 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({ - required this.total, - required this.continents, - }); + ContinentList({required this.total, required this.continents}); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from( + map['continents'].map((p) => Continent.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index 565b1d66..c52b50f2 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,28 +2,19 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({ - required this.name, - required this.code, - }); + Country({required this.name, required this.code}); - factory Country.fromMap(Map map) { - return Country( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Country.fromMap(Map map) { + return Country(name: map['name'].toString(), code: map['code'].toString()); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index e0b8f29f..6ef8ec42 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({ - required this.total, - required this.countries, - }); + CountryList({required this.total, required this.countries}); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from(map['countries'].map((p) => Country.fromMap(p))), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from( + map['countries'].map((p) => Country.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index deafffe3..27eef0c1 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index f67049ae..acb515e3 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({ - required this.total, - required this.currencies, - }); + CurrencyList({required this.total, required this.currencies}); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from( + map['currencies'].map((p) => Currency.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 09ee2aae..298a46a3 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 03b959db..5b6df8d4 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({ - required this.total, - required this.databases, - }); + DatabaseList({required this.total, required this.databases}); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from(map['databases'].map((p) => Database.fromMap(p))), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from( + map['databases'].map((p) => Database.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index ecf7e791..448c62c7 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,178 +2,178 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; + /// Deployment creation date in ISO 8601 format. + final String $createdAt; - /// Deployment update date in ISO 8601 format. - final String $updatedAt; + /// Deployment update date in ISO 8601 format. + final String $updatedAt; - /// Type of deployment. - final String type; + /// Type of deployment. + final String type; - /// Resource ID. - final String resourceId; + /// Resource ID. + final String resourceId; - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int sourceSize; - - /// The build output size in bytes. - final int buildSize; - - /// The total size in bytes (source and build output). - final int totalSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// Screenshot with light theme preference file ID. - final String screenshotLight; - - /// Screenshot with dark theme preference file ID. - final String screenshotDark; - - /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildDuration; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.sourceSize, - required this.buildSize, - required this.totalSize, - required this.buildId, - required this.activate, - required this.screenshotLight, - required this.screenshotDark, - required this.status, - required this.buildLogs, - required this.buildDuration, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - sourceSize: map['sourceSize'], - buildSize: map['buildSize'], - totalSize: map['totalSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - screenshotLight: map['screenshotLight'].toString(), - screenshotDark: map['screenshotDark'].toString(), - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildDuration: map['buildDuration'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "sourceSize": sourceSize, - "buildSize": buildSize, - "totalSize": totalSize, - "buildId": buildId, - "activate": activate, - "screenshotLight": screenshotLight, - "screenshotDark": screenshotDark, - "status": status, - "buildLogs": buildLogs, - "buildDuration": buildDuration, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int sourceSize; + + /// The build output size in bytes. + final int buildSize; + + /// The total size in bytes (source and build output). + final int totalSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildDuration; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.sourceSize, + required this.buildSize, + required this.totalSize, + required this.buildId, + required this.activate, + required this.screenshotLight, + required this.screenshotDark, + required this.status, + required this.buildLogs, + required this.buildDuration, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + sourceSize: map['sourceSize'], + buildSize: map['buildSize'], + totalSize: map['totalSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildDuration: map['buildDuration'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "sourceSize": sourceSize, + "buildSize": buildSize, + "totalSize": totalSize, + "buildId": buildId, + "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, + "status": status, + "buildLogs": buildLogs, + "buildDuration": buildDuration, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 508bb705..15a93ef4 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({ - required this.total, - required this.deployments, - }); + DeploymentList({required this.total, required this.deployments}); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from( + map['deployments'].map((p) => Deployment.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index b6454aae..37fb2b7b 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 8af34256..126ad805 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,31 +2,30 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({ - required this.total, - required this.documents, - }); + DocumentList({required this.total, required this.documents}); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from(map['documents'].map((p) => Document.fromMap(p))), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from( + map['documents'].map((p) => Document.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 0cfdbb4e..8618bcd6 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,118 +2,122 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Resource(function/site) execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Resource(function/site) execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from( + map['requestHeaders'].map((p) => Headers.fromMap(p)), + ), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from( + map['responseHeaders'].map((p) => Headers.fromMap(p)), + ), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 0bcbad6a..2a2ef056 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({ - required this.total, - required this.executions, - }); + ExecutionList({required this.total, required this.executions}); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from( + map['executions'].map((p) => Execution.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index de8439ec..a6a9fa46 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 28bc6fcf..9f01530b 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({ - required this.total, - required this.files, - }); + FileList({required this.total, required this.files}); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "files": files.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "files": files.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart index ea6b601a..693c9b07 100644 --- a/lib/src/models/framework.dart +++ b/lib/src/models/framework.dart @@ -2,46 +2,48 @@ part of '../../models.dart'; /// Framework class Framework implements Model { - /// Framework key. - final String key; - - /// Framework Name. - final String name; - - /// Default runtime version. - final String buildRuntime; - - /// List of supported runtime versions. - final List runtimes; - - /// List of supported adapters. - final List adapters; - - Framework({ - required this.key, - required this.name, - required this.buildRuntime, - required this.runtimes, - required this.adapters, - }); - - factory Framework.fromMap(Map map) { - return Framework( - key: map['key'].toString(), - name: map['name'].toString(), - buildRuntime: map['buildRuntime'].toString(), - runtimes: List.from(map['runtimes'] ?? []), - adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), - ); - } - - Map toMap() { - return { - "key": key, - "name": name, - "buildRuntime": buildRuntime, - "runtimes": runtimes, - "adapters": adapters.map((p) => p.toMap()).toList(), - }; - } + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from( + map['adapters'].map((p) => FrameworkAdapter.fromMap(p)), + ), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart index 7614616a..0b908240 100644 --- a/lib/src/models/framework_adapter.dart +++ b/lib/src/models/framework_adapter.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Framework Adapter class FrameworkAdapter implements Model { - /// Adapter key. - final String key; - - /// Default command to download dependencies. - final String installCommand; - - /// Default command to build site into output directory. - final String buildCommand; - - /// Default output directory of build. - final String outputDirectory; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - FrameworkAdapter({ - required this.key, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.fallbackFile, - }); - - factory FrameworkAdapter.fromMap(Map map) { - return FrameworkAdapter( - key: map['key'].toString(), - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "fallbackFile": fallbackFile, - }; - } + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart index deb19e62..266d8edf 100644 --- a/lib/src/models/framework_list.dart +++ b/lib/src/models/framework_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Frameworks List class FrameworkList implements Model { - /// Total number of frameworks documents that matched your query. - final int total; + /// Total number of frameworks documents that matched your query. + final int total; - /// List of frameworks. - final List frameworks; + /// List of frameworks. + final List frameworks; - FrameworkList({ - required this.total, - required this.frameworks, - }); + FrameworkList({required this.total, required this.frameworks}); - factory FrameworkList.fromMap(Map map) { - return FrameworkList( - total: map['total'], - frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), - ); - } + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from( + map['frameworks'].map((p) => Framework.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "frameworks": frameworks.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 64401c3f..56c2eded 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,184 +2,184 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; + /// Function creation date in ISO 8601 format. + final String $createdAt; - /// Function update date in ISO 8601 format. - final String $updatedAt; + /// Function update date in ISO 8601 format. + final String $updatedAt; - /// Execution permissions. - final List execute; + /// Execution permissions. + final List execute; - /// Function name. - final String name; + /// Function name. + final String name; - /// Function enabled. - final bool enabled; + /// Function enabled. + final bool enabled; - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// When disabled, executions will exclude logs and errors, and will be slightly faster. - final bool logging; - - /// Function execution and build runtime. - final String runtime; - - /// Function's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Function's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// When disabled, executions will exclude logs and errors, and will be slightly faster. + final bool logging; + + /// Function execution and build runtime. + final String runtime; + + /// Function's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index 8f0b8928..c37f0615 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,28 +2,25 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({ - required this.total, - required this.functions, - }); + FunctionList({required this.total, required this.functions}); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index ecf0a178..463cf696 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({ - required this.name, - required this.value, - }); + Headers({required this.name, required this.value}); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "value": value, - }; - } + Map toMap() { + return {"name": name, "value": value}; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index 54c31e70..fa402e97 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({ - required this.version, - required this.status, - }); + HealthAntivirus({required this.version, required this.status}); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "version": version, - "status": status, - }; - } + Map toMap() { + return {"version": version, "status": status}; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index 0a5b6ce9..d412eba9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 95da1235..5f06906b 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({ - required this.size, - }); + HealthQueue({required this.size}); - factory HealthQueue.fromMap(Map map) { - return HealthQueue( - size: map['size'], - ); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue(size: map['size']); + } - Map toMap() { - return { - "size": size, - }; - } + Map toMap() { + return {"size": size}; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 0d6e7216..59b7092c 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({ - required this.name, - required this.ping, - required this.status, - }); + HealthStatus({required this.name, required this.ping, required this.status}); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "ping": ping, - "status": status, - }; - } + Map toMap() { + return {"name": name, "ping": ping, "status": status}; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index 102dfe77..dec2d54f 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,34 +2,30 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return { - "remoteTime": remoteTime, - "localTime": localTime, - "diff": diff, - }; - } + Map toMap() { + return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index c43c4d57..807bdfd0 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index e92e36cc..f38eaf66 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({ - required this.total, - required this.identities, - }); + IdentityList({required this.total, required this.identities}); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from( + map['identities'].map((p) => Identity.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 07d22743..961b9e5e 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index attributes length. - final List lengths; + /// Index attributes length. + final List lengths; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - required this.lengths, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + required this.lengths, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - lengths: List.from(map['lengths'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "lengths": lengths, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "lengths": lengths, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index 8eac7956..dc759dfb 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({ - required this.total, - required this.indexes, - }); + IndexList({required this.total, required this.indexes}); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 1b4ff7de..490a1824 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({ - required this.jwt, - }); + Jwt({required this.jwt}); - factory Jwt.fromMap(Map map) { - return Jwt( - jwt: map['jwt'].toString(), - ); - } + factory Jwt.fromMap(Map map) { + return Jwt(jwt: map['jwt'].toString()); + } - Map toMap() { - return { - "jwt": jwt, - }; - } + Map toMap() { + return {"jwt": jwt}; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 43eaad08..9c45adb1 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({ - required this.name, - required this.code, - required this.nativeName, - }); + Language({required this.name, required this.code, required this.nativeName}); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - "nativeName": nativeName, - }; - } + Map toMap() { + return {"name": name, "code": code, "nativeName": nativeName}; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index fe271118..046b879e 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({ - required this.total, - required this.languages, - }); + LanguageList({required this.total, required this.languages}); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from(map['languages'].map((p) => Language.fromMap(p))), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from( + map['languages'].map((p) => Language.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index b5e9ad1a..084475bf 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index 10499ef5..cd5a1155 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({ - required this.code, - required this.name, - }); + LocaleCode({required this.code, required this.name}); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "name": name, - }; - } + Map toMap() { + return {"code": code, "name": name}; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 839474d7..662fee4f 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({ - required this.total, - required this.localeCodes, - }); + LocaleCodeList({required this.total, required this.localeCodes}); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from( + map['localeCodes'].map((p) => LocaleCode.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index cb567bd7..7fb3f364 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 91d024d0..628237fa 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({ - required this.total, - required this.logs, - }); + LogList({required this.total, required this.logs}); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "logs": logs.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 26610e46..8ee142ad 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 409cdbfb..46468a3a 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({ - required this.total, - required this.memberships, - }); + MembershipList({required this.total, required this.memberships}); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from( + map['memberships'].map((p) => Membership.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index c4e9e858..9b93b00d 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 702c912b..7bd0891f 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({ - required this.total, - required this.messages, - }); + MessageList({required this.total, required this.messages}); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from(map['messages'].map((p) => Message.fromMap(p))), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from( + map['messages'].map((p) => Message.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 46c166fb..96bf3c65 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index d49989d8..c930a23e 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 6c8b4e36..63411988 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,22 +2,18 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({ - required this.recoveryCodes, - }); + MfaRecoveryCodes({required this.recoveryCodes}); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return { - "recoveryCodes": recoveryCodes, - }; - } + Map toMap() { + return {"recoveryCodes": recoveryCodes}; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index 01cf0857..fa57cb8b 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({ - required this.secret, - required this.uri, - }); + MfaType({required this.secret, required this.uri}); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return { - "secret": secret, - "uri": uri, - }; - } + Map toMap() { + return {"secret": secret, "uri": uri}; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index 48e5b84a..f810a35b 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} \ No newline at end of file +} diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index c8bbb95b..40f7bcd2 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index beab76e8..18d2803d 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({ - required this.total, - required this.phones, - }); + PhoneList({required this.total, required this.phones}); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "phones": phones.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 3c62f86d..48163dfc 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,23 +2,17 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({ - required this.data, - }); + Preferences({required this.data}); - factory Preferences.fromMap(Map map) { - return Preferences( - data: map, - ); - } + factory Preferences.fromMap(Map map) { + return Preferences(data: map); + } - Map toMap() { - return { - "data": data, - }; - } + Map toMap() { + return {"data": data}; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 4295c486..1a762f85 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index 7c09eb56..aeb28ecd 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({ - required this.total, - required this.providers, - }); + ProviderList({required this.total, required this.providers}); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from( + map['providers'].map((p) => Provider.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart index ed520cc4..dad35dcc 100644 --- a/lib/src/models/resource_token.dart +++ b/lib/src/models/resource_token.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// ResourceToken class ResourceToken implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// JWT encoded string. - final String secret; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - ResourceToken({ - required this.$id, - required this.$createdAt, - required this.resourceId, - required this.resourceType, - required this.expire, - required this.secret, - required this.accessedAt, - }); - - factory ResourceToken.fromMap(Map map) { - return ResourceToken( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - expire: map['expire'].toString(), - secret: map['secret'].toString(), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "resourceId": resourceId, - "resourceType": resourceType, - "expire": expire, - "secret": secret, - "accessedAt": accessedAt, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart index ba8f0d89..f30531f4 100644 --- a/lib/src/models/resource_token_list.dart +++ b/lib/src/models/resource_token_list.dart @@ -2,28 +2,24 @@ part of '../../models.dart'; /// Resource Tokens List class ResourceTokenList implements Model { - /// Total number of tokens documents that matched your query. - final int total; + /// Total number of tokens documents that matched your query. + final int total; - /// List of tokens. - final List tokens; + /// List of tokens. + final List tokens; - ResourceTokenList({ - required this.total, - required this.tokens, - }); + ResourceTokenList({required this.total, required this.tokens}); - factory ResourceTokenList.fromMap(Map map) { - return ResourceTokenList( - total: map['total'], - tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), - ); - } + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from( + map['tokens'].map((p) => ResourceToken.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "tokens": tokens.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "tokens": tokens.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 35f82cfa..7c9677d8 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 7615fd9e..02c7b2e5 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({ - required this.total, - required this.runtimes, - }); + RuntimeList({required this.total, required this.runtimes}); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from( + map['runtimes'].map((p) => Runtime.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index 3a1d955f..d2fe4f64 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 6d26d6a8..479272b9 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({ - required this.total, - required this.sessions, - }); + SessionList({required this.total, required this.sessions}); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from( + map['sessions'].map((p) => Session.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart index 5cda6acc..1449f8bd 100644 --- a/lib/src/models/site.dart +++ b/lib/src/models/site.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Site class Site implements Model { - /// Site ID. - final String $id; + /// Site ID. + final String $id; - /// Site creation date in ISO 8601 format. - final String $createdAt; + /// Site creation date in ISO 8601 format. + final String $createdAt; - /// Site update date in ISO 8601 format. - final String $updatedAt; + /// Site update date in ISO 8601 format. + final String $updatedAt; - /// Site name. - final String name; + /// Site name. + final String name; - /// Site enabled. - final bool enabled; + /// Site enabled. + final bool enabled; - /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. - final bool live; + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; - /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. - final bool logging; + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; - /// Site framework. - final String framework; - - /// Site's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Screenshot of active deployment with light theme preference file ID. - final String deploymentScreenshotLight; - - /// Screenshot of active deployment with dark theme preference file ID. - final String deploymentScreenshotDark; - - /// Site's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Site variables. - final List vars; - - /// Site request timeout in seconds. - final int timeout; - - /// The install command used to install the site dependencies. - final String installCommand; - - /// The build command used to build the site. - final String buildCommand; - - /// The directory where the site build output is located. - final String outputDirectory; - - /// Site VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to site in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - /// Site build runtime. - final String buildRuntime; - - /// Site framework adapter. - final String adapter; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - Site({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.framework, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.deploymentScreenshotLight, - required this.deploymentScreenshotDark, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.vars, - required this.timeout, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - required this.buildRuntime, - required this.adapter, - required this.fallbackFile, - }); - - factory Site.fromMap(Map map) { - return Site( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - framework: map['framework'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), - deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - timeout: map['timeout'], - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - buildRuntime: map['buildRuntime'].toString(), - adapter: map['adapter'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "framework": framework, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "deploymentScreenshotLight": deploymentScreenshotLight, - "deploymentScreenshotDark": deploymentScreenshotDark, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "vars": vars.map((p) => p.toMap()).toList(), - "timeout": timeout, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - "buildRuntime": buildRuntime, - "adapter": adapter, - "fallbackFile": fallbackFile, - }; - } + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart index 02a6a2be..a403dd5b 100644 --- a/lib/src/models/site_list.dart +++ b/lib/src/models/site_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Sites List class SiteList implements Model { - /// Total number of sites documents that matched your query. - final int total; + /// Total number of sites documents that matched your query. + final int total; - /// List of sites. - final List sites; + /// List of sites. + final List sites; - SiteList({ - required this.total, - required this.sites, - }); + SiteList({required this.total, required this.sites}); - factory SiteList.fromMap(Map map) { - return SiteList( - total: map['total'], - sites: List.from(map['sites'].map((p) => Site.fromMap(p))), - ); - } + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sites": sites.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "sites": sites.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e49d399c..e8fb8c75 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,40 +2,35 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return { - "memory": memory, - "cpus": cpus, - "enabled": enabled, - "slug": slug, - }; - } + Map toMap() { + return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index 72703f84..e4bef89b 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({ - required this.total, - required this.specifications, - }); + SpecificationList({required this.total, required this.specifications}); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from( + map['specifications'].map((p) => Specification.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 36e18a7e..0c926297 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index d7d3c3e3..7030fa0a 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({ - required this.total, - required this.subscribers, - }); + SubscriberList({required this.total, required this.subscribers}); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from( + map['subscribers'].map((p) => Subscriber.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index f2b3b6b4..4be8b545 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 2d38efe5..1042e5a2 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({ - required this.total, - required this.targets, - }); + TargetList({required this.total, required this.targets}); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "targets": targets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index e9058b5b..43df33a8 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index 2fb3611e..e604f192 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({ - required this.total, - required this.teams, - }); + TeamList({required this.total, required this.teams}); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "teams": teams.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 4f6b8454..35115467 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 461d5694..430d44ac 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index e57ef05f..a4d1f44f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({ - required this.total, - required this.topics, - }); + TopicList({required this.total, required this.topics}); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "topics": topics.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index effc397c..50bfb3ce 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 55dfcf77..03e55cc6 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({ - required this.total, - required this.users, - }); + UserList({required this.total, required this.users}); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "users": users.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "users": users.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 58882a9f..2a8e276a 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; + /// Variable ID. + final String $id; - /// Variable creation date in ISO 8601 format. - final String $createdAt; + /// Variable creation date in ISO 8601 format. + final String $createdAt; - /// Variable creation date in ISO 8601 format. - final String $updatedAt; + /// Variable creation date in ISO 8601 format. + final String $updatedAt; - /// Variable key. - final String key; + /// Variable key. + final String key; - /// Variable value. - final String value; + /// Variable value. + final String value; - /// Variable secret flag. Secret variables can only be updated or deleted, but never read. - final bool secret; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.secret, - required this.resourceType, - required this.resourceId, - }); + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.secret, + required this.resourceType, + required this.resourceId, + }); - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - secret: map['secret'], - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + secret: map['secret'], + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "secret": secret, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "secret": secret, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index b6da02cc..4ff3e189 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({ - required this.total, - required this.variables, - }); + VariableList({required this.total, required this.variables}); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from( + map['variables'].map((p) => Variable.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 44cde383..5a19b0fc 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded + "chunksUploaded": chunksUploaded, }; } From 8513591c28ee5e73871d41af473f13777f979ad2 Mon Sep 17 00:00:00 2001 From: root Date: Sun, 18 May 2025 08:36:01 +0000 Subject: [PATCH 6/7] chore: add changelog --- CHANGELOG.md | 14 + lib/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 ++++++++------- lib/services/avatars.dart | 434 ++- lib/services/databases.dart | 2528 ++++++++---------- lib/services/functions.dart | 1385 +++++----- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 ++--- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 ++++++++----------- lib/services/sites.dart | 1282 ++++----- lib/services/storage.dart | 744 +++--- lib/services/teams.dart | 671 +++-- lib/services/tokens.dart | 216 +- lib/services/users.dart | 2063 +++++++-------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 123 +- lib/src/client_io.dart | 150 +- lib/src/client_mixin.dart | 65 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/adapter.dart | 14 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/build_runtime.dart | 136 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/deployment_download_type.dart | 14 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 +-- lib/src/enums/framework.dart | 38 +- lib/src/enums/image_format.dart | 22 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 136 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/enums/vcs_deployment_type.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 338 +-- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/framework.dart | 86 +- lib/src/models/framework_adapter.dart | 84 +- lib/src/models/framework_list.dart | 39 +- lib/src/models/function.dart | 348 +-- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 110 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/resource_token.dart | 108 +- lib/src/models/resource_token_list.dart | 36 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/site.dart | 358 +-- lib/src/models/site_list.dart | 34 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 100 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- 151 files changed, 12042 insertions(+), 13072 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b1f1e1b1..290809b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +# Change Log + +## 16.0.0 + +* Add `<REGION>` to doc examples due to the new multi region endpoints +* Add doc examples and methods for bulk api transactions: `createDocuments`, `deleteDocuments` etc. +* Add doc examples, class and methods for new `Sites` service +* Add doc examples, class and methods for new `Tokens` service +* Add enums for `BuildRuntime `, `Adapter`, `Framework`, `DeploymentDownloadType` and `VCSDeploymentType` +* Add `token` param to `getFilePreview` and `getFileView` for File tokens usage +* Add `queries` and `search` params to `listMemberships` method +* Update enum for `runtimes` with Pythonml312, Dart219, Flutter327 and Flutter329 +* Remove `search` param from `listExecutions` method + ## 14.0.0 * Breaking changes: diff --git a/lib/client_browser.dart b/lib/client_browser.dart index b9805a3a..09f110ea 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; +export 'src/client_browser.dart'; \ No newline at end of file diff --git a/lib/client_io.dart b/lib/client_io.dart index 42a0c0b6..4d85cbfa 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; +export 'src/client_io.dart'; \ No newline at end of file diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 0848a050..5f5ffe9d 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.7.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 28ff15e8..72e26a23 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,7 +10,8 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 9107a9a4..46882207 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,5 +1,6 @@ part of 'dart_appwrite.dart'; + /// Helper class to generate query strings. class Query { final String method; @@ -9,13 +10,15 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = {'method': method}; + final map = { + 'method': method, + }; - if (attribute != null) { + if(attribute != null) { map['attribute'] = attribute; } - - if (values != null) { + + if(values != null) { map['values'] = values is List ? values : [values]; } @@ -26,7 +29,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -58,12 +61,10 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => - Query._('isNull', attribute).toString(); + static String isNull(String attribute) => Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => - Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -83,52 +84,40 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._( - 'or', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); static String and(List queries) => - Query._( - 'and', - null, - queries.map((query) => jsonDecode(query)).toList(), - ).toString(); + Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => - Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => - Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => - Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => - Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => - Query._('offset', null, offset).toString(); -} + static String offset(int offset) => Query._('offset', null, offset).toString(); + +} \ No newline at end of file diff --git a/lib/role.dart b/lib/role.dart index dafeb78d..6552df47 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); + + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if (status.isEmpty) { - return 'user:$id'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if(status.isEmpty) { + return 'user:$id'; + } + return 'user:$id/$status'; } - return 'user:$id/$status'; - } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if (status.isEmpty) { - return 'users'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if(status.isEmpty) { + return 'users'; + } + return 'users/$status'; } - return 'users/$status'; - } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if (role.isEmpty) { - return 'team:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if(role.isEmpty) { + return 'team:$id'; + } + return 'team:$id/$role'; } - return 'team:$id/$role'; - } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; - } + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} \ No newline at end of file diff --git a/lib/services/account.dart b/lib/services/account.dart index 90e1f03e..fdc8cc97 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1084 +2,1081 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/account'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({ - required String email, - required String password, - }) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({ - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaType.fromMap(res.data); - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({ - required enums.AuthenticatorType type, - required String otp, - }) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {'otp': otp}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( - '{type}', - type.value, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({ - required enums.AuthenticationFactor factor, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = {'factor': factor.value}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaChallenge.fromMap(res.data); - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({ - required String challengeId, - required String otp, - }) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - 'challengeId': challengeId, - 'otp': otp, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({ - required String password, - String? oldPassword, - }) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - 'password': password, - 'oldPassword': oldPassword, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({ - required String phone, - required String password, - }) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - 'phone': phone, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({ - required String email, - required String url, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = {'email': email, 'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({ - required String userId, - required String secret, - required String password, - }) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - 'userId': userId, - 'secret': secret, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({ - required String email, - required String password, - }) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - 'email': email, - 'password': password, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll( - '{sessionId}', - sessionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({ - required String userId, - required String email, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({ - required String userId, - required String email, - String? url, - bool? phrase, - }) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'url': url, - 'phrase': phrase, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({ - required enums.OAuthProvider provider, - String? success, - String? failure, - List? scopes, - }) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( - '{provider}', - provider.value, - ); - - final Map params = { - 'success': success, - 'failure': failure, - 'scopes': scopes, - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add( - Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), - ); - } - } else if (value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri( - scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&'), - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({ - required String userId, - required String phone, - }) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = {'userId': userId, 'phone': phone}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'url': url}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({ - required String userId, - required String secret, - }) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } -} + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/account'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({required String email, required String password}) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaType.fromMap(res.data); + + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + 'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'factor': factor.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaChallenge.fromMap(res.data); + + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({required String challengeId, required String otp}) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + + 'challengeId': challengeId, +'otp': otp, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({required String password, String? oldPassword}) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + + 'password': password, +'oldPassword': oldPassword, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({required String phone, required String password}) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + + 'phone': phone, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({required String email, required String url}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'email': email, +'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({required String userId, required String secret, required String password}) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({required String email, required String password}) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + + 'email': email, +'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({required String userId, required String secret}) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({required String userId, required String email, bool? phrase}) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'url': url, +'phrase': phrase, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); + + final Map params = { + 'success': success, +'failure': failure, +'scopes': scopes, + + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); + } + } else if(value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri(scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&') + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({required String userId, required String phone}) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = { + + 'userId': userId, +'phone': phone, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'url': url, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({required String userId, required String secret}) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 8033f1cd..381146d4 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,253 +3,187 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({ - required enums.Browser code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({ - required enums.CreditCard code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({ - required enums.Flag code, - int? width, - int? height, - int? quality, - }) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll( - '{code}', - code.value, - ); - - final Map params = { - 'width': width, - 'height': height, - 'quality': quality, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({ - required String url, - int? width, - int? height, - }) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, - 'width': width, - 'height': height, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({ - String? name, - int? width, - int? height, - String? background, - }) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, - 'width': width, - 'height': height, - 'background': background, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({ - required String text, - int? size, - int? margin, - bool? download, - }) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, - 'size': size, - 'margin': margin, - 'download': download, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); + + final Map params = { + 'width': width, +'height': height, +'quality': quality, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({required String url, int? width, int? height}) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, +'width': width, +'height': height, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({String? name, int? width, int? height, String? background}) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, +'width': width, +'height': height, +'background': background, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({required String text, int? size, int? margin, bool? download}) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, +'size': size, +'margin': margin, +'download': download, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 4b26a220..49e2bbc2 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1439 +3,1095 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DatabaseList.fromMap(res.data); - } - - /// Create a new Database. - /// - Future create({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'databaseId': databaseId, - 'name': name, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Update a database by its unique ID. - Future update({ - required String databaseId, - required String name, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {'name': name, 'enabled': enabled}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Database.fromMap(res.data); - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({ - required String databaseId, - List? queries, - String? search, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.CollectionList.fromMap(res.data); - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll( - '{databaseId}', - databaseId, - ); - - final Map apiParams = { - 'collectionId': collectionId, - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Update a collection by its unique ID. - Future updateCollection({ - required String databaseId, - required String collectionId, - required String name, - List? permissions, - bool? documentSecurity, - bool? enabled, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'documentSecurity': documentSecurity, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Collection.fromMap(res.data); - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({ - required String databaseId, - required String collectionId, - }) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List attributes in the collection. - Future listAttributes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeList.fromMap(res.data); - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - bool? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required bool? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeBoolean.fromMap(res.data); - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeDatetime.fromMap(res.data); - } - - /// Create an email attribute. - /// - Future createEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEmail.fromMap(res.data); - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({ - required String databaseId, - required String collectionId, - required String key, - required List elements, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'elements': elements, - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeEnum.fromMap(res.data); - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - double? min, - double? max, - double? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required double? xdefault, - double? min, - double? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeFloat.fromMap(res.data); - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - int? min, - int? max, - int? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required int? xdefault, - int? min, - int? max, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'min': min, - 'max': max, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeInteger.fromMap(res.data); - } - - /// Create IP address attribute. - /// - Future createIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeIp.fromMap(res.data); - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String relatedCollectionId, - required enums.RelationshipType type, - bool? twoWay, - String? key, - String? twoWayKey, - enums.RelationMutate? onDelete, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'relatedCollectionId': relatedCollectionId, - 'type': type.value, - 'twoWay': twoWay, - 'key': key, - 'twoWayKey': twoWayKey, - 'onDelete': onDelete?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Create a string attribute. - /// - Future createStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required int size, - required bool xrequired, - String? xdefault, - bool? array, - bool? encrypt, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'size': size, - 'required': xrequired, - 'default': xdefault, - 'array': array, - 'encrypt': encrypt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - int? size, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'size': size, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeString.fromMap(res.data); - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - String? xdefault, - bool? array, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'required': xrequired, - 'default': xdefault, - 'array': array, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({ - required String databaseId, - required String collectionId, - required String key, - required bool xrequired, - required String? xdefault, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'required': xrequired, - 'default': xdefault, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeUrl.fromMap(res.data); - } - - /// Get attribute by ID. - Future getAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Deletes an attribute. - Future deleteAttribute({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({ - required String databaseId, - required String collectionId, - required String key, - enums.RelationMutate? onDelete, - String? newKey, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = { - 'onDelete': onDelete?.value, - 'newKey': newKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.AttributeRelationship.fromMap(res.data); - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Create a new Document. 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. - Future createDocument({ - required String databaseId, - required String collectionId, - required String documentId, - required Map data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'documentId': documentId, - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// 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. - Future createDocuments({ - required String databaseId, - required String collectionId, - required List documents, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'documents': documents}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// 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. - /// - Future upsertDocuments({ - required String databaseId, - required String collectionId, - List? documents, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'documents': documents}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// 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. - Future updateDocuments({ - required String databaseId, - required String collectionId, - Map? data, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'data': data, 'queries': queries}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Bulk delete documents using queries, if no queries are passed then all - /// documents are deleted. - Future deleteDocuments({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DocumentList.fromMap(res.data); - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({ - required String databaseId, - required String collectionId, - required String documentId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({ - required String databaseId, - required String collectionId, - required String documentId, - Map? data, - List? permissions, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'data': data, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Document.fromMap(res.data); - } - - /// Delete a document by its unique ID. - Future deleteDocument({ - required String databaseId, - required String collectionId, - required String documentId, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{documentId}', documentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List indexes in the collection. - Future listIndexes({ - required String databaseId, - required String collectionId, - List? queries, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IndexList.fromMap(res.data); - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({ - required String databaseId, - required String collectionId, - required String key, - required enums.IndexType type, - required List attributes, - List? orders, - List? lengths, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'key': key, - 'type': type.value, - 'attributes': attributes, - 'orders': orders, - 'lengths': lengths, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Get index by ID. - Future getIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Index.fromMap(res.data); - } - - /// Delete an index. - Future deleteIndex({ - required String databaseId, - required String collectionId, - required String key, - }) async { - final String apiPath = - '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' - .replaceAll('{databaseId}', databaseId) - .replaceAll('{collectionId}', collectionId) - .replaceAll('{key}', key); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DatabaseList.fromMap(res.data); + + } + + /// Create a new Database. + /// + Future create({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases'; + + final Map apiParams = { + + 'databaseId': databaseId, +'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Update a database by its unique ID. + Future update({required String databaseId, required String name, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Database.fromMap(res.data); + + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({required String databaseId, List? queries, String? search}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CollectionList.fromMap(res.data); + + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); + + final Map apiParams = { + + 'collectionId': collectionId, +'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Update a collection by its unique ID. + Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'documentSecurity': documentSecurity, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Collection.fromMap(res.data); + + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({required String databaseId, required String collectionId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List attributes in the collection. + Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeList.fromMap(res.data); + + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeBoolean.fromMap(res.data); + + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeDatetime.fromMap(res.data); + + } + + /// Create an email attribute. + /// + Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEmail.fromMap(res.data); + + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'elements': elements, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'elements': elements, +'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeEnum.fromMap(res.data); + + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeFloat.fromMap(res.data); + + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'min': min, +'max': max, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeInteger.fromMap(res.data); + + } + + /// Create IP address attribute. + /// + Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeIp.fromMap(res.data); + + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'relatedCollectionId': relatedCollectionId, +'type': type.value, +'twoWay': twoWay, +'key': key, +'twoWayKey': twoWayKey, +'onDelete': onDelete?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Create a string attribute. + /// + Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'size': size, +'required': xrequired, +'default': xdefault, +'array': array, +'encrypt': encrypt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'size': size, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeString.fromMap(res.data); + + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'required': xrequired, +'default': xdefault, +'array': array, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'required': xrequired, +'default': xdefault, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeUrl.fromMap(res.data); + + } + + /// Get attribute by ID. + Future getAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Deletes an attribute. + Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + 'onDelete': onDelete?.value, +'newKey': newKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.AttributeRelationship.fromMap(res.data); + + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Create a new Document. 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. + Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documentId': documentId, +'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// 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. + Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + /// + Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'documents': documents, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// 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. + Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'data': data, +'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'queries': queries, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DocumentList.fromMap(res.data); + + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + 'data': data, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Document.fromMap(res.data); + + } + + /// Delete a document by its unique ID. + Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List indexes in the collection. + Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IndexList.fromMap(res.data); + + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + + 'key': key, +'type': type.value, +'attributes': attributes, +'orders': orders, +'lengths': lengths, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Get index by ID. + Future getIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Index.fromMap(res.data); + + } + + /// Delete an index. + Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/functions.dart b/lib/services/functions.dart index e86f1afe..ad261abf 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,768 +3,623 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({ - List? queries, - String? search, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FunctionList.fromMap(res.data); - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({ - required String functionId, - required String name, - required enums.Runtime runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'functionId': functionId, - 'name': name, - 'runtime': runtime.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.RuntimeList.fromMap(res.data); - } - - /// List allowed function specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SpecificationList.fromMap(res.data); - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Update function by its unique ID. - Future update({ - required String functionId, - required String name, - enums.Runtime? runtime, - List? execute, - List? events, - String? schedule, - int? timeout, - bool? enabled, - bool? logging, - String? entrypoint, - String? commands, - List? scopes, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'name': name, - 'runtime': runtime?.value, - 'execute': execute, - 'events': events, - 'schedule': schedule, - 'timeout': timeout, - 'enabled': enabled, - 'logging': logging, - 'entrypoint': entrypoint, - 'commands': commands, - 'scopes': scopes, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the function active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your function. - Future updateFunctionDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployment'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Func.fromMap(res.data); - } - - /// Get a list of all the function's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({ - required String functionId, - List? queries, - String? search, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DeploymentList.fromMap(res.data); - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({ - required String functionId, - required InputFile code, - required bool activate, - String? entrypoint, - String? commands, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'entrypoint': entrypoint, - 'commands': commands, - 'code': code, - 'activate': activate, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createDuplicateDeployment({ - required String functionId, - required String deploymentId, - String? buildId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/duplicate' - .replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'deploymentId': deploymentId, - 'buildId': buildId, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createTemplateDeployment({ - required String functionId, - required String repository, - required String owner, - required String rootDirectory, - required String version, - bool? activate, - }) async { - final String apiPath = '/functions/{functionId}/deployments/template' - .replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'repository': repository, - 'owner': owner, - 'rootDirectory': rootDirectory, - 'version': version, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Create a deployment when a function is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({ - required String functionId, - required enums.VCSDeploymentType type, - required String reference, - bool? activate, - }) async { - final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'type': type.value, - 'reference': reference, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a function deployment by its unique ID. - Future getDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future getDeploymentDownload({ - required String functionId, - required String deploymentId, - enums.DeploymentDownloadType? type, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/download' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({ - required String functionId, - required String deploymentId, - }) async { - final String apiPath = - '/functions/{functionId}/deployments/{deploymentId}/status' - .replaceAll('{functionId}', functionId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({ - required String functionId, - List? queries, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ExecutionList.fromMap(res.data); - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({ - required String functionId, - String? body, - bool? xasync, - String? path, - enums.ExecutionMethod? method, - Map? headers, - String? scheduledAt, - }) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'body': body, - 'async': xasync, - 'path': path, - 'method': method?.value, - 'headers': headers, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Get a function execution log by its unique ID. - Future getExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Delete a function execution by its unique ID. - Future deleteExecution({ - required String functionId, - required String executionId, - }) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{executionId}', executionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all variables of a specific function. - Future listVariables({ - required String functionId, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.VariableList.fromMap(res.data); - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({ - required String functionId, - required String key, - required String value, - bool? secret, - }) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll( - '{functionId}', - functionId, - ); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Get a variable by its unique ID. - Future getVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Update variable by its unique ID. - Future updateVariable({ - required String functionId, - required String variableId, - required String key, - String? value, - bool? secret, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Delete a variable by its unique ID. - Future deleteVariable({ - required String functionId, - required String variableId, - }) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}' - .replaceAll('{functionId}', functionId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FunctionList.fromMap(res.data); + + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/functions'; + + final Map apiParams = { + + 'functionId': functionId, +'name': name, +'runtime': runtime.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.RuntimeList.fromMap(res.data); + + } + + /// List allowed function specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Update function by its unique ID. + Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'name': name, +'runtime': runtime?.value, +'execute': execute, +'events': events, +'schedule': schedule, +'timeout': timeout, +'enabled': enabled, +'logging': logging, +'entrypoint': entrypoint, +'commands': commands, +'scopes': scopes, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the function active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your function. + Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Func.fromMap(res.data); + + } + + /// Get a list of all the function's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({required String functionId, List? queries, String? search}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'entrypoint': entrypoint, +'commands': commands, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'deploymentId': deploymentId, +'buildId': buildId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'type': type.value, +'reference': reference, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a function deployment by its unique ID. + Future getDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({required String functionId, List? queries}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'body': body, +'async': xasync, +'path': path, +'method': method?.value, +'headers': headers, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Get a function execution log by its unique ID. + Future getExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a function execution by its unique ID. + Future deleteExecution({required String functionId, required String executionId}) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific function. + Future listVariables({required String functionId}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String functionId, required String variableId}) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 18eb54f1..92cc591f 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,47 +3,49 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = {'query': query}; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', - 'content-type': 'application/json', - }; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = { + + 'query': query, + + }; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', +'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/health.dart b/lib/services/health.dart index 5250c91d..3bfeba6b 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,434 +3,459 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + } - final Map apiParams = {}; + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthAntivirus.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + return models.HealthAntivirus.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'domain': domain}; + return models.HealthStatus.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthCertificate.fromMap(res.data); - } + final Map apiParams = { + 'domain': domain, - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthCertificate.fromMap(res.data); - return models.HealthStatus.fromMap(res.data); - } + } - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthStatus.fromMap(res.data); - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + } - final Map apiParams = {'threshold': threshold}; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthStatus.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({ - String? name, - int? threshold, - }) async { - final String apiPath = '/health/queue/databases'; + final Map apiHeaders = { + + }; - final Map apiParams = { - 'name': name, - 'threshold': threshold, - }; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; - - final Map apiParams = {'threshold': threshold}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.HealthQueue.fromMap(res.data); - } - - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({ - required enums.Name name, - int? threshold, - }) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll( - '{name}', - name.value, - ); + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } - - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({String? name, int? threshold}) async { + final String apiPath = '/health/queue/databases'; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiParams = { + 'name': name, +'threshold': threshold, - final Map apiParams = {'threshold': threshold}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthQueue.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + } - final Map apiParams = {'threshold': threshold}; + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthQueue.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {'threshold': threshold}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({required enums.Name name, int? threshold}) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); - return models.HealthQueue.fromMap(res.data); - } + final Map apiParams = { + 'threshold': threshold, - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + + }; - final Map apiParams = {'threshold': threshold}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.HealthQueue.fromMap(res.data); - return models.HealthQueue.fromMap(res.data); - } + } - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - final Map apiParams = {'threshold': threshold}; + final Map apiParams = { + 'threshold': threshold, - final Map apiHeaders = {}; + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.HealthQueue.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; + return models.HealthQueue.fromMap(res.data); - final Map apiParams = {'threshold': threshold}; + } - final Map apiHeaders = {}; + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + 'threshold': threshold, - return models.HealthQueue.fromMap(res.data); - } + + }; - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; + final Map apiHeaders = { + + }; - final Map apiParams = {'threshold': threshold}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.HealthQueue.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.HealthQueue.fromMap(res.data); - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; + final Map apiParams = { + 'threshold': threshold, - final Map apiParams = {}; + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.HealthStatus.fromMap(res.data); - } + return models.HealthQueue.fromMap(res.data); - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; + } - final Map apiParams = {}; + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - final Map apiHeaders = {}; + final Map apiParams = { + 'threshold': threshold, - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + + }; - return models.HealthStatus.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.HealthQueue.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - return models.HealthTime.fromMap(res.data); - } -} + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; + + final Map apiParams = { + 'threshold': threshold, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthQueue.fromMap(res.data); + + } + + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthStatus.fromMap(res.data); + + } + + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.HealthTime.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/locale.dart b/lib/services/locale.dart index 4d3cc3e0..b75b4711 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,162 +3,170 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.Locale.fromMap(res.data); - } + return models.Locale.fromMap(res.data); - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + } - final Map apiParams = {}; + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LocaleCodeList.fromMap(res.data); - } + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + return models.LocaleCodeList.fromMap(res.data); - final Map apiParams = {}; + } - final Map apiHeaders = {}; + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiParams = { + + + }; - return models.ContinentList.fromMap(res.data); - } + final Map apiHeaders = { + + }; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiParams = {}; + return models.ContinentList.fromMap(res.data); - final Map apiHeaders = {}; + } - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.CountryList.fromMap(res.data); - } + final Map apiParams = { + + + }; - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + final Map apiHeaders = { + + }; - final Map apiParams = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final Map apiHeaders = {}; + return models.CountryList.fromMap(res.data); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + } - return models.CountryList.fromMap(res.data); - } + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + final Map apiParams = { + + + }; - final Map apiParams = {}; + final Map apiHeaders = { + + }; - final Map apiHeaders = {}; + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + return models.CountryList.fromMap(res.data); - return models.PhoneList.fromMap(res.data); - } + } - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiParams = {}; + final Map apiParams = { + + + }; - final Map apiHeaders = {}; + final Map apiHeaders = { + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - return models.CurrencyList.fromMap(res.data); - } + return models.PhoneList.fromMap(res.data); - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; + } - final Map apiParams = {}; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiHeaders = {}; + final Map apiParams = { + + + }; - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); + final Map apiHeaders = { + + }; - return models.LanguageList.fromMap(res.data); - } -} + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.CurrencyList.fromMap(res.data); + + } + + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LanguageList.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index afe3ee86..710bb6d4 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1476 +3,1158 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MessageList.fromMap(res.data); - } - - /// Create a new email message. - Future createEmail({ - required String messageId, - required String subject, - required String content, - List? topics, - List? users, - List? targets, - List? cc, - List? bcc, - List? attachments, - bool? draft, - bool? html, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - 'messageId': messageId, - 'subject': subject, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'cc': cc, - 'bcc': bcc, - 'attachments': attachments, - 'draft': draft, - 'html': html, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({ - required String messageId, - List? topics, - List? users, - List? targets, - String? subject, - String? content, - bool? draft, - bool? html, - List? cc, - List? bcc, - String? scheduledAt, - List? attachments, - }) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'subject': subject, - 'content': content, - 'draft': draft, - 'html': html, - 'cc': cc, - 'bcc': bcc, - 'scheduledAt': scheduledAt, - 'attachments': attachments, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new push notification. - Future createPush({ - required String messageId, - String? title, - String? body, - List? topics, - List? users, - List? targets, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - 'messageId': messageId, - 'title': title, - 'body': body, - 'topics': topics, - 'users': users, - 'targets': targets, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({ - required String messageId, - List? topics, - List? users, - List? targets, - String? title, - String? body, - Map? data, - String? action, - String? image, - String? icon, - String? sound, - String? color, - String? tag, - int? badge, - bool? draft, - String? scheduledAt, - bool? contentAvailable, - bool? critical, - enums.MessagePriority? priority, - }) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'title': title, - 'body': body, - 'data': data, - 'action': action, - 'image': image, - 'icon': icon, - 'sound': sound, - 'color': color, - 'tag': tag, - 'badge': badge, - 'draft': draft, - 'scheduledAt': scheduledAt, - 'contentAvailable': contentAvailable, - 'critical': critical, - 'priority': priority?.value, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Create a new SMS message. - Future createSms({ - required String messageId, - required String content, - List? topics, - List? users, - List? targets, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - 'messageId': messageId, - 'content': content, - 'topics': topics, - 'users': users, - 'targets': targets, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({ - required String messageId, - List? topics, - List? users, - List? targets, - String? content, - bool? draft, - String? scheduledAt, - }) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = { - 'topics': topics, - 'users': users, - 'targets': targets, - 'content': content, - 'draft': draft, - 'scheduledAt': scheduledAt, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Message.fromMap(res.data); - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of the targets associated with a message. - Future listTargets({ - required String messageId, - List? queries, - }) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( - '{messageId}', - messageId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ProviderList.fromMap(res.data); - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({ - required String providerId, - required String name, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({ - required String providerId, - String? name, - bool? enabled, - String? authKey, - String? authKeyId, - String? teamId, - String? bundleId, - bool? sandbox, - }) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'authKey': authKey, - 'authKeyId': authKeyId, - 'teamId': teamId, - 'bundleId': bundleId, - 'sandbox': sandbox, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({ - required String providerId, - required String name, - Map? serviceAccountJSON, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'serviceAccountJSON': serviceAccountJSON, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({ - required String providerId, - String? name, - bool? enabled, - Map? serviceAccountJSON, - }) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'serviceAccountJSON': serviceAccountJSON, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({ - required String providerId, - required String name, - String? apiKey, - String? domain, - bool? isEuRegion, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({ - required String providerId, - String? name, - String? apiKey, - String? domain, - bool? isEuRegion, - bool? enabled, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'apiKey': apiKey, - 'domain': domain, - 'isEuRegion': isEuRegion, - 'enabled': enabled, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({ - required String providerId, - required String name, - String? templateId, - String? senderId, - String? authKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({ - required String providerId, - String? name, - bool? enabled, - String? templateId, - String? senderId, - String? authKey, - }) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'templateId': templateId, - 'senderId': senderId, - 'authKey': authKey, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({ - required String providerId, - required String name, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - }) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new SMTP provider. - Future createSmtpProvider({ - required String providerId, - required String name, - required String host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({ - required String providerId, - String? name, - String? host, - int? port, - String? username, - String? password, - enums.SmtpEncryption? encryption, - bool? autoTLS, - String? mailer, - String? fromName, - String? fromEmail, - String? replyToName, - String? replyToEmail, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = { - 'name': name, - 'host': host, - 'port': port, - 'username': username, - 'password': password, - 'encryption': encryption?.value, - 'autoTLS': autoTLS, - 'mailer': mailer, - 'fromName': fromName, - 'fromEmail': fromEmail, - 'replyToName': replyToName, - 'replyToEmail': replyToEmail, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Telesign provider. - Future createTelesignProvider({ - required String providerId, - required String name, - String? from, - String? customerId, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'customerId': customerId, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({ - required String providerId, - String? name, - bool? enabled, - String? customerId, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/telesign/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'customerId': customerId, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({ - required String providerId, - required String name, - String? from, - String? username, - String? apiKey, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'username': username, - 'apiKey': apiKey, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({ - required String providerId, - String? name, - bool? enabled, - String? username, - String? apiKey, - String? from, - }) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'username': username, - 'apiKey': apiKey, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Twilio provider. - Future createTwilioProvider({ - required String providerId, - required String name, - String? from, - String? accountSid, - String? authToken, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'accountSid': accountSid, - 'authToken': authToken, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({ - required String providerId, - String? name, - bool? enabled, - String? accountSid, - String? authToken, - String? from, - }) async { - final String apiPath = '/messaging/providers/twilio/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'accountSid': accountSid, - 'authToken': authToken, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Create a new Vonage provider. - Future createVonageProvider({ - required String providerId, - required String name, - String? from, - String? apiKey, - String? apiSecret, - bool? enabled, - }) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - 'providerId': providerId, - 'name': name, - 'from': from, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'enabled': enabled, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({ - required String providerId, - String? name, - bool? enabled, - String? apiKey, - String? apiSecret, - String? from, - }) async { - final String apiPath = '/messaging/providers/vonage/{providerId}' - .replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'name': name, - 'enabled': enabled, - 'apiKey': apiKey, - 'apiSecret': apiSecret, - 'from': from, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Provider.fromMap(res.data); - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({ - required String providerId, - List? queries, - }) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( - '{providerId}', - providerId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({ - required String subscriberId, - List? queries, - }) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs' - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({ - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TopicList.fromMap(res.data); - } - - /// Create a new topic. - Future createTopic({ - required String topicId, - required String name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'topicId': topicId, - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({ - required String topicId, - String? name, - List? subscribe, - }) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'name': name, - 'subscribe': subscribe, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Topic.fromMap(res.data); - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({ - required String topicId, - List? queries, - }) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({ - required String topicId, - List? queries, - String? search, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SubscriberList.fromMap(res.data); - } - - /// Create a new subscriber. - Future createSubscriber({ - required String topicId, - required String subscriberId, - required String targetId, - }) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( - '{topicId}', - topicId, - ); - - final Map apiParams = { - 'subscriberId': subscriberId, - 'targetId': targetId, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Subscriber.fromMap(res.data); - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({ - required String topicId, - required String subscriberId, - }) async { - final String apiPath = - '/messaging/topics/{topicId}/subscribers/{subscriberId}' - .replaceAll('{topicId}', topicId) - .replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({List? queries, String? search}) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MessageList.fromMap(res.data); + + } + + /// Create a new email message. + Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + + 'messageId': messageId, +'subject': subject, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'cc': cc, +'bcc': bcc, +'attachments': attachments, +'draft': draft, +'html': html, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'subject': subject, +'content': content, +'draft': draft, +'html': html, +'cc': cc, +'bcc': bcc, +'scheduledAt': scheduledAt, +'attachments': attachments, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new push notification. + Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + + 'messageId': messageId, +'title': title, +'body': body, +'topics': topics, +'users': users, +'targets': targets, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'title': title, +'body': body, +'data': data, +'action': action, +'image': image, +'icon': icon, +'sound': sound, +'color': color, +'tag': tag, +'badge': badge, +'draft': draft, +'scheduledAt': scheduledAt, +'contentAvailable': contentAvailable, +'critical': critical, +'priority': priority?.value, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Create a new SMS message. + Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + + 'messageId': messageId, +'content': content, +'topics': topics, +'users': users, +'targets': targets, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + 'topics': topics, +'users': users, +'targets': targets, +'content': content, +'draft': draft, +'scheduledAt': scheduledAt, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Message.fromMap(res.data); + + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of the targets associated with a message. + Future listTargets({required String messageId, List? queries}) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({List? queries, String? search}) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ProviderList.fromMap(res.data); + + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'authKey': authKey, +'authKeyId': authKeyId, +'teamId': teamId, +'bundleId': bundleId, +'sandbox': sandbox, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'serviceAccountJSON': serviceAccountJSON, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'serviceAccountJSON': serviceAccountJSON, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'apiKey': apiKey, +'domain': domain, +'isEuRegion': isEuRegion, +'enabled': enabled, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'templateId': templateId, +'senderId': senderId, +'authKey': authKey, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new SMTP provider. + Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'host': host, +'port': port, +'username': username, +'password': password, +'encryption': encryption?.value, +'autoTLS': autoTLS, +'mailer': mailer, +'fromName': fromName, +'fromEmail': fromEmail, +'replyToName': replyToName, +'replyToEmail': replyToEmail, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Telesign provider. + Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'customerId': customerId, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'customerId': customerId, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'username': username, +'apiKey': apiKey, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'username': username, +'apiKey': apiKey, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Twilio provider. + Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'accountSid': accountSid, +'authToken': authToken, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { + final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'accountSid': accountSid, +'authToken': authToken, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Create a new Vonage provider. + Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + + 'providerId': providerId, +'name': name, +'from': from, +'apiKey': apiKey, +'apiSecret': apiSecret, +'enabled': enabled, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { + final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + 'name': name, +'enabled': enabled, +'apiKey': apiKey, +'apiSecret': apiSecret, +'from': from, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Provider.fromMap(res.data); + + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({required String providerId, List? queries}) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({required String subscriberId, List? queries}) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({List? queries, String? search}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TopicList.fromMap(res.data); + + } + + /// Create a new topic. + Future createTopic({required String topicId, required String name, List? subscribe}) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + + 'topicId': topicId, +'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({required String topicId, String? name, List? subscribe}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'name': name, +'subscribe': subscribe, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Topic.fromMap(res.data); + + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({required String topicId, List? queries}) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({required String topicId, List? queries, String? search}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SubscriberList.fromMap(res.data); + + } + + /// Create a new subscriber. + Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); + + final Map apiParams = { + + 'subscriberId': subscriberId, +'targetId': targetId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Subscriber.fromMap(res.data); + + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({required String topicId, required String subscriberId}) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/sites.dart b/lib/services/sites.dart index d89f2192..90511473 100644 --- a/lib/services/sites.dart +++ b/lib/services/sites.dart @@ -2,703 +2,585 @@ part of '../dart_appwrite.dart'; /// The Sites Service allows you view, create and manage your web applications. class Sites extends Service { - Sites(super.client); - - /// Get a list of all the project's sites. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SiteList.fromMap(res.data); - } - - /// Create a new site. - Future create({ - required String siteId, - required String name, - required enums.Framework framework, - required enums.BuildRuntime buildRuntime, - bool? enabled, - bool? logging, - int? timeout, - String? installCommand, - String? buildCommand, - String? outputDirectory, - enums.Adapter? adapter, - String? installationId, - String? fallbackFile, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'siteId': siteId, - 'name': name, - 'framework': framework.value, - 'enabled': enabled, - 'logging': logging, - 'timeout': timeout, - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'buildRuntime': buildRuntime.value, - 'adapter': adapter?.value, - 'installationId': installationId, - 'fallbackFile': fallbackFile, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Get a list of all frameworks that are currently available on the server - /// instance. - Future listFrameworks() async { - final String apiPath = '/sites/frameworks'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FrameworkList.fromMap(res.data); - } - - /// List allowed site specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/sites/specifications'; - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SpecificationList.fromMap(res.data); - } - - /// Get a site by its unique ID. - Future get({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Update site by its unique ID. - Future update({ - required String siteId, - required String name, - required enums.Framework framework, - bool? enabled, - bool? logging, - int? timeout, - String? installCommand, - String? buildCommand, - String? outputDirectory, - enums.BuildRuntime? buildRuntime, - enums.Adapter? adapter, - String? fallbackFile, - String? installationId, - String? providerRepositoryId, - String? providerBranch, - bool? providerSilentMode, - String? providerRootDirectory, - String? specification, - }) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'name': name, - 'framework': framework.value, - 'enabled': enabled, - 'logging': logging, - 'timeout': timeout, - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'buildRuntime': buildRuntime?.value, - 'adapter': adapter?.value, - 'fallbackFile': fallbackFile, - 'installationId': installationId, - 'providerRepositoryId': providerRepositoryId, - 'providerBranch': providerBranch, - 'providerSilentMode': providerSilentMode, - 'providerRootDirectory': providerRootDirectory, - 'specification': specification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Delete a site by its unique ID. - Future delete({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the site active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your site. - Future updateSiteDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployment'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Site.fromMap(res.data); - } - - /// Get a list of all the site's code deployments. You can use the query params - /// to filter your results. - Future listDeployments({ - required String siteId, - List? queries, - String? search, - }) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.DeploymentList.fromMap(res.data); - } - - /// 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. - Future createDeployment({ - required String siteId, - required InputFile code, - required bool activate, - String? installCommand, - String? buildCommand, - String? outputDirectory, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'installCommand': installCommand, - 'buildCommand': buildCommand, - 'outputDirectory': outputDirectory, - 'code': code, - 'activate': activate, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createDuplicateDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'deploymentId': deploymentId}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// 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. - Future createTemplateDeployment({ - required String siteId, - required String repository, - required String owner, - required String rootDirectory, - required String version, - bool? activate, - }) async { - final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'repository': repository, - 'owner': owner, - 'rootDirectory': rootDirectory, - 'version': version, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Create a deployment when a site is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({ - required String siteId, - required enums.VCSDeploymentType type, - required String reference, - bool? activate, - }) async { - final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'type': type.value, - 'reference': reference, - 'activate': activate, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a site deployment by its unique ID. - Future getDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Delete a site deployment by its unique ID. - Future deleteDeployment({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// 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. - Future getDeploymentDownload({ - required String siteId, - required String deploymentId, - enums.DeploymentDownloadType? type, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({ - required String siteId, - required String deploymentId, - }) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status' - .replaceAll('{siteId}', siteId) - .replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Deployment.fromMap(res.data); - } - - /// Get a list of all site logs. You can use the query params to filter your - /// results. - Future listLogs({ - required String siteId, - List? queries, - }) async { - final String apiPath = '/sites/{siteId}/logs'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ExecutionList.fromMap(res.data); - } - - /// Get a site request log by its unique ID. - Future getLog({ - required String siteId, - required String logId, - }) async { - final String apiPath = '/sites/{siteId}/logs/{logId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{logId}', logId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Execution.fromMap(res.data); - } - - /// Delete a site log by its unique ID. - Future deleteLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{logId}', logId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all variables of a specific site. - Future listVariables({required String siteId}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.VariableList.fromMap(res.data); - } - - /// Create a new site variable. These variables can be accessed during build - /// and runtime (server-side rendering) as environment variables. - Future createVariable({ - required String siteId, - required String key, - required String value, - bool? secret, - }) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll( - '{siteId}', - siteId, - ); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Get a variable by its unique ID. - Future getVariable({ - required String siteId, - required String variableId, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Update variable by its unique ID. - Future updateVariable({ - required String siteId, - required String variableId, - required String key, - String? value, - bool? secret, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = { - 'key': key, - 'value': value, - 'secret': secret, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Variable.fromMap(res.data); - } - - /// Delete a variable by its unique ID. - Future deleteVariable({ - required String siteId, - required String variableId, - }) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}' - .replaceAll('{siteId}', siteId) - .replaceAll('{variableId}', variableId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SiteList.fromMap(res.data); + + } + + /// Create a new site. + Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + + 'siteId': siteId, +'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime.value, +'adapter': adapter?.value, +'installationId': installationId, +'fallbackFile': fallbackFile, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FrameworkList.fromMap(res.data); + + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SpecificationList.fromMap(res.data); + + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Update site by its unique ID. + Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'name': name, +'framework': framework.value, +'enabled': enabled, +'logging': logging, +'timeout': timeout, +'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'buildRuntime': buildRuntime?.value, +'adapter': adapter?.value, +'fallbackFile': fallbackFile, +'installationId': installationId, +'providerRepositoryId': providerRepositoryId, +'providerBranch': providerBranch, +'providerSilentMode': providerSilentMode, +'providerRootDirectory': providerRootDirectory, +'specification': specification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Site.fromMap(res.data); + + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({required String siteId, List? queries, String? search}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.DeploymentList.fromMap(res.data); + + } + + /// 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. + Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'installCommand': installCommand, +'buildCommand': buildCommand, +'outputDirectory': outputDirectory, +'code': code, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'deploymentId': deploymentId, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// 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. + Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'repository': repository, +'owner': owner, +'rootDirectory': rootDirectory, +'version': version, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'type': type.value, +'reference': reference, +'activate': activate, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a site deployment by its unique ID. + Future getDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// 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. + Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Deployment.fromMap(res.data); + + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({required String siteId, List? queries}) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ExecutionList.fromMap(res.data); + + } + + /// Get a site request log by its unique ID. + Future getLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Execution.fromMap(res.data); + + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.VariableList.fromMap(res.data); + + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Get a variable by its unique ID. + Future getVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Update variable by its unique ID. + Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + 'key': key, +'value': value, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Variable.fromMap(res.data); + + } + + /// Delete a variable by its unique ID. + Future deleteVariable({required String siteId, required String variableId}) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/storage.dart b/lib/services/storage.dart index ee630883..9165e91b 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,421 +2,329 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({ - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.BucketList.fromMap(res.data); - } - - /// Create a new storage bucket. - Future createBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'bucketId': bucketId, - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({ - required String bucketId, - required String name, - List? permissions, - bool? fileSecurity, - bool? enabled, - int? maximumFileSize, - List? allowedFileExtensions, - enums.Compression? compression, - bool? encryption, - bool? antivirus, - }) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - 'fileSecurity': fileSecurity, - 'enabled': enabled, - 'maximumFileSize': maximumFileSize, - 'allowedFileExtensions': allowedFileExtensions, - 'compression': compression?.value, - 'encryption': encryption, - 'antivirus': antivirus, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Bucket.fromMap(res.data); - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({ - required String bucketId, - List? queries, - String? search, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.FileList.fromMap(res.data); - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({ - required String bucketId, - required String fileId, - required InputFile file, - List? permissions, - Function(UploadProgress)? onProgress, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( - '{bucketId}', - bucketId, - ); - - final Map apiParams = { - 'fileId': fileId, - 'file': file, - 'permissions': permissions, - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({ - required String bucketId, - required String fileId, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({ - required String bucketId, - required String fileId, - String? name, - List? permissions, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'name': name, - 'permissions': permissions, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.File.fromMap(res.data); - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Get a file 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. - Future getFileDownload({ - required String bucketId, - required String fileId, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({ - required String bucketId, - required String fileId, - int? width, - int? height, - enums.ImageGravity? gravity, - int? quality, - int? borderWidth, - String? borderColor, - int? borderRadius, - double? opacity, - int? rotation, - String? background, - enums.ImageFormat? output, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, - 'height': height, - 'gravity': gravity?.value, - 'quality': quality, - 'borderWidth': borderWidth, - 'borderColor': borderColor, - 'borderRadius': borderRadius, - 'opacity': opacity, - 'rotation': rotation, - 'background': background, - 'output': output?.value, - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({ - required String bucketId, - required String fileId, - String? token, - }) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: params, - responseType: ResponseType.bytes, - ); - return res.data; - } -} + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({List? queries, String? search}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.BucketList.fromMap(res.data); + + } + + /// Create a new storage bucket. + Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + + 'bucketId': bucketId, +'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, +'fileSecurity': fileSecurity, +'enabled': enabled, +'maximumFileSize': maximumFileSize, +'allowedFileExtensions': allowedFileExtensions, +'compression': compression?.value, +'encryption': encryption, +'antivirus': antivirus, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Bucket.fromMap(res.data); + + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({required String bucketId, List? queries, String? search}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.FileList.fromMap(res.data); + + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); + + final Map apiParams = { + + 'fileId': fileId, +'file': file, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'name': name, +'permissions': permissions, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.File.fromMap(res.data); + + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Get a file 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. + Future getFileDownload({required String bucketId, required String fileId, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, +'height': height, +'gravity': gravity?.value, +'quality': quality, +'borderWidth': borderWidth, +'borderColor': borderColor, +'borderRadius': borderRadius, +'opacity': opacity, +'rotation': rotation, +'background': background, +'output': output?.value, +'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({required String bucketId, required String fileId, String? token}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); + return res.data; + } +} \ No newline at end of file diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 5fd59641..2b492f27 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,356 +3,321 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TeamList.fromMap(res.data); - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({ - required String teamId, - required String name, - List? roles, - }) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'teamId': teamId, - 'name': name, - 'roles': roles, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Update the team's name by its unique ID. - Future updateName({ - required String teamId, - required String name, - }) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Team.fromMap(res.data); - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({ - required String teamId, - List? queries, - String? search, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({ - required String teamId, - required List roles, - String? email, - String? userId, - String? phone, - String? url, - String? name, - }) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = { - 'email': email, - 'userId': userId, - 'phone': phone, - 'roles': roles, - 'url': url, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({ - required String teamId, - required String membershipId, - required List roles, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'roles': roles}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({ - required String teamId, - required String membershipId, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({ - required String teamId, - required String membershipId, - required String userId, - required String secret, - }) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' - .replaceAll('{teamId}', teamId) - .replaceAll('{membershipId}', membershipId); - - final Map apiParams = {'userId': userId, 'secret': secret}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Membership.fromMap(res.data); - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({ - required String teamId, - required Map prefs, - }) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll( - '{teamId}', - teamId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } -} + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TeamList.fromMap(res.data); + + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({required String teamId, required String name, List? roles}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + + 'teamId': teamId, +'name': name, +'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Update the team's name by its unique ID. + Future updateName({required String teamId, required String name}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Team.fromMap(res.data); + + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({required String teamId, List? queries, String? search}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'email': email, +'userId': userId, +'phone': phone, +'roles': roles, +'url': url, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({required String teamId, required String membershipId, required List roles}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'roles': roles, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({required String teamId, required String membershipId}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); + + final Map apiParams = { + + 'userId': userId, +'secret': secret, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Membership.fromMap(res.data); + + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({required String teamId, required Map prefs}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart index 0224b0a5..a9b8f78a 100644 --- a/lib/services/tokens.dart +++ b/lib/services/tokens.dart @@ -1,113 +1,109 @@ part of '../dart_appwrite.dart'; class Tokens extends Service { - Tokens(super.client); - - /// List all the tokens created for a specific file or bucket. You can use the - /// query params to filter your results. - Future list({ - required String bucketId, - required String fileId, - List? queries, - }) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceTokenList.fromMap(res.data); - } - - /// Create a new token. A token is linked to a file. Token can be passed as a - /// header or request get parameter. - Future createFileToken({ - required String bucketId, - required String fileId, - String? expire, - }) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' - .replaceAll('{bucketId}', bucketId) - .replaceAll('{fileId}', fileId); - - final Map apiParams = {'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Get a token by its unique ID. - Future get({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Update a token by its unique ID. Use this endpoint to update a token's - /// expiry date. - Future update({ - required String tokenId, - String? expire, - }) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.ResourceToken.fromMap(res.data); - } - - /// Delete a token by its unique ID. - Future delete({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } -} + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({required String bucketId, required String fileId, List? queries}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceTokenList.fromMap(res.data); + + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({required String bucketId, required String fileId, String? expire}) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({required String tokenId, String? expire}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + 'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.ResourceToken.fromMap(res.data); + + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } +} \ No newline at end of file diff --git a/lib/services/users.dart b/lib/services/users.dart index c98182b7..765ec3e6 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,1107 +2,962 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.UserList.fromMap(res.data); - } - - /// Create a new user. - Future create({ - required String userId, - String? email, - String? phone, - String? password, - String? name, - }) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'phone': phone, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get identities for all users. - Future listIdentities({ - List? queries, - String? search, - }) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.IdentityList.fromMap(res.data); - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll( - '{identityId}', - identityId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({ - required String userId, - required String email, - required String password, - String? name, - }) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required int passwordCpu, - required int passwordMemory, - required int passwordParallel, - required int passwordLength, - String? name, - }) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordCpu': passwordCpu, - 'passwordMemory': passwordMemory, - 'passwordParallel': passwordParallel, - 'passwordLength': passwordLength, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({ - required String userId, - required String email, - required String password, - required String passwordSalt, - required String passwordSaltSeparator, - required String passwordSignerKey, - String? name, - }) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordSalt': passwordSalt, - 'passwordSaltSeparator': passwordSaltSeparator, - 'passwordSignerKey': passwordSignerKey, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({ - required String userId, - required String email, - required String password, - enums.PasswordHash? passwordVersion, - String? name, - }) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - 'userId': userId, - 'email': email, - 'password': password, - 'passwordVersion': passwordVersion?.value, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user email by its unique ID. - Future updateEmail({ - required String userId, - required String email, - }) async { - final String apiPath = '/users/{userId}/email'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'email': email}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({ - required String userId, - String? sessionId, - int? duration, - }) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'sessionId': sessionId, - 'duration': duration, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Jwt.fromMap(res.data); - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({ - required String userId, - required List labels, - }) async { - final String apiPath = '/users/{userId}/labels'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'labels': labels}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/logs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.LogList.fromMap(res.data); - } - - /// Get the user membership list by its unique ID. - Future listMemberships({ - required String userId, - List? queries, - String? search, - }) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'queries': queries, - 'search': search, - }; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MembershipList.fromMap(res.data); - } - - /// Enable or disable MFA on a user account. - Future updateMfa({ - required String userId, - required bool mfa, - }) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = {'mfa': mfa}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({ - required String userId, - required enums.AuthenticatorType type, - }) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}' - .replaceAll('{userId}', userId) - .replaceAll('{type}', type.value); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaFactors.fromMap(res.data); - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.put, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({ - required String userId, - }) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.MfaRecoveryCodes.fromMap(res.data); - } - - /// Update the user name by its unique ID. - Future updateName({ - required String userId, - required String name, - }) async { - final String apiPath = '/users/{userId}/name'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'name': name}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user password by its unique ID. - Future updatePassword({ - required String userId, - required String password, - }) async { - final String apiPath = '/users/{userId}/password'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'password': password}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone by its unique ID. - Future updatePhone({ - required String userId, - required String number, - }) async { - final String apiPath = '/users/{userId}/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'number': number}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({ - required String userId, - required Map prefs, - }) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'prefs': prefs}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Preferences.fromMap(res.data); - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.SessionList.fromMap(res.data); - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Session.fromMap(res.data); - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({ - required String userId, - required String sessionId, - }) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}' - .replaceAll('{userId}', userId) - .replaceAll('{sessionId}', sessionId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({ - required String userId, - required bool status, - }) async { - final String apiPath = '/users/{userId}/status'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'status': status}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// List the messaging targets that are associated with a user. - Future listTargets({ - required String userId, - List? queries, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'queries': queries}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.TargetList.fromMap(res.data); - } - - /// Create a messaging target. - Future createTarget({ - required String userId, - required String targetId, - required enums.MessagingProviderType providerType, - required String identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'targetId': targetId, - 'providerType': providerType.value, - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Get a user's push notification target by ID. - Future getTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {}; - - final res = await client.call( - HttpMethod.get, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Update a messaging target. - Future updateTarget({ - required String userId, - required String targetId, - String? identifier, - String? providerId, - String? name, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = { - 'identifier': identifier, - 'providerId': providerId, - 'name': name, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Target.fromMap(res.data); - } - - /// Delete a messaging target. - Future deleteTarget({ - required String userId, - required String targetId, - }) async { - final String apiPath = '/users/{userId}/targets/{targetId}' - .replaceAll('{userId}', userId) - .replaceAll('{targetId}', targetId); - - final Map apiParams = {}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.delete, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return res.data; - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({ - required String userId, - int? length, - int? expire, - }) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = {'length': length, 'expire': expire}; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.post, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.Token.fromMap(res.data); - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({ - required String userId, - required bool emailVerification, - }) async { - final String apiPath = '/users/{userId}/verification'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'emailVerification': emailVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({ - required String userId, - required bool phoneVerification, - }) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll( - '{userId}', - userId, - ); - - final Map apiParams = { - 'phoneVerification': phoneVerification, - }; - - final Map apiHeaders = {'content-type': 'application/json'}; - - final res = await client.call( - HttpMethod.patch, - path: apiPath, - params: apiParams, - headers: apiHeaders, - ); - - return models.User.fromMap(res.data); - } -} + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.UserList.fromMap(res.data); + + } + + /// Create a new user. + Future create({required String userId, String? email, String? phone, String? password, String? name}) async { + final String apiPath = '/users'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'phone': phone, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get identities for all users. + Future listIdentities({List? queries, String? search}) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.IdentityList.fromMap(res.data); + + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordCpu': passwordCpu, +'passwordMemory': passwordMemory, +'passwordParallel': passwordParallel, +'passwordLength': passwordLength, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordSalt': passwordSalt, +'passwordSaltSeparator': passwordSaltSeparator, +'passwordSignerKey': passwordSignerKey, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + + 'userId': userId, +'email': email, +'password': password, +'passwordVersion': passwordVersion?.value, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user email by its unique ID. + Future updateEmail({required String userId, required String email}) async { + final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'email': email, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({required String userId, String? sessionId, int? duration}) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'sessionId': sessionId, +'duration': duration, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Jwt.fromMap(res.data); + + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({required String userId, required List labels}) async { + final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'labels': labels, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.LogList.fromMap(res.data); + + } + + /// Get the user membership list by its unique ID. + Future listMemberships({required String userId, List? queries, String? search}) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, +'search': search, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MembershipList.fromMap(res.data); + + } + + /// Enable or disable MFA on a user account. + Future updateMfa({required String userId, required bool mfa}) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'mfa': mfa, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaFactors.fromMap(res.data); + + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.MfaRecoveryCodes.fromMap(res.data); + + } + + /// Update the user name by its unique ID. + Future updateName({required String userId, required String name}) async { + final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user password by its unique ID. + Future updatePassword({required String userId, required String password}) async { + final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'password': password, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone by its unique ID. + Future updatePhone({required String userId, required String number}) async { + final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'number': number, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({required String userId, required Map prefs}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'prefs': prefs, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Preferences.fromMap(res.data); + + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.SessionList.fromMap(res.data); + + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Session.fromMap(res.data); + + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({required String userId, required String sessionId}) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({required String userId, required bool status}) async { + final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'status': status, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// List the messaging targets that are associated with a user. + Future listTargets({required String userId, List? queries}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + 'queries': queries, + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.TargetList.fromMap(res.data); + + } + + /// Create a messaging target. + Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'targetId': targetId, +'providerType': providerType.value, +'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Get a user's push notification target by ID. + Future getTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + + }; + + final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Update a messaging target. + Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + 'identifier': identifier, +'providerId': providerId, +'name': name, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Target.fromMap(res.data); + + } + + /// Delete a messaging target. + Future deleteTarget({required String userId, required String targetId}) async { + final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); + + final Map apiParams = { + + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); + + return res.data; + + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({required String userId, int? length, int? expire}) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'length': length, +'expire': expire, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.Token.fromMap(res.data); + + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({required String userId, required bool emailVerification}) async { + final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'emailVerification': emailVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); + + final Map apiParams = { + + 'phoneVerification': phoneVerification, + + }; + + final Map apiHeaders = { + 'content-type': 'application/json', + + }; + + final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); + + return models.User.fromMap(res.data); + + } +} \ No newline at end of file diff --git a/lib/src/client.dart b/lib/src/client.dart index d82d623a..2fc990a5 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client({ - String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false, - }) => createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client( + {String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false}) => + createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,8 +81,7 @@ abstract class Client { }); /// Send the API request. - Future call( - HttpMethod method, { + Future call(HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index 08d93b85..cd82d264 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,25 +2,21 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); - /// Your secret API key @override ClientBase setKey(value); - /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); - /// The user session to authenticate with @override ClientBase setSession(value); - /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index aa59d03e..7b2cb4e8 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,11 +9,14 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -31,66 +34,59 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'X-Appwrite-Response-Format': '1.7.0', + 'X-Appwrite-Response-Format' : '1.7.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -139,11 +135,7 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); return call( HttpMethod.post, path: path, @@ -170,19 +162,12 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index b942cfe4..88663581 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,11 +10,17 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({required String endPoint, required bool selfSigned}) => - ClientIO(endPoint: endPoint, selfSigned: selfSigned); +ClientBase createClient({ + required String endPoint, + required bool selfSigned, +}) => + ClientIO( + endPoint: endPoint, + selfSigned: selfSigned, + ); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5 * 1024 * 1024; + static const int CHUNK_SIZE = 5*1024*1024; String _endPoint; Map? _headers; @override @@ -26,10 +32,9 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = - HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -38,68 +43,60 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'user-agent': - 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format': '1.7.0', + 'user-agent' : 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format' : '1.7.0', }; config = {}; - assert( - _endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'", - ); + assert(_endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'"); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -154,16 +151,11 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, - file.path!, - filename: file.filename, - ); + paramName, file.path!, + filename: file.filename); } else { - params[paramName] = http.MultipartFile.fromBytes( - paramName, - file.bytes!, - filename: file.filename, - ); + params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, + filename: file.filename); } return call( HttpMethod.post, @@ -202,19 +194,12 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = http.MultipartFile.fromBytes( - paramName, - chunk, - filename: file.filename, - ); + params[paramName] = + http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call( - HttpMethod.post, - path: path, - headers: headers, - params: params, - ); + res = await call(HttpMethod.post, + path: path, headers: headers, params: params); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -259,7 +244,10 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse(res, responseType: responseType); + return prepareResponse( + res, + responseType: responseType, + ); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index 310bc3ca..658b79b6 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest).fields.addAll({ - "$key[$i]": v.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({"$key[$i]": v.toString()}); }); } else { - (request as http.MultipartRequest).fields.addAll({ - key: value.toString(), - }); + (request as http.MultipartRequest) + .fields + .addAll({key: value.toString()}); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value) { + params = params.map((key, value){ if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,13 +51,12 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port, - ); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); @@ -67,9 +66,7 @@ mixin ClientMixin { headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); } if (headers['X-Forwarded-User-Agent'] != null) { - headers['X-Forwarded-User-Agent'] = Uri.encodeFull( - headers['X-Forwarded-User-Agent']!, - ); + headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); } request.headers.addAll(headers); @@ -116,26 +113,18 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse( - http.StreamedResponse streamedResponse, - ) async { - if (streamedResponse.statusCode == 204) { - return http.Response( - '', - streamedResponse.statusCode, - headers: streamedResponse.headers.map( - (k, v) => - k.toLowerCase() == 'content-type' - ? MapEntry(k, 'text/plain') - : MapEntry(k, v), - ), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse(http.StreamedResponse streamedResponse) async { + if(streamedResponse.statusCode == 204) { + return http.Response('', + streamedResponse.statusCode, + headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 2cb7727e..95e9d217 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,5 +3,4 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.', - ); + 'Cannot create a client without dart:html or dart:io.'); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 08fd6068..6566f2e1 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes, + bytes } diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart index d1af0722..053080ef 100644 --- a/lib/src/enums/adapter.dart +++ b/lib/src/enums/adapter.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum Adapter { - static(value: 'static'), - ssr(value: 'ssr'); + static(value: 'static'), + ssr(value: 'ssr'); - const Adapter({required this.value}); + const Adapter({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 1d5271eb..00d12830 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({required this.value}); + const AuthenticationFactor({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index c1fe8584..10460393 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,11 +1,13 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({required this.value}); + const AuthenticatorType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 949f4c47..386fa11d 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,24 +1,26 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({required this.value}); + const Browser({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart index 88ffbfa6..fdccfcbb 100644 --- a/lib/src/enums/build_runtime.dart +++ b/lib/src/enums/build_runtime.dart @@ -1,73 +1,75 @@ part of '../../enums.dart'; enum BuildRuntime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const BuildRuntime({required this.value}); + const BuildRuntime({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 768930d9..209acfb8 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({required this.value}); + const Compression({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index 1bae5c8a..cd45b6a1 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,27 +1,29 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({required this.value}); + const CreditCard({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart index 1788f892..782b30c7 100644 --- a/lib/src/enums/deployment_download_type.dart +++ b/lib/src/enums/deployment_download_type.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum DeploymentDownloadType { - source(value: 'source'), - output(value: 'output'); + source(value: 'source'), + output(value: 'output'); - const DeploymentDownloadType({required this.value}); + const DeploymentDownloadType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 42954430..7d2d7016 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,16 +1,18 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({required this.value}); + const ExecutionMethod({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index a44cb81d..27c25cac 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,205 +1,207 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({required this.value}); + const Flag({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart index e20f48c6..af5ebaad 100644 --- a/lib/src/enums/framework.dart +++ b/lib/src/enums/framework.dart @@ -1,24 +1,26 @@ part of '../../enums.dart'; enum Framework { - analog(value: 'analog'), - angular(value: 'angular'), - nextjs(value: 'nextjs'), - react(value: 'react'), - nuxt(value: 'nuxt'), - vue(value: 'vue'), - sveltekit(value: 'sveltekit'), - astro(value: 'astro'), - remix(value: 'remix'), - lynx(value: 'lynx'), - flutter(value: 'flutter'), - reactNative(value: 'react-native'), - vite(value: 'vite'), - other(value: 'other'); + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); - const Framework({required this.value}); + const Framework({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index 120c93f4..dbf6825e 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,16 +1,18 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({required this.value}); + const ImageFormat({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 88029044..79bc4d62 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,19 +1,21 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({required this.value}); + const ImageGravity({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index b101d35f..8d86530d 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({required this.value}); + const IndexType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index a07e6f76..375913e8 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,12 +1,14 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({required this.value}); + const MessagePriority({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index c69bf01e..a6859648 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({required this.value}); + const MessagingProviderType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 74823feb..613bf5f1 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,22 +1,24 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({required this.value}); + const Name({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 383e45b1..076c1c50 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,50 +1,52 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({required this.value}); + const OAuthProvider({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 9d98c26a..510ee260 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,21 +1,23 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({required this.value}); + const PasswordHash({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index b215a8fa..9f4c1a85 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({required this.value}); + const RelationMutate({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 30efc944..301bc61d 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,14 +1,16 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({required this.value}); + const RelationshipType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index fec56a9b..a0ff38c8 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,73 +1,75 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const Runtime({required this.value}); + const Runtime({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index cb6cee26..6c880ed6 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({required this.value}); + const SmtpEncryption({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart index f01fcb01..0bf8e2ad 100644 --- a/lib/src/enums/vcs_deployment_type.dart +++ b/lib/src/enums/vcs_deployment_type.dart @@ -1,13 +1,15 @@ part of '../../enums.dart'; enum VCSDeploymentType { - branch(value: 'branch'), - commit(value: 'commit'), - tag(value: 'tag'); + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); - const VCSDeploymentType({required this.value}); + const VCSDeploymentType({ + required this.value + }); - final String value; + final String value; - String toJson() => value; -} + String toJson() => value; +} \ No newline at end of file diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 82229daa..93b6ee3d 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index 4145f701..f174d569 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index 4e901476..c9f67200 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({required this.type}); + AlgoBcrypt({ + required this.type, + }); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt(type: map['type'].toString()); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 35c7b767..2fabb416 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({required this.type}); + AlgoMd5({ + required this.type, + }); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5(type: map['type'].toString()); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index 7d27adba..fdcee07a 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({required this.type}); + AlgoPhpass({ + required this.type, + }); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass(type: map['type'].toString()); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index fec6f65a..120723df 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 0e80700f..504b5f8f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index bae6618f..5f3e1654 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({required this.type}); + AlgoSha({ + required this.type, + }); - factory AlgoSha.fromMap(Map map) { - return AlgoSha(type: map['type'].toString()); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha( + type: map['type'].toString(), + ); + } - Map toMap() { - return {"type": type}; - } + Map toMap() { + return { + "type": type, + }; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 0ca54691..20dd7189 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index 1df01f19..a5b27b4f 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 21f8e9a3..96ce554b 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index 298c181a..a4953a0e 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index c6eecadd..03ba94c7 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 1ef48332..8a5aa89d 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index 8c8fcb73..d17f414a 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index c5fa6adc..4098a5a1 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({required this.total, required this.attributes}); + AttributeList({ + required this.total, + required this.attributes, + }); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return {"total": total, "attributes": attributes}; - } + Map toMap() { + return { + "total": total, + "attributes": attributes, + }; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 903c6290..050cbe14 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index d32b6829..89de3a57 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index f0bc295e..0c3ddf9e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index b8fb5e48..3bb374be 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 224c910d..366d80f9 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({required this.total, required this.buckets}); + BucketList({ + required this.total, + required this.buckets, + }); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "buckets": buckets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index 72de429d..c55110cf 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index 49785e2b..aad4d44a 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({required this.total, required this.collections}); + CollectionList({ + required this.total, + required this.collections, + }); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from( - map['collections'].map((p) => Collection.fromMap(p)), - ), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 7318b7ad..1a9c5038 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({required this.name, required this.code}); + Continent({ + required this.name, + required this.code, + }); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 2c605d3b..7a1eb84c 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({required this.total, required this.continents}); + ContinentList({ + required this.total, + required this.continents, + }); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from( - map['continents'].map((p) => Continent.fromMap(p)), - ), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index c52b50f2..565b1d66 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,19 +2,28 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({required this.name, required this.code}); + Country({ + required this.name, + required this.code, + }); - factory Country.fromMap(Map map) { - return Country(name: map['name'].toString(), code: map['code'].toString()); - } + factory Country.fromMap(Map map) { + return Country( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code}; - } + Map toMap() { + return { + "name": name, + "code": code, + }; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index 6ef8ec42..e0b8f29f 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({required this.total, required this.countries}); + CountryList({ + required this.total, + required this.countries, + }); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from( - map['countries'].map((p) => Country.fromMap(p)), - ), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from(map['countries'].map((p) => Country.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index 27eef0c1..deafffe3 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index acb515e3..f67049ae 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({required this.total, required this.currencies}); + CurrencyList({ + required this.total, + required this.currencies, + }); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from( - map['currencies'].map((p) => Currency.fromMap(p)), - ), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 298a46a3..09ee2aae 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 5b6df8d4..03b959db 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({required this.total, required this.databases}); + DatabaseList({ + required this.total, + required this.databases, + }); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from( - map['databases'].map((p) => Database.fromMap(p)), - ), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from(map['databases'].map((p) => Database.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index 448c62c7..ecf7e791 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,178 +2,178 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; + /// Deployment creation date in ISO 8601 format. + final String $createdAt; - /// Deployment update date in ISO 8601 format. - final String $updatedAt; + /// Deployment update date in ISO 8601 format. + final String $updatedAt; - /// Type of deployment. - final String type; + /// Type of deployment. + final String type; - /// Resource ID. - final String resourceId; + /// Resource ID. + final String resourceId; - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int sourceSize; - - /// The build output size in bytes. - final int buildSize; - - /// The total size in bytes (source and build output). - final int totalSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// Screenshot with light theme preference file ID. - final String screenshotLight; - - /// Screenshot with dark theme preference file ID. - final String screenshotDark; - - /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildDuration; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.sourceSize, - required this.buildSize, - required this.totalSize, - required this.buildId, - required this.activate, - required this.screenshotLight, - required this.screenshotDark, - required this.status, - required this.buildLogs, - required this.buildDuration, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - sourceSize: map['sourceSize'], - buildSize: map['buildSize'], - totalSize: map['totalSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - screenshotLight: map['screenshotLight'].toString(), - screenshotDark: map['screenshotDark'].toString(), - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildDuration: map['buildDuration'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "sourceSize": sourceSize, - "buildSize": buildSize, - "totalSize": totalSize, - "buildId": buildId, - "activate": activate, - "screenshotLight": screenshotLight, - "screenshotDark": screenshotDark, - "status": status, - "buildLogs": buildLogs, - "buildDuration": buildDuration, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int sourceSize; + + /// The build output size in bytes. + final int buildSize; + + /// The total size in bytes (source and build output). + final int totalSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildDuration; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.sourceSize, + required this.buildSize, + required this.totalSize, + required this.buildId, + required this.activate, + required this.screenshotLight, + required this.screenshotDark, + required this.status, + required this.buildLogs, + required this.buildDuration, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + sourceSize: map['sourceSize'], + buildSize: map['buildSize'], + totalSize: map['totalSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildDuration: map['buildDuration'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "sourceSize": sourceSize, + "buildSize": buildSize, + "totalSize": totalSize, + "buildId": buildId, + "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, + "status": status, + "buildLogs": buildLogs, + "buildDuration": buildDuration, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 15a93ef4..508bb705 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({required this.total, required this.deployments}); + DeploymentList({ + required this.total, + required this.deployments, + }); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from( - map['deployments'].map((p) => Deployment.fromMap(p)), - ), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index 37fb2b7b..b6454aae 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 126ad805..8af34256 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,30 +2,31 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({required this.total, required this.documents}); + DocumentList({ + required this.total, + required this.documents, + }); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from( - map['documents'].map((p) => Document.fromMap(p)), - ), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from(map['documents'].map((p) => Document.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 8618bcd6..0cfdbb4e 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,122 +2,118 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Resource(function/site) execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from( - map['requestHeaders'].map((p) => Headers.fromMap(p)), - ), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from( - map['responseHeaders'].map((p) => Headers.fromMap(p)), - ), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Resource(function/site) execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 2a2ef056..0bcbad6a 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({required this.total, required this.executions}); + ExecutionList({ + required this.total, + required this.executions, + }); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from( - map['executions'].map((p) => Execution.fromMap(p)), - ), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index a6a9fa46..de8439ec 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 9f01530b..28bc6fcf 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({required this.total, required this.files}); + FileList({ + required this.total, + required this.files, + }); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "files": files.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "files": files.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart index 693c9b07..ea6b601a 100644 --- a/lib/src/models/framework.dart +++ b/lib/src/models/framework.dart @@ -2,48 +2,46 @@ part of '../../models.dart'; /// Framework class Framework implements Model { - /// Framework key. - final String key; - - /// Framework Name. - final String name; - - /// Default runtime version. - final String buildRuntime; - - /// List of supported runtime versions. - final List runtimes; - - /// List of supported adapters. - final List adapters; - - Framework({ - required this.key, - required this.name, - required this.buildRuntime, - required this.runtimes, - required this.adapters, - }); - - factory Framework.fromMap(Map map) { - return Framework( - key: map['key'].toString(), - name: map['name'].toString(), - buildRuntime: map['buildRuntime'].toString(), - runtimes: List.from(map['runtimes'] ?? []), - adapters: List.from( - map['adapters'].map((p) => FrameworkAdapter.fromMap(p)), - ), - ); - } - - Map toMap() { - return { - "key": key, - "name": name, - "buildRuntime": buildRuntime, - "runtimes": runtimes, - "adapters": adapters.map((p) => p.toMap()).toList(), - }; - } + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart index 0b908240..7614616a 100644 --- a/lib/src/models/framework_adapter.dart +++ b/lib/src/models/framework_adapter.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Framework Adapter class FrameworkAdapter implements Model { - /// Adapter key. - final String key; - - /// Default command to download dependencies. - final String installCommand; - - /// Default command to build site into output directory. - final String buildCommand; - - /// Default output directory of build. - final String outputDirectory; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - FrameworkAdapter({ - required this.key, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.fallbackFile, - }); - - factory FrameworkAdapter.fromMap(Map map) { - return FrameworkAdapter( - key: map['key'].toString(), - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "fallbackFile": fallbackFile, - }; - } + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart index 266d8edf..deb19e62 100644 --- a/lib/src/models/framework_list.dart +++ b/lib/src/models/framework_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Frameworks List class FrameworkList implements Model { - /// Total number of frameworks documents that matched your query. - final int total; + /// Total number of frameworks documents that matched your query. + final int total; - /// List of frameworks. - final List frameworks; + /// List of frameworks. + final List frameworks; - FrameworkList({required this.total, required this.frameworks}); + FrameworkList({ + required this.total, + required this.frameworks, + }); - factory FrameworkList.fromMap(Map map) { - return FrameworkList( - total: map['total'], - frameworks: List.from( - map['frameworks'].map((p) => Framework.fromMap(p)), - ), - ); - } + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "frameworks": frameworks.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 56c2eded..64401c3f 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,184 +2,184 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; + /// Function creation date in ISO 8601 format. + final String $createdAt; - /// Function update date in ISO 8601 format. - final String $updatedAt; + /// Function update date in ISO 8601 format. + final String $updatedAt; - /// Execution permissions. - final List execute; + /// Execution permissions. + final List execute; - /// Function name. - final String name; + /// Function name. + final String name; - /// Function enabled. - final bool enabled; + /// Function enabled. + final bool enabled; - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// When disabled, executions will exclude logs and errors, and will be slightly faster. - final bool logging; - - /// Function execution and build runtime. - final String runtime; - - /// Function's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Function's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// When disabled, executions will exclude logs and errors, and will be slightly faster. + final bool logging; + + /// Function execution and build runtime. + final String runtime; + + /// Function's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index c37f0615..8f0b8928 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,25 +2,28 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({required this.total, required this.functions}); + FunctionList({ + required this.total, + required this.functions, + }); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index 463cf696..ecf0a178 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({required this.name, required this.value}); + Headers({ + required this.name, + required this.value, + }); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return {"name": name, "value": value}; - } + Map toMap() { + return { + "name": name, + "value": value, + }; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index fa402e97..54c31e70 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({required this.version, required this.status}); + HealthAntivirus({ + required this.version, + required this.status, + }); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return {"version": version, "status": status}; - } + Map toMap() { + return { + "version": version, + "status": status, + }; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index d412eba9..0a5b6ce9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 5f06906b..95da1235 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({required this.size}); + HealthQueue({ + required this.size, + }); - factory HealthQueue.fromMap(Map map) { - return HealthQueue(size: map['size']); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue( + size: map['size'], + ); + } - Map toMap() { - return {"size": size}; - } + Map toMap() { + return { + "size": size, + }; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 59b7092c..0d6e7216 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({required this.name, required this.ping, required this.status}); + HealthStatus({ + required this.name, + required this.ping, + required this.status, + }); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return {"name": name, "ping": ping, "status": status}; - } + Map toMap() { + return { + "name": name, + "ping": ping, + "status": status, + }; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index dec2d54f..102dfe77 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,30 +2,34 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; - } + Map toMap() { + return { + "remoteTime": remoteTime, + "localTime": localTime, + "diff": diff, + }; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index 807bdfd0..c43c4d57 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index f38eaf66..e92e36cc 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({required this.total, required this.identities}); + IdentityList({ + required this.total, + required this.identities, + }); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from( - map['identities'].map((p) => Identity.fromMap(p)), - ), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 961b9e5e..07d22743 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index attributes length. - final List lengths; + /// Index attributes length. + final List lengths; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - required this.lengths, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + required this.lengths, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - lengths: List.from(map['lengths'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "lengths": lengths, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "lengths": lengths, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index dc759dfb..8eac7956 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({required this.total, required this.indexes}); + IndexList({ + required this.total, + required this.indexes, + }); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 490a1824..1b4ff7de 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,16 +2,22 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({required this.jwt}); + Jwt({ + required this.jwt, + }); - factory Jwt.fromMap(Map map) { - return Jwt(jwt: map['jwt'].toString()); - } + factory Jwt.fromMap(Map map) { + return Jwt( + jwt: map['jwt'].toString(), + ); + } - Map toMap() { - return {"jwt": jwt}; - } + Map toMap() { + return { + "jwt": jwt, + }; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 9c45adb1..43eaad08 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,26 +2,34 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({required this.name, required this.code, required this.nativeName}); + Language({ + required this.name, + required this.code, + required this.nativeName, + }); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return {"name": name, "code": code, "nativeName": nativeName}; - } + Map toMap() { + return { + "name": name, + "code": code, + "nativeName": nativeName, + }; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index 046b879e..fe271118 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({required this.total, required this.languages}); + LanguageList({ + required this.total, + required this.languages, + }); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from( - map['languages'].map((p) => Language.fromMap(p)), - ), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from(map['languages'].map((p) => Language.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index 084475bf..b5e9ad1a 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index cd5a1155..10499ef5 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({required this.code, required this.name}); + LocaleCode({ + required this.code, + required this.name, + }); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return {"code": code, "name": name}; - } + Map toMap() { + return { + "code": code, + "name": name, + }; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 662fee4f..839474d7 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({required this.total, required this.localeCodes}); + LocaleCodeList({ + required this.total, + required this.localeCodes, + }); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from( - map['localeCodes'].map((p) => LocaleCode.fromMap(p)), - ), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index 7fb3f364..cb567bd7 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 628237fa..91d024d0 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({required this.total, required this.logs}); + LogList({ + required this.total, + required this.logs, + }); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "logs": logs.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 8ee142ad..26610e46 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 46468a3a..409cdbfb 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({required this.total, required this.memberships}); + MembershipList({ + required this.total, + required this.memberships, + }); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from( - map['memberships'].map((p) => Membership.fromMap(p)), - ), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index 9b93b00d..c4e9e858 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 7bd0891f..702c912b 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({required this.total, required this.messages}); + MessageList({ + required this.total, + required this.messages, + }); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from( - map['messages'].map((p) => Message.fromMap(p)), - ), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from(map['messages'].map((p) => Message.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 96bf3c65..46c166fb 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index c930a23e..d49989d8 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 63411988..6c8b4e36 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,18 +2,22 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({required this.recoveryCodes}); + MfaRecoveryCodes({ + required this.recoveryCodes, + }); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return {"recoveryCodes": recoveryCodes}; - } + Map toMap() { + return { + "recoveryCodes": recoveryCodes, + }; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index fa57cb8b..01cf0857 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({required this.secret, required this.uri}); + MfaType({ + required this.secret, + required this.uri, + }); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return {"secret": secret, "uri": uri}; - } + Map toMap() { + return { + "secret": secret, + "uri": uri, + }; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index f810a35b..48e5b84a 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} +} \ No newline at end of file diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index 40f7bcd2..c8bbb95b 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index 18d2803d..beab76e8 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({required this.total, required this.phones}); + PhoneList({ + required this.total, + required this.phones, + }); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "phones": phones.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 48163dfc..3c62f86d 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,17 +2,23 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({required this.data}); + Preferences({ + required this.data, + }); - factory Preferences.fromMap(Map map) { - return Preferences(data: map); - } + factory Preferences.fromMap(Map map) { + return Preferences( + data: map, + ); + } - Map toMap() { - return {"data": data}; - } + Map toMap() { + return { + "data": data, + }; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 1a762f85..4295c486 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index aeb28ecd..7c09eb56 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({required this.total, required this.providers}); + ProviderList({ + required this.total, + required this.providers, + }); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from( - map['providers'].map((p) => Provider.fromMap(p)), - ), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart index dad35dcc..ed520cc4 100644 --- a/lib/src/models/resource_token.dart +++ b/lib/src/models/resource_token.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// ResourceToken class ResourceToken implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// JWT encoded string. - final String secret; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - ResourceToken({ - required this.$id, - required this.$createdAt, - required this.resourceId, - required this.resourceType, - required this.expire, - required this.secret, - required this.accessedAt, - }); - - factory ResourceToken.fromMap(Map map) { - return ResourceToken( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - expire: map['expire'].toString(), - secret: map['secret'].toString(), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "resourceId": resourceId, - "resourceType": resourceType, - "expire": expire, - "secret": secret, - "accessedAt": accessedAt, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart index f30531f4..ba8f0d89 100644 --- a/lib/src/models/resource_token_list.dart +++ b/lib/src/models/resource_token_list.dart @@ -2,24 +2,28 @@ part of '../../models.dart'; /// Resource Tokens List class ResourceTokenList implements Model { - /// Total number of tokens documents that matched your query. - final int total; + /// Total number of tokens documents that matched your query. + final int total; - /// List of tokens. - final List tokens; + /// List of tokens. + final List tokens; - ResourceTokenList({required this.total, required this.tokens}); + ResourceTokenList({ + required this.total, + required this.tokens, + }); - factory ResourceTokenList.fromMap(Map map) { - return ResourceTokenList( - total: map['total'], - tokens: List.from( - map['tokens'].map((p) => ResourceToken.fromMap(p)), - ), - ); - } + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "tokens": tokens.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "tokens": tokens.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 7c9677d8..35f82cfa 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 02c7b2e5..7615fd9e 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({required this.total, required this.runtimes}); + RuntimeList({ + required this.total, + required this.runtimes, + }); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from( - map['runtimes'].map((p) => Runtime.fromMap(p)), - ), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index d2fe4f64..3a1d955f 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 479272b9..6d26d6a8 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({required this.total, required this.sessions}); + SessionList({ + required this.total, + required this.sessions, + }); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from( - map['sessions'].map((p) => Session.fromMap(p)), - ), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart index 1449f8bd..5cda6acc 100644 --- a/lib/src/models/site.dart +++ b/lib/src/models/site.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Site class Site implements Model { - /// Site ID. - final String $id; + /// Site ID. + final String $id; - /// Site creation date in ISO 8601 format. - final String $createdAt; + /// Site creation date in ISO 8601 format. + final String $createdAt; - /// Site update date in ISO 8601 format. - final String $updatedAt; + /// Site update date in ISO 8601 format. + final String $updatedAt; - /// Site name. - final String name; + /// Site name. + final String name; - /// Site enabled. - final bool enabled; + /// Site enabled. + final bool enabled; - /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. - final bool live; + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; - /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. - final bool logging; + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; - /// Site framework. - final String framework; - - /// Site's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Screenshot of active deployment with light theme preference file ID. - final String deploymentScreenshotLight; - - /// Screenshot of active deployment with dark theme preference file ID. - final String deploymentScreenshotDark; - - /// Site's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Site variables. - final List vars; - - /// Site request timeout in seconds. - final int timeout; - - /// The install command used to install the site dependencies. - final String installCommand; - - /// The build command used to build the site. - final String buildCommand; - - /// The directory where the site build output is located. - final String outputDirectory; - - /// Site VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to site in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - /// Site build runtime. - final String buildRuntime; - - /// Site framework adapter. - final String adapter; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - Site({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.framework, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.deploymentScreenshotLight, - required this.deploymentScreenshotDark, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.vars, - required this.timeout, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - required this.buildRuntime, - required this.adapter, - required this.fallbackFile, - }); - - factory Site.fromMap(Map map) { - return Site( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - framework: map['framework'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), - deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - timeout: map['timeout'], - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - buildRuntime: map['buildRuntime'].toString(), - adapter: map['adapter'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "framework": framework, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "deploymentScreenshotLight": deploymentScreenshotLight, - "deploymentScreenshotDark": deploymentScreenshotDark, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "vars": vars.map((p) => p.toMap()).toList(), - "timeout": timeout, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - "buildRuntime": buildRuntime, - "adapter": adapter, - "fallbackFile": fallbackFile, - }; - } + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart index a403dd5b..02a6a2be 100644 --- a/lib/src/models/site_list.dart +++ b/lib/src/models/site_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Sites List class SiteList implements Model { - /// Total number of sites documents that matched your query. - final int total; + /// Total number of sites documents that matched your query. + final int total; - /// List of sites. - final List sites; + /// List of sites. + final List sites; - SiteList({required this.total, required this.sites}); + SiteList({ + required this.total, + required this.sites, + }); - factory SiteList.fromMap(Map map) { - return SiteList( - total: map['total'], - sites: List.from(map['sites'].map((p) => Site.fromMap(p))), - ); - } + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "sites": sites.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "sites": sites.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e8fb8c75..e49d399c 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,35 +2,40 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; - } + Map toMap() { + return { + "memory": memory, + "cpus": cpus, + "enabled": enabled, + "slug": slug, + }; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index e4bef89b..72703f84 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({required this.total, required this.specifications}); + SpecificationList({ + required this.total, + required this.specifications, + }); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from( - map['specifications'].map((p) => Specification.fromMap(p)), - ), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 0c926297..36e18a7e 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index 7030fa0a..d7d3c3e3 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({required this.total, required this.subscribers}); + SubscriberList({ + required this.total, + required this.subscribers, + }); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from( - map['subscribers'].map((p) => Subscriber.fromMap(p)), - ), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index 4be8b545..f2b3b6b4 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 1042e5a2..2d38efe5 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({required this.total, required this.targets}); + TargetList({ + required this.total, + required this.targets, + }); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "targets": targets.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index 43df33a8..e9058b5b 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index e604f192..2fb3611e 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({required this.total, required this.teams}); + TeamList({ + required this.total, + required this.teams, + }); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "teams": teams.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 35115467..4f6b8454 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 430d44ac..461d5694 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index a4d1f44f..e57ef05f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({required this.total, required this.topics}); + TopicList({ + required this.total, + required this.topics, + }); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "topics": topics.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index 50bfb3ce..effc397c 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 03e55cc6..55dfcf77 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,22 +2,28 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({required this.total, required this.users}); + UserList({ + required this.total, + required this.users, + }); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return {"total": total, "users": users.map((p) => p.toMap()).toList()}; - } + Map toMap() { + return { + "total": total, + "users": users.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 2a8e276a..58882a9f 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; + /// Variable ID. + final String $id; - /// Variable creation date in ISO 8601 format. - final String $createdAt; + /// Variable creation date in ISO 8601 format. + final String $createdAt; - /// Variable creation date in ISO 8601 format. - final String $updatedAt; + /// Variable creation date in ISO 8601 format. + final String $updatedAt; - /// Variable key. - final String key; + /// Variable key. + final String key; - /// Variable value. - final String value; + /// Variable value. + final String value; - /// Variable secret flag. Secret variables can only be updated or deleted, but never read. - final bool secret; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.secret, - required this.resourceType, - required this.resourceId, - }); + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.secret, + required this.resourceType, + required this.resourceId, + }); - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - secret: map['secret'], - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + secret: map['secret'], + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "secret": secret, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "secret": secret, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index 4ff3e189..b6da02cc 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,27 +2,28 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({required this.total, required this.variables}); + VariableList({ + required this.total, + required this.variables, + }); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from( - map['variables'].map((p) => Variable.fromMap(p)), - ), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 5a19b0fc..44cde383 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, + "chunksUploaded": chunksUploaded }; } From 845ca67c9b5480efb4e7a68f8ffc8189a669e808 Mon Sep 17 00:00:00 2001 From: ChiragAgg5k Date: Sun, 18 May 2025 08:36:24 +0000 Subject: [PATCH 7/7] Commit from GitHub Actions (Format and push) --- lib/client_browser.dart | 2 +- lib/client_io.dart | 2 +- lib/dart_appwrite.dart | 2 +- lib/id.dart | 3 +- lib/query.dart | 55 +- lib/role.dart | 106 +- lib/services/account.dart | 2159 +++++++-------- lib/services/avatars.dart | 434 +-- lib/services/databases.dart | 2528 ++++++++++-------- lib/services/functions.dart | 1385 +++++----- lib/services/graphql.dart | 90 +- lib/services/health.dart | 683 +++-- lib/services/locale.dart | 246 +- lib/services/messaging.dart | 2628 +++++++++++-------- lib/services/sites.dart | 1282 +++++---- lib/services/storage.dart | 744 +++--- lib/services/teams.dart | 671 ++--- lib/services/tokens.dart | 216 +- lib/services/users.dart | 2063 ++++++++------- lib/src/client.dart | 15 +- lib/src/client_base.dart | 6 +- lib/src/client_browser.dart | 123 +- lib/src/client_io.dart | 150 +- lib/src/client_mixin.dart | 65 +- lib/src/client_stub.dart | 3 +- lib/src/enums.dart | 2 +- lib/src/enums/adapter.dart | 14 +- lib/src/enums/authentication_factor.dart | 18 +- lib/src/enums/authenticator_type.dart | 12 +- lib/src/enums/browser.dart | 38 +- lib/src/enums/build_runtime.dart | 136 +- lib/src/enums/compression.dart | 16 +- lib/src/enums/credit_card.dart | 44 +- lib/src/enums/deployment_download_type.dart | 14 +- lib/src/enums/execution_method.dart | 22 +- lib/src/enums/flag.dart | 400 ++- lib/src/enums/framework.dart | 38 +- lib/src/enums/image_format.dart | 22 +- lib/src/enums/image_gravity.dart | 28 +- lib/src/enums/index_type.dart | 16 +- lib/src/enums/message_priority.dart | 14 +- lib/src/enums/messaging_provider_type.dart | 16 +- lib/src/enums/name.dart | 34 +- lib/src/enums/o_auth_provider.dart | 90 +- lib/src/enums/password_hash.dart | 32 +- lib/src/enums/relation_mutate.dart | 16 +- lib/src/enums/relationship_type.dart | 18 +- lib/src/enums/runtime.dart | 136 +- lib/src/enums/smtp_encryption.dart | 16 +- lib/src/enums/vcs_deployment_type.dart | 16 +- lib/src/exception.dart | 2 +- lib/src/models/algo_argon2.dart | 60 +- lib/src/models/algo_bcrypt.dart | 24 +- lib/src/models/algo_md5.dart | 24 +- lib/src/models/algo_phpass.dart | 24 +- lib/src/models/algo_scrypt.dart | 84 +- lib/src/models/algo_scrypt_modified.dart | 60 +- lib/src/models/algo_sha.dart | 24 +- lib/src/models/attribute_boolean.dart | 110 +- lib/src/models/attribute_datetime.dart | 120 +- lib/src/models/attribute_email.dart | 120 +- lib/src/models/attribute_enum.dart | 130 +- lib/src/models/attribute_float.dart | 130 +- lib/src/models/attribute_integer.dart | 130 +- lib/src/models/attribute_ip.dart | 120 +- lib/src/models/attribute_list.dart | 34 +- lib/src/models/attribute_relationship.dart | 192 +- lib/src/models/attribute_string.dart | 120 +- lib/src/models/attribute_url.dart | 120 +- lib/src/models/bucket.dart | 140 +- lib/src/models/bucket_list.dart | 34 +- lib/src/models/collection.dart | 120 +- lib/src/models/collection_list.dart | 39 +- lib/src/models/continent.dart | 34 +- lib/src/models/continent_list.dart | 39 +- lib/src/models/country.dart | 31 +- lib/src/models/country_list.dart | 39 +- lib/src/models/currency.dart | 108 +- lib/src/models/currency_list.dart | 39 +- lib/src/models/database.dart | 84 +- lib/src/models/database_list.dart | 39 +- lib/src/models/deployment.dart | 338 +-- lib/src/models/deployment_list.dart | 39 +- lib/src/models/document.dart | 110 +- lib/src/models/document_list.dart | 43 +- lib/src/models/execution.dart | 232 +- lib/src/models/execution_list.dart | 39 +- lib/src/models/file.dart | 130 +- lib/src/models/file_list.dart | 34 +- lib/src/models/framework.dart | 86 +- lib/src/models/framework_adapter.dart | 84 +- lib/src/models/framework_list.dart | 39 +- lib/src/models/function.dart | 348 +-- lib/src/models/function_list.dart | 37 +- lib/src/models/headers.dart | 34 +- lib/src/models/health_antivirus.dart | 34 +- lib/src/models/health_certificate.dart | 96 +- lib/src/models/health_queue.dart | 24 +- lib/src/models/health_status.dart | 42 +- lib/src/models/health_time.dart | 46 +- lib/src/models/identity.dart | 120 +- lib/src/models/identity_list.dart | 39 +- lib/src/models/index.dart | 110 +- lib/src/models/index_list.dart | 34 +- lib/src/models/jwt.dart | 24 +- lib/src/models/language.dart | 42 +- lib/src/models/language_list.dart | 39 +- lib/src/models/locale.dart | 108 +- lib/src/models/locale_code.dart | 34 +- lib/src/models/locale_code_list.dart | 39 +- lib/src/models/log.dart | 276 +- lib/src/models/log_list.dart | 34 +- lib/src/models/membership.dart | 180 +- lib/src/models/membership_list.dart | 39 +- lib/src/models/message.dart | 180 +- lib/src/models/message_list.dart | 39 +- lib/src/models/mfa_challenge.dart | 60 +- lib/src/models/mfa_factors.dart | 60 +- lib/src/models/mfa_recovery_codes.dart | 26 +- lib/src/models/mfa_type.dart | 34 +- lib/src/models/model.dart | 2 +- lib/src/models/phone.dart | 50 +- lib/src/models/phone_list.dart | 34 +- lib/src/models/preferences.dart | 24 +- lib/src/models/provider.dart | 110 +- lib/src/models/provider_list.dart | 39 +- lib/src/models/resource_token.dart | 108 +- lib/src/models/resource_token_list.dart | 36 +- lib/src/models/runtime.dart | 100 +- lib/src/models/runtime_list.dart | 39 +- lib/src/models/session.dart | 358 +-- lib/src/models/session_list.dart | 39 +- lib/src/models/site.dart | 358 +-- lib/src/models/site_list.dart | 34 +- lib/src/models/specification.dart | 55 +- lib/src/models/specification_list.dart | 39 +- lib/src/models/subscriber.dart | 110 +- lib/src/models/subscriber_list.dart | 39 +- lib/src/models/target.dart | 110 +- lib/src/models/target_list.dart | 34 +- lib/src/models/team.dart | 96 +- lib/src/models/team_list.dart | 34 +- lib/src/models/token.dart | 96 +- lib/src/models/topic.dart | 100 +- lib/src/models/topic_list.dart | 34 +- lib/src/models/user.dart | 252 +- lib/src/models/user_list.dart | 34 +- lib/src/models/variable.dart | 100 +- lib/src/models/variable_list.dart | 39 +- lib/src/upload_progress.dart | 2 +- 150 files changed, 13072 insertions(+), 12028 deletions(-) diff --git a/lib/client_browser.dart b/lib/client_browser.dart index 09f110ea..b9805a3a 100644 --- a/lib/client_browser.dart +++ b/lib/client_browser.dart @@ -1 +1 @@ -export 'src/client_browser.dart'; \ No newline at end of file +export 'src/client_browser.dart'; diff --git a/lib/client_io.dart b/lib/client_io.dart index 4d85cbfa..42a0c0b6 100644 --- a/lib/client_io.dart +++ b/lib/client_io.dart @@ -1 +1 @@ -export 'src/client_io.dart'; \ No newline at end of file +export 'src/client_io.dart'; diff --git a/lib/dart_appwrite.dart b/lib/dart_appwrite.dart index 5f5ffe9d..0848a050 100644 --- a/lib/dart_appwrite.dart +++ b/lib/dart_appwrite.dart @@ -1,6 +1,6 @@ /// Appwrite Dart SDK /// -/// This SDK is compatible with Appwrite server version 1.7.x. +/// This SDK is compatible with Appwrite server version 1.7.x. /// For older versions, please check /// [previous releases](https://github.com/appwrite/sdk-for-dart/releases). library dart_appwrite; diff --git a/lib/id.dart b/lib/id.dart index 72e26a23..28ff15e8 100644 --- a/lib/id.dart +++ b/lib/id.dart @@ -10,8 +10,7 @@ class ID { final now = DateTime.now(); final sec = (now.millisecondsSinceEpoch / 1000).floor(); final usec = now.microsecondsSinceEpoch - (sec * 1000000); - return sec.toRadixString(16) + - usec.toRadixString(16).padLeft(5, '0'); + return sec.toRadixString(16) + usec.toRadixString(16).padLeft(5, '0'); } // Generate a unique ID with padding to have a longer ID diff --git a/lib/query.dart b/lib/query.dart index 46882207..9107a9a4 100644 --- a/lib/query.dart +++ b/lib/query.dart @@ -1,6 +1,5 @@ part of 'dart_appwrite.dart'; - /// Helper class to generate query strings. class Query { final String method; @@ -10,15 +9,13 @@ class Query { Query._(this.method, [this.attribute = null, this.values = null]); Map toJson() { - final map = { - 'method': method, - }; + final map = {'method': method}; - if(attribute != null) { + if (attribute != null) { map['attribute'] = attribute; } - - if(values != null) { + + if (values != null) { map['values'] = values is List ? values : [values]; } @@ -29,7 +26,7 @@ class Query { String toString() => jsonEncode(toJson()); /// Filter resources where [attribute] is equal to [value]. - /// + /// /// [value] can be a single value or a list. If a list is used /// the query will return resources where [attribute] is equal /// to any of the values in the list. @@ -61,10 +58,12 @@ class Query { Query._('search', attribute, value).toString(); /// Filter resources where [attribute] is null. - static String isNull(String attribute) => Query._('isNull', attribute).toString(); + static String isNull(String attribute) => + Query._('isNull', attribute).toString(); /// Filter resources where [attribute] is not null. - static String isNotNull(String attribute) => Query._('isNotNull', attribute).toString(); + static String isNotNull(String attribute) => + Query._('isNotNull', attribute).toString(); /// Filter resources where [attribute] is between [start] and [end] (inclusive). static String between(String attribute, dynamic start, dynamic end) => @@ -84,40 +83,52 @@ class Query { Query._('contains', attribute, value).toString(); static String or(List queries) => - Query._('or', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'or', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); static String and(List queries) => - Query._('and', null, queries.map((query) => jsonDecode(query)).toList()).toString(); + Query._( + 'and', + null, + queries.map((query) => jsonDecode(query)).toList(), + ).toString(); /// Specify which attributes should be returned by the API call. static String select(List attributes) => Query._('select', null, attributes).toString(); /// Sort results by [attribute] ascending. - static String orderAsc(String attribute) => Query._('orderAsc', attribute).toString(); + static String orderAsc(String attribute) => + Query._('orderAsc', attribute).toString(); /// Sort results by [attribute] descending. - static String orderDesc(String attribute) => Query._('orderDesc', attribute).toString(); + static String orderDesc(String attribute) => + Query._('orderDesc', attribute).toString(); /// Return results before [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorBefore(String id) => Query._('cursorBefore', null, id).toString(); + static String cursorBefore(String id) => + Query._('cursorBefore', null, id).toString(); /// Return results after [id]. - /// + /// /// Refer to the [Cursor Based Pagination](https://appwrite.io/docs/pagination#cursor-pagination) /// docs for more information. - static String cursorAfter(String id) => Query._('cursorAfter', null, id).toString(); + static String cursorAfter(String id) => + Query._('cursorAfter', null, id).toString(); /// Return only [limit] results. static String limit(int limit) => Query._('limit', null, limit).toString(); /// Return results from [offset]. - /// + /// /// Refer to the [Offset Pagination](https://appwrite.io/docs/pagination#offset-pagination) /// docs for more information. - static String offset(int offset) => Query._('offset', null, offset).toString(); - -} \ No newline at end of file + static String offset(int offset) => + Query._('offset', null, offset).toString(); +} diff --git a/lib/role.dart b/lib/role.dart index 6552df47..dafeb78d 100644 --- a/lib/role.dart +++ b/lib/role.dart @@ -2,65 +2,65 @@ part of 'dart_appwrite.dart'; /// Helper class to generate role strings for [Permission]. class Role { - Role._(); - - /// Grants access to anyone. - /// - /// This includes authenticated and unauthenticated users. - static String any() { - return 'any'; - } + Role._(); - /// Grants access to a specific user by user ID. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String user(String id, [String status = '']) { - if(status.isEmpty) { - return 'user:$id'; - } - return 'user:$id/$status'; - } + /// Grants access to anyone. + /// + /// This includes authenticated and unauthenticated users. + static String any() { + return 'any'; + } - /// Grants access to any authenticated or anonymous user. - /// - /// You can optionally pass verified or unverified for - /// [status] to target specific types of users. - static String users([String status = '']) { - if(status.isEmpty) { - return 'users'; - } - return 'users/$status'; + /// Grants access to a specific user by user ID. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String user(String id, [String status = '']) { + if (status.isEmpty) { + return 'user:$id'; } + return 'user:$id/$status'; + } - /// Grants access to any guest user without a session. - /// - /// Authenticated users don't have access to this role. - static String guests() { - return 'guests'; + /// Grants access to any authenticated or anonymous user. + /// + /// You can optionally pass verified or unverified for + /// [status] to target specific types of users. + static String users([String status = '']) { + if (status.isEmpty) { + return 'users'; } + return 'users/$status'; + } - /// Grants access to a team by team ID. - /// - /// You can optionally pass a role for [role] to target - /// team members with the specified role. - static String team(String id, [String role = '']) { - if(role.isEmpty) { - return 'team:$id'; - } - return 'team:$id/$role'; - } + /// Grants access to any guest user without a session. + /// + /// Authenticated users don't have access to this role. + static String guests() { + return 'guests'; + } - /// Grants access to a specific member of a team. - /// - /// When the member is removed from the team, they will - /// no longer have access. - static String member(String id) { - return 'member:$id'; + /// Grants access to a team by team ID. + /// + /// You can optionally pass a role for [role] to target + /// team members with the specified role. + static String team(String id, [String role = '']) { + if (role.isEmpty) { + return 'team:$id'; } + return 'team:$id/$role'; + } - /// Grants access to a user with the specified label. - static String label(String name) { - return 'label:$name'; - } -} \ No newline at end of file + /// Grants access to a specific member of a team. + /// + /// When the member is removed from the team, they will + /// no longer have access. + static String member(String id) { + return 'member:$id'; + } + + /// Grants access to a user with the specified label. + static String label(String name) { + return 'label:$name'; + } +} diff --git a/lib/services/account.dart b/lib/services/account.dart index fdc8cc97..90e1f03e 100644 --- a/lib/services/account.dart +++ b/lib/services/account.dart @@ -2,1081 +2,1084 @@ part of '../dart_appwrite.dart'; /// The Account service allows you to authenticate and manage a user account. class Account extends Service { - Account(super.client); - - /// Get the currently logged in user. - Future get() async { - final String apiPath = '/account'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to allow a new user to register a new account in your - /// project. After the user registration completes successfully, you can use - /// the - /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) - /// route to start verifying the user email address. To allow the new user to - /// login to their new account, you need to create a new [account - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). - Future create({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/account'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user account email address. After changing user - /// address, the user confirmation status will get reset. A new confirmation - /// email is not sent automatically however you can use the send confirmation - /// email endpoint again to send the confirmation email. For security measures, - /// user password is required to complete this request. - /// This endpoint can also be used to convert an anonymous account to a normal - /// one, by passing an email address and a new password. - /// - Future updateEmail({required String email, required String password}) async { - final String apiPath = '/account/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the list of identities for the currently logged in user. - Future listIdentities({List? queries}) async { - final String apiPath = '/account/identities'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/account/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT - /// to authenticate on behalf of the current user when working with the - /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes - /// from its creation and will be invalid if the user will logout in that time - /// frame. - Future createJWT() async { - final String apiPath = '/account/jwts'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Get the list of latest security activity logs for the currently logged in - /// user. Each log returns user IP address, location and date and time of log. - Future listLogs({List? queries}) async { - final String apiPath = '/account/logs'; - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Enable or disable MFA on an account. - Future updateMFA({required bool mfa}) async { - final String apiPath = '/account/mfa'; - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Add an authenticator app to be used as an MFA factor. Verify the - /// authenticator using the [verify - /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) - /// method. - Future createMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaType.fromMap(res.data); - - } - - /// Verify an authenticator app after adding it using the [add - /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) - /// method. - Future updateMfaAuthenticator({required enums.AuthenticatorType type, required String otp}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - 'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator for a user by ID. - Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { - final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Begin the process of MFA verification after sign-in. Finish the flow with - /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) - /// method. - Future createMfaChallenge({required enums.AuthenticationFactor factor}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'factor': factor.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaChallenge.fromMap(res.data); - - } - - /// Complete the MFA challenge by providing the one-time password. Finish the - /// process of MFA verification by providing the one-time password. To begin - /// the flow, use - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future updateMfaChallenge({required String challengeId, required String otp}) async { - final String apiPath = '/account/mfa/challenge'; - - final Map apiParams = { - - 'challengeId': challengeId, -'otp': otp, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors() async { - final String apiPath = '/account/mfa/factors'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow. Before getting - /// codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to read recovery codes. - Future getMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes as backup for MFA flow. It's recommended to - /// generate and show then immediately after user successfully adds their - /// authehticator. Recovery codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method. - Future createMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow. Before - /// regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. An OTP challenge is required to regenreate recovery codes. - Future updateMfaRecoveryCodes() async { - final String apiPath = '/account/mfa/recovery-codes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update currently logged in user account name. - Future updateName({required String name}) async { - final String apiPath = '/account/name'; - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update currently logged in user password. For validation, user is required - /// to pass in the new password, and the old password. For users created with - /// OAuth, Team Invites and Magic URL, oldPassword is optional. - Future updatePassword({required String password, String? oldPassword}) async { - final String apiPath = '/account/password'; - - final Map apiParams = { - - 'password': password, -'oldPassword': oldPassword, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the currently logged in user's phone number. After updating the - /// phone number, the phone verification status will be reset. A confirmation - /// SMS is not sent automatically, however you can use the [POST - /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) - /// endpoint to send a confirmation SMS. - Future updatePhone({required String phone, required String password}) async { - final String apiPath = '/account/phone'; - - final Map apiParams = { - - 'phone': phone, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the preferences as a key-value object for the currently logged in user. - Future getPrefs() async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update currently logged in user account preferences. The object you pass is - /// stored as is, and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws error if exceeded. - Future updatePrefs({required Map prefs}) async { - final String apiPath = '/account/prefs'; - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a temporary secret key for password reset. - /// When the user clicks the confirmation link he is redirected back to your - /// app password reset URL with the secret key and email address values - /// attached to the URL query string. Use the query string params to submit a - /// request to the [PUT - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) - /// endpoint to complete the process. The verification link sent to the user's - /// email address is valid for 1 hour. - Future createRecovery({required String email, required String url}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'email': email, -'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user account password reset. Both the - /// **userId** and **secret** arguments will be passed as query parameters to - /// the redirect URL you have provided when sending your request to the [POST - /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) - /// endpoint. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - Future updateRecovery({required String userId, required String secret, required String password}) async { - final String apiPath = '/account/recovery'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Get the list of active sessions across different devices for the currently - /// logged in user. - Future listSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Delete all sessions from the user account and remove any sessions cookies - /// from the end client. - Future deleteSessions() async { - final String apiPath = '/account/sessions'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a new user to register an anonymous account in - /// your project. This route will also create a new session for the user. To - /// allow the new user to convert an anonymous account to a normal account, you - /// need to update its [email and - /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) - /// or create an [OAuth2 - /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). - Future createAnonymousSession() async { - final String apiPath = '/account/sessions/anonymous'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Allow the user to login into their account by providing a valid email and - /// password combination. This route will create a new session for the user. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailPasswordSession({required String email, required String password}) async { - final String apiPath = '/account/sessions/email'; - - final Map apiParams = { - - 'email': email, -'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updateMagicURLSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future updatePhoneSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to create a session from token. Provide the **userId** - /// and **secret** parameters from the successful response of authentication - /// flows initiated by token creation. For example, magic URL and phone login. - Future createSession({required String userId, required String secret}) async { - final String apiPath = '/account/sessions/token'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to get a logged in user's session using a Session ID. - /// Inputting 'current' will return the current session being used. - Future getSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Use this endpoint to extend a session's length. Extending a session is - /// useful when session expiry is short. If the session was created using an - /// OAuth provider, this endpoint refreshes the access token from the provider. - Future updateSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Logout the user. Use 'current' as the session ID to logout on this device, - /// use a session ID to logout on another device. If you're looking to logout - /// the user on all devices, use [Delete - /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) - /// instead. - Future deleteSession({required String sessionId}) async { - final String apiPath = '/account/sessions/{sessionId}'.replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Block the currently logged in user account. Behind the scene, the user - /// record is not deleted but permanently blocked from any access. To - /// completely delete a user, use the Users API instead. - Future updateStatus() async { - final String apiPath = '/account/status'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's email - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createEmailToken({required String userId, required String email, bool? phrase}) async { - final String apiPath = '/account/tokens/email'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Sends the user an email with a secret key for creating a session. If the - /// provided user ID has not been registered, a new user will be created. When - /// the user clicks the link in the email, the user is redirected back to the - /// URL you provided with the secret key and userId values attached to the URL - /// query string. Use the query string parameters to submit a request to the - /// [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The link sent to the user's email - /// address is valid for 1 hour. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - /// - Future createMagicURLToken({required String userId, required String email, String? url, bool? phrase}) async { - final String apiPath = '/account/tokens/magic-url'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'url': url, -'phrase': phrase, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Allow the user to login to their account using the OAuth2 provider of their - /// choice. Each OAuth2 provider should be enabled from the Appwrite console - /// first. Use the success and failure arguments to provide a redirect URL's - /// back to your app when login is completed. - /// - /// If authentication succeeds, `userId` and `secret` of a token will be - /// appended to the success URL as query parameters. These can be used to - /// create a new session using the [Create - /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createOAuth2Token({required enums.OAuthProvider provider, String? success, String? failure, List? scopes}) async { - final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll('{provider}', provider.value); - - final Map params = { - 'success': success, -'failure': failure, -'scopes': scopes, - - - 'project': client.config['project'], - }; - - final List query = []; - - params.forEach((key, value) { - if (value is List) { - for (var item in value) { - query.add(Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item)); - } - } else if(value != null) { - query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); - } - }); - - Uri endpoint = Uri.parse(client.endPoint); - Uri url = Uri(scheme: endpoint.scheme, - host: endpoint.host, - port: endpoint.port, - path: endpoint.path + apiPath, - query: query.join('&') - ); - - return client.webAuth(url); - } - - /// Sends the user an SMS with a secret key for creating a session. If the - /// provided user ID has not be registered, a new user will be created. Use the - /// returned user ID and secret and submit a request to the [POST - /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. The secret sent to the user's phone - /// is valid for 15 minutes. - /// - /// A user is limited to 10 active sessions at a time by default. [Learn more - /// about session - /// limits](https://appwrite.io/docs/authentication-security#limits). - Future createPhoneToken({required String userId, required String phone}) async { - final String apiPath = '/account/tokens/phone'; - - final Map apiParams = { - - 'userId': userId, -'phone': phone, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification message to your user email address - /// to confirm they are the valid owners of that address. Both the **userId** - /// and **secret** arguments will be passed as query parameters to the URL you - /// have provided to be attached to the verification email. The provided URL - /// should redirect the user back to your app and allow you to complete the - /// verification process by verifying both the **userId** and **secret** - /// parameters. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). - /// The verification link sent to the user's email address is valid for 7 days. - /// - /// Please note that in order to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), - /// the only valid redirect URLs are the ones from domains you have set when - /// adding your platforms in the console interface. - /// - Future createVerification({required String url}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'url': url, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user email verification process. Use both - /// the **userId** and **secret** parameters that were attached to your app URL - /// to verify the user email ownership. If confirmed this route will return a - /// 200 status code. - Future updateVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to send a verification SMS to the currently logged in - /// user. This endpoint is meant for use after updating a user's phone number - /// using the - /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) - /// endpoint. Learn more about how to [complete the verification - /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). - /// The verification code sent to the user's phone number is valid for 15 - /// minutes. - Future createPhoneVerification() async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Use this endpoint to complete the user phone verification process. Use the - /// **userId** and **secret** that were sent to your user's phone number to - /// verify the user email ownership. If confirmed this route will return a 200 - /// status code. - Future updatePhoneVerification({required String userId, required String secret}) async { - final String apiPath = '/account/verification/phone'; - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } -} \ No newline at end of file + Account(super.client); + + /// Get the currently logged in user. + Future get() async { + final String apiPath = '/account'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to allow a new user to register a new account in your + /// project. After the user registration completes successfully, you can use + /// the + /// [/account/verfication](https://appwrite.io/docs/references/cloud/client-web/account#createVerification) + /// route to start verifying the user email address. To allow the new user to + /// login to their new account, you need to create a new [account + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createEmailSession). + Future create({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/account'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user account email address. After changing user + /// address, the user confirmation status will get reset. A new confirmation + /// email is not sent automatically however you can use the send confirmation + /// email endpoint again to send the confirmation email. For security measures, + /// user password is required to complete this request. + /// This endpoint can also be used to convert an anonymous account to a normal + /// one, by passing an email address and a new password. + /// + Future updateEmail({ + required String email, + required String password, + }) async { + final String apiPath = '/account/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the list of identities for the currently logged in user. + Future listIdentities({List? queries}) async { + final String apiPath = '/account/identities'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/account/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to create a JSON Web Token. You can use the resulting JWT + /// to authenticate on behalf of the current user when working with the + /// Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes + /// from its creation and will be invalid if the user will logout in that time + /// frame. + Future createJWT() async { + final String apiPath = '/account/jwts'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Get the list of latest security activity logs for the currently logged in + /// user. Each log returns user IP address, location and date and time of log. + Future listLogs({List? queries}) async { + final String apiPath = '/account/logs'; + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Enable or disable MFA on an account. + Future updateMFA({required bool mfa}) async { + final String apiPath = '/account/mfa'; + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Add an authenticator app to be used as an MFA factor. Verify the + /// authenticator using the [verify + /// authenticator](/docs/references/cloud/client-web/account#updateMfaAuthenticator) + /// method. + Future createMfaAuthenticator({ + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaType.fromMap(res.data); + } + + /// Verify an authenticator app after adding it using the [add + /// authenticator](/docs/references/cloud/client-web/account#createMfaAuthenticator) + /// method. + Future updateMfaAuthenticator({ + required enums.AuthenticatorType type, + required String otp, + }) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {'otp': otp}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator for a user by ID. + Future deleteMfaAuthenticator({required enums.AuthenticatorType type}) async { + final String apiPath = '/account/mfa/authenticators/{type}'.replaceAll( + '{type}', + type.value, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Begin the process of MFA verification after sign-in. Finish the flow with + /// [updateMfaChallenge](/docs/references/cloud/client-web/account#updateMfaChallenge) + /// method. + Future createMfaChallenge({ + required enums.AuthenticationFactor factor, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = {'factor': factor.value}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaChallenge.fromMap(res.data); + } + + /// Complete the MFA challenge by providing the one-time password. Finish the + /// process of MFA verification by providing the one-time password. To begin + /// the flow, use + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future updateMfaChallenge({ + required String challengeId, + required String otp, + }) async { + final String apiPath = '/account/mfa/challenge'; + + final Map apiParams = { + 'challengeId': challengeId, + 'otp': otp, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors() async { + final String apiPath = '/account/mfa/factors'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow. Before getting + /// codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to read recovery codes. + Future getMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes as backup for MFA flow. It's recommended to + /// generate and show then immediately after user successfully adds their + /// authehticator. Recovery codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method. + Future createMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow. Before + /// regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. An OTP challenge is required to regenreate recovery codes. + Future updateMfaRecoveryCodes() async { + final String apiPath = '/account/mfa/recovery-codes'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update currently logged in user account name. + Future updateName({required String name}) async { + final String apiPath = '/account/name'; + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update currently logged in user password. For validation, user is required + /// to pass in the new password, and the old password. For users created with + /// OAuth, Team Invites and Magic URL, oldPassword is optional. + Future updatePassword({ + required String password, + String? oldPassword, + }) async { + final String apiPath = '/account/password'; + + final Map apiParams = { + 'password': password, + 'oldPassword': oldPassword, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the currently logged in user's phone number. After updating the + /// phone number, the phone verification status will be reset. A confirmation + /// SMS is not sent automatically, however you can use the [POST + /// /account/verification/phone](https://appwrite.io/docs/references/cloud/client-web/account#createPhoneVerification) + /// endpoint to send a confirmation SMS. + Future updatePhone({ + required String phone, + required String password, + }) async { + final String apiPath = '/account/phone'; + + final Map apiParams = { + 'phone': phone, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the preferences as a key-value object for the currently logged in user. + Future getPrefs() async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update currently logged in user account preferences. The object you pass is + /// stored as is, and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws error if exceeded. + Future updatePrefs({required Map prefs}) async { + final String apiPath = '/account/prefs'; + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a temporary secret key for password reset. + /// When the user clicks the confirmation link he is redirected back to your + /// app password reset URL with the secret key and email address values + /// attached to the URL query string. Use the query string params to submit a + /// request to the [PUT + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#updateRecovery) + /// endpoint to complete the process. The verification link sent to the user's + /// email address is valid for 1 hour. + Future createRecovery({ + required String email, + required String url, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = {'email': email, 'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user account password reset. Both the + /// **userId** and **secret** arguments will be passed as query parameters to + /// the redirect URL you have provided when sending your request to the [POST + /// /account/recovery](https://appwrite.io/docs/references/cloud/client-web/account#createRecovery) + /// endpoint. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + Future updateRecovery({ + required String userId, + required String secret, + required String password, + }) async { + final String apiPath = '/account/recovery'; + + final Map apiParams = { + 'userId': userId, + 'secret': secret, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Get the list of active sessions across different devices for the currently + /// logged in user. + Future listSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Delete all sessions from the user account and remove any sessions cookies + /// from the end client. + Future deleteSessions() async { + final String apiPath = '/account/sessions'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a new user to register an anonymous account in + /// your project. This route will also create a new session for the user. To + /// allow the new user to convert an anonymous account to a normal account, you + /// need to update its [email and + /// password](https://appwrite.io/docs/references/cloud/client-web/account#updateEmail) + /// or create an [OAuth2 + /// session](https://appwrite.io/docs/references/cloud/client-web/account#CreateOAuth2Session). + Future createAnonymousSession() async { + final String apiPath = '/account/sessions/anonymous'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Allow the user to login into their account by providing a valid email and + /// password combination. This route will create a new session for the user. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailPasswordSession({ + required String email, + required String password, + }) async { + final String apiPath = '/account/sessions/email'; + + final Map apiParams = { + 'email': email, + 'password': password, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updateMagicURLSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/magic-url'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future updatePhoneSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to create a session from token. Provide the **userId** + /// and **secret** parameters from the successful response of authentication + /// flows initiated by token creation. For example, magic URL and phone login. + Future createSession({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/sessions/token'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to get a logged in user's session using a Session ID. + /// Inputting 'current' will return the current session being used. + Future getSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Use this endpoint to extend a session's length. Extending a session is + /// useful when session expiry is short. If the session was created using an + /// OAuth provider, this endpoint refreshes the access token from the provider. + Future updateSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Logout the user. Use 'current' as the session ID to logout on this device, + /// use a session ID to logout on another device. If you're looking to logout + /// the user on all devices, use [Delete + /// Sessions](https://appwrite.io/docs/references/cloud/client-web/account#deleteSessions) + /// instead. + Future deleteSession({required String sessionId}) async { + final String apiPath = '/account/sessions/{sessionId}'.replaceAll( + '{sessionId}', + sessionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Block the currently logged in user account. Behind the scene, the user + /// record is not deleted but permanently blocked from any access. To + /// completely delete a user, use the Users API instead. + Future updateStatus() async { + final String apiPath = '/account/status'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's email + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createEmailToken({ + required String userId, + required String email, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/email'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Sends the user an email with a secret key for creating a session. If the + /// provided user ID has not been registered, a new user will be created. When + /// the user clicks the link in the email, the user is redirected back to the + /// URL you provided with the secret key and userId values attached to the URL + /// query string. Use the query string parameters to submit a request to the + /// [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The link sent to the user's email + /// address is valid for 1 hour. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + /// + Future createMagicURLToken({ + required String userId, + required String email, + String? url, + bool? phrase, + }) async { + final String apiPath = '/account/tokens/magic-url'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'url': url, + 'phrase': phrase, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Allow the user to login to their account using the OAuth2 provider of their + /// choice. Each OAuth2 provider should be enabled from the Appwrite console + /// first. Use the success and failure arguments to provide a redirect URL's + /// back to your app when login is completed. + /// + /// If authentication succeeds, `userId` and `secret` of a token will be + /// appended to the success URL as query parameters. These can be used to + /// create a new session using the [Create + /// session](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createOAuth2Token({ + required enums.OAuthProvider provider, + String? success, + String? failure, + List? scopes, + }) async { + final String apiPath = '/account/tokens/oauth2/{provider}'.replaceAll( + '{provider}', + provider.value, + ); + + final Map params = { + 'success': success, + 'failure': failure, + 'scopes': scopes, + + 'project': client.config['project'], + }; + + final List query = []; + + params.forEach((key, value) { + if (value is List) { + for (var item in value) { + query.add( + Uri.encodeComponent(key + '[]') + '=' + Uri.encodeComponent(item), + ); + } + } else if (value != null) { + query.add(Uri.encodeComponent(key) + '=' + Uri.encodeComponent(value)); + } + }); + + Uri endpoint = Uri.parse(client.endPoint); + Uri url = Uri( + scheme: endpoint.scheme, + host: endpoint.host, + port: endpoint.port, + path: endpoint.path + apiPath, + query: query.join('&'), + ); + + return client.webAuth(url); + } + + /// Sends the user an SMS with a secret key for creating a session. If the + /// provided user ID has not be registered, a new user will be created. Use the + /// returned user ID and secret and submit a request to the [POST + /// /v1/account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. The secret sent to the user's phone + /// is valid for 15 minutes. + /// + /// A user is limited to 10 active sessions at a time by default. [Learn more + /// about session + /// limits](https://appwrite.io/docs/authentication-security#limits). + Future createPhoneToken({ + required String userId, + required String phone, + }) async { + final String apiPath = '/account/tokens/phone'; + + final Map apiParams = {'userId': userId, 'phone': phone}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification message to your user email address + /// to confirm they are the valid owners of that address. Both the **userId** + /// and **secret** arguments will be passed as query parameters to the URL you + /// have provided to be attached to the verification email. The provided URL + /// should redirect the user back to your app and allow you to complete the + /// verification process by verifying both the **userId** and **secret** + /// parameters. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updateVerification). + /// The verification link sent to the user's email address is valid for 7 days. + /// + /// Please note that in order to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), + /// the only valid redirect URLs are the ones from domains you have set when + /// adding your platforms in the console interface. + /// + Future createVerification({required String url}) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'url': url}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user email verification process. Use both + /// the **userId** and **secret** parameters that were attached to your app URL + /// to verify the user email ownership. If confirmed this route will return a + /// 200 status code. + Future updateVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to send a verification SMS to the currently logged in + /// user. This endpoint is meant for use after updating a user's phone number + /// using the + /// [accountUpdatePhone](https://appwrite.io/docs/references/cloud/client-web/account#updatePhone) + /// endpoint. Learn more about how to [complete the verification + /// process](https://appwrite.io/docs/references/cloud/client-web/account#updatePhoneVerification). + /// The verification code sent to the user's phone number is valid for 15 + /// minutes. + Future createPhoneVerification() async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Use this endpoint to complete the user phone verification process. Use the + /// **userId** and **secret** that were sent to your user's phone number to + /// verify the user email ownership. If confirmed this route will return a 200 + /// status code. + Future updatePhoneVerification({ + required String userId, + required String secret, + }) async { + final String apiPath = '/account/verification/phone'; + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } +} diff --git a/lib/services/avatars.dart b/lib/services/avatars.dart index 381146d4..8033f1cd 100644 --- a/lib/services/avatars.dart +++ b/lib/services/avatars.dart @@ -3,187 +3,253 @@ part of '../dart_appwrite.dart'; /// The Avatars service aims to help you complete everyday tasks related to /// your app image, icons, and avatars. class Avatars extends Service { - Avatars(super.client); - - /// You can use this endpoint to show different browser icons to your users. - /// The code argument receives the browser code as it appears in your user [GET - /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) - /// endpoint. Use width, height and quality arguments to change the output - /// settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - Future getBrowser({required enums.Browser code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/browsers/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// The credit card endpoint will return you the icon of the credit card - /// provider you need. Use width, height and quality arguments to change the - /// output settings. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getCreditCard({required enums.CreditCard code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/credit-cards/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote - /// website URL. - /// - /// This endpoint does not follow HTTP redirects. - Future getFavicon({required String url}) async { - final String apiPath = '/avatars/favicon'; - - final Map params = { - 'url': url, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// You can use this endpoint to show different country flags icons to your - /// users. The code argument receives the 2 letter country code. Use width, - /// height and quality arguments to change the output settings. Country codes - /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getFlag({required enums.Flag code, int? width, int? height, int? quality}) async { - final String apiPath = '/avatars/flags/{code}'.replaceAll('{code}', code.value); - - final Map params = { - 'width': width, -'height': height, -'quality': quality, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to fetch a remote image URL and crop it to any image size - /// you want. This endpoint is very useful if you need to crop and display - /// remote images in your app or in case you want to make sure a 3rd party - /// image is properly served using a TLS protocol. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 400x400px. - /// - /// This endpoint does not follow HTTP redirects. - Future getImage({required String url, int? width, int? height}) async { - final String apiPath = '/avatars/image'; - - final Map params = { - 'url': url, -'width': width, -'height': height, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Use this endpoint to show your user initials avatar icon on your website or - /// app. By default, this route will try to print your logged-in user name or - /// email initials. You can also overwrite the user name if you pass the 'name' - /// parameter. If no name is given and no user is logged, an empty avatar will - /// be returned. - /// - /// You can use the color and background params to change the avatar colors. By - /// default, a random theme will be selected. The random theme will persist for - /// the user's initials when reloading the same theme will always return for - /// the same initials. - /// - /// When one dimension is specified and the other is 0, the image is scaled - /// with preserved aspect ratio. If both dimensions are 0, the API provides an - /// image at source quality. If dimensions are not specified, the default size - /// of image returned is 100x100px. - /// - Future getInitials({String? name, int? width, int? height, String? background}) async { - final String apiPath = '/avatars/initials'; - - final Map params = { - 'name': name, -'width': width, -'height': height, -'background': background, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Converts a given plain text to a QR code image. You can use the query - /// parameters to change the size and style of the resulting image. - /// - Future getQR({required String text, int? size, int? margin, bool? download}) async { - final String apiPath = '/avatars/qr'; - - final Map params = { - 'text': text, -'size': size, -'margin': margin, -'download': download, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Avatars(super.client); + + /// You can use this endpoint to show different browser icons to your users. + /// The code argument receives the browser code as it appears in your user [GET + /// /account/sessions](https://appwrite.io/docs/references/cloud/client-web/account#getSessions) + /// endpoint. Use width, height and quality arguments to change the output + /// settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + Future getBrowser({ + required enums.Browser code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/browsers/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// The credit card endpoint will return you the icon of the credit card + /// provider you need. Use width, height and quality arguments to change the + /// output settings. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getCreditCard({ + required enums.CreditCard code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/credit-cards/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch the favorite icon (AKA favicon) of any remote + /// website URL. + /// + /// This endpoint does not follow HTTP redirects. + Future getFavicon({required String url}) async { + final String apiPath = '/avatars/favicon'; + + final Map params = { + 'url': url, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// You can use this endpoint to show different country flags icons to your + /// users. The code argument receives the 2 letter country code. Use width, + /// height and quality arguments to change the output settings. Country codes + /// follow the [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) standard. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getFlag({ + required enums.Flag code, + int? width, + int? height, + int? quality, + }) async { + final String apiPath = '/avatars/flags/{code}'.replaceAll( + '{code}', + code.value, + ); + + final Map params = { + 'width': width, + 'height': height, + 'quality': quality, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to fetch a remote image URL and crop it to any image size + /// you want. This endpoint is very useful if you need to crop and display + /// remote images in your app or in case you want to make sure a 3rd party + /// image is properly served using a TLS protocol. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 400x400px. + /// + /// This endpoint does not follow HTTP redirects. + Future getImage({ + required String url, + int? width, + int? height, + }) async { + final String apiPath = '/avatars/image'; + + final Map params = { + 'url': url, + 'width': width, + 'height': height, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Use this endpoint to show your user initials avatar icon on your website or + /// app. By default, this route will try to print your logged-in user name or + /// email initials. You can also overwrite the user name if you pass the 'name' + /// parameter. If no name is given and no user is logged, an empty avatar will + /// be returned. + /// + /// You can use the color and background params to change the avatar colors. By + /// default, a random theme will be selected. The random theme will persist for + /// the user's initials when reloading the same theme will always return for + /// the same initials. + /// + /// When one dimension is specified and the other is 0, the image is scaled + /// with preserved aspect ratio. If both dimensions are 0, the API provides an + /// image at source quality. If dimensions are not specified, the default size + /// of image returned is 100x100px. + /// + Future getInitials({ + String? name, + int? width, + int? height, + String? background, + }) async { + final String apiPath = '/avatars/initials'; + + final Map params = { + 'name': name, + 'width': width, + 'height': height, + 'background': background, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Converts a given plain text to a QR code image. You can use the query + /// parameters to change the size and style of the resulting image. + /// + Future getQR({ + required String text, + int? size, + int? margin, + bool? download, + }) async { + final String apiPath = '/avatars/qr'; + + final Map params = { + 'text': text, + 'size': size, + 'margin': margin, + 'download': download, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/databases.dart b/lib/services/databases.dart index 49e2bbc2..4b26a220 100644 --- a/lib/services/databases.dart +++ b/lib/services/databases.dart @@ -3,1095 +3,1439 @@ part of '../dart_appwrite.dart'; /// The Databases service allows you to create structured collections of /// documents, query and filter lists of documents class Databases extends Service { - Databases(super.client); - - /// Get a list of all databases from the current Appwrite project. You can use - /// the search parameter to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DatabaseList.fromMap(res.data); - - } - - /// Create a new Database. - /// - Future create({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases'; - - final Map apiParams = { - - 'databaseId': databaseId, -'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Get a database by its unique ID. This endpoint response returns a JSON - /// object with the database metadata. - Future get({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Update a database by its unique ID. - Future update({required String databaseId, required String name, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Database.fromMap(res.data); - - } - - /// Delete a database by its unique ID. Only API keys with with databases.write - /// scope can delete a database. - Future delete({required String databaseId}) async { - final String apiPath = '/databases/{databaseId}'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all collections that belong to the provided databaseId. You - /// can use the search parameter to filter your results. - Future listCollections({required String databaseId, List? queries, String? search}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CollectionList.fromMap(res.data); - - } - - /// Create a new Collection. Before using this route, you should create a new - /// database resource using either a [server - /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) - /// API or directly from your database console. - Future createCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections'.replaceAll('{databaseId}', databaseId); - - final Map apiParams = { - - 'collectionId': collectionId, -'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Get a collection by its unique ID. This endpoint response returns a JSON - /// object with the collection metadata. - Future getCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Update a collection by its unique ID. - Future updateCollection({required String databaseId, required String collectionId, required String name, List? permissions, bool? documentSecurity, bool? enabled}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'documentSecurity': documentSecurity, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Collection.fromMap(res.data); - - } - - /// Delete a collection by its unique ID. Only users with write permissions - /// have access to delete this resource. - Future deleteCollection({required String databaseId, required String collectionId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List attributes in the collection. - Future listAttributes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeList.fromMap(res.data); - - } - - /// Create a boolean attribute. - /// - Future createBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, bool? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Update a boolean attribute. Changing the `default` value will not update - /// already existing documents. - Future updateBooleanAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required bool? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeBoolean.fromMap(res.data); - - } - - /// Create a date time attribute according to the ISO 8601 standard. - Future createDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Update a date time attribute. Changing the `default` value will not update - /// already existing documents. - Future updateDatetimeAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeDatetime.fromMap(res.data); - - } - - /// Create an email attribute. - /// - Future createEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Update an email attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEmailAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEmail.fromMap(res.data); - - } - - /// Create an enumeration attribute. The `elements` param acts as a white-list - /// of accepted values for this attribute. - /// - Future createEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'elements': elements, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Update an enum attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateEnumAttribute({required String databaseId, required String collectionId, required String key, required List elements, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'elements': elements, -'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeEnum.fromMap(res.data); - - } - - /// Create a float attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, double? min, double? max, double? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Update a float attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateFloatAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required double? xdefault, double? min, double? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeFloat.fromMap(res.data); - - } - - /// Create an integer attribute. Optionally, minimum and maximum values can be - /// provided. - /// - Future createIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, int? min, int? max, int? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Update an integer attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIntegerAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required int? xdefault, int? min, int? max, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'min': min, -'max': max, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeInteger.fromMap(res.data); - - } - - /// Create IP address attribute. - /// - Future createIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Update an ip attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateIpAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeIp.fromMap(res.data); - - } - - /// Create relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future createRelationshipAttribute({required String databaseId, required String collectionId, required String relatedCollectionId, required enums.RelationshipType type, bool? twoWay, String? key, String? twoWayKey, enums.RelationMutate? onDelete}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'relatedCollectionId': relatedCollectionId, -'type': type.value, -'twoWay': twoWay, -'key': key, -'twoWayKey': twoWayKey, -'onDelete': onDelete?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Create a string attribute. - /// - Future createStringAttribute({required String databaseId, required String collectionId, required String key, required int size, required bool xrequired, String? xdefault, bool? array, bool? encrypt}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'size': size, -'required': xrequired, -'default': xdefault, -'array': array, -'encrypt': encrypt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Update a string attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateStringAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, int? size, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'size': size, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeString.fromMap(res.data); - - } - - /// Create a URL attribute. - /// - Future createUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, String? xdefault, bool? array}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'required': xrequired, -'default': xdefault, -'array': array, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Update an url attribute. Changing the `default` value will not update - /// already existing documents. - /// - Future updateUrlAttribute({required String databaseId, required String collectionId, required String key, required bool xrequired, required String? xdefault, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'required': xrequired, -'default': xdefault, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeUrl.fromMap(res.data); - - } - - /// Get attribute by ID. - Future getAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Deletes an attribute. - Future deleteAttribute({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update relationship attribute. [Learn more about relationship - /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). - /// - Future updateRelationshipAttribute({required String databaseId, required String collectionId, required String key, enums.RelationMutate? onDelete, String? newKey}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - 'onDelete': onDelete?.value, -'newKey': newKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.AttributeRelationship.fromMap(res.data); - - } - - /// Get a list of all the user's documents in a given collection. You can use - /// the query params to filter your results. - Future listDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Create a new Document. 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. - Future createDocument({required String databaseId, required String collectionId, required String documentId, required Map data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documentId': documentId, -'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// 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. - Future createDocuments({required String databaseId, required String collectionId, required List documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - /// - Future upsertDocuments({required String databaseId, required String collectionId, List? documents}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'documents': documents, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// 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. - Future updateDocuments({required String databaseId, required String collectionId, Map? data, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'data': data, -'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Bulk delete documents using queries, if no queries are passed then all - /// documents are deleted. - Future deleteDocuments({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'queries': queries, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DocumentList.fromMap(res.data); - - } - - /// Get a document by its unique ID. This endpoint response returns a JSON - /// object with the document data. - Future getDocument({required String databaseId, required String collectionId, required String documentId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Update a document by its unique ID. Using the patch method you can pass - /// only specific fields that will get updated. - Future updateDocument({required String databaseId, required String collectionId, required String documentId, Map? data, List? permissions}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - 'data': data, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Document.fromMap(res.data); - - } - - /// Delete a document by its unique ID. - Future deleteDocument({required String databaseId, required String collectionId, required String documentId}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{documentId}', documentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List indexes in the collection. - Future listIndexes({required String databaseId, required String collectionId, List? queries}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IndexList.fromMap(res.data); - - } - - /// Creates an index on the attributes listed. Your index should include all - /// the attributes you will query in a single request. - /// Attributes can be `key`, `fulltext`, and `unique`. - Future createIndex({required String databaseId, required String collectionId, required String key, required enums.IndexType type, required List attributes, List? orders, List? lengths}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId); - - final Map apiParams = { - - 'key': key, -'type': type.value, -'attributes': attributes, -'orders': orders, -'lengths': lengths, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Get index by ID. - Future getIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Index.fromMap(res.data); - - } - - /// Delete an index. - Future deleteIndex({required String databaseId, required String collectionId, required String key}) async { - final String apiPath = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'.replaceAll('{databaseId}', databaseId).replaceAll('{collectionId}', collectionId).replaceAll('{key}', key); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Databases(super.client); + + /// Get a list of all databases from the current Appwrite project. You can use + /// the search parameter to filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DatabaseList.fromMap(res.data); + } + + /// Create a new Database. + /// + Future create({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases'; + + final Map apiParams = { + 'databaseId': databaseId, + 'name': name, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Get a database by its unique ID. This endpoint response returns a JSON + /// object with the database metadata. + Future get({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Update a database by its unique ID. + Future update({ + required String databaseId, + required String name, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {'name': name, 'enabled': enabled}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Database.fromMap(res.data); + } + + /// Delete a database by its unique ID. Only API keys with with databases.write + /// scope can delete a database. + Future delete({required String databaseId}) async { + final String apiPath = '/databases/{databaseId}'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all collections that belong to the provided databaseId. You + /// can use the search parameter to filter your results. + Future listCollections({ + required String databaseId, + List? queries, + String? search, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.CollectionList.fromMap(res.data); + } + + /// Create a new Collection. Before using this route, you should create a new + /// database resource using either a [server + /// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) + /// API or directly from your database console. + Future createCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections'.replaceAll( + '{databaseId}', + databaseId, + ); + + final Map apiParams = { + 'collectionId': collectionId, + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Get a collection by its unique ID. This endpoint response returns a JSON + /// object with the collection metadata. + Future getCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Update a collection by its unique ID. + Future updateCollection({ + required String databaseId, + required String collectionId, + required String name, + List? permissions, + bool? documentSecurity, + bool? enabled, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'documentSecurity': documentSecurity, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Collection.fromMap(res.data); + } + + /// Delete a collection by its unique ID. Only users with write permissions + /// have access to delete this resource. + Future deleteCollection({ + required String databaseId, + required String collectionId, + }) async { + final String apiPath = '/databases/{databaseId}/collections/{collectionId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List attributes in the collection. + Future listAttributes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeList.fromMap(res.data); + } + + /// Create a boolean attribute. + /// + Future createBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + bool? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Update a boolean attribute. Changing the `default` value will not update + /// already existing documents. + Future updateBooleanAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required bool? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeBoolean.fromMap(res.data); + } + + /// Create a date time attribute according to the ISO 8601 standard. + Future createDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Update a date time attribute. Changing the `default` value will not update + /// already existing documents. + Future updateDatetimeAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeDatetime.fromMap(res.data); + } + + /// Create an email attribute. + /// + Future createEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Update an email attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEmailAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEmail.fromMap(res.data); + } + + /// Create an enumeration attribute. The `elements` param acts as a white-list + /// of accepted values for this attribute. + /// + Future createEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Update an enum attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateEnumAttribute({ + required String databaseId, + required String collectionId, + required String key, + required List elements, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'elements': elements, + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeEnum.fromMap(res.data); + } + + /// Create a float attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + double? min, + double? max, + double? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Update a float attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateFloatAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required double? xdefault, + double? min, + double? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeFloat.fromMap(res.data); + } + + /// Create an integer attribute. Optionally, minimum and maximum values can be + /// provided. + /// + Future createIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + int? min, + int? max, + int? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Update an integer attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIntegerAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required int? xdefault, + int? min, + int? max, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'min': min, + 'max': max, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeInteger.fromMap(res.data); + } + + /// Create IP address attribute. + /// + Future createIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Update an ip attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateIpAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeIp.fromMap(res.data); + } + + /// Create relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future createRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String relatedCollectionId, + required enums.RelationshipType type, + bool? twoWay, + String? key, + String? twoWayKey, + enums.RelationMutate? onDelete, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'relatedCollectionId': relatedCollectionId, + 'type': type.value, + 'twoWay': twoWay, + 'key': key, + 'twoWayKey': twoWayKey, + 'onDelete': onDelete?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Create a string attribute. + /// + Future createStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required int size, + required bool xrequired, + String? xdefault, + bool? array, + bool? encrypt, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'size': size, + 'required': xrequired, + 'default': xdefault, + 'array': array, + 'encrypt': encrypt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Update a string attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateStringAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + int? size, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'size': size, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeString.fromMap(res.data); + } + + /// Create a URL attribute. + /// + Future createUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + String? xdefault, + bool? array, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'required': xrequired, + 'default': xdefault, + 'array': array, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Update an url attribute. Changing the `default` value will not update + /// already existing documents. + /// + Future updateUrlAttribute({ + required String databaseId, + required String collectionId, + required String key, + required bool xrequired, + required String? xdefault, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'required': xrequired, + 'default': xdefault, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeUrl.fromMap(res.data); + } + + /// Get attribute by ID. + Future getAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Deletes an attribute. + Future deleteAttribute({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update relationship attribute. [Learn more about relationship + /// attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes). + /// + Future updateRelationshipAttribute({ + required String databaseId, + required String collectionId, + required String key, + enums.RelationMutate? onDelete, + String? newKey, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = { + 'onDelete': onDelete?.value, + 'newKey': newKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.AttributeRelationship.fromMap(res.data); + } + + /// Get a list of all the user's documents in a given collection. You can use + /// the query params to filter your results. + Future listDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Create a new Document. 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. + Future createDocument({ + required String databaseId, + required String collectionId, + required String documentId, + required Map data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'documentId': documentId, + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// 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. + Future createDocuments({ + required String databaseId, + required String collectionId, + required List documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + /// + Future upsertDocuments({ + required String databaseId, + required String collectionId, + List? documents, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'documents': documents}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// 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. + Future updateDocuments({ + required String databaseId, + required String collectionId, + Map? data, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'data': data, 'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Bulk delete documents using queries, if no queries are passed then all + /// documents are deleted. + Future deleteDocuments({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DocumentList.fromMap(res.data); + } + + /// Get a document by its unique ID. This endpoint response returns a JSON + /// object with the document data. + Future getDocument({ + required String databaseId, + required String collectionId, + required String documentId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Update a document by its unique ID. Using the patch method you can pass + /// only specific fields that will get updated. + Future updateDocument({ + required String databaseId, + required String collectionId, + required String documentId, + Map? data, + List? permissions, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = { + 'data': data, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Document.fromMap(res.data); + } + + /// Delete a document by its unique ID. + Future deleteDocument({ + required String databaseId, + required String collectionId, + required String documentId, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{documentId}', documentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List indexes in the collection. + Future listIndexes({ + required String databaseId, + required String collectionId, + List? queries, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IndexList.fromMap(res.data); + } + + /// Creates an index on the attributes listed. Your index should include all + /// the attributes you will query in a single request. + /// Attributes can be `key`, `fulltext`, and `unique`. + Future createIndex({ + required String databaseId, + required String collectionId, + required String key, + required enums.IndexType type, + required List attributes, + List? orders, + List? lengths, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId); + + final Map apiParams = { + 'key': key, + 'type': type.value, + 'attributes': attributes, + 'orders': orders, + 'lengths': lengths, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Get index by ID. + Future getIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Index.fromMap(res.data); + } + + /// Delete an index. + Future deleteIndex({ + required String databaseId, + required String collectionId, + required String key, + }) async { + final String apiPath = + '/databases/{databaseId}/collections/{collectionId}/indexes/{key}' + .replaceAll('{databaseId}', databaseId) + .replaceAll('{collectionId}', collectionId) + .replaceAll('{key}', key); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/functions.dart b/lib/services/functions.dart index ad261abf..e86f1afe 100644 --- a/lib/services/functions.dart +++ b/lib/services/functions.dart @@ -3,623 +3,768 @@ part of '../dart_appwrite.dart'; /// The Functions Service allows you view, create and manage your Cloud /// Functions. class Functions extends Service { - Functions(super.client); - - /// Get a list of all the project's functions. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FunctionList.fromMap(res.data); - - } - - /// Create a new function. You can pass a list of - /// [permissions](https://appwrite.io/docs/permissions) to allow different - /// project users or team with access to execute the function using the client - /// API. - Future create({required String functionId, required String name, required enums.Runtime runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions'; - - final Map apiParams = { - - 'functionId': functionId, -'name': name, -'runtime': runtime.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all runtimes that are currently active on your instance. - Future listRuntimes() async { - final String apiPath = '/functions/runtimes'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.RuntimeList.fromMap(res.data); - - } - - /// List allowed function specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/functions/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a function by its unique ID. - Future get({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Update function by its unique ID. - Future update({required String functionId, required String name, enums.Runtime? runtime, List? execute, List? events, String? schedule, int? timeout, bool? enabled, bool? logging, String? entrypoint, String? commands, List? scopes, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'name': name, -'runtime': runtime?.value, -'execute': execute, -'events': events, -'schedule': schedule, -'timeout': timeout, -'enabled': enabled, -'logging': logging, -'entrypoint': entrypoint, -'commands': commands, -'scopes': scopes, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Delete a function by its unique ID. - Future delete({required String functionId}) async { - final String apiPath = '/functions/{functionId}'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the function active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your function. - Future updateFunctionDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployment'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Func.fromMap(res.data); - - } - - /// Get a list of all the function's code deployments. You can use the query - /// params to filter your results. - Future listDeployments({required String functionId, List? queries, String? search}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// Create a new function code deployment. Use this endpoint to upload a new - /// version of your code function. To execute your newly uploaded code, you'll - /// need to update the function's deployment to use your new deployment UID. - /// - /// This endpoint accepts a tar.gz file compressed with your code. Make sure to - /// include any dependencies your code has within the compressed file. You can - /// learn more about code packaging in the [Appwrite Cloud Functions - /// tutorial](https://appwrite.io/docs/functions). - /// - /// Use the "command" param to set the entrypoint used to execute your code. - Future createDeployment({required String functionId, required InputFile code, required bool activate, String? entrypoint, String? commands, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/functions/{functionId}/deployments'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'entrypoint': entrypoint, -'commands': commands, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String functionId, required String deploymentId, String? buildId}) async { - final String apiPath = '/functions/{functionId}/deployments/duplicate'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'deploymentId': deploymentId, -'buildId': buildId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String functionId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/template'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a function is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String functionId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a function deployment by its unique ID. - Future getDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a code deployment by its unique ID. - Future deleteDeployment({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String functionId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/download'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String functionId, required String deploymentId}) async { - final String apiPath = '/functions/{functionId}/deployments/{deploymentId}/status'.replaceAll('{functionId}', functionId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all the current user function execution logs. You can use the - /// query params to filter your results. - Future listExecutions({required String functionId, List? queries}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Trigger a function execution. The returned object will return you the - /// current execution status. You can ping the `Get Execution` endpoint to get - /// updates on the current execution status. Once this endpoint is called, your - /// function execution process will start asynchronously. - Future createExecution({required String functionId, String? body, bool? xasync, String? path, enums.ExecutionMethod? method, Map? headers, String? scheduledAt}) async { - final String apiPath = '/functions/{functionId}/executions'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'body': body, -'async': xasync, -'path': path, -'method': method?.value, -'headers': headers, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Get a function execution log by its unique ID. - Future getExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a function execution by its unique ID. - Future deleteExecution({required String functionId, required String executionId}) async { - final String apiPath = '/functions/{functionId}/executions/{executionId}'.replaceAll('{functionId}', functionId).replaceAll('{executionId}', executionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific function. - Future listVariables({required String functionId}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new function environment variable. These variables can be accessed - /// in the function at runtime as environment variables. - Future createVariable({required String functionId, required String key, required String value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables'.replaceAll('{functionId}', functionId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String functionId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String functionId, required String variableId}) async { - final String apiPath = '/functions/{functionId}/variables/{variableId}'.replaceAll('{functionId}', functionId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Functions(super.client); + + /// Get a list of all the project's functions. You can use the query params to + /// filter your results. + Future list({ + List? queries, + String? search, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FunctionList.fromMap(res.data); + } + + /// Create a new function. You can pass a list of + /// [permissions](https://appwrite.io/docs/permissions) to allow different + /// project users or team with access to execute the function using the client + /// API. + Future create({ + required String functionId, + required String name, + required enums.Runtime runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions'; + + final Map apiParams = { + 'functionId': functionId, + 'name': name, + 'runtime': runtime.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all runtimes that are currently active on your instance. + Future listRuntimes() async { + final String apiPath = '/functions/runtimes'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.RuntimeList.fromMap(res.data); + } + + /// List allowed function specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/functions/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a function by its unique ID. + Future get({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Update function by its unique ID. + Future update({ + required String functionId, + required String name, + enums.Runtime? runtime, + List? execute, + List? events, + String? schedule, + int? timeout, + bool? enabled, + bool? logging, + String? entrypoint, + String? commands, + List? scopes, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'name': name, + 'runtime': runtime?.value, + 'execute': execute, + 'events': events, + 'schedule': schedule, + 'timeout': timeout, + 'enabled': enabled, + 'logging': logging, + 'entrypoint': entrypoint, + 'commands': commands, + 'scopes': scopes, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Delete a function by its unique ID. + Future delete({required String functionId}) async { + final String apiPath = '/functions/{functionId}'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the function active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your function. + Future updateFunctionDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployment'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Func.fromMap(res.data); + } + + /// Get a list of all the function's code deployments. You can use the query + /// params to filter your results. + Future listDeployments({ + required String functionId, + List? queries, + String? search, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// Create a new function code deployment. Use this endpoint to upload a new + /// version of your code function. To execute your newly uploaded code, you'll + /// need to update the function's deployment to use your new deployment UID. + /// + /// This endpoint accepts a tar.gz file compressed with your code. Make sure to + /// include any dependencies your code has within the compressed file. You can + /// learn more about code packaging in the [Appwrite Cloud Functions + /// tutorial](https://appwrite.io/docs/functions). + /// + /// Use the "command" param to set the entrypoint used to execute your code. + Future createDeployment({ + required String functionId, + required InputFile code, + required bool activate, + String? entrypoint, + String? commands, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/functions/{functionId}/deployments'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'entrypoint': entrypoint, + 'commands': commands, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String functionId, + required String deploymentId, + String? buildId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/duplicate' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'deploymentId': deploymentId, + 'buildId': buildId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String functionId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/template' + .replaceAll('{functionId}', functionId); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a function is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String functionId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/functions/{functionId}/deployments/vcs'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a function deployment by its unique ID. + Future getDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a code deployment by its unique ID. + Future deleteDeployment({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = '/functions/{functionId}/deployments/{deploymentId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String functionId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/download' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String functionId, + required String deploymentId, + }) async { + final String apiPath = + '/functions/{functionId}/deployments/{deploymentId}/status' + .replaceAll('{functionId}', functionId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all the current user function execution logs. You can use the + /// query params to filter your results. + Future listExecutions({ + required String functionId, + List? queries, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Trigger a function execution. The returned object will return you the + /// current execution status. You can ping the `Get Execution` endpoint to get + /// updates on the current execution status. Once this endpoint is called, your + /// function execution process will start asynchronously. + Future createExecution({ + required String functionId, + String? body, + bool? xasync, + String? path, + enums.ExecutionMethod? method, + Map? headers, + String? scheduledAt, + }) async { + final String apiPath = '/functions/{functionId}/executions'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'body': body, + 'async': xasync, + 'path': path, + 'method': method?.value, + 'headers': headers, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Get a function execution log by its unique ID. + Future getExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a function execution by its unique ID. + Future deleteExecution({ + required String functionId, + required String executionId, + }) async { + final String apiPath = '/functions/{functionId}/executions/{executionId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{executionId}', executionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific function. + Future listVariables({ + required String functionId, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new function environment variable. These variables can be accessed + /// in the function at runtime as environment variables. + Future createVariable({ + required String functionId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables'.replaceAll( + '{functionId}', + functionId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String functionId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String functionId, + required String variableId, + }) async { + final String apiPath = '/functions/{functionId}/variables/{variableId}' + .replaceAll('{functionId}', functionId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/graphql.dart b/lib/services/graphql.dart index 92cc591f..18eb54f1 100644 --- a/lib/services/graphql.dart +++ b/lib/services/graphql.dart @@ -3,49 +3,47 @@ part of '../dart_appwrite.dart'; /// The GraphQL API allows you to query and mutate your Appwrite server using /// GraphQL. class Graphql extends Service { - Graphql(super.client); - - /// Execute a GraphQL mutation. - Future query({required Map query}) async { - final String apiPath = '/graphql'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Execute a GraphQL mutation. - Future mutation({required Map query}) async { - final String apiPath = '/graphql/mutation'; - - final Map apiParams = { - - 'query': query, - - }; - - final Map apiHeaders = { - 'x-sdk-graphql': 'true', -'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Graphql(super.client); + + /// Execute a GraphQL mutation. + Future query({required Map query}) async { + final String apiPath = '/graphql'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Execute a GraphQL mutation. + Future mutation({required Map query}) async { + final String apiPath = '/graphql/mutation'; + + final Map apiParams = {'query': query}; + + final Map apiHeaders = { + 'x-sdk-graphql': 'true', + 'content-type': 'application/json', + }; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/health.dart b/lib/services/health.dart index 3bfeba6b..5250c91d 100644 --- a/lib/services/health.dart +++ b/lib/services/health.dart @@ -3,459 +3,434 @@ part of '../dart_appwrite.dart'; /// The Health service allows you to both validate and monitor your Appwrite /// server's health. class Health extends Service { - Health(super.client); + Health(super.client); - /// Check the Appwrite HTTP server is up and responsive. - Future get() async { - final String apiPath = '/health'; + /// Check the Appwrite HTTP server is up and responsive. + Future get() async { + final String apiPath = '/health'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite Antivirus server is up and connection is successful. + Future getAntivirus() async { + final String apiPath = '/health/anti-virus'; - /// Check the Appwrite Antivirus server is up and connection is successful. - Future getAntivirus() async { - final String apiPath = '/health/anti-virus'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthAntivirus.fromMap(res.data); + } - return models.HealthAntivirus.fromMap(res.data); + /// Check the Appwrite in-memory cache servers are up and connection is + /// successful. + Future getCache() async { + final String apiPath = '/health/cache'; - } + final Map apiParams = {}; - /// Check the Appwrite in-memory cache servers are up and connection is - /// successful. - Future getCache() async { - final String apiPath = '/health/cache'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the SSL certificate for a domain + Future getCertificate({String? domain}) async { + final String apiPath = '/health/certificate'; - return models.HealthStatus.fromMap(res.data); + final Map apiParams = {'domain': domain}; - } + final Map apiHeaders = {}; - /// Get the SSL certificate for a domain - Future getCertificate({String? domain}) async { - final String apiPath = '/health/certificate'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'domain': domain, + return models.HealthCertificate.fromMap(res.data); + } - - }; + /// Check the Appwrite database servers are up and connection is successful. + Future getDB() async { + final String apiPath = '/health/db'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthCertificate.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthStatus.fromMap(res.data); + } - /// Check the Appwrite database servers are up and connection is successful. - Future getDB() async { - final String apiPath = '/health/db'; + /// Check the Appwrite pub-sub servers are up and connection is successful. + Future getPubSub() async { + final String apiPath = '/health/pubsub'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthStatus.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Get the number of builds that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueBuilds({int? threshold}) async { + final String apiPath = '/health/queue/builds'; - /// Check the Appwrite pub-sub servers are up and connection is successful. - Future getPubSub() async { - final String apiPath = '/health/pubsub'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthStatus.fromMap(res.data); + /// Get the number of certificates that are waiting to be issued against + /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue + /// server. + Future getQueueCertificates({int? threshold}) async { + final String apiPath = '/health/queue/certificates'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of builds that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueBuilds({int? threshold}) async { - final String apiPath = '/health/queue/builds'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of database changes that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueDatabases({ + String? name, + int? threshold, + }) async { + final String apiPath = '/health/queue/databases'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = { + 'name': name, + 'threshold': threshold, + }; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of certificates that are waiting to be issued against - /// [Letsencrypt](https://letsencrypt.org/) in the Appwrite internal queue - /// server. - Future getQueueCertificates({int? threshold}) async { - final String apiPath = '/health/queue/certificates'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Get the number of background destructive changes that are waiting to be + /// processed in the Appwrite internal queue server. + Future getQueueDeletes({int? threshold}) async { + final String apiPath = '/health/queue/deletes'; + + final Map apiParams = {'threshold': threshold}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.HealthQueue.fromMap(res.data); + } + + /// Returns the amount of failed jobs in a given queue. + /// + Future getFailedJobs({ + required enums.Name name, + int? threshold, + }) async { + final String apiPath = '/health/queue/failed/{name}'.replaceAll( + '{name}', + name.value, + ); - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } + + /// Get the number of function executions that are waiting to be processed in + /// the Appwrite internal queue server. + Future getQueueFunctions({int? threshold}) async { + final String apiPath = '/health/queue/functions'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of database changes that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueDatabases({String? name, int? threshold}) async { - final String apiPath = '/health/queue/databases'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'name': name, -'threshold': threshold, + /// Get the number of logs that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueLogs({int? threshold}) async { + final String apiPath = '/health/queue/logs'; - - }; + final Map apiParams = {'threshold': threshold}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthQueue.fromMap(res.data); + } - } + /// Get the number of mails that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMails({int? threshold}) async { + final String apiPath = '/health/queue/mails'; - /// Get the number of background destructive changes that are waiting to be - /// processed in the Appwrite internal queue server. - Future getQueueDeletes({int? threshold}) async { - final String apiPath = '/health/queue/deletes'; + final Map apiParams = {'threshold': threshold}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthQueue.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Get the number of messages that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueMessaging({int? threshold}) async { + final String apiPath = '/health/queue/messaging'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {'threshold': threshold}; - } + final Map apiHeaders = {}; - /// Returns the amount of failed jobs in a given queue. - /// - Future getFailedJobs({required enums.Name name, int? threshold}) async { - final String apiPath = '/health/queue/failed/{name}'.replaceAll('{name}', name.value); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, + return models.HealthQueue.fromMap(res.data); + } - - }; + /// Get the number of migrations that are waiting to be processed in the + /// Appwrite internal queue server. + Future getQueueMigrations({int? threshold}) async { + final String apiPath = '/health/queue/migrations'; - final Map apiHeaders = { - - }; + final Map apiParams = {'threshold': threshold}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.HealthQueue.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.HealthQueue.fromMap(res.data); + } - /// Get the number of function executions that are waiting to be processed in - /// the Appwrite internal queue server. - Future getQueueFunctions({int? threshold}) async { - final String apiPath = '/health/queue/functions'; + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// stats resources queue. + Future getQueueStatsResources({int? threshold}) async { + final String apiPath = '/health/queue/stats-resources'; - final Map apiParams = { - 'threshold': threshold, + final Map apiParams = {'threshold': threshold}; - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.HealthQueue.fromMap(res.data); + } - return models.HealthQueue.fromMap(res.data); + /// Get the number of metrics that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueUsage({int? threshold}) async { + final String apiPath = '/health/queue/stats-usage'; - } + final Map apiParams = {'threshold': threshold}; - /// Get the number of logs that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueLogs({int? threshold}) async { - final String apiPath = '/health/queue/logs'; + final Map apiHeaders = {}; - final Map apiParams = { - 'threshold': threshold, + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - - }; + return models.HealthQueue.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// Get the number of webhooks that are waiting to be processed in the Appwrite + /// internal queue server. + Future getQueueWebhooks({int? threshold}) async { + final String apiPath = '/health/queue/webhooks'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {'threshold': threshold}; - return models.HealthQueue.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// Get the number of mails that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMails({int? threshold}) async { - final String apiPath = '/health/queue/mails'; + return models.HealthQueue.fromMap(res.data); + } - final Map apiParams = { - 'threshold': threshold, + /// Check the Appwrite storage device is up and connection is successful. + Future getStorage() async { + final String apiPath = '/health/storage'; - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.HealthQueue.fromMap(res.data); + return models.HealthStatus.fromMap(res.data); + } - } + /// Check the Appwrite local storage device is up and connection is successful. + Future getStorageLocal() async { + final String apiPath = '/health/storage/local'; - /// Get the number of messages that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueMessaging({int? threshold}) async { - final String apiPath = '/health/queue/messaging'; + final Map apiParams = {}; - final Map apiParams = { - 'threshold': threshold, + final Map apiHeaders = {}; - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.HealthStatus.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// Check the Appwrite server time is synced with Google remote NTP server. We + /// use this technology to smoothly handle leap seconds with no disruptive + /// events. The [Network Time + /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is + /// used by hundreds of millions of computers and devices to synchronize their + /// clocks over the Internet. If your computer sets its own clock, it likely + /// uses NTP. + Future getTime() async { + final String apiPath = '/health/time'; - return models.HealthQueue.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// Get the number of migrations that are waiting to be processed in the - /// Appwrite internal queue server. - Future getQueueMigrations({int? threshold}) async { - final String apiPath = '/health/queue/migrations'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// stats resources queue. - Future getQueueStatsResources({int? threshold}) async { - final String apiPath = '/health/queue/stats-resources'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of metrics that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueUsage({int? threshold}) async { - final String apiPath = '/health/queue/stats-usage'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Get the number of webhooks that are waiting to be processed in the Appwrite - /// internal queue server. - Future getQueueWebhooks({int? threshold}) async { - final String apiPath = '/health/queue/webhooks'; - - final Map apiParams = { - 'threshold': threshold, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthQueue.fromMap(res.data); - - } - - /// Check the Appwrite storage device is up and connection is successful. - Future getStorage() async { - final String apiPath = '/health/storage'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite local storage device is up and connection is successful. - Future getStorageLocal() async { - final String apiPath = '/health/storage/local'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthStatus.fromMap(res.data); - - } - - /// Check the Appwrite server time is synced with Google remote NTP server. We - /// use this technology to smoothly handle leap seconds with no disruptive - /// events. The [Network Time - /// Protocol](https://en.wikipedia.org/wiki/Network_Time_Protocol) (NTP) is - /// used by hundreds of millions of computers and devices to synchronize their - /// clocks over the Internet. If your computer sets its own clock, it likely - /// uses NTP. - Future getTime() async { - final String apiPath = '/health/time'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.HealthTime.fromMap(res.data); - - } -} \ No newline at end of file + return models.HealthTime.fromMap(res.data); + } +} diff --git a/lib/services/locale.dart b/lib/services/locale.dart index b75b4711..4d3cc3e0 100644 --- a/lib/services/locale.dart +++ b/lib/services/locale.dart @@ -3,170 +3,162 @@ part of '../dart_appwrite.dart'; /// The Locale service allows you to customize your app based on your users' /// location. class Locale extends Service { - Locale(super.client); + Locale(super.client); - /// Get the current user location based on IP. Returns an object with user - /// country code, country name, continent name, continent code, ip address and - /// suggested currency. You can use the locale header to get the data in a - /// supported language. - /// - /// ([IP Geolocation by DB-IP](https://db-ip.com)) - Future get() async { - final String apiPath = '/locale'; + /// Get the current user location based on IP. Returns an object with user + /// country code, country name, continent name, continent code, ip address and + /// suggested currency. You can use the locale header to get the data in a + /// supported language. + /// + /// ([IP Geolocation by DB-IP](https://db-ip.com)) + Future get() async { + final String apiPath = '/locale'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.Locale.fromMap(res.data); + return models.Locale.fromMap(res.data); + } - } + /// List of all locale codes in [ISO + /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). + Future listCodes() async { + final String apiPath = '/locale/codes'; - /// List of all locale codes in [ISO - /// 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). - Future listCodes() async { - final String apiPath = '/locale/codes'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + return models.LocaleCodeList.fromMap(res.data); + } - return models.LocaleCodeList.fromMap(res.data); + /// List of all continents. You can use the locale header to get the data in a + /// supported language. + Future listContinents() async { + final String apiPath = '/locale/continents'; - } + final Map apiParams = {}; - /// List of all continents. You can use the locale header to get the data in a - /// supported language. - Future listContinents() async { - final String apiPath = '/locale/continents'; + final Map apiHeaders = {}; - final Map apiParams = { - - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiHeaders = { - - }; + return models.ContinentList.fromMap(res.data); + } - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + /// List of all countries. You can use the locale header to get the data in a + /// supported language. + Future listCountries() async { + final String apiPath = '/locale/countries'; - return models.ContinentList.fromMap(res.data); + final Map apiParams = {}; - } + final Map apiHeaders = {}; - /// List of all countries. You can use the locale header to get the data in a - /// supported language. - Future listCountries() async { - final String apiPath = '/locale/countries'; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final Map apiParams = { - - - }; + return models.CountryList.fromMap(res.data); + } - final Map apiHeaders = { - - }; + /// List of all countries that are currently members of the EU. You can use the + /// locale header to get the data in a supported language. + Future listCountriesEU() async { + final String apiPath = '/locale/countries/eu'; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiParams = {}; - return models.CountryList.fromMap(res.data); + final Map apiHeaders = {}; - } + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - /// List of all countries that are currently members of the EU. You can use the - /// locale header to get the data in a supported language. - Future listCountriesEU() async { - final String apiPath = '/locale/countries/eu'; + return models.CountryList.fromMap(res.data); + } - final Map apiParams = { - - - }; + /// List of all countries phone codes. You can use the locale header to get the + /// data in a supported language. + Future listCountriesPhones() async { + final String apiPath = '/locale/countries/phones'; - final Map apiHeaders = { - - }; + final Map apiParams = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final Map apiHeaders = {}; - return models.CountryList.fromMap(res.data); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - } + return models.PhoneList.fromMap(res.data); + } - /// List of all countries phone codes. You can use the locale header to get the - /// data in a supported language. - Future listCountriesPhones() async { - final String apiPath = '/locale/countries/phones'; + /// List of all currencies, including currency symbol, name, plural, and + /// decimal digits for all major and minor currencies. You can use the locale + /// header to get the data in a supported language. + Future listCurrencies() async { + final String apiPath = '/locale/currencies'; - final Map apiParams = { - - - }; + final Map apiParams = {}; - final Map apiHeaders = { - - }; + final Map apiHeaders = {}; - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - return models.PhoneList.fromMap(res.data); + return models.CurrencyList.fromMap(res.data); + } - } + /// List of all languages classified by ISO 639-1 including 2-letter code, name + /// in English, and name in the respective language. + Future listLanguages() async { + final String apiPath = '/locale/languages'; - /// List of all currencies, including currency symbol, name, plural, and - /// decimal digits for all major and minor currencies. You can use the locale - /// header to get the data in a supported language. - Future listCurrencies() async { - final String apiPath = '/locale/currencies'; + final Map apiParams = {}; - final Map apiParams = { - - - }; + final Map apiHeaders = {}; - final Map apiHeaders = { - - }; + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.CurrencyList.fromMap(res.data); - - } - - /// List of all languages classified by ISO 639-1 including 2-letter code, name - /// in English, and name in the respective language. - Future listLanguages() async { - final String apiPath = '/locale/languages'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LanguageList.fromMap(res.data); - - } -} \ No newline at end of file + return models.LanguageList.fromMap(res.data); + } +} diff --git a/lib/services/messaging.dart b/lib/services/messaging.dart index 710bb6d4..afe3ee86 100644 --- a/lib/services/messaging.dart +++ b/lib/services/messaging.dart @@ -3,1158 +3,1476 @@ part of '../dart_appwrite.dart'; /// The Messaging service allows you to send messages to any provider type /// (SMTP, push notification, SMS, etc.). class Messaging extends Service { - Messaging(super.client); - - /// Get a list of all messages from the current Appwrite project. - Future listMessages({List? queries, String? search}) async { - final String apiPath = '/messaging/messages'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MessageList.fromMap(res.data); - - } - - /// Create a new email message. - Future createEmail({required String messageId, required String subject, required String content, List? topics, List? users, List? targets, List? cc, List? bcc, List? attachments, bool? draft, bool? html, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/email'; - - final Map apiParams = { - - 'messageId': messageId, -'subject': subject, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'cc': cc, -'bcc': bcc, -'attachments': attachments, -'draft': draft, -'html': html, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an email message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateEmail({required String messageId, List? topics, List? users, List? targets, String? subject, String? content, bool? draft, bool? html, List? cc, List? bcc, String? scheduledAt, List? attachments}) async { - final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'subject': subject, -'content': content, -'draft': draft, -'html': html, -'cc': cc, -'bcc': bcc, -'scheduledAt': scheduledAt, -'attachments': attachments, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new push notification. - Future createPush({required String messageId, String? title, String? body, List? topics, List? users, List? targets, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push'; - - final Map apiParams = { - - 'messageId': messageId, -'title': title, -'body': body, -'topics': topics, -'users': users, -'targets': targets, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update a push notification by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updatePush({required String messageId, List? topics, List? users, List? targets, String? title, String? body, Map? data, String? action, String? image, String? icon, String? sound, String? color, String? tag, int? badge, bool? draft, String? scheduledAt, bool? contentAvailable, bool? critical, enums.MessagePriority? priority}) async { - final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'title': title, -'body': body, -'data': data, -'action': action, -'image': image, -'icon': icon, -'sound': sound, -'color': color, -'tag': tag, -'badge': badge, -'draft': draft, -'scheduledAt': scheduledAt, -'contentAvailable': contentAvailable, -'critical': critical, -'priority': priority?.value, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Create a new SMS message. - Future createSms({required String messageId, required String content, List? topics, List? users, List? targets, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms'; - - final Map apiParams = { - - 'messageId': messageId, -'content': content, -'topics': topics, -'users': users, -'targets': targets, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Update an SMS message by its unique ID. This endpoint only works on - /// messages that are in draft status. Messages that are already processing, - /// sent, or failed cannot be updated. - /// - Future updateSms({required String messageId, List? topics, List? users, List? targets, String? content, bool? draft, String? scheduledAt}) async { - final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - 'topics': topics, -'users': users, -'targets': targets, -'content': content, -'draft': draft, -'scheduledAt': scheduledAt, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Get a message by its unique ID. - /// - Future getMessage({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Message.fromMap(res.data); - - } - - /// Delete a message. If the message is not a draft or scheduled, but has been - /// sent, this will not recall the message. - Future delete({required String messageId}) async { - final String apiPath = '/messaging/messages/{messageId}'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the message activity logs listed by its unique ID. - Future listMessageLogs({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of the targets associated with a message. - Future listTargets({required String messageId, List? queries}) async { - final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll('{messageId}', messageId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Get a list of all providers from the current Appwrite project. - Future listProviders({List? queries, String? search}) async { - final String apiPath = '/messaging/providers'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ProviderList.fromMap(res.data); - - } - - /// Create a new Apple Push Notification service provider. - Future createApnsProvider({required String providerId, required String name, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox, bool? enabled}) async { - final String apiPath = '/messaging/providers/apns'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Apple Push Notification service provider by its unique ID. - Future updateApnsProvider({required String providerId, String? name, bool? enabled, String? authKey, String? authKeyId, String? teamId, String? bundleId, bool? sandbox}) async { - final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'authKey': authKey, -'authKeyId': authKeyId, -'teamId': teamId, -'bundleId': bundleId, -'sandbox': sandbox, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Firebase Cloud Messaging provider. - Future createFcmProvider({required String providerId, required String name, Map? serviceAccountJSON, bool? enabled}) async { - final String apiPath = '/messaging/providers/fcm'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'serviceAccountJSON': serviceAccountJSON, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Firebase Cloud Messaging provider by its unique ID. - Future updateFcmProvider({required String providerId, String? name, bool? enabled, Map? serviceAccountJSON}) async { - final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'serviceAccountJSON': serviceAccountJSON, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Mailgun provider. - Future createMailgunProvider({required String providerId, required String name, String? apiKey, String? domain, bool? isEuRegion, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/mailgun'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Mailgun provider by its unique ID. - Future updateMailgunProvider({required String providerId, String? name, String? apiKey, String? domain, bool? isEuRegion, bool? enabled, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/mailgun/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'apiKey': apiKey, -'domain': domain, -'isEuRegion': isEuRegion, -'enabled': enabled, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new MSG91 provider. - Future createMsg91Provider({required String providerId, required String name, String? templateId, String? senderId, String? authKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/msg91'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a MSG91 provider by its unique ID. - Future updateMsg91Provider({required String providerId, String? name, bool? enabled, String? templateId, String? senderId, String? authKey}) async { - final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'templateId': templateId, -'senderId': senderId, -'authKey': authKey, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Sendgrid provider. - Future createSendgridProvider({required String providerId, required String name, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/sendgrid'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Sendgrid provider by its unique ID. - Future updateSendgridProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail}) async { - final String apiPath = '/messaging/providers/sendgrid/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new SMTP provider. - Future createSmtpProvider({required String providerId, required String name, required String host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a SMTP provider by its unique ID. - Future updateSmtpProvider({required String providerId, String? name, String? host, int? port, String? username, String? password, enums.SmtpEncryption? encryption, bool? autoTLS, String? mailer, String? fromName, String? fromEmail, String? replyToName, String? replyToEmail, bool? enabled}) async { - final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'host': host, -'port': port, -'username': username, -'password': password, -'encryption': encryption?.value, -'autoTLS': autoTLS, -'mailer': mailer, -'fromName': fromName, -'fromEmail': fromEmail, -'replyToName': replyToName, -'replyToEmail': replyToEmail, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Telesign provider. - Future createTelesignProvider({required String providerId, required String name, String? from, String? customerId, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/telesign'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'customerId': customerId, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Telesign provider by its unique ID. - Future updateTelesignProvider({required String providerId, String? name, bool? enabled, String? customerId, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/telesign/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'customerId': customerId, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Textmagic provider. - Future createTextmagicProvider({required String providerId, required String name, String? from, String? username, String? apiKey, bool? enabled}) async { - final String apiPath = '/messaging/providers/textmagic'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'username': username, -'apiKey': apiKey, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Textmagic provider by its unique ID. - Future updateTextmagicProvider({required String providerId, String? name, bool? enabled, String? username, String? apiKey, String? from}) async { - final String apiPath = '/messaging/providers/textmagic/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'username': username, -'apiKey': apiKey, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Twilio provider. - Future createTwilioProvider({required String providerId, required String name, String? from, String? accountSid, String? authToken, bool? enabled}) async { - final String apiPath = '/messaging/providers/twilio'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'accountSid': accountSid, -'authToken': authToken, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Twilio provider by its unique ID. - Future updateTwilioProvider({required String providerId, String? name, bool? enabled, String? accountSid, String? authToken, String? from}) async { - final String apiPath = '/messaging/providers/twilio/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'accountSid': accountSid, -'authToken': authToken, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Create a new Vonage provider. - Future createVonageProvider({required String providerId, required String name, String? from, String? apiKey, String? apiSecret, bool? enabled}) async { - final String apiPath = '/messaging/providers/vonage'; - - final Map apiParams = { - - 'providerId': providerId, -'name': name, -'from': from, -'apiKey': apiKey, -'apiSecret': apiSecret, -'enabled': enabled, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Update a Vonage provider by its unique ID. - Future updateVonageProvider({required String providerId, String? name, bool? enabled, String? apiKey, String? apiSecret, String? from}) async { - final String apiPath = '/messaging/providers/vonage/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - 'name': name, -'enabled': enabled, -'apiKey': apiKey, -'apiSecret': apiSecret, -'from': from, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Get a provider by its unique ID. - /// - Future getProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Provider.fromMap(res.data); - - } - - /// Delete a provider by its unique ID. - Future deleteProvider({required String providerId}) async { - final String apiPath = '/messaging/providers/{providerId}'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the provider activity logs listed by its unique ID. - Future listProviderLogs({required String providerId, List? queries}) async { - final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll('{providerId}', providerId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the subscriber activity logs listed by its unique ID. - Future listSubscriberLogs({required String subscriberId, List? queries}) async { - final String apiPath = '/messaging/subscribers/{subscriberId}/logs'.replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all topics from the current Appwrite project. - Future listTopics({List? queries, String? search}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TopicList.fromMap(res.data); - - } - - /// Create a new topic. - Future createTopic({required String topicId, required String name, List? subscribe}) async { - final String apiPath = '/messaging/topics'; - - final Map apiParams = { - - 'topicId': topicId, -'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Get a topic by its unique ID. - /// - Future getTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Update a topic by its unique ID. - /// - Future updateTopic({required String topicId, String? name, List? subscribe}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'name': name, -'subscribe': subscribe, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Topic.fromMap(res.data); - - } - - /// Delete a topic by its unique ID. - Future deleteTopic({required String topicId}) async { - final String apiPath = '/messaging/topics/{topicId}'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get the topic activity logs listed by its unique ID. - Future listTopicLogs({required String topicId, List? queries}) async { - final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get a list of all subscribers from the current Appwrite project. - Future listSubscribers({required String topicId, List? queries, String? search}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SubscriberList.fromMap(res.data); - - } - - /// Create a new subscriber. - Future createSubscriber({required String topicId, required String subscriberId, required String targetId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll('{topicId}', topicId); - - final Map apiParams = { - - 'subscriberId': subscriberId, -'targetId': targetId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Get a subscriber by its unique ID. - /// - Future getSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Subscriber.fromMap(res.data); - - } - - /// Delete a subscriber by its unique ID. - Future deleteSubscriber({required String topicId, required String subscriberId}) async { - final String apiPath = '/messaging/topics/{topicId}/subscribers/{subscriberId}'.replaceAll('{topicId}', topicId).replaceAll('{subscriberId}', subscriberId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Messaging(super.client); + + /// Get a list of all messages from the current Appwrite project. + Future listMessages({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/messages'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MessageList.fromMap(res.data); + } + + /// Create a new email message. + Future createEmail({ + required String messageId, + required String subject, + required String content, + List? topics, + List? users, + List? targets, + List? cc, + List? bcc, + List? attachments, + bool? draft, + bool? html, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/email'; + + final Map apiParams = { + 'messageId': messageId, + 'subject': subject, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'cc': cc, + 'bcc': bcc, + 'attachments': attachments, + 'draft': draft, + 'html': html, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an email message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateEmail({ + required String messageId, + List? topics, + List? users, + List? targets, + String? subject, + String? content, + bool? draft, + bool? html, + List? cc, + List? bcc, + String? scheduledAt, + List? attachments, + }) async { + final String apiPath = '/messaging/messages/email/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'subject': subject, + 'content': content, + 'draft': draft, + 'html': html, + 'cc': cc, + 'bcc': bcc, + 'scheduledAt': scheduledAt, + 'attachments': attachments, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new push notification. + Future createPush({ + required String messageId, + String? title, + String? body, + List? topics, + List? users, + List? targets, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push'; + + final Map apiParams = { + 'messageId': messageId, + 'title': title, + 'body': body, + 'topics': topics, + 'users': users, + 'targets': targets, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update a push notification by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updatePush({ + required String messageId, + List? topics, + List? users, + List? targets, + String? title, + String? body, + Map? data, + String? action, + String? image, + String? icon, + String? sound, + String? color, + String? tag, + int? badge, + bool? draft, + String? scheduledAt, + bool? contentAvailable, + bool? critical, + enums.MessagePriority? priority, + }) async { + final String apiPath = '/messaging/messages/push/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'title': title, + 'body': body, + 'data': data, + 'action': action, + 'image': image, + 'icon': icon, + 'sound': sound, + 'color': color, + 'tag': tag, + 'badge': badge, + 'draft': draft, + 'scheduledAt': scheduledAt, + 'contentAvailable': contentAvailable, + 'critical': critical, + 'priority': priority?.value, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Create a new SMS message. + Future createSms({ + required String messageId, + required String content, + List? topics, + List? users, + List? targets, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms'; + + final Map apiParams = { + 'messageId': messageId, + 'content': content, + 'topics': topics, + 'users': users, + 'targets': targets, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Update an SMS message by its unique ID. This endpoint only works on + /// messages that are in draft status. Messages that are already processing, + /// sent, or failed cannot be updated. + /// + Future updateSms({ + required String messageId, + List? topics, + List? users, + List? targets, + String? content, + bool? draft, + String? scheduledAt, + }) async { + final String apiPath = '/messaging/messages/sms/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = { + 'topics': topics, + 'users': users, + 'targets': targets, + 'content': content, + 'draft': draft, + 'scheduledAt': scheduledAt, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Get a message by its unique ID. + /// + Future getMessage({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Message.fromMap(res.data); + } + + /// Delete a message. If the message is not a draft or scheduled, but has been + /// sent, this will not recall the message. + Future delete({required String messageId}) async { + final String apiPath = '/messaging/messages/{messageId}'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the message activity logs listed by its unique ID. + Future listMessageLogs({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/logs'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of the targets associated with a message. + Future listTargets({ + required String messageId, + List? queries, + }) async { + final String apiPath = '/messaging/messages/{messageId}/targets'.replaceAll( + '{messageId}', + messageId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Get a list of all providers from the current Appwrite project. + Future listProviders({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/providers'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ProviderList.fromMap(res.data); + } + + /// Create a new Apple Push Notification service provider. + Future createApnsProvider({ + required String providerId, + required String name, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/apns'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Apple Push Notification service provider by its unique ID. + Future updateApnsProvider({ + required String providerId, + String? name, + bool? enabled, + String? authKey, + String? authKeyId, + String? teamId, + String? bundleId, + bool? sandbox, + }) async { + final String apiPath = '/messaging/providers/apns/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'authKey': authKey, + 'authKeyId': authKeyId, + 'teamId': teamId, + 'bundleId': bundleId, + 'sandbox': sandbox, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Firebase Cloud Messaging provider. + Future createFcmProvider({ + required String providerId, + required String name, + Map? serviceAccountJSON, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/fcm'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'serviceAccountJSON': serviceAccountJSON, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Firebase Cloud Messaging provider by its unique ID. + Future updateFcmProvider({ + required String providerId, + String? name, + bool? enabled, + Map? serviceAccountJSON, + }) async { + final String apiPath = '/messaging/providers/fcm/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'serviceAccountJSON': serviceAccountJSON, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Mailgun provider. + Future createMailgunProvider({ + required String providerId, + required String name, + String? apiKey, + String? domain, + bool? isEuRegion, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/mailgun'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Mailgun provider by its unique ID. + Future updateMailgunProvider({ + required String providerId, + String? name, + String? apiKey, + String? domain, + bool? isEuRegion, + bool? enabled, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/mailgun/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'apiKey': apiKey, + 'domain': domain, + 'isEuRegion': isEuRegion, + 'enabled': enabled, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new MSG91 provider. + Future createMsg91Provider({ + required String providerId, + required String name, + String? templateId, + String? senderId, + String? authKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/msg91'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a MSG91 provider by its unique ID. + Future updateMsg91Provider({ + required String providerId, + String? name, + bool? enabled, + String? templateId, + String? senderId, + String? authKey, + }) async { + final String apiPath = '/messaging/providers/msg91/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'templateId': templateId, + 'senderId': senderId, + 'authKey': authKey, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Sendgrid provider. + Future createSendgridProvider({ + required String providerId, + required String name, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/sendgrid'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Sendgrid provider by its unique ID. + Future updateSendgridProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + }) async { + final String apiPath = '/messaging/providers/sendgrid/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new SMTP provider. + Future createSmtpProvider({ + required String providerId, + required String name, + required String host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a SMTP provider by its unique ID. + Future updateSmtpProvider({ + required String providerId, + String? name, + String? host, + int? port, + String? username, + String? password, + enums.SmtpEncryption? encryption, + bool? autoTLS, + String? mailer, + String? fromName, + String? fromEmail, + String? replyToName, + String? replyToEmail, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/smtp/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = { + 'name': name, + 'host': host, + 'port': port, + 'username': username, + 'password': password, + 'encryption': encryption?.value, + 'autoTLS': autoTLS, + 'mailer': mailer, + 'fromName': fromName, + 'fromEmail': fromEmail, + 'replyToName': replyToName, + 'replyToEmail': replyToEmail, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Telesign provider. + Future createTelesignProvider({ + required String providerId, + required String name, + String? from, + String? customerId, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/telesign'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'customerId': customerId, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Telesign provider by its unique ID. + Future updateTelesignProvider({ + required String providerId, + String? name, + bool? enabled, + String? customerId, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/telesign/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'customerId': customerId, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Textmagic provider. + Future createTextmagicProvider({ + required String providerId, + required String name, + String? from, + String? username, + String? apiKey, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/textmagic'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'username': username, + 'apiKey': apiKey, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Textmagic provider by its unique ID. + Future updateTextmagicProvider({ + required String providerId, + String? name, + bool? enabled, + String? username, + String? apiKey, + String? from, + }) async { + final String apiPath = '/messaging/providers/textmagic/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'username': username, + 'apiKey': apiKey, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Twilio provider. + Future createTwilioProvider({ + required String providerId, + required String name, + String? from, + String? accountSid, + String? authToken, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/twilio'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'accountSid': accountSid, + 'authToken': authToken, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Twilio provider by its unique ID. + Future updateTwilioProvider({ + required String providerId, + String? name, + bool? enabled, + String? accountSid, + String? authToken, + String? from, + }) async { + final String apiPath = '/messaging/providers/twilio/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'accountSid': accountSid, + 'authToken': authToken, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Create a new Vonage provider. + Future createVonageProvider({ + required String providerId, + required String name, + String? from, + String? apiKey, + String? apiSecret, + bool? enabled, + }) async { + final String apiPath = '/messaging/providers/vonage'; + + final Map apiParams = { + 'providerId': providerId, + 'name': name, + 'from': from, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'enabled': enabled, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Update a Vonage provider by its unique ID. + Future updateVonageProvider({ + required String providerId, + String? name, + bool? enabled, + String? apiKey, + String? apiSecret, + String? from, + }) async { + final String apiPath = '/messaging/providers/vonage/{providerId}' + .replaceAll('{providerId}', providerId); + + final Map apiParams = { + 'name': name, + 'enabled': enabled, + 'apiKey': apiKey, + 'apiSecret': apiSecret, + 'from': from, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Get a provider by its unique ID. + /// + Future getProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Provider.fromMap(res.data); + } + + /// Delete a provider by its unique ID. + Future deleteProvider({required String providerId}) async { + final String apiPath = '/messaging/providers/{providerId}'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the provider activity logs listed by its unique ID. + Future listProviderLogs({ + required String providerId, + List? queries, + }) async { + final String apiPath = '/messaging/providers/{providerId}/logs'.replaceAll( + '{providerId}', + providerId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the subscriber activity logs listed by its unique ID. + Future listSubscriberLogs({ + required String subscriberId, + List? queries, + }) async { + final String apiPath = '/messaging/subscribers/{subscriberId}/logs' + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all topics from the current Appwrite project. + Future listTopics({ + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TopicList.fromMap(res.data); + } + + /// Create a new topic. + Future createTopic({ + required String topicId, + required String name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics'; + + final Map apiParams = { + 'topicId': topicId, + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Get a topic by its unique ID. + /// + Future getTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Update a topic by its unique ID. + /// + Future updateTopic({ + required String topicId, + String? name, + List? subscribe, + }) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'name': name, + 'subscribe': subscribe, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Topic.fromMap(res.data); + } + + /// Delete a topic by its unique ID. + Future deleteTopic({required String topicId}) async { + final String apiPath = '/messaging/topics/{topicId}'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get the topic activity logs listed by its unique ID. + Future listTopicLogs({ + required String topicId, + List? queries, + }) async { + final String apiPath = '/messaging/topics/{topicId}/logs'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get a list of all subscribers from the current Appwrite project. + Future listSubscribers({ + required String topicId, + List? queries, + String? search, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SubscriberList.fromMap(res.data); + } + + /// Create a new subscriber. + Future createSubscriber({ + required String topicId, + required String subscriberId, + required String targetId, + }) async { + final String apiPath = '/messaging/topics/{topicId}/subscribers'.replaceAll( + '{topicId}', + topicId, + ); + + final Map apiParams = { + 'subscriberId': subscriberId, + 'targetId': targetId, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Get a subscriber by its unique ID. + /// + Future getSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Subscriber.fromMap(res.data); + } + + /// Delete a subscriber by its unique ID. + Future deleteSubscriber({ + required String topicId, + required String subscriberId, + }) async { + final String apiPath = + '/messaging/topics/{topicId}/subscribers/{subscriberId}' + .replaceAll('{topicId}', topicId) + .replaceAll('{subscriberId}', subscriberId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/sites.dart b/lib/services/sites.dart index 90511473..d89f2192 100644 --- a/lib/services/sites.dart +++ b/lib/services/sites.dart @@ -2,585 +2,703 @@ part of '../dart_appwrite.dart'; /// The Sites Service allows you view, create and manage your web applications. class Sites extends Service { - Sites(super.client); - - /// Get a list of all the project's sites. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SiteList.fromMap(res.data); - - } - - /// Create a new site. - Future create({required String siteId, required String name, required enums.Framework framework, required enums.BuildRuntime buildRuntime, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.Adapter? adapter, String? installationId, String? fallbackFile, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites'; - - final Map apiParams = { - - 'siteId': siteId, -'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime.value, -'adapter': adapter?.value, -'installationId': installationId, -'fallbackFile': fallbackFile, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all frameworks that are currently available on the server - /// instance. - Future listFrameworks() async { - final String apiPath = '/sites/frameworks'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FrameworkList.fromMap(res.data); - - } - - /// List allowed site specifications for this instance. - Future listSpecifications() async { - final String apiPath = '/sites/specifications'; - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SpecificationList.fromMap(res.data); - - } - - /// Get a site by its unique ID. - Future get({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Update site by its unique ID. - Future update({required String siteId, required String name, required enums.Framework framework, bool? enabled, bool? logging, int? timeout, String? installCommand, String? buildCommand, String? outputDirectory, enums.BuildRuntime? buildRuntime, enums.Adapter? adapter, String? fallbackFile, String? installationId, String? providerRepositoryId, String? providerBranch, bool? providerSilentMode, String? providerRootDirectory, String? specification}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'name': name, -'framework': framework.value, -'enabled': enabled, -'logging': logging, -'timeout': timeout, -'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'buildRuntime': buildRuntime?.value, -'adapter': adapter?.value, -'fallbackFile': fallbackFile, -'installationId': installationId, -'providerRepositoryId': providerRepositoryId, -'providerBranch': providerBranch, -'providerSilentMode': providerSilentMode, -'providerRootDirectory': providerRootDirectory, -'specification': specification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Delete a site by its unique ID. - Future delete({required String siteId}) async { - final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the site active deployment. Use this endpoint to switch the code - /// deployment that should be used when visitor opens your site. - Future updateSiteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployment'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Site.fromMap(res.data); - - } - - /// Get a list of all the site's code deployments. You can use the query params - /// to filter your results. - Future listDeployments({required String siteId, List? queries, String? search}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.DeploymentList.fromMap(res.data); - - } - - /// 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. - Future createDeployment({required String siteId, required InputFile code, required bool activate, String? installCommand, String? buildCommand, String? outputDirectory, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/sites/{siteId}/deployments'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'installCommand': installCommand, -'buildCommand': buildCommand, -'outputDirectory': outputDirectory, -'code': code, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - final paramName = 'code'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createDuplicateDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'deploymentId': deploymentId, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// 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. - Future createTemplateDeployment({required String siteId, required String repository, required String owner, required String rootDirectory, required String version, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'repository': repository, -'owner': owner, -'rootDirectory': rootDirectory, -'version': version, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Create a deployment when a site is connected to VCS. - /// - /// This endpoint lets you create deployment from a branch, commit, or a tag. - Future createVcsDeployment({required String siteId, required enums.VCSDeploymentType type, required String reference, bool? activate}) async { - final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'type': type.value, -'reference': reference, -'activate': activate, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a site deployment by its unique ID. - Future getDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Delete a site deployment by its unique ID. - Future deleteDeployment({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// 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. - Future getDeploymentDownload({required String siteId, required String deploymentId, enums.DeploymentDownloadType? type}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map params = { - 'type': type?.value, - - - 'project': client.config['project'], - 'key': client.config['key'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// 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. - Future updateDeploymentStatus({required String siteId, required String deploymentId}) async { - final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status'.replaceAll('{siteId}', siteId).replaceAll('{deploymentId}', deploymentId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Deployment.fromMap(res.data); - - } - - /// Get a list of all site logs. You can use the query params to filter your - /// results. - Future listLogs({required String siteId, List? queries}) async { - final String apiPath = '/sites/{siteId}/logs'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ExecutionList.fromMap(res.data); - - } - - /// Get a site request log by its unique ID. - Future getLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Execution.fromMap(res.data); - - } - - /// Delete a site log by its unique ID. - Future deleteLog({required String siteId, required String logId}) async { - final String apiPath = '/sites/{siteId}/logs/{logId}'.replaceAll('{siteId}', siteId).replaceAll('{logId}', logId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all variables of a specific site. - Future listVariables({required String siteId}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.VariableList.fromMap(res.data); - - } - - /// Create a new site variable. These variables can be accessed during build - /// and runtime (server-side rendering) as environment variables. - Future createVariable({required String siteId, required String key, required String value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables'.replaceAll('{siteId}', siteId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Get a variable by its unique ID. - Future getVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Update variable by its unique ID. - Future updateVariable({required String siteId, required String variableId, required String key, String? value, bool? secret}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - 'key': key, -'value': value, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Variable.fromMap(res.data); - - } - - /// Delete a variable by its unique ID. - Future deleteVariable({required String siteId, required String variableId}) async { - final String apiPath = '/sites/{siteId}/variables/{variableId}'.replaceAll('{siteId}', siteId).replaceAll('{variableId}', variableId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Sites(super.client); + + /// Get a list of all the project's sites. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SiteList.fromMap(res.data); + } + + /// Create a new site. + Future create({ + required String siteId, + required String name, + required enums.Framework framework, + required enums.BuildRuntime buildRuntime, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.Adapter? adapter, + String? installationId, + String? fallbackFile, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites'; + + final Map apiParams = { + 'siteId': siteId, + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime.value, + 'adapter': adapter?.value, + 'installationId': installationId, + 'fallbackFile': fallbackFile, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all frameworks that are currently available on the server + /// instance. + Future listFrameworks() async { + final String apiPath = '/sites/frameworks'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FrameworkList.fromMap(res.data); + } + + /// List allowed site specifications for this instance. + Future listSpecifications() async { + final String apiPath = '/sites/specifications'; + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SpecificationList.fromMap(res.data); + } + + /// Get a site by its unique ID. + Future get({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Update site by its unique ID. + Future update({ + required String siteId, + required String name, + required enums.Framework framework, + bool? enabled, + bool? logging, + int? timeout, + String? installCommand, + String? buildCommand, + String? outputDirectory, + enums.BuildRuntime? buildRuntime, + enums.Adapter? adapter, + String? fallbackFile, + String? installationId, + String? providerRepositoryId, + String? providerBranch, + bool? providerSilentMode, + String? providerRootDirectory, + String? specification, + }) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = { + 'name': name, + 'framework': framework.value, + 'enabled': enabled, + 'logging': logging, + 'timeout': timeout, + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'buildRuntime': buildRuntime?.value, + 'adapter': adapter?.value, + 'fallbackFile': fallbackFile, + 'installationId': installationId, + 'providerRepositoryId': providerRepositoryId, + 'providerBranch': providerBranch, + 'providerSilentMode': providerSilentMode, + 'providerRootDirectory': providerRootDirectory, + 'specification': specification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Delete a site by its unique ID. + Future delete({required String siteId}) async { + final String apiPath = '/sites/{siteId}'.replaceAll('{siteId}', siteId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the site active deployment. Use this endpoint to switch the code + /// deployment that should be used when visitor opens your site. + Future updateSiteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployment'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Site.fromMap(res.data); + } + + /// Get a list of all the site's code deployments. You can use the query params + /// to filter your results. + Future listDeployments({ + required String siteId, + List? queries, + String? search, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.DeploymentList.fromMap(res.data); + } + + /// 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. + Future createDeployment({ + required String siteId, + required InputFile code, + required bool activate, + String? installCommand, + String? buildCommand, + String? outputDirectory, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/sites/{siteId}/deployments'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'installCommand': installCommand, + 'buildCommand': buildCommand, + 'outputDirectory': outputDirectory, + 'code': code, + 'activate': activate, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + final paramName = 'code'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createDuplicateDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/duplicate'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'deploymentId': deploymentId}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// 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. + Future createTemplateDeployment({ + required String siteId, + required String repository, + required String owner, + required String rootDirectory, + required String version, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/template'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'repository': repository, + 'owner': owner, + 'rootDirectory': rootDirectory, + 'version': version, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Create a deployment when a site is connected to VCS. + /// + /// This endpoint lets you create deployment from a branch, commit, or a tag. + Future createVcsDeployment({ + required String siteId, + required enums.VCSDeploymentType type, + required String reference, + bool? activate, + }) async { + final String apiPath = '/sites/{siteId}/deployments/vcs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'type': type.value, + 'reference': reference, + 'activate': activate, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a site deployment by its unique ID. + Future getDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Delete a site deployment by its unique ID. + Future deleteDeployment({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// 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. + Future getDeploymentDownload({ + required String siteId, + required String deploymentId, + enums.DeploymentDownloadType? type, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/download' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map params = { + 'type': type?.value, + + 'project': client.config['project'], + 'key': client.config['key'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// 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. + Future updateDeploymentStatus({ + required String siteId, + required String deploymentId, + }) async { + final String apiPath = '/sites/{siteId}/deployments/{deploymentId}/status' + .replaceAll('{siteId}', siteId) + .replaceAll('{deploymentId}', deploymentId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Deployment.fromMap(res.data); + } + + /// Get a list of all site logs. You can use the query params to filter your + /// results. + Future listLogs({ + required String siteId, + List? queries, + }) async { + final String apiPath = '/sites/{siteId}/logs'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ExecutionList.fromMap(res.data); + } + + /// Get a site request log by its unique ID. + Future getLog({ + required String siteId, + required String logId, + }) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Execution.fromMap(res.data); + } + + /// Delete a site log by its unique ID. + Future deleteLog({required String siteId, required String logId}) async { + final String apiPath = '/sites/{siteId}/logs/{logId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{logId}', logId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all variables of a specific site. + Future listVariables({required String siteId}) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.VariableList.fromMap(res.data); + } + + /// Create a new site variable. These variables can be accessed during build + /// and runtime (server-side rendering) as environment variables. + Future createVariable({ + required String siteId, + required String key, + required String value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables'.replaceAll( + '{siteId}', + siteId, + ); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Get a variable by its unique ID. + Future getVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Update variable by its unique ID. + Future updateVariable({ + required String siteId, + required String variableId, + required String key, + String? value, + bool? secret, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = { + 'key': key, + 'value': value, + 'secret': secret, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Variable.fromMap(res.data); + } + + /// Delete a variable by its unique ID. + Future deleteVariable({ + required String siteId, + required String variableId, + }) async { + final String apiPath = '/sites/{siteId}/variables/{variableId}' + .replaceAll('{siteId}', siteId) + .replaceAll('{variableId}', variableId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/storage.dart b/lib/services/storage.dart index 9165e91b..ee630883 100644 --- a/lib/services/storage.dart +++ b/lib/services/storage.dart @@ -2,329 +2,421 @@ part of '../dart_appwrite.dart'; /// The Storage service allows you to manage your project files. class Storage extends Service { - Storage(super.client); - - /// Get a list of all the storage buckets. You can use the query params to - /// filter your results. - Future listBuckets({List? queries, String? search}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.BucketList.fromMap(res.data); - - } - - /// Create a new storage bucket. - Future createBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets'; - - final Map apiParams = { - - 'bucketId': bucketId, -'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Get a storage bucket by its unique ID. This endpoint response returns a - /// JSON object with the storage bucket metadata. - Future getBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Update a storage bucket by its unique ID. - Future updateBucket({required String bucketId, required String name, List? permissions, bool? fileSecurity, bool? enabled, int? maximumFileSize, List? allowedFileExtensions, enums.Compression? compression, bool? encryption, bool? antivirus}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, -'fileSecurity': fileSecurity, -'enabled': enabled, -'maximumFileSize': maximumFileSize, -'allowedFileExtensions': allowedFileExtensions, -'compression': compression?.value, -'encryption': encryption, -'antivirus': antivirus, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Bucket.fromMap(res.data); - - } - - /// Delete a storage bucket by its unique ID. - Future deleteBucket({required String bucketId}) async { - final String apiPath = '/storage/buckets/{bucketId}'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a list of all the user files. You can use the query params to filter - /// your results. - Future listFiles({required String bucketId, List? queries, String? search}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.FileList.fromMap(res.data); - - } - - /// Create a new file. Before using this route, you should create a new bucket - /// resource using either a [server - /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) - /// API or directly from your Appwrite console. - /// - /// Larger files should be uploaded using multiple requests with the - /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) - /// header to send a partial request with a maximum supported chunk of `5MB`. - /// The `content-range` header values should always be in bytes. - /// - /// When the first request is sent, the server will return the **File** object, - /// and the subsequent part request must include the file's **id** in - /// `x-appwrite-id` header to allow the server to know that the partial upload - /// is for the existing file and not for a new one. - /// - /// If you're creating a new file using one of the Appwrite SDKs, all the - /// chunking logic will be managed by the SDK internally. - /// - Future createFile({required String bucketId, required String fileId, required InputFile file, List? permissions, Function(UploadProgress)? onProgress}) async { - final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll('{bucketId}', bucketId); - - final Map apiParams = { - - 'fileId': fileId, -'file': file, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'multipart/form-data', - - }; - - String idParamName = ''; - idParamName = 'fileId'; - final paramName = 'file'; - final res = await client.chunkedUpload( - path: apiPath, - params: apiParams, - paramName: paramName, - idParamName: idParamName, - headers: apiHeaders, - onProgress: onProgress, - ); - - return models.File.fromMap(res.data); - - } - - /// Get a file by its unique ID. This endpoint response returns a JSON object - /// with the file metadata. - Future getFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Update a file by its unique ID. Only users with write permissions have - /// access to update this resource. - Future updateFile({required String bucketId, required String fileId, String? name, List? permissions}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'name': name, -'permissions': permissions, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.File.fromMap(res.data); - - } - - /// Delete a file by its unique ID. Only users with write permissions have - /// access to delete this resource. - Future deleteFile({required String bucketId, required String fileId}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Get a file 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. - Future getFileDownload({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file preview image. Currently, this method supports preview for image - /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, - /// and spreadsheets, will return the file icon image. You can also pass query - /// string arguments for cutting and resizing your preview image. Preview is - /// supported only for image files smaller than 10MB. - Future getFilePreview({required String bucketId, required String fileId, int? width, int? height, enums.ImageGravity? gravity, int? quality, int? borderWidth, String? borderColor, int? borderRadius, double? opacity, int? rotation, String? background, enums.ImageFormat? output, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'width': width, -'height': height, -'gravity': gravity?.value, -'quality': quality, -'borderWidth': borderWidth, -'borderColor': borderColor, -'borderRadius': borderRadius, -'opacity': opacity, -'rotation': rotation, -'background': background, -'output': output?.value, -'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } - - /// Get a file content by its unique ID. This endpoint is similar to the - /// download method but returns with no 'Content-Disposition: attachment' - /// header. - Future getFileView({required String bucketId, required String fileId, String? token}) async { - final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map params = { - 'token': token, - - - 'project': client.config['project'], - 'session': client.config['session'], - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: params, responseType: ResponseType.bytes); - return res.data; - } -} \ No newline at end of file + Storage(super.client); + + /// Get a list of all the storage buckets. You can use the query params to + /// filter your results. + Future listBuckets({ + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.BucketList.fromMap(res.data); + } + + /// Create a new storage bucket. + Future createBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets'; + + final Map apiParams = { + 'bucketId': bucketId, + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Get a storage bucket by its unique ID. This endpoint response returns a + /// JSON object with the storage bucket metadata. + Future getBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Update a storage bucket by its unique ID. + Future updateBucket({ + required String bucketId, + required String name, + List? permissions, + bool? fileSecurity, + bool? enabled, + int? maximumFileSize, + List? allowedFileExtensions, + enums.Compression? compression, + bool? encryption, + bool? antivirus, + }) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + 'fileSecurity': fileSecurity, + 'enabled': enabled, + 'maximumFileSize': maximumFileSize, + 'allowedFileExtensions': allowedFileExtensions, + 'compression': compression?.value, + 'encryption': encryption, + 'antivirus': antivirus, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Bucket.fromMap(res.data); + } + + /// Delete a storage bucket by its unique ID. + Future deleteBucket({required String bucketId}) async { + final String apiPath = '/storage/buckets/{bucketId}'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a list of all the user files. You can use the query params to filter + /// your results. + Future listFiles({ + required String bucketId, + List? queries, + String? search, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.FileList.fromMap(res.data); + } + + /// Create a new file. Before using this route, you should create a new bucket + /// resource using either a [server + /// integration](https://appwrite.io/docs/server/storage#storageCreateBucket) + /// API or directly from your Appwrite console. + /// + /// Larger files should be uploaded using multiple requests with the + /// [content-range](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Range) + /// header to send a partial request with a maximum supported chunk of `5MB`. + /// The `content-range` header values should always be in bytes. + /// + /// When the first request is sent, the server will return the **File** object, + /// and the subsequent part request must include the file's **id** in + /// `x-appwrite-id` header to allow the server to know that the partial upload + /// is for the existing file and not for a new one. + /// + /// If you're creating a new file using one of the Appwrite SDKs, all the + /// chunking logic will be managed by the SDK internally. + /// + Future createFile({ + required String bucketId, + required String fileId, + required InputFile file, + List? permissions, + Function(UploadProgress)? onProgress, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files'.replaceAll( + '{bucketId}', + bucketId, + ); + + final Map apiParams = { + 'fileId': fileId, + 'file': file, + 'permissions': permissions, + }; + + final Map apiHeaders = { + 'content-type': 'multipart/form-data', + }; + + String idParamName = ''; + idParamName = 'fileId'; + final paramName = 'file'; + final res = await client.chunkedUpload( + path: apiPath, + params: apiParams, + paramName: paramName, + idParamName: idParamName, + headers: apiHeaders, + onProgress: onProgress, + ); + + return models.File.fromMap(res.data); + } + + /// Get a file by its unique ID. This endpoint response returns a JSON object + /// with the file metadata. + Future getFile({ + required String bucketId, + required String fileId, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Update a file by its unique ID. Only users with write permissions have + /// access to update this resource. + Future updateFile({ + required String bucketId, + required String fileId, + String? name, + List? permissions, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = { + 'name': name, + 'permissions': permissions, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.File.fromMap(res.data); + } + + /// Delete a file by its unique ID. Only users with write permissions have + /// access to delete this resource. + Future deleteFile({required String bucketId, required String fileId}) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Get a file 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. + Future getFileDownload({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/download' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file preview image. Currently, this method supports preview for image + /// files (jpg, png, and gif), other supported formats, like pdf, docs, slides, + /// and spreadsheets, will return the file icon image. You can also pass query + /// string arguments for cutting and resizing your preview image. Preview is + /// supported only for image files smaller than 10MB. + Future getFilePreview({ + required String bucketId, + required String fileId, + int? width, + int? height, + enums.ImageGravity? gravity, + int? quality, + int? borderWidth, + String? borderColor, + int? borderRadius, + double? opacity, + int? rotation, + String? background, + enums.ImageFormat? output, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/preview' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'width': width, + 'height': height, + 'gravity': gravity?.value, + 'quality': quality, + 'borderWidth': borderWidth, + 'borderColor': borderColor, + 'borderRadius': borderRadius, + 'opacity': opacity, + 'rotation': rotation, + 'background': background, + 'output': output?.value, + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } + + /// Get a file content by its unique ID. This endpoint is similar to the + /// download method but returns with no 'Content-Disposition: attachment' + /// header. + Future getFileView({ + required String bucketId, + required String fileId, + String? token, + }) async { + final String apiPath = '/storage/buckets/{bucketId}/files/{fileId}/view' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map params = { + 'token': token, + + 'project': client.config['project'], + 'session': client.config['session'], + }; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: params, + responseType: ResponseType.bytes, + ); + return res.data; + } +} diff --git a/lib/services/teams.dart b/lib/services/teams.dart index 2b492f27..5fd59641 100644 --- a/lib/services/teams.dart +++ b/lib/services/teams.dart @@ -3,321 +3,356 @@ part of '../dart_appwrite.dart'; /// The Teams service allows you to group users of your project and to enable /// them to share read and write access to your project resources class Teams extends Service { - Teams(super.client); - - /// Get a list of all the teams in which the current user is a member. You can - /// use the parameters to filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TeamList.fromMap(res.data); - - } - - /// Create a new team. The user who creates the team will automatically be - /// assigned as the owner of the team. Only the users with the owner role can - /// invite new members, add new owners and delete or update the team. - Future create({required String teamId, required String name, List? roles}) async { - final String apiPath = '/teams'; - - final Map apiParams = { - - 'teamId': teamId, -'name': name, -'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Get a team by its ID. All team members have read access for this resource. - Future get({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Update the team's name by its unique ID. - Future updateName({required String teamId, required String name}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Team.fromMap(res.data); - - } - - /// Delete a team using its ID. Only team members with the owner role can - /// delete the team. - Future delete({required String teamId}) async { - final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to list a team's members using the team's ID. All team - /// members have read access to this endpoint. Hide sensitive attributes from - /// the response by toggling membership privacy in the Console. - Future listMemberships({required String teamId, List? queries, String? search}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Invite a new member to join your team. Provide an ID for existing users, or - /// invite unregistered users using an email or phone number. If initiated from - /// a Client SDK, Appwrite will send an email or sms with a link to join the - /// team to the invited user, and an account will be created for them if one - /// doesn't exist. If initiated from a Server SDK, the new member will be added - /// automatically to the team. - /// - /// You only need to provide one of a user ID, email, or phone number. Appwrite - /// will prioritize accepting the user ID > email > phone number if you provide - /// more than one of these parameters. - /// - /// Use the `url` parameter to redirect the user from the invitation email to - /// your app. After the user is redirected, use the [Update Team Membership - /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) - /// endpoint to allow the user to accept the invitation to the team. - /// - /// Please note that to avoid a [Redirect - /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) - /// Appwrite will accept the only redirect URLs under the domains you have - /// added as a platform on the Appwrite Console. - /// - Future createMembership({required String teamId, required List roles, String? email, String? userId, String? phone, String? url, String? name}) async { - final String apiPath = '/teams/{teamId}/memberships'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'email': email, -'userId': userId, -'phone': phone, -'roles': roles, -'url': url, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get a team member by the membership unique id. All team members have read - /// access for this resource. Hide sensitive attributes from the response by - /// toggling membership privacy in the Console. - Future getMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Modify the roles of a team member. Only team members with the owner role - /// have access to this endpoint. Learn more about [roles and - /// permissions](https://appwrite.io/docs/permissions). - /// - Future updateMembership({required String teamId, required String membershipId, required List roles}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'roles': roles, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// This endpoint allows a user to leave a team or for a team owner to delete - /// the membership of any other team member. You can also use this endpoint to - /// delete a user membership even if it is not accepted. - Future deleteMembership({required String teamId, required String membershipId}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Use this endpoint to allow a user to accept an invitation to join a team - /// after being redirected back to your app from the invitation email received - /// by the user. - /// - /// If the request is successful, a session for the user is automatically - /// created. - /// - Future updateMembershipStatus({required String teamId, required String membershipId, required String userId, required String secret}) async { - final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status'.replaceAll('{teamId}', teamId).replaceAll('{membershipId}', membershipId); - - final Map apiParams = { - - 'userId': userId, -'secret': secret, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Membership.fromMap(res.data); - - } - - /// Get the team's shared preferences by its unique ID. If a preference doesn't - /// need to be shared by all team members, prefer storing them in [user - /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). - Future getPrefs({required String teamId}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the team's preferences by its unique ID. The object you pass is - /// stored as is and replaces any previous value. The maximum allowed prefs - /// size is 64kB and throws an error if exceeded. - Future updatePrefs({required String teamId, required Map prefs}) async { - final String apiPath = '/teams/{teamId}/prefs'.replaceAll('{teamId}', teamId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } -} \ No newline at end of file + Teams(super.client); + + /// Get a list of all the teams in which the current user is a member. You can + /// use the parameters to filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TeamList.fromMap(res.data); + } + + /// Create a new team. The user who creates the team will automatically be + /// assigned as the owner of the team. Only the users with the owner role can + /// invite new members, add new owners and delete or update the team. + Future create({ + required String teamId, + required String name, + List? roles, + }) async { + final String apiPath = '/teams'; + + final Map apiParams = { + 'teamId': teamId, + 'name': name, + 'roles': roles, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Get a team by its ID. All team members have read access for this resource. + Future get({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Update the team's name by its unique ID. + Future updateName({ + required String teamId, + required String name, + }) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Team.fromMap(res.data); + } + + /// Delete a team using its ID. Only team members with the owner role can + /// delete the team. + Future delete({required String teamId}) async { + final String apiPath = '/teams/{teamId}'.replaceAll('{teamId}', teamId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to list a team's members using the team's ID. All team + /// members have read access to this endpoint. Hide sensitive attributes from + /// the response by toggling membership privacy in the Console. + Future listMemberships({ + required String teamId, + List? queries, + String? search, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Invite a new member to join your team. Provide an ID for existing users, or + /// invite unregistered users using an email or phone number. If initiated from + /// a Client SDK, Appwrite will send an email or sms with a link to join the + /// team to the invited user, and an account will be created for them if one + /// doesn't exist. If initiated from a Server SDK, the new member will be added + /// automatically to the team. + /// + /// You only need to provide one of a user ID, email, or phone number. Appwrite + /// will prioritize accepting the user ID > email > phone number if you provide + /// more than one of these parameters. + /// + /// Use the `url` parameter to redirect the user from the invitation email to + /// your app. After the user is redirected, use the [Update Team Membership + /// Status](https://appwrite.io/docs/references/cloud/client-web/teams#updateMembershipStatus) + /// endpoint to allow the user to accept the invitation to the team. + /// + /// Please note that to avoid a [Redirect + /// Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) + /// Appwrite will accept the only redirect URLs under the domains you have + /// added as a platform on the Appwrite Console. + /// + Future createMembership({ + required String teamId, + required List roles, + String? email, + String? userId, + String? phone, + String? url, + String? name, + }) async { + final String apiPath = '/teams/{teamId}/memberships'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = { + 'email': email, + 'userId': userId, + 'phone': phone, + 'roles': roles, + 'url': url, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get a team member by the membership unique id. All team members have read + /// access for this resource. Hide sensitive attributes from the response by + /// toggling membership privacy in the Console. + Future getMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Modify the roles of a team member. Only team members with the owner role + /// have access to this endpoint. Learn more about [roles and + /// permissions](https://appwrite.io/docs/permissions). + /// + Future updateMembership({ + required String teamId, + required String membershipId, + required List roles, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'roles': roles}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// This endpoint allows a user to leave a team or for a team owner to delete + /// the membership of any other team member. You can also use this endpoint to + /// delete a user membership even if it is not accepted. + Future deleteMembership({ + required String teamId, + required String membershipId, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Use this endpoint to allow a user to accept an invitation to join a team + /// after being redirected back to your app from the invitation email received + /// by the user. + /// + /// If the request is successful, a session for the user is automatically + /// created. + /// + Future updateMembershipStatus({ + required String teamId, + required String membershipId, + required String userId, + required String secret, + }) async { + final String apiPath = '/teams/{teamId}/memberships/{membershipId}/status' + .replaceAll('{teamId}', teamId) + .replaceAll('{membershipId}', membershipId); + + final Map apiParams = {'userId': userId, 'secret': secret}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Membership.fromMap(res.data); + } + + /// Get the team's shared preferences by its unique ID. If a preference doesn't + /// need to be shared by all team members, prefer storing them in [user + /// preferences](https://appwrite.io/docs/references/cloud/client-web/account#getPrefs). + Future getPrefs({required String teamId}) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the team's preferences by its unique ID. The object you pass is + /// stored as is and replaces any previous value. The maximum allowed prefs + /// size is 64kB and throws an error if exceeded. + Future updatePrefs({ + required String teamId, + required Map prefs, + }) async { + final String apiPath = '/teams/{teamId}/prefs'.replaceAll( + '{teamId}', + teamId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } +} diff --git a/lib/services/tokens.dart b/lib/services/tokens.dart index a9b8f78a..0224b0a5 100644 --- a/lib/services/tokens.dart +++ b/lib/services/tokens.dart @@ -1,109 +1,113 @@ part of '../dart_appwrite.dart'; class Tokens extends Service { - Tokens(super.client); - - /// List all the tokens created for a specific file or bucket. You can use the - /// query params to filter your results. - Future list({required String bucketId, required String fileId, List? queries}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceTokenList.fromMap(res.data); - - } - - /// Create a new token. A token is linked to a file. Token can be passed as a - /// header or request get parameter. - Future createFileToken({required String bucketId, required String fileId, String? expire}) async { - final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}'.replaceAll('{bucketId}', bucketId).replaceAll('{fileId}', fileId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Get a token by its unique ID. - Future get({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Update a token by its unique ID. Use this endpoint to update a token's - /// expiry date. - Future update({required String tokenId, String? expire}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - 'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.ResourceToken.fromMap(res.data); - - } - - /// Delete a token by its unique ID. - Future delete({required String tokenId}) async { - final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } -} \ No newline at end of file + Tokens(super.client); + + /// List all the tokens created for a specific file or bucket. You can use the + /// query params to filter your results. + Future list({ + required String bucketId, + required String fileId, + List? queries, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceTokenList.fromMap(res.data); + } + + /// Create a new token. A token is linked to a file. Token can be passed as a + /// header or request get parameter. + Future createFileToken({ + required String bucketId, + required String fileId, + String? expire, + }) async { + final String apiPath = '/tokens/buckets/{bucketId}/files/{fileId}' + .replaceAll('{bucketId}', bucketId) + .replaceAll('{fileId}', fileId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Get a token by its unique ID. + Future get({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Update a token by its unique ID. Use this endpoint to update a token's + /// expiry date. + Future update({ + required String tokenId, + String? expire, + }) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.ResourceToken.fromMap(res.data); + } + + /// Delete a token by its unique ID. + Future delete({required String tokenId}) async { + final String apiPath = '/tokens/{tokenId}'.replaceAll('{tokenId}', tokenId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } +} diff --git a/lib/services/users.dart b/lib/services/users.dart index 765ec3e6..c98182b7 100644 --- a/lib/services/users.dart +++ b/lib/services/users.dart @@ -2,962 +2,1107 @@ part of '../dart_appwrite.dart'; /// The Users service allows you to manage your project users. class Users extends Service { - Users(super.client); - - /// Get a list of all the project's users. You can use the query params to - /// filter your results. - Future list({List? queries, String? search}) async { - final String apiPath = '/users'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.UserList.fromMap(res.data); - - } - - /// Create a new user. - Future create({required String userId, String? email, String? phone, String? password, String? name}) async { - final String apiPath = '/users'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'phone': phone, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createArgon2User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/argon2'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createBcryptUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/bcrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get identities for all users. - Future listIdentities({List? queries, String? search}) async { - final String apiPath = '/users/identities'; - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.IdentityList.fromMap(res.data); - - } - - /// Delete an identity by its unique ID. - Future deleteIdentity({required String identityId}) async { - final String apiPath = '/users/identities/{identityId}'.replaceAll('{identityId}', identityId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Create a new user. Password provided must be hashed with the - /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createMD5User({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/md5'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createPHPassUser({required String userId, required String email, required String password, String? name}) async { - final String apiPath = '/users/phpass'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptUser({required String userId, required String email, required String password, required String passwordSalt, required int passwordCpu, required int passwordMemory, required int passwordParallel, required int passwordLength, String? name}) async { - final String apiPath = '/users/scrypt'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordCpu': passwordCpu, -'passwordMemory': passwordMemory, -'passwordParallel': passwordParallel, -'passwordLength': passwordLength, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the [Scrypt - /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) - /// algorithm. Use the [POST - /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to - /// create users with a plain text password. - Future createScryptModifiedUser({required String userId, required String email, required String password, required String passwordSalt, required String passwordSaltSeparator, required String passwordSignerKey, String? name}) async { - final String apiPath = '/users/scrypt-modified'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordSalt': passwordSalt, -'passwordSaltSeparator': passwordSaltSeparator, -'passwordSignerKey': passwordSignerKey, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Create a new user. Password provided must be hashed with the - /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use - /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) - /// endpoint to create users with a plain text password. - Future createSHAUser({required String userId, required String email, required String password, enums.PasswordHash? passwordVersion, String? name}) async { - final String apiPath = '/users/sha'; - - final Map apiParams = { - - 'userId': userId, -'email': email, -'password': password, -'passwordVersion': passwordVersion?.value, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get a user by its unique ID. - Future get({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is - /// released and can be reused, all user-related resources like documents or - /// storage files should be deleted before user deletion. If you want to keep - /// ID reserved, use the - /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) - /// endpoint instead. - Future delete({required String userId}) async { - final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user email by its unique ID. - Future updateEmail({required String userId, required String email}) async { - final String apiPath = '/users/{userId}/email'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'email': email, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Use this endpoint to create a JSON Web Token for user by its unique ID. You - /// can use the resulting JWT to authenticate on behalf of the user. The JWT - /// secret will become invalid if the session it uses gets deleted. - Future createJWT({required String userId, String? sessionId, int? duration}) async { - final String apiPath = '/users/{userId}/jwts'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'sessionId': sessionId, -'duration': duration, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Jwt.fromMap(res.data); - - } - - /// Update the user labels by its unique ID. - /// - /// Labels can be used to grant access to resources. While teams are a way for - /// user's to share access to a resource, labels can be defined by the - /// developer to grant access without an invitation. See the [Permissions - /// docs](https://appwrite.io/docs/permissions) for more info. - Future updateLabels({required String userId, required List labels}) async { - final String apiPath = '/users/{userId}/labels'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'labels': labels, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user activity logs list by its unique ID. - Future listLogs({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/logs'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.LogList.fromMap(res.data); - - } - - /// Get the user membership list by its unique ID. - Future listMemberships({required String userId, List? queries, String? search}) async { - final String apiPath = '/users/{userId}/memberships'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, -'search': search, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MembershipList.fromMap(res.data); - - } - - /// Enable or disable MFA on a user account. - Future updateMfa({required String userId, required bool mfa}) async { - final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'mfa': mfa, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Delete an authenticator app. - Future deleteMfaAuthenticator({required String userId, required enums.AuthenticatorType type}) async { - final String apiPath = '/users/{userId}/mfa/authenticators/{type}'.replaceAll('{userId}', userId).replaceAll('{type}', type.value); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// List the factors available on the account to be used as a MFA challange. - Future listMfaFactors({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/factors'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaFactors.fromMap(res.data); - - } - - /// Get recovery codes that can be used as backup for MFA flow by User ID. - /// Before getting codes, they must be generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future getMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Regenerate recovery codes that can be used as backup for MFA flow by User - /// ID. Before regenerating codes, they must be first generated using - /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) - /// method. - Future updateMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.put, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Generate recovery codes used as backup for MFA flow for User ID. Recovery - /// codes can be used as a MFA verification type in - /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) - /// method by client SDK. - Future createMfaRecoveryCodes({required String userId}) async { - final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.MfaRecoveryCodes.fromMap(res.data); - - } - - /// Update the user name by its unique ID. - Future updateName({required String userId, required String name}) async { - final String apiPath = '/users/{userId}/name'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user password by its unique ID. - Future updatePassword({required String userId, required String password}) async { - final String apiPath = '/users/{userId}/password'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'password': password, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone by its unique ID. - Future updatePhone({required String userId, required String number}) async { - final String apiPath = '/users/{userId}/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'number': number, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Get the user preferences by its unique ID. - Future getPrefs({required String userId}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Update the user preferences by its unique ID. The object you pass is stored - /// as is, and replaces any previous value. The maximum allowed prefs size is - /// 64kB and throws error if exceeded. - Future updatePrefs({required String userId, required Map prefs}) async { - final String apiPath = '/users/{userId}/prefs'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'prefs': prefs, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Preferences.fromMap(res.data); - - } - - /// Get the user sessions list by its unique ID. - Future listSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.SessionList.fromMap(res.data); - - } - - /// Creates a session for a user. Returns an immediately usable session object. - /// - /// If you want to generate a token for a custom authentication flow, use the - /// [POST - /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) - /// endpoint. - Future createSession({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Session.fromMap(res.data); - - } - - /// Delete all user's sessions by using the user's unique ID. - Future deleteSessions({required String userId}) async { - final String apiPath = '/users/{userId}/sessions'.replaceAll('{userId}', userId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Delete a user sessions by its unique ID. - Future deleteSession({required String userId, required String sessionId}) async { - final String apiPath = '/users/{userId}/sessions/{sessionId}'.replaceAll('{userId}', userId).replaceAll('{sessionId}', sessionId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Update the user status by its unique ID. Use this endpoint as an - /// alternative to deleting a user if you want to keep user's ID reserved. - Future updateStatus({required String userId, required bool status}) async { - final String apiPath = '/users/{userId}/status'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'status': status, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// List the messaging targets that are associated with a user. - Future listTargets({required String userId, List? queries}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - 'queries': queries, - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.TargetList.fromMap(res.data); - - } - - /// Create a messaging target. - Future createTarget({required String userId, required String targetId, required enums.MessagingProviderType providerType, required String identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'targetId': targetId, -'providerType': providerType.value, -'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Get a user's push notification target by ID. - Future getTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - - }; - - final res = await client.call(HttpMethod.get, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Update a messaging target. - Future updateTarget({required String userId, required String targetId, String? identifier, String? providerId, String? name}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - 'identifier': identifier, -'providerId': providerId, -'name': name, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Target.fromMap(res.data); - - } - - /// Delete a messaging target. - Future deleteTarget({required String userId, required String targetId}) async { - final String apiPath = '/users/{userId}/targets/{targetId}'.replaceAll('{userId}', userId).replaceAll('{targetId}', targetId); - - final Map apiParams = { - - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.delete, path: apiPath, params: apiParams, headers: apiHeaders); - - return res.data; - - } - - /// Returns a token with a secret key for creating a session. Use the user ID - /// and secret and submit a request to the [PUT - /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) - /// endpoint to complete the login process. - /// - Future createToken({required String userId, int? length, int? expire}) async { - final String apiPath = '/users/{userId}/tokens'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'length': length, -'expire': expire, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.post, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.Token.fromMap(res.data); - - } - - /// Update the user email verification status by its unique ID. - Future updateEmailVerification({required String userId, required bool emailVerification}) async { - final String apiPath = '/users/{userId}/verification'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'emailVerification': emailVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } - - /// Update the user phone verification status by its unique ID. - Future updatePhoneVerification({required String userId, required bool phoneVerification}) async { - final String apiPath = '/users/{userId}/verification/phone'.replaceAll('{userId}', userId); - - final Map apiParams = { - - 'phoneVerification': phoneVerification, - - }; - - final Map apiHeaders = { - 'content-type': 'application/json', - - }; - - final res = await client.call(HttpMethod.patch, path: apiPath, params: apiParams, headers: apiHeaders); - - return models.User.fromMap(res.data); - - } -} \ No newline at end of file + Users(super.client); + + /// Get a list of all the project's users. You can use the query params to + /// filter your results. + Future list({List? queries, String? search}) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.UserList.fromMap(res.data); + } + + /// Create a new user. + Future create({ + required String userId, + String? email, + String? phone, + String? password, + String? name, + }) async { + final String apiPath = '/users'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'phone': phone, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Argon2](https://en.wikipedia.org/wiki/Argon2) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createArgon2User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/argon2'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Bcrypt](https://en.wikipedia.org/wiki/Bcrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createBcryptUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/bcrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get identities for all users. + Future listIdentities({ + List? queries, + String? search, + }) async { + final String apiPath = '/users/identities'; + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.IdentityList.fromMap(res.data); + } + + /// Delete an identity by its unique ID. + Future deleteIdentity({required String identityId}) async { + final String apiPath = '/users/identities/{identityId}'.replaceAll( + '{identityId}', + identityId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Create a new user. Password provided must be hashed with the + /// [MD5](https://en.wikipedia.org/wiki/MD5) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createMD5User({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/md5'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [PHPass](https://www.openwall.com/phpass/) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createPHPassUser({ + required String userId, + required String email, + required String password, + String? name, + }) async { + final String apiPath = '/users/phpass'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [Scrypt](https://github.com/Tarsnap/scrypt) algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required int passwordCpu, + required int passwordMemory, + required int passwordParallel, + required int passwordLength, + String? name, + }) async { + final String apiPath = '/users/scrypt'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordCpu': passwordCpu, + 'passwordMemory': passwordMemory, + 'passwordParallel': passwordParallel, + 'passwordLength': passwordLength, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the [Scrypt + /// Modified](https://gist.github.com/Meldiron/eecf84a0225eccb5a378d45bb27462cc) + /// algorithm. Use the [POST + /// /users](https://appwrite.io/docs/server/users#usersCreate) endpoint to + /// create users with a plain text password. + Future createScryptModifiedUser({ + required String userId, + required String email, + required String password, + required String passwordSalt, + required String passwordSaltSeparator, + required String passwordSignerKey, + String? name, + }) async { + final String apiPath = '/users/scrypt-modified'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordSalt': passwordSalt, + 'passwordSaltSeparator': passwordSaltSeparator, + 'passwordSignerKey': passwordSignerKey, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Create a new user. Password provided must be hashed with the + /// [SHA](https://en.wikipedia.org/wiki/Secure_Hash_Algorithm) algorithm. Use + /// the [POST /users](https://appwrite.io/docs/server/users#usersCreate) + /// endpoint to create users with a plain text password. + Future createSHAUser({ + required String userId, + required String email, + required String password, + enums.PasswordHash? passwordVersion, + String? name, + }) async { + final String apiPath = '/users/sha'; + + final Map apiParams = { + 'userId': userId, + 'email': email, + 'password': password, + 'passwordVersion': passwordVersion?.value, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get a user by its unique ID. + Future get({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete a user by its unique ID, thereby releasing it's ID. Since ID is + /// released and can be reused, all user-related resources like documents or + /// storage files should be deleted before user deletion. If you want to keep + /// ID reserved, use the + /// [updateStatus](https://appwrite.io/docs/server/users#usersUpdateStatus) + /// endpoint instead. + Future delete({required String userId}) async { + final String apiPath = '/users/{userId}'.replaceAll('{userId}', userId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user email by its unique ID. + Future updateEmail({ + required String userId, + required String email, + }) async { + final String apiPath = '/users/{userId}/email'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'email': email}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Use this endpoint to create a JSON Web Token for user by its unique ID. You + /// can use the resulting JWT to authenticate on behalf of the user. The JWT + /// secret will become invalid if the session it uses gets deleted. + Future createJWT({ + required String userId, + String? sessionId, + int? duration, + }) async { + final String apiPath = '/users/{userId}/jwts'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'sessionId': sessionId, + 'duration': duration, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Jwt.fromMap(res.data); + } + + /// Update the user labels by its unique ID. + /// + /// Labels can be used to grant access to resources. While teams are a way for + /// user's to share access to a resource, labels can be defined by the + /// developer to grant access without an invitation. See the [Permissions + /// docs](https://appwrite.io/docs/permissions) for more info. + Future updateLabels({ + required String userId, + required List labels, + }) async { + final String apiPath = '/users/{userId}/labels'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'labels': labels}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user activity logs list by its unique ID. + Future listLogs({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/logs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.LogList.fromMap(res.data); + } + + /// Get the user membership list by its unique ID. + Future listMemberships({ + required String userId, + List? queries, + String? search, + }) async { + final String apiPath = '/users/{userId}/memberships'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'queries': queries, + 'search': search, + }; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MembershipList.fromMap(res.data); + } + + /// Enable or disable MFA on a user account. + Future updateMfa({ + required String userId, + required bool mfa, + }) async { + final String apiPath = '/users/{userId}/mfa'.replaceAll('{userId}', userId); + + final Map apiParams = {'mfa': mfa}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Delete an authenticator app. + Future deleteMfaAuthenticator({ + required String userId, + required enums.AuthenticatorType type, + }) async { + final String apiPath = '/users/{userId}/mfa/authenticators/{type}' + .replaceAll('{userId}', userId) + .replaceAll('{type}', type.value); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// List the factors available on the account to be used as a MFA challange. + Future listMfaFactors({required String userId}) async { + final String apiPath = '/users/{userId}/mfa/factors'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaFactors.fromMap(res.data); + } + + /// Get recovery codes that can be used as backup for MFA flow by User ID. + /// Before getting codes, they must be generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future getMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Regenerate recovery codes that can be used as backup for MFA flow by User + /// ID. Before regenerating codes, they must be first generated using + /// [createMfaRecoveryCodes](/docs/references/cloud/client-web/account#createMfaRecoveryCodes) + /// method. + Future updateMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.put, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Generate recovery codes used as backup for MFA flow for User ID. Recovery + /// codes can be used as a MFA verification type in + /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge) + /// method by client SDK. + Future createMfaRecoveryCodes({ + required String userId, + }) async { + final String apiPath = '/users/{userId}/mfa/recovery-codes'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.MfaRecoveryCodes.fromMap(res.data); + } + + /// Update the user name by its unique ID. + Future updateName({ + required String userId, + required String name, + }) async { + final String apiPath = '/users/{userId}/name'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'name': name}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user password by its unique ID. + Future updatePassword({ + required String userId, + required String password, + }) async { + final String apiPath = '/users/{userId}/password'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'password': password}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone by its unique ID. + Future updatePhone({ + required String userId, + required String number, + }) async { + final String apiPath = '/users/{userId}/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'number': number}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Get the user preferences by its unique ID. + Future getPrefs({required String userId}) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Update the user preferences by its unique ID. The object you pass is stored + /// as is, and replaces any previous value. The maximum allowed prefs size is + /// 64kB and throws error if exceeded. + Future updatePrefs({ + required String userId, + required Map prefs, + }) async { + final String apiPath = '/users/{userId}/prefs'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'prefs': prefs}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Preferences.fromMap(res.data); + } + + /// Get the user sessions list by its unique ID. + Future listSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.SessionList.fromMap(res.data); + } + + /// Creates a session for a user. Returns an immediately usable session object. + /// + /// If you want to generate a token for a custom authentication flow, use the + /// [POST + /// /users/{userId}/tokens](https://appwrite.io/docs/server/users#createToken) + /// endpoint. + Future createSession({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Session.fromMap(res.data); + } + + /// Delete all user's sessions by using the user's unique ID. + Future deleteSessions({required String userId}) async { + final String apiPath = '/users/{userId}/sessions'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Delete a user sessions by its unique ID. + Future deleteSession({ + required String userId, + required String sessionId, + }) async { + final String apiPath = '/users/{userId}/sessions/{sessionId}' + .replaceAll('{userId}', userId) + .replaceAll('{sessionId}', sessionId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Update the user status by its unique ID. Use this endpoint as an + /// alternative to deleting a user if you want to keep user's ID reserved. + Future updateStatus({ + required String userId, + required bool status, + }) async { + final String apiPath = '/users/{userId}/status'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'status': status}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// List the messaging targets that are associated with a user. + Future listTargets({ + required String userId, + List? queries, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'queries': queries}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.TargetList.fromMap(res.data); + } + + /// Create a messaging target. + Future createTarget({ + required String userId, + required String targetId, + required enums.MessagingProviderType providerType, + required String identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'targetId': targetId, + 'providerType': providerType.value, + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Get a user's push notification target by ID. + Future getTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {}; + + final res = await client.call( + HttpMethod.get, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Update a messaging target. + Future updateTarget({ + required String userId, + required String targetId, + String? identifier, + String? providerId, + String? name, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = { + 'identifier': identifier, + 'providerId': providerId, + 'name': name, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Target.fromMap(res.data); + } + + /// Delete a messaging target. + Future deleteTarget({ + required String userId, + required String targetId, + }) async { + final String apiPath = '/users/{userId}/targets/{targetId}' + .replaceAll('{userId}', userId) + .replaceAll('{targetId}', targetId); + + final Map apiParams = {}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.delete, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return res.data; + } + + /// Returns a token with a secret key for creating a session. Use the user ID + /// and secret and submit a request to the [PUT + /// /account/sessions/token](https://appwrite.io/docs/references/cloud/client-web/account#createSession) + /// endpoint to complete the login process. + /// + Future createToken({ + required String userId, + int? length, + int? expire, + }) async { + final String apiPath = '/users/{userId}/tokens'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = {'length': length, 'expire': expire}; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.post, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.Token.fromMap(res.data); + } + + /// Update the user email verification status by its unique ID. + Future updateEmailVerification({ + required String userId, + required bool emailVerification, + }) async { + final String apiPath = '/users/{userId}/verification'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'emailVerification': emailVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } + + /// Update the user phone verification status by its unique ID. + Future updatePhoneVerification({ + required String userId, + required bool phoneVerification, + }) async { + final String apiPath = '/users/{userId}/verification/phone'.replaceAll( + '{userId}', + userId, + ); + + final Map apiParams = { + 'phoneVerification': phoneVerification, + }; + + final Map apiHeaders = {'content-type': 'application/json'}; + + final res = await client.call( + HttpMethod.patch, + path: apiPath, + params: apiParams, + headers: apiHeaders, + ); + + return models.User.fromMap(res.data); + } +} diff --git a/lib/src/client.dart b/lib/src/client.dart index 2fc990a5..d82d623a 100644 --- a/lib/src/client.dart +++ b/lib/src/client.dart @@ -8,7 +8,7 @@ import 'upload_progress.dart'; /// [Client] that handles requests to Appwrite abstract class Client { /// The size for cunked uploads in bytes. - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; /// Holds configuration such as project. late Map config; @@ -18,16 +18,16 @@ abstract class Client { String get endPoint => _endPoint; /// Initializes a [Client]. - factory Client( - {String endPoint = 'https://cloud.appwrite.io/v1', - bool selfSigned = false}) => - createClient(endPoint: endPoint, selfSigned: selfSigned); + factory Client({ + String endPoint = 'https://cloud.appwrite.io/v1', + bool selfSigned = false, + }) => createClient(endPoint: endPoint, selfSigned: selfSigned); /// Handle OAuth2 session creation. Future webAuth(Uri url); /// Set self signed to [status]. - /// + /// /// If self signed is true, [Client] will ignore invalid certificates. /// This is helpful in environments where your Appwrite /// instance does not have a valid SSL certificate. @@ -81,7 +81,8 @@ abstract class Client { }); /// Send the API request. - Future call(HttpMethod method, { + Future call( + HttpMethod method, { String path = '', Map headers = const {}, Map params = const {}, diff --git a/lib/src/client_base.dart b/lib/src/client_base.dart index cd82d264..08d93b85 100644 --- a/lib/src/client_base.dart +++ b/lib/src/client_base.dart @@ -2,21 +2,25 @@ import 'response.dart'; import 'client.dart'; import 'enums.dart'; -abstract class ClientBase implements Client { +abstract class ClientBase implements Client { /// Your project ID @override ClientBase setProject(value); + /// Your secret API key @override ClientBase setKey(value); + /// Your secret JSON Web Token @override ClientBase setJWT(value); @override ClientBase setLocale(value); + /// The user session to authenticate with @override ClientBase setSession(value); + /// The user agent string of the client that made the request @override ClientBase setForwardedUserAgent(value); diff --git a/lib/src/client_browser.dart b/lib/src/client_browser.dart index 7b2cb4e8..aa59d03e 100644 --- a/lib/src/client_browser.dart +++ b/lib/src/client_browser.dart @@ -9,14 +9,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => +ClientBase createClient({required String endPoint, required bool selfSigned}) => ClientBrowser(endPoint: endPoint, selfSigned: selfSigned); class ClientBrowser extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -34,59 +31,66 @@ class ClientBrowser extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'X-Appwrite-Response-Format' : '1.7.0', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientBrowser setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientBrowser setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientBrowser setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientBrowser setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientBrowser setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientBrowser setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientBrowser setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientBrowser setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientBrowser setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientBrowser setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientBrowser setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientBrowser setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientBrowser setSelfSigned({bool status = true}) { @@ -135,7 +139,11 @@ class ClientBrowser extends ClientBase with ClientMixin { late Response res; if (size <= CHUNK_SIZE) { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); return call( HttpMethod.post, path: path, @@ -162,12 +170,19 @@ class ClientBrowser extends ClientBase with ClientMixin { List chunk = []; final end = min(offset + CHUNK_SIZE, size); chunk = file.bytes!.getRange(offset, end).toList(); - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; diff --git a/lib/src/client_io.dart b/lib/src/client_io.dart index 88663581..b942cfe4 100644 --- a/lib/src/client_io.dart +++ b/lib/src/client_io.dart @@ -10,17 +10,11 @@ import 'response.dart'; import 'input_file.dart'; import 'upload_progress.dart'; -ClientBase createClient({ - required String endPoint, - required bool selfSigned, -}) => - ClientIO( - endPoint: endPoint, - selfSigned: selfSigned, - ); +ClientBase createClient({required String endPoint, required bool selfSigned}) => + ClientIO(endPoint: endPoint, selfSigned: selfSigned); class ClientIO extends ClientBase with ClientMixin { - static const int CHUNK_SIZE = 5*1024*1024; + static const int CHUNK_SIZE = 5 * 1024 * 1024; String _endPoint; Map? _headers; @override @@ -32,9 +26,10 @@ class ClientIO extends ClientBase with ClientMixin { String endPoint = 'https://cloud.appwrite.io/v1', bool selfSigned = false, }) : _endPoint = endPoint { - _nativeClient = HttpClient() - ..badCertificateCallback = - ((X509Certificate cert, String host, int port) => selfSigned); + _nativeClient = + HttpClient() + ..badCertificateCallback = + ((X509Certificate cert, String host, int port) => selfSigned); _httpClient = IOClient(_nativeClient); _endPoint = endPoint; _headers = { @@ -43,60 +38,68 @@ class ClientIO extends ClientBase with ClientMixin { 'x-sdk-platform': 'server', 'x-sdk-language': 'dart', 'x-sdk-version': '16.0.0', - 'user-agent' : 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', - 'X-Appwrite-Response-Format' : '1.7.0', + 'user-agent': + 'AppwriteDartSDK/16.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})', + 'X-Appwrite-Response-Format': '1.7.0', }; config = {}; - assert(_endPoint.startsWith(RegExp("http://|https://")), - "endPoint $_endPoint must start with 'http'"); + assert( + _endPoint.startsWith(RegExp("http://|https://")), + "endPoint $_endPoint must start with 'http'", + ); } @override String get endPoint => _endPoint; - /// Your project ID - @override - ClientIO setProject(value) { - config['project'] = value; - addHeader('X-Appwrite-Project', value); - return this; - } - /// Your secret API key - @override - ClientIO setKey(value) { - config['key'] = value; - addHeader('X-Appwrite-Key', value); - return this; - } - /// Your secret JSON Web Token - @override - ClientIO setJWT(value) { - config['jWT'] = value; - addHeader('X-Appwrite-JWT', value); - return this; - } - @override - ClientIO setLocale(value) { - config['locale'] = value; - addHeader('X-Appwrite-Locale', value); - return this; - } - /// The user session to authenticate with - @override - ClientIO setSession(value) { - config['session'] = value; - addHeader('X-Appwrite-Session', value); - return this; - } - /// The user agent string of the client that made the request - @override - ClientIO setForwardedUserAgent(value) { - config['forwardedUserAgent'] = value; - addHeader('X-Forwarded-User-Agent', value); - return this; - } + /// Your project ID + @override + ClientIO setProject(value) { + config['project'] = value; + addHeader('X-Appwrite-Project', value); + return this; + } + + /// Your secret API key + @override + ClientIO setKey(value) { + config['key'] = value; + addHeader('X-Appwrite-Key', value); + return this; + } + + /// Your secret JSON Web Token + @override + ClientIO setJWT(value) { + config['jWT'] = value; + addHeader('X-Appwrite-JWT', value); + return this; + } + + @override + ClientIO setLocale(value) { + config['locale'] = value; + addHeader('X-Appwrite-Locale', value); + return this; + } + + /// The user session to authenticate with + @override + ClientIO setSession(value) { + config['session'] = value; + addHeader('X-Appwrite-Session', value); + return this; + } + + /// The user agent string of the client that made the request + @override + ClientIO setForwardedUserAgent(value) { + config['forwardedUserAgent'] = value; + addHeader('X-Forwarded-User-Agent', value); + return this; + } @override ClientIO setSelfSigned({bool status = true}) { @@ -151,11 +154,16 @@ class ClientIO extends ClientBase with ClientMixin { if (size <= CHUNK_SIZE) { if (file.path != null) { params[paramName] = await http.MultipartFile.fromPath( - paramName, file.path!, - filename: file.filename); + paramName, + file.path!, + filename: file.filename, + ); } else { - params[paramName] = http.MultipartFile.fromBytes(paramName, file.bytes!, - filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + file.bytes!, + filename: file.filename, + ); } return call( HttpMethod.post, @@ -194,12 +202,19 @@ class ClientIO extends ClientBase with ClientMixin { raf!.setPositionSync(offset); chunk = raf.readSync(CHUNK_SIZE); } - params[paramName] = - http.MultipartFile.fromBytes(paramName, chunk, filename: file.filename); + params[paramName] = http.MultipartFile.fromBytes( + paramName, + chunk, + filename: file.filename, + ); headers['content-range'] = 'bytes $offset-${min((offset + CHUNK_SIZE - 1), size - 1)}/$size'; - res = await call(HttpMethod.post, - path: path, headers: headers, params: params); + res = await call( + HttpMethod.post, + path: path, + headers: headers, + params: params, + ); offset += CHUNK_SIZE; if (offset < size) { headers['x-appwrite-id'] = res.data['\$id']; @@ -244,10 +259,7 @@ class ClientIO extends ClientBase with ClientMixin { try { final streamedResponse = await _httpClient.send(request); res = await toResponse(streamedResponse); - return prepareResponse( - res, - responseType: responseType, - ); + return prepareResponse(res, responseType: responseType); } catch (e) { if (e is AppwriteException) { rethrow; diff --git a/lib/src/client_mixin.dart b/lib/src/client_mixin.dart index 658b79b6..310bc3ca 100644 --- a/lib/src/client_mixin.dart +++ b/lib/src/client_mixin.dart @@ -26,21 +26,21 @@ mixin ClientMixin { } else { if (value is List) { value.asMap().forEach((i, v) { - (request as http.MultipartRequest) - .fields - .addAll({"$key[$i]": v.toString()}); + (request as http.MultipartRequest).fields.addAll({ + "$key[$i]": v.toString(), + }); }); } else { - (request as http.MultipartRequest) - .fields - .addAll({key: value.toString()}); + (request as http.MultipartRequest).fields.addAll({ + key: value.toString(), + }); } } }); } } else if (method == HttpMethod.get) { if (params.isNotEmpty) { - params = params.map((key, value){ + params = params.map((key, value) { if (value is int || value is double) { return MapEntry(key, value.toString()); } @@ -51,12 +51,13 @@ mixin ClientMixin { }); } uri = Uri( - fragment: uri.fragment, - path: uri.path, - host: uri.host, - scheme: uri.scheme, - queryParameters: params, - port: uri.port); + fragment: uri.fragment, + path: uri.path, + host: uri.host, + scheme: uri.scheme, + queryParameters: params, + port: uri.port, + ); request = http.Request(method.name(), uri); } else { (request as http.Request).body = jsonEncode(params); @@ -66,7 +67,9 @@ mixin ClientMixin { headers['User-Agent'] = Uri.encodeFull(headers['User-Agent']!); } if (headers['X-Forwarded-User-Agent'] != null) { - headers['X-Forwarded-User-Agent'] = Uri.encodeFull(headers['X-Forwarded-User-Agent']!); + headers['X-Forwarded-User-Agent'] = Uri.encodeFull( + headers['X-Forwarded-User-Agent']!, + ); } request.headers.addAll(headers); @@ -113,18 +116,26 @@ mixin ClientMixin { return Response(data: data); } - Future toResponse(http.StreamedResponse streamedResponse) async { - if(streamedResponse.statusCode == 204) { - return http.Response('', - streamedResponse.statusCode, - headers: streamedResponse.headers.map((k,v) => k.toLowerCase()=='content-type' ? MapEntry(k, 'text/plain') : MapEntry(k,v)), - request: streamedResponse.request, - isRedirect: streamedResponse.isRedirect, - persistentConnection: streamedResponse.persistentConnection, - reasonPhrase: streamedResponse.reasonPhrase, - ); - } else { - return await http.Response.fromStream(streamedResponse); - } + Future toResponse( + http.StreamedResponse streamedResponse, + ) async { + if (streamedResponse.statusCode == 204) { + return http.Response( + '', + streamedResponse.statusCode, + headers: streamedResponse.headers.map( + (k, v) => + k.toLowerCase() == 'content-type' + ? MapEntry(k, 'text/plain') + : MapEntry(k, v), + ), + request: streamedResponse.request, + isRedirect: streamedResponse.isRedirect, + persistentConnection: streamedResponse.persistentConnection, + reasonPhrase: streamedResponse.reasonPhrase, + ); + } else { + return await http.Response.fromStream(streamedResponse); + } } } diff --git a/lib/src/client_stub.dart b/lib/src/client_stub.dart index 95e9d217..2cb7727e 100644 --- a/lib/src/client_stub.dart +++ b/lib/src/client_stub.dart @@ -3,4 +3,5 @@ import 'client_base.dart'; /// Implemented in `browser_client.dart` and `io_client.dart`. ClientBase createClient({required String endPoint, required bool selfSigned}) => throw UnsupportedError( - 'Cannot create a client without dart:html or dart:io.'); + 'Cannot create a client without dart:html or dart:io.', + ); diff --git a/lib/src/enums.dart b/lib/src/enums.dart index 6566f2e1..08fd6068 100644 --- a/lib/src/enums.dart +++ b/lib/src/enums.dart @@ -17,5 +17,5 @@ enum ResponseType { plain, /// Get original bytes, the type of response will be List - bytes + bytes, } diff --git a/lib/src/enums/adapter.dart b/lib/src/enums/adapter.dart index 053080ef..d1af0722 100644 --- a/lib/src/enums/adapter.dart +++ b/lib/src/enums/adapter.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum Adapter { - static(value: 'static'), - ssr(value: 'ssr'); + static(value: 'static'), + ssr(value: 'ssr'); - const Adapter({ - required this.value - }); + const Adapter({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authentication_factor.dart b/lib/src/enums/authentication_factor.dart index 00d12830..1d5271eb 100644 --- a/lib/src/enums/authentication_factor.dart +++ b/lib/src/enums/authentication_factor.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum AuthenticationFactor { - email(value: 'email'), - phone(value: 'phone'), - totp(value: 'totp'), - recoverycode(value: 'recoverycode'); + email(value: 'email'), + phone(value: 'phone'), + totp(value: 'totp'), + recoverycode(value: 'recoverycode'); - const AuthenticationFactor({ - required this.value - }); + const AuthenticationFactor({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/authenticator_type.dart b/lib/src/enums/authenticator_type.dart index 10460393..c1fe8584 100644 --- a/lib/src/enums/authenticator_type.dart +++ b/lib/src/enums/authenticator_type.dart @@ -1,13 +1,11 @@ part of '../../enums.dart'; enum AuthenticatorType { - totp(value: 'totp'); + totp(value: 'totp'); - const AuthenticatorType({ - required this.value - }); + const AuthenticatorType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/browser.dart b/lib/src/enums/browser.dart index 386fa11d..949f4c47 100644 --- a/lib/src/enums/browser.dart +++ b/lib/src/enums/browser.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Browser { - avantBrowser(value: 'aa'), - androidWebViewBeta(value: 'an'), - googleChrome(value: 'ch'), - googleChromeIOS(value: 'ci'), - googleChromeMobile(value: 'cm'), - chromium(value: 'cr'), - mozillaFirefox(value: 'ff'), - safari(value: 'sf'), - mobileSafari(value: 'mf'), - microsoftEdge(value: 'ps'), - microsoftEdgeIOS(value: 'oi'), - operaMini(value: 'om'), - opera(value: 'op'), - operaNext(value: 'on'); + avantBrowser(value: 'aa'), + androidWebViewBeta(value: 'an'), + googleChrome(value: 'ch'), + googleChromeIOS(value: 'ci'), + googleChromeMobile(value: 'cm'), + chromium(value: 'cr'), + mozillaFirefox(value: 'ff'), + safari(value: 'sf'), + mobileSafari(value: 'mf'), + microsoftEdge(value: 'ps'), + microsoftEdgeIOS(value: 'oi'), + operaMini(value: 'om'), + opera(value: 'op'), + operaNext(value: 'on'); - const Browser({ - required this.value - }); + const Browser({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/build_runtime.dart b/lib/src/enums/build_runtime.dart index fdccfcbb..88ffbfa6 100644 --- a/lib/src/enums/build_runtime.dart +++ b/lib/src/enums/build_runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum BuildRuntime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const BuildRuntime({ - required this.value - }); + const BuildRuntime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/compression.dart b/lib/src/enums/compression.dart index 209acfb8..768930d9 100644 --- a/lib/src/enums/compression.dart +++ b/lib/src/enums/compression.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum Compression { - none(value: 'none'), - gzip(value: 'gzip'), - zstd(value: 'zstd'); + none(value: 'none'), + gzip(value: 'gzip'), + zstd(value: 'zstd'); - const Compression({ - required this.value - }); + const Compression({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/credit_card.dart b/lib/src/enums/credit_card.dart index cd45b6a1..1bae5c8a 100644 --- a/lib/src/enums/credit_card.dart +++ b/lib/src/enums/credit_card.dart @@ -1,29 +1,27 @@ part of '../../enums.dart'; enum CreditCard { - americanExpress(value: 'amex'), - argencard(value: 'argencard'), - cabal(value: 'cabal'), - cencosud(value: 'cencosud'), - dinersClub(value: 'diners'), - discover(value: 'discover'), - elo(value: 'elo'), - hipercard(value: 'hipercard'), - jCB(value: 'jcb'), - mastercard(value: 'mastercard'), - naranja(value: 'naranja'), - tarjetaShopping(value: 'targeta-shopping'), - unionChinaPay(value: 'union-china-pay'), - visa(value: 'visa'), - mIR(value: 'mir'), - maestro(value: 'maestro'), - rupay(value: 'rupay'); + americanExpress(value: 'amex'), + argencard(value: 'argencard'), + cabal(value: 'cabal'), + cencosud(value: 'cencosud'), + dinersClub(value: 'diners'), + discover(value: 'discover'), + elo(value: 'elo'), + hipercard(value: 'hipercard'), + jCB(value: 'jcb'), + mastercard(value: 'mastercard'), + naranja(value: 'naranja'), + tarjetaShopping(value: 'targeta-shopping'), + unionChinaPay(value: 'union-china-pay'), + visa(value: 'visa'), + mIR(value: 'mir'), + maestro(value: 'maestro'), + rupay(value: 'rupay'); - const CreditCard({ - required this.value - }); + const CreditCard({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/deployment_download_type.dart b/lib/src/enums/deployment_download_type.dart index 782b30c7..1788f892 100644 --- a/lib/src/enums/deployment_download_type.dart +++ b/lib/src/enums/deployment_download_type.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum DeploymentDownloadType { - source(value: 'source'), - output(value: 'output'); + source(value: 'source'), + output(value: 'output'); - const DeploymentDownloadType({ - required this.value - }); + const DeploymentDownloadType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/execution_method.dart b/lib/src/enums/execution_method.dart index 7d2d7016..42954430 100644 --- a/lib/src/enums/execution_method.dart +++ b/lib/src/enums/execution_method.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ExecutionMethod { - gET(value: 'GET'), - pOST(value: 'POST'), - pUT(value: 'PUT'), - pATCH(value: 'PATCH'), - dELETE(value: 'DELETE'), - oPTIONS(value: 'OPTIONS'); + gET(value: 'GET'), + pOST(value: 'POST'), + pUT(value: 'PUT'), + pATCH(value: 'PATCH'), + dELETE(value: 'DELETE'), + oPTIONS(value: 'OPTIONS'); - const ExecutionMethod({ - required this.value - }); + const ExecutionMethod({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/flag.dart b/lib/src/enums/flag.dart index 27c25cac..a44cb81d 100644 --- a/lib/src/enums/flag.dart +++ b/lib/src/enums/flag.dart @@ -1,207 +1,205 @@ part of '../../enums.dart'; enum Flag { - afghanistan(value: 'af'), - angola(value: 'ao'), - albania(value: 'al'), - andorra(value: 'ad'), - unitedArabEmirates(value: 'ae'), - argentina(value: 'ar'), - armenia(value: 'am'), - antiguaAndBarbuda(value: 'ag'), - australia(value: 'au'), - austria(value: 'at'), - azerbaijan(value: 'az'), - burundi(value: 'bi'), - belgium(value: 'be'), - benin(value: 'bj'), - burkinaFaso(value: 'bf'), - bangladesh(value: 'bd'), - bulgaria(value: 'bg'), - bahrain(value: 'bh'), - bahamas(value: 'bs'), - bosniaAndHerzegovina(value: 'ba'), - belarus(value: 'by'), - belize(value: 'bz'), - bolivia(value: 'bo'), - brazil(value: 'br'), - barbados(value: 'bb'), - bruneiDarussalam(value: 'bn'), - bhutan(value: 'bt'), - botswana(value: 'bw'), - centralAfricanRepublic(value: 'cf'), - canada(value: 'ca'), - switzerland(value: 'ch'), - chile(value: 'cl'), - china(value: 'cn'), - coteDIvoire(value: 'ci'), - cameroon(value: 'cm'), - democraticRepublicOfTheCongo(value: 'cd'), - republicOfTheCongo(value: 'cg'), - colombia(value: 'co'), - comoros(value: 'km'), - capeVerde(value: 'cv'), - costaRica(value: 'cr'), - cuba(value: 'cu'), - cyprus(value: 'cy'), - czechRepublic(value: 'cz'), - germany(value: 'de'), - djibouti(value: 'dj'), - dominica(value: 'dm'), - denmark(value: 'dk'), - dominicanRepublic(value: 'do'), - algeria(value: 'dz'), - ecuador(value: 'ec'), - egypt(value: 'eg'), - eritrea(value: 'er'), - spain(value: 'es'), - estonia(value: 'ee'), - ethiopia(value: 'et'), - finland(value: 'fi'), - fiji(value: 'fj'), - france(value: 'fr'), - micronesiaFederatedStatesOf(value: 'fm'), - gabon(value: 'ga'), - unitedKingdom(value: 'gb'), - georgia(value: 'ge'), - ghana(value: 'gh'), - guinea(value: 'gn'), - gambia(value: 'gm'), - guineaBissau(value: 'gw'), - equatorialGuinea(value: 'gq'), - greece(value: 'gr'), - grenada(value: 'gd'), - guatemala(value: 'gt'), - guyana(value: 'gy'), - honduras(value: 'hn'), - croatia(value: 'hr'), - haiti(value: 'ht'), - hungary(value: 'hu'), - indonesia(value: 'id'), - india(value: 'in'), - ireland(value: 'ie'), - iranIslamicRepublicOf(value: 'ir'), - iraq(value: 'iq'), - iceland(value: 'is'), - israel(value: 'il'), - italy(value: 'it'), - jamaica(value: 'jm'), - jordan(value: 'jo'), - japan(value: 'jp'), - kazakhstan(value: 'kz'), - kenya(value: 'ke'), - kyrgyzstan(value: 'kg'), - cambodia(value: 'kh'), - kiribati(value: 'ki'), - saintKittsAndNevis(value: 'kn'), - southKorea(value: 'kr'), - kuwait(value: 'kw'), - laoPeopleSDemocraticRepublic(value: 'la'), - lebanon(value: 'lb'), - liberia(value: 'lr'), - libya(value: 'ly'), - saintLucia(value: 'lc'), - liechtenstein(value: 'li'), - sriLanka(value: 'lk'), - lesotho(value: 'ls'), - lithuania(value: 'lt'), - luxembourg(value: 'lu'), - latvia(value: 'lv'), - morocco(value: 'ma'), - monaco(value: 'mc'), - moldova(value: 'md'), - madagascar(value: 'mg'), - maldives(value: 'mv'), - mexico(value: 'mx'), - marshallIslands(value: 'mh'), - northMacedonia(value: 'mk'), - mali(value: 'ml'), - malta(value: 'mt'), - myanmar(value: 'mm'), - montenegro(value: 'me'), - mongolia(value: 'mn'), - mozambique(value: 'mz'), - mauritania(value: 'mr'), - mauritius(value: 'mu'), - malawi(value: 'mw'), - malaysia(value: 'my'), - namibia(value: 'na'), - niger(value: 'ne'), - nigeria(value: 'ng'), - nicaragua(value: 'ni'), - netherlands(value: 'nl'), - norway(value: 'no'), - nepal(value: 'np'), - nauru(value: 'nr'), - newZealand(value: 'nz'), - oman(value: 'om'), - pakistan(value: 'pk'), - panama(value: 'pa'), - peru(value: 'pe'), - philippines(value: 'ph'), - palau(value: 'pw'), - papuaNewGuinea(value: 'pg'), - poland(value: 'pl'), - frenchPolynesia(value: 'pf'), - northKorea(value: 'kp'), - portugal(value: 'pt'), - paraguay(value: 'py'), - qatar(value: 'qa'), - romania(value: 'ro'), - russia(value: 'ru'), - rwanda(value: 'rw'), - saudiArabia(value: 'sa'), - sudan(value: 'sd'), - senegal(value: 'sn'), - singapore(value: 'sg'), - solomonIslands(value: 'sb'), - sierraLeone(value: 'sl'), - elSalvador(value: 'sv'), - sanMarino(value: 'sm'), - somalia(value: 'so'), - serbia(value: 'rs'), - southSudan(value: 'ss'), - saoTomeAndPrincipe(value: 'st'), - suriname(value: 'sr'), - slovakia(value: 'sk'), - slovenia(value: 'si'), - sweden(value: 'se'), - eswatini(value: 'sz'), - seychelles(value: 'sc'), - syria(value: 'sy'), - chad(value: 'td'), - togo(value: 'tg'), - thailand(value: 'th'), - tajikistan(value: 'tj'), - turkmenistan(value: 'tm'), - timorLeste(value: 'tl'), - tonga(value: 'to'), - trinidadAndTobago(value: 'tt'), - tunisia(value: 'tn'), - turkey(value: 'tr'), - tuvalu(value: 'tv'), - tanzania(value: 'tz'), - uganda(value: 'ug'), - ukraine(value: 'ua'), - uruguay(value: 'uy'), - unitedStates(value: 'us'), - uzbekistan(value: 'uz'), - vaticanCity(value: 'va'), - saintVincentAndTheGrenadines(value: 'vc'), - venezuela(value: 've'), - vietnam(value: 'vn'), - vanuatu(value: 'vu'), - samoa(value: 'ws'), - yemen(value: 'ye'), - southAfrica(value: 'za'), - zambia(value: 'zm'), - zimbabwe(value: 'zw'); + afghanistan(value: 'af'), + angola(value: 'ao'), + albania(value: 'al'), + andorra(value: 'ad'), + unitedArabEmirates(value: 'ae'), + argentina(value: 'ar'), + armenia(value: 'am'), + antiguaAndBarbuda(value: 'ag'), + australia(value: 'au'), + austria(value: 'at'), + azerbaijan(value: 'az'), + burundi(value: 'bi'), + belgium(value: 'be'), + benin(value: 'bj'), + burkinaFaso(value: 'bf'), + bangladesh(value: 'bd'), + bulgaria(value: 'bg'), + bahrain(value: 'bh'), + bahamas(value: 'bs'), + bosniaAndHerzegovina(value: 'ba'), + belarus(value: 'by'), + belize(value: 'bz'), + bolivia(value: 'bo'), + brazil(value: 'br'), + barbados(value: 'bb'), + bruneiDarussalam(value: 'bn'), + bhutan(value: 'bt'), + botswana(value: 'bw'), + centralAfricanRepublic(value: 'cf'), + canada(value: 'ca'), + switzerland(value: 'ch'), + chile(value: 'cl'), + china(value: 'cn'), + coteDIvoire(value: 'ci'), + cameroon(value: 'cm'), + democraticRepublicOfTheCongo(value: 'cd'), + republicOfTheCongo(value: 'cg'), + colombia(value: 'co'), + comoros(value: 'km'), + capeVerde(value: 'cv'), + costaRica(value: 'cr'), + cuba(value: 'cu'), + cyprus(value: 'cy'), + czechRepublic(value: 'cz'), + germany(value: 'de'), + djibouti(value: 'dj'), + dominica(value: 'dm'), + denmark(value: 'dk'), + dominicanRepublic(value: 'do'), + algeria(value: 'dz'), + ecuador(value: 'ec'), + egypt(value: 'eg'), + eritrea(value: 'er'), + spain(value: 'es'), + estonia(value: 'ee'), + ethiopia(value: 'et'), + finland(value: 'fi'), + fiji(value: 'fj'), + france(value: 'fr'), + micronesiaFederatedStatesOf(value: 'fm'), + gabon(value: 'ga'), + unitedKingdom(value: 'gb'), + georgia(value: 'ge'), + ghana(value: 'gh'), + guinea(value: 'gn'), + gambia(value: 'gm'), + guineaBissau(value: 'gw'), + equatorialGuinea(value: 'gq'), + greece(value: 'gr'), + grenada(value: 'gd'), + guatemala(value: 'gt'), + guyana(value: 'gy'), + honduras(value: 'hn'), + croatia(value: 'hr'), + haiti(value: 'ht'), + hungary(value: 'hu'), + indonesia(value: 'id'), + india(value: 'in'), + ireland(value: 'ie'), + iranIslamicRepublicOf(value: 'ir'), + iraq(value: 'iq'), + iceland(value: 'is'), + israel(value: 'il'), + italy(value: 'it'), + jamaica(value: 'jm'), + jordan(value: 'jo'), + japan(value: 'jp'), + kazakhstan(value: 'kz'), + kenya(value: 'ke'), + kyrgyzstan(value: 'kg'), + cambodia(value: 'kh'), + kiribati(value: 'ki'), + saintKittsAndNevis(value: 'kn'), + southKorea(value: 'kr'), + kuwait(value: 'kw'), + laoPeopleSDemocraticRepublic(value: 'la'), + lebanon(value: 'lb'), + liberia(value: 'lr'), + libya(value: 'ly'), + saintLucia(value: 'lc'), + liechtenstein(value: 'li'), + sriLanka(value: 'lk'), + lesotho(value: 'ls'), + lithuania(value: 'lt'), + luxembourg(value: 'lu'), + latvia(value: 'lv'), + morocco(value: 'ma'), + monaco(value: 'mc'), + moldova(value: 'md'), + madagascar(value: 'mg'), + maldives(value: 'mv'), + mexico(value: 'mx'), + marshallIslands(value: 'mh'), + northMacedonia(value: 'mk'), + mali(value: 'ml'), + malta(value: 'mt'), + myanmar(value: 'mm'), + montenegro(value: 'me'), + mongolia(value: 'mn'), + mozambique(value: 'mz'), + mauritania(value: 'mr'), + mauritius(value: 'mu'), + malawi(value: 'mw'), + malaysia(value: 'my'), + namibia(value: 'na'), + niger(value: 'ne'), + nigeria(value: 'ng'), + nicaragua(value: 'ni'), + netherlands(value: 'nl'), + norway(value: 'no'), + nepal(value: 'np'), + nauru(value: 'nr'), + newZealand(value: 'nz'), + oman(value: 'om'), + pakistan(value: 'pk'), + panama(value: 'pa'), + peru(value: 'pe'), + philippines(value: 'ph'), + palau(value: 'pw'), + papuaNewGuinea(value: 'pg'), + poland(value: 'pl'), + frenchPolynesia(value: 'pf'), + northKorea(value: 'kp'), + portugal(value: 'pt'), + paraguay(value: 'py'), + qatar(value: 'qa'), + romania(value: 'ro'), + russia(value: 'ru'), + rwanda(value: 'rw'), + saudiArabia(value: 'sa'), + sudan(value: 'sd'), + senegal(value: 'sn'), + singapore(value: 'sg'), + solomonIslands(value: 'sb'), + sierraLeone(value: 'sl'), + elSalvador(value: 'sv'), + sanMarino(value: 'sm'), + somalia(value: 'so'), + serbia(value: 'rs'), + southSudan(value: 'ss'), + saoTomeAndPrincipe(value: 'st'), + suriname(value: 'sr'), + slovakia(value: 'sk'), + slovenia(value: 'si'), + sweden(value: 'se'), + eswatini(value: 'sz'), + seychelles(value: 'sc'), + syria(value: 'sy'), + chad(value: 'td'), + togo(value: 'tg'), + thailand(value: 'th'), + tajikistan(value: 'tj'), + turkmenistan(value: 'tm'), + timorLeste(value: 'tl'), + tonga(value: 'to'), + trinidadAndTobago(value: 'tt'), + tunisia(value: 'tn'), + turkey(value: 'tr'), + tuvalu(value: 'tv'), + tanzania(value: 'tz'), + uganda(value: 'ug'), + ukraine(value: 'ua'), + uruguay(value: 'uy'), + unitedStates(value: 'us'), + uzbekistan(value: 'uz'), + vaticanCity(value: 'va'), + saintVincentAndTheGrenadines(value: 'vc'), + venezuela(value: 've'), + vietnam(value: 'vn'), + vanuatu(value: 'vu'), + samoa(value: 'ws'), + yemen(value: 'ye'), + southAfrica(value: 'za'), + zambia(value: 'zm'), + zimbabwe(value: 'zw'); - const Flag({ - required this.value - }); + const Flag({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/framework.dart b/lib/src/enums/framework.dart index af5ebaad..e20f48c6 100644 --- a/lib/src/enums/framework.dart +++ b/lib/src/enums/framework.dart @@ -1,26 +1,24 @@ part of '../../enums.dart'; enum Framework { - analog(value: 'analog'), - angular(value: 'angular'), - nextjs(value: 'nextjs'), - react(value: 'react'), - nuxt(value: 'nuxt'), - vue(value: 'vue'), - sveltekit(value: 'sveltekit'), - astro(value: 'astro'), - remix(value: 'remix'), - lynx(value: 'lynx'), - flutter(value: 'flutter'), - reactNative(value: 'react-native'), - vite(value: 'vite'), - other(value: 'other'); + analog(value: 'analog'), + angular(value: 'angular'), + nextjs(value: 'nextjs'), + react(value: 'react'), + nuxt(value: 'nuxt'), + vue(value: 'vue'), + sveltekit(value: 'sveltekit'), + astro(value: 'astro'), + remix(value: 'remix'), + lynx(value: 'lynx'), + flutter(value: 'flutter'), + reactNative(value: 'react-native'), + vite(value: 'vite'), + other(value: 'other'); - const Framework({ - required this.value - }); + const Framework({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_format.dart b/lib/src/enums/image_format.dart index dbf6825e..120c93f4 100644 --- a/lib/src/enums/image_format.dart +++ b/lib/src/enums/image_format.dart @@ -1,18 +1,16 @@ part of '../../enums.dart'; enum ImageFormat { - jpg(value: 'jpg'), - jpeg(value: 'jpeg'), - png(value: 'png'), - webp(value: 'webp'), - heic(value: 'heic'), - avif(value: 'avif'); + jpg(value: 'jpg'), + jpeg(value: 'jpeg'), + png(value: 'png'), + webp(value: 'webp'), + heic(value: 'heic'), + avif(value: 'avif'); - const ImageFormat({ - required this.value - }); + const ImageFormat({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/image_gravity.dart b/lib/src/enums/image_gravity.dart index 79bc4d62..88029044 100644 --- a/lib/src/enums/image_gravity.dart +++ b/lib/src/enums/image_gravity.dart @@ -1,21 +1,19 @@ part of '../../enums.dart'; enum ImageGravity { - center(value: 'center'), - topLeft(value: 'top-left'), - top(value: 'top'), - topRight(value: 'top-right'), - left(value: 'left'), - right(value: 'right'), - bottomLeft(value: 'bottom-left'), - bottom(value: 'bottom'), - bottomRight(value: 'bottom-right'); + center(value: 'center'), + topLeft(value: 'top-left'), + top(value: 'top'), + topRight(value: 'top-right'), + left(value: 'left'), + right(value: 'right'), + bottomLeft(value: 'bottom-left'), + bottom(value: 'bottom'), + bottomRight(value: 'bottom-right'); - const ImageGravity({ - required this.value - }); + const ImageGravity({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/index_type.dart b/lib/src/enums/index_type.dart index 8d86530d..b101d35f 100644 --- a/lib/src/enums/index_type.dart +++ b/lib/src/enums/index_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum IndexType { - key(value: 'key'), - fulltext(value: 'fulltext'), - unique(value: 'unique'); + key(value: 'key'), + fulltext(value: 'fulltext'), + unique(value: 'unique'); - const IndexType({ - required this.value - }); + const IndexType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/message_priority.dart b/lib/src/enums/message_priority.dart index 375913e8..a07e6f76 100644 --- a/lib/src/enums/message_priority.dart +++ b/lib/src/enums/message_priority.dart @@ -1,14 +1,12 @@ part of '../../enums.dart'; enum MessagePriority { - normal(value: 'normal'), - high(value: 'high'); + normal(value: 'normal'), + high(value: 'high'); - const MessagePriority({ - required this.value - }); + const MessagePriority({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/messaging_provider_type.dart b/lib/src/enums/messaging_provider_type.dart index a6859648..c69bf01e 100644 --- a/lib/src/enums/messaging_provider_type.dart +++ b/lib/src/enums/messaging_provider_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum MessagingProviderType { - email(value: 'email'), - sms(value: 'sms'), - push(value: 'push'); + email(value: 'email'), + sms(value: 'sms'), + push(value: 'push'); - const MessagingProviderType({ - required this.value - }); + const MessagingProviderType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/name.dart b/lib/src/enums/name.dart index 613bf5f1..74823feb 100644 --- a/lib/src/enums/name.dart +++ b/lib/src/enums/name.dart @@ -1,24 +1,22 @@ part of '../../enums.dart'; enum Name { - v1Database(value: 'v1-database'), - v1Deletes(value: 'v1-deletes'), - v1Audits(value: 'v1-audits'), - v1Mails(value: 'v1-mails'), - v1Functions(value: 'v1-functions'), - v1StatsResources(value: 'v1-stats-resources'), - v1StatsUsage(value: 'v1-stats-usage'), - v1Webhooks(value: 'v1-webhooks'), - v1Certificates(value: 'v1-certificates'), - v1Builds(value: 'v1-builds'), - v1Messaging(value: 'v1-messaging'), - v1Migrations(value: 'v1-migrations'); + v1Database(value: 'v1-database'), + v1Deletes(value: 'v1-deletes'), + v1Audits(value: 'v1-audits'), + v1Mails(value: 'v1-mails'), + v1Functions(value: 'v1-functions'), + v1StatsResources(value: 'v1-stats-resources'), + v1StatsUsage(value: 'v1-stats-usage'), + v1Webhooks(value: 'v1-webhooks'), + v1Certificates(value: 'v1-certificates'), + v1Builds(value: 'v1-builds'), + v1Messaging(value: 'v1-messaging'), + v1Migrations(value: 'v1-migrations'); - const Name({ - required this.value - }); + const Name({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/o_auth_provider.dart b/lib/src/enums/o_auth_provider.dart index 076c1c50..383e45b1 100644 --- a/lib/src/enums/o_auth_provider.dart +++ b/lib/src/enums/o_auth_provider.dart @@ -1,52 +1,50 @@ part of '../../enums.dart'; enum OAuthProvider { - amazon(value: 'amazon'), - apple(value: 'apple'), - auth0(value: 'auth0'), - authentik(value: 'authentik'), - autodesk(value: 'autodesk'), - bitbucket(value: 'bitbucket'), - bitly(value: 'bitly'), - box(value: 'box'), - dailymotion(value: 'dailymotion'), - discord(value: 'discord'), - disqus(value: 'disqus'), - dropbox(value: 'dropbox'), - etsy(value: 'etsy'), - facebook(value: 'facebook'), - figma(value: 'figma'), - github(value: 'github'), - gitlab(value: 'gitlab'), - google(value: 'google'), - linkedin(value: 'linkedin'), - microsoft(value: 'microsoft'), - notion(value: 'notion'), - oidc(value: 'oidc'), - okta(value: 'okta'), - paypal(value: 'paypal'), - paypalSandbox(value: 'paypalSandbox'), - podio(value: 'podio'), - salesforce(value: 'salesforce'), - slack(value: 'slack'), - spotify(value: 'spotify'), - stripe(value: 'stripe'), - tradeshift(value: 'tradeshift'), - tradeshiftBox(value: 'tradeshiftBox'), - twitch(value: 'twitch'), - wordpress(value: 'wordpress'), - yahoo(value: 'yahoo'), - yammer(value: 'yammer'), - yandex(value: 'yandex'), - zoho(value: 'zoho'), - zoom(value: 'zoom'), - mock(value: 'mock'); + amazon(value: 'amazon'), + apple(value: 'apple'), + auth0(value: 'auth0'), + authentik(value: 'authentik'), + autodesk(value: 'autodesk'), + bitbucket(value: 'bitbucket'), + bitly(value: 'bitly'), + box(value: 'box'), + dailymotion(value: 'dailymotion'), + discord(value: 'discord'), + disqus(value: 'disqus'), + dropbox(value: 'dropbox'), + etsy(value: 'etsy'), + facebook(value: 'facebook'), + figma(value: 'figma'), + github(value: 'github'), + gitlab(value: 'gitlab'), + google(value: 'google'), + linkedin(value: 'linkedin'), + microsoft(value: 'microsoft'), + notion(value: 'notion'), + oidc(value: 'oidc'), + okta(value: 'okta'), + paypal(value: 'paypal'), + paypalSandbox(value: 'paypalSandbox'), + podio(value: 'podio'), + salesforce(value: 'salesforce'), + slack(value: 'slack'), + spotify(value: 'spotify'), + stripe(value: 'stripe'), + tradeshift(value: 'tradeshift'), + tradeshiftBox(value: 'tradeshiftBox'), + twitch(value: 'twitch'), + wordpress(value: 'wordpress'), + yahoo(value: 'yahoo'), + yammer(value: 'yammer'), + yandex(value: 'yandex'), + zoho(value: 'zoho'), + zoom(value: 'zoom'), + mock(value: 'mock'); - const OAuthProvider({ - required this.value - }); + const OAuthProvider({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/password_hash.dart b/lib/src/enums/password_hash.dart index 510ee260..9d98c26a 100644 --- a/lib/src/enums/password_hash.dart +++ b/lib/src/enums/password_hash.dart @@ -1,23 +1,21 @@ part of '../../enums.dart'; enum PasswordHash { - sha1(value: 'sha1'), - sha224(value: 'sha224'), - sha256(value: 'sha256'), - sha384(value: 'sha384'), - sha512224(value: 'sha512/224'), - sha512256(value: 'sha512/256'), - sha512(value: 'sha512'), - sha3224(value: 'sha3-224'), - sha3256(value: 'sha3-256'), - sha3384(value: 'sha3-384'), - sha3512(value: 'sha3-512'); + sha1(value: 'sha1'), + sha224(value: 'sha224'), + sha256(value: 'sha256'), + sha384(value: 'sha384'), + sha512224(value: 'sha512/224'), + sha512256(value: 'sha512/256'), + sha512(value: 'sha512'), + sha3224(value: 'sha3-224'), + sha3256(value: 'sha3-256'), + sha3384(value: 'sha3-384'), + sha3512(value: 'sha3-512'); - const PasswordHash({ - required this.value - }); + const PasswordHash({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relation_mutate.dart b/lib/src/enums/relation_mutate.dart index 9f4c1a85..b215a8fa 100644 --- a/lib/src/enums/relation_mutate.dart +++ b/lib/src/enums/relation_mutate.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum RelationMutate { - cascade(value: 'cascade'), - restrict(value: 'restrict'), - setNull(value: 'setNull'); + cascade(value: 'cascade'), + restrict(value: 'restrict'), + setNull(value: 'setNull'); - const RelationMutate({ - required this.value - }); + const RelationMutate({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/relationship_type.dart b/lib/src/enums/relationship_type.dart index 301bc61d..30efc944 100644 --- a/lib/src/enums/relationship_type.dart +++ b/lib/src/enums/relationship_type.dart @@ -1,16 +1,14 @@ part of '../../enums.dart'; enum RelationshipType { - oneToOne(value: 'oneToOne'), - manyToOne(value: 'manyToOne'), - manyToMany(value: 'manyToMany'), - oneToMany(value: 'oneToMany'); + oneToOne(value: 'oneToOne'), + manyToOne(value: 'manyToOne'), + manyToMany(value: 'manyToMany'), + oneToMany(value: 'oneToMany'); - const RelationshipType({ - required this.value - }); + const RelationshipType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/runtime.dart b/lib/src/enums/runtime.dart index a0ff38c8..fec56a9b 100644 --- a/lib/src/enums/runtime.dart +++ b/lib/src/enums/runtime.dart @@ -1,75 +1,73 @@ part of '../../enums.dart'; enum Runtime { - node145(value: 'node-14.5'), - node160(value: 'node-16.0'), - node180(value: 'node-18.0'), - node190(value: 'node-19.0'), - node200(value: 'node-20.0'), - node210(value: 'node-21.0'), - node22(value: 'node-22'), - php80(value: 'php-8.0'), - php81(value: 'php-8.1'), - php82(value: 'php-8.2'), - php83(value: 'php-8.3'), - ruby30(value: 'ruby-3.0'), - ruby31(value: 'ruby-3.1'), - ruby32(value: 'ruby-3.2'), - ruby33(value: 'ruby-3.3'), - python38(value: 'python-3.8'), - python39(value: 'python-3.9'), - python310(value: 'python-3.10'), - python311(value: 'python-3.11'), - python312(value: 'python-3.12'), - pythonMl311(value: 'python-ml-3.11'), - pythonMl312(value: 'python-ml-3.12'), - deno121(value: 'deno-1.21'), - deno124(value: 'deno-1.24'), - deno135(value: 'deno-1.35'), - deno140(value: 'deno-1.40'), - deno146(value: 'deno-1.46'), - deno20(value: 'deno-2.0'), - dart215(value: 'dart-2.15'), - dart216(value: 'dart-2.16'), - dart217(value: 'dart-2.17'), - dart218(value: 'dart-2.18'), - dart219(value: 'dart-2.19'), - dart30(value: 'dart-3.0'), - dart31(value: 'dart-3.1'), - dart33(value: 'dart-3.3'), - dart35(value: 'dart-3.5'), - dotnet60(value: 'dotnet-6.0'), - dotnet70(value: 'dotnet-7.0'), - dotnet80(value: 'dotnet-8.0'), - java80(value: 'java-8.0'), - java110(value: 'java-11.0'), - java170(value: 'java-17.0'), - java180(value: 'java-18.0'), - java210(value: 'java-21.0'), - java22(value: 'java-22'), - swift55(value: 'swift-5.5'), - swift58(value: 'swift-5.8'), - swift59(value: 'swift-5.9'), - swift510(value: 'swift-5.10'), - kotlin16(value: 'kotlin-1.6'), - kotlin18(value: 'kotlin-1.8'), - kotlin19(value: 'kotlin-1.9'), - kotlin20(value: 'kotlin-2.0'), - cpp17(value: 'cpp-17'), - cpp20(value: 'cpp-20'), - bun10(value: 'bun-1.0'), - bun11(value: 'bun-1.1'), - go123(value: 'go-1.23'), - static1(value: 'static-1'), - flutter324(value: 'flutter-3.24'), - flutter327(value: 'flutter-3.27'), - flutter329(value: 'flutter-3.29'); + node145(value: 'node-14.5'), + node160(value: 'node-16.0'), + node180(value: 'node-18.0'), + node190(value: 'node-19.0'), + node200(value: 'node-20.0'), + node210(value: 'node-21.0'), + node22(value: 'node-22'), + php80(value: 'php-8.0'), + php81(value: 'php-8.1'), + php82(value: 'php-8.2'), + php83(value: 'php-8.3'), + ruby30(value: 'ruby-3.0'), + ruby31(value: 'ruby-3.1'), + ruby32(value: 'ruby-3.2'), + ruby33(value: 'ruby-3.3'), + python38(value: 'python-3.8'), + python39(value: 'python-3.9'), + python310(value: 'python-3.10'), + python311(value: 'python-3.11'), + python312(value: 'python-3.12'), + pythonMl311(value: 'python-ml-3.11'), + pythonMl312(value: 'python-ml-3.12'), + deno121(value: 'deno-1.21'), + deno124(value: 'deno-1.24'), + deno135(value: 'deno-1.35'), + deno140(value: 'deno-1.40'), + deno146(value: 'deno-1.46'), + deno20(value: 'deno-2.0'), + dart215(value: 'dart-2.15'), + dart216(value: 'dart-2.16'), + dart217(value: 'dart-2.17'), + dart218(value: 'dart-2.18'), + dart219(value: 'dart-2.19'), + dart30(value: 'dart-3.0'), + dart31(value: 'dart-3.1'), + dart33(value: 'dart-3.3'), + dart35(value: 'dart-3.5'), + dotnet60(value: 'dotnet-6.0'), + dotnet70(value: 'dotnet-7.0'), + dotnet80(value: 'dotnet-8.0'), + java80(value: 'java-8.0'), + java110(value: 'java-11.0'), + java170(value: 'java-17.0'), + java180(value: 'java-18.0'), + java210(value: 'java-21.0'), + java22(value: 'java-22'), + swift55(value: 'swift-5.5'), + swift58(value: 'swift-5.8'), + swift59(value: 'swift-5.9'), + swift510(value: 'swift-5.10'), + kotlin16(value: 'kotlin-1.6'), + kotlin18(value: 'kotlin-1.8'), + kotlin19(value: 'kotlin-1.9'), + kotlin20(value: 'kotlin-2.0'), + cpp17(value: 'cpp-17'), + cpp20(value: 'cpp-20'), + bun10(value: 'bun-1.0'), + bun11(value: 'bun-1.1'), + go123(value: 'go-1.23'), + static1(value: 'static-1'), + flutter324(value: 'flutter-3.24'), + flutter327(value: 'flutter-3.27'), + flutter329(value: 'flutter-3.29'); - const Runtime({ - required this.value - }); + const Runtime({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/smtp_encryption.dart b/lib/src/enums/smtp_encryption.dart index 6c880ed6..cb6cee26 100644 --- a/lib/src/enums/smtp_encryption.dart +++ b/lib/src/enums/smtp_encryption.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum SmtpEncryption { - none(value: 'none'), - ssl(value: 'ssl'), - tls(value: 'tls'); + none(value: 'none'), + ssl(value: 'ssl'), + tls(value: 'tls'); - const SmtpEncryption({ - required this.value - }); + const SmtpEncryption({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/enums/vcs_deployment_type.dart b/lib/src/enums/vcs_deployment_type.dart index 0bf8e2ad..f01fcb01 100644 --- a/lib/src/enums/vcs_deployment_type.dart +++ b/lib/src/enums/vcs_deployment_type.dart @@ -1,15 +1,13 @@ part of '../../enums.dart'; enum VCSDeploymentType { - branch(value: 'branch'), - commit(value: 'commit'), - tag(value: 'tag'); + branch(value: 'branch'), + commit(value: 'commit'), + tag(value: 'tag'); - const VCSDeploymentType({ - required this.value - }); + const VCSDeploymentType({required this.value}); - final String value; + final String value; - String toJson() => value; -} \ No newline at end of file + String toJson() => value; +} diff --git a/lib/src/exception.dart b/lib/src/exception.dart index 93b6ee3d..82229daa 100644 --- a/lib/src/exception.dart +++ b/lib/src/exception.dart @@ -13,7 +13,7 @@ class AppwriteException implements Exception { /// Initializes an Appwrite Exception. AppwriteException([this.message = "", this.code, this.type, this.response]); - + /// Returns the error type, message, and code. @override String toString() { diff --git a/lib/src/models/algo_argon2.dart b/lib/src/models/algo_argon2.dart index f174d569..4145f701 100644 --- a/lib/src/models/algo_argon2.dart +++ b/lib/src/models/algo_argon2.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoArgon2 class AlgoArgon2 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Memory used to compute hash. - final int memoryCost; + /// Memory used to compute hash. + final int memoryCost; - /// Amount of time consumed to compute hash - final int timeCost; + /// Amount of time consumed to compute hash + final int timeCost; - /// Number of threads used to compute hash. - final int threads; + /// Number of threads used to compute hash. + final int threads; - AlgoArgon2({ - required this.type, - required this.memoryCost, - required this.timeCost, - required this.threads, - }); + AlgoArgon2({ + required this.type, + required this.memoryCost, + required this.timeCost, + required this.threads, + }); - factory AlgoArgon2.fromMap(Map map) { - return AlgoArgon2( - type: map['type'].toString(), - memoryCost: map['memoryCost'], - timeCost: map['timeCost'], - threads: map['threads'], - ); - } + factory AlgoArgon2.fromMap(Map map) { + return AlgoArgon2( + type: map['type'].toString(), + memoryCost: map['memoryCost'], + timeCost: map['timeCost'], + threads: map['threads'], + ); + } - Map toMap() { - return { - "type": type, - "memoryCost": memoryCost, - "timeCost": timeCost, - "threads": threads, - }; - } + Map toMap() { + return { + "type": type, + "memoryCost": memoryCost, + "timeCost": timeCost, + "threads": threads, + }; + } } diff --git a/lib/src/models/algo_bcrypt.dart b/lib/src/models/algo_bcrypt.dart index c9f67200..4e901476 100644 --- a/lib/src/models/algo_bcrypt.dart +++ b/lib/src/models/algo_bcrypt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoBcrypt class AlgoBcrypt implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoBcrypt({ - required this.type, - }); + AlgoBcrypt({required this.type}); - factory AlgoBcrypt.fromMap(Map map) { - return AlgoBcrypt( - type: map['type'].toString(), - ); - } + factory AlgoBcrypt.fromMap(Map map) { + return AlgoBcrypt(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_md5.dart b/lib/src/models/algo_md5.dart index 2fabb416..35c7b767 100644 --- a/lib/src/models/algo_md5.dart +++ b/lib/src/models/algo_md5.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoMD5 class AlgoMd5 implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoMd5({ - required this.type, - }); + AlgoMd5({required this.type}); - factory AlgoMd5.fromMap(Map map) { - return AlgoMd5( - type: map['type'].toString(), - ); - } + factory AlgoMd5.fromMap(Map map) { + return AlgoMd5(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_phpass.dart b/lib/src/models/algo_phpass.dart index fdcee07a..7d27adba 100644 --- a/lib/src/models/algo_phpass.dart +++ b/lib/src/models/algo_phpass.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoPHPass class AlgoPhpass implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoPhpass({ - required this.type, - }); + AlgoPhpass({required this.type}); - factory AlgoPhpass.fromMap(Map map) { - return AlgoPhpass( - type: map['type'].toString(), - ); - } + factory AlgoPhpass.fromMap(Map map) { + return AlgoPhpass(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/algo_scrypt.dart b/lib/src/models/algo_scrypt.dart index 120723df..fec6f65a 100644 --- a/lib/src/models/algo_scrypt.dart +++ b/lib/src/models/algo_scrypt.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// AlgoScrypt class AlgoScrypt implements Model { - /// Algo type. - final String type; - - /// CPU complexity of computed hash. - final int costCpu; - - /// Memory complexity of computed hash. - final int costMemory; - - /// Parallelization of computed hash. - final int costParallel; - - /// Length used to compute hash. - final int length; - - AlgoScrypt({ - required this.type, - required this.costCpu, - required this.costMemory, - required this.costParallel, - required this.length, - }); - - factory AlgoScrypt.fromMap(Map map) { - return AlgoScrypt( - type: map['type'].toString(), - costCpu: map['costCpu'], - costMemory: map['costMemory'], - costParallel: map['costParallel'], - length: map['length'], - ); - } - - Map toMap() { - return { - "type": type, - "costCpu": costCpu, - "costMemory": costMemory, - "costParallel": costParallel, - "length": length, - }; - } + /// Algo type. + final String type; + + /// CPU complexity of computed hash. + final int costCpu; + + /// Memory complexity of computed hash. + final int costMemory; + + /// Parallelization of computed hash. + final int costParallel; + + /// Length used to compute hash. + final int length; + + AlgoScrypt({ + required this.type, + required this.costCpu, + required this.costMemory, + required this.costParallel, + required this.length, + }); + + factory AlgoScrypt.fromMap(Map map) { + return AlgoScrypt( + type: map['type'].toString(), + costCpu: map['costCpu'], + costMemory: map['costMemory'], + costParallel: map['costParallel'], + length: map['length'], + ); + } + + Map toMap() { + return { + "type": type, + "costCpu": costCpu, + "costMemory": costMemory, + "costParallel": costParallel, + "length": length, + }; + } } diff --git a/lib/src/models/algo_scrypt_modified.dart b/lib/src/models/algo_scrypt_modified.dart index 504b5f8f..0e80700f 100644 --- a/lib/src/models/algo_scrypt_modified.dart +++ b/lib/src/models/algo_scrypt_modified.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// AlgoScryptModified class AlgoScryptModified implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - /// Salt used to compute hash. - final String salt; + /// Salt used to compute hash. + final String salt; - /// Separator used to compute hash. - final String saltSeparator; + /// Separator used to compute hash. + final String saltSeparator; - /// Key used to compute hash. - final String signerKey; + /// Key used to compute hash. + final String signerKey; - AlgoScryptModified({ - required this.type, - required this.salt, - required this.saltSeparator, - required this.signerKey, - }); + AlgoScryptModified({ + required this.type, + required this.salt, + required this.saltSeparator, + required this.signerKey, + }); - factory AlgoScryptModified.fromMap(Map map) { - return AlgoScryptModified( - type: map['type'].toString(), - salt: map['salt'].toString(), - saltSeparator: map['saltSeparator'].toString(), - signerKey: map['signerKey'].toString(), - ); - } + factory AlgoScryptModified.fromMap(Map map) { + return AlgoScryptModified( + type: map['type'].toString(), + salt: map['salt'].toString(), + saltSeparator: map['saltSeparator'].toString(), + signerKey: map['signerKey'].toString(), + ); + } - Map toMap() { - return { - "type": type, - "salt": salt, - "saltSeparator": saltSeparator, - "signerKey": signerKey, - }; - } + Map toMap() { + return { + "type": type, + "salt": salt, + "saltSeparator": saltSeparator, + "signerKey": signerKey, + }; + } } diff --git a/lib/src/models/algo_sha.dart b/lib/src/models/algo_sha.dart index 5f3e1654..bae6618f 100644 --- a/lib/src/models/algo_sha.dart +++ b/lib/src/models/algo_sha.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// AlgoSHA class AlgoSha implements Model { - /// Algo type. - final String type; + /// Algo type. + final String type; - AlgoSha({ - required this.type, - }); + AlgoSha({required this.type}); - factory AlgoSha.fromMap(Map map) { - return AlgoSha( - type: map['type'].toString(), - ); - } + factory AlgoSha.fromMap(Map map) { + return AlgoSha(type: map['type'].toString()); + } - Map toMap() { - return { - "type": type, - }; - } + Map toMap() { + return {"type": type}; + } } diff --git a/lib/src/models/attribute_boolean.dart b/lib/src/models/attribute_boolean.dart index 20dd7189..0ca54691 100644 --- a/lib/src/models/attribute_boolean.dart +++ b/lib/src/models/attribute_boolean.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// AttributeBoolean class AttributeBoolean implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final bool? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final bool? xdefault; - AttributeBoolean({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.xdefault, - }); + AttributeBoolean({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.xdefault, + }); - factory AttributeBoolean.fromMap(Map map) { - return AttributeBoolean( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - xdefault: map['default'], - ); - } + factory AttributeBoolean.fromMap(Map map) { + return AttributeBoolean( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_datetime.dart b/lib/src/models/attribute_datetime.dart index a5b27b4f..1df01f19 100644 --- a/lib/src/models/attribute_datetime.dart +++ b/lib/src/models/attribute_datetime.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeDatetime class AttributeDatetime implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// ISO 8601 format. - final String format; + /// ISO 8601 format. + final String format; - /// Default value for attribute when not provided. Only null is optional - final String? xdefault; + /// Default value for attribute when not provided. Only null is optional + final String? xdefault; - AttributeDatetime({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeDatetime({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeDatetime.fromMap(Map map) { - return AttributeDatetime( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeDatetime.fromMap(Map map) { + return AttributeDatetime( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_email.dart b/lib/src/models/attribute_email.dart index 96ce554b..21f8e9a3 100644 --- a/lib/src/models/attribute_email.dart +++ b/lib/src/models/attribute_email.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeEmail class AttributeEmail implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEmail({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeEmail({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeEmail.fromMap(Map map) { - return AttributeEmail( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEmail.fromMap(Map map) { + return AttributeEmail( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_enum.dart b/lib/src/models/attribute_enum.dart index a4953a0e..298c181a 100644 --- a/lib/src/models/attribute_enum.dart +++ b/lib/src/models/attribute_enum.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeEnum class AttributeEnum implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Array of elements in enumerated type. - final List elements; + /// Array of elements in enumerated type. + final List elements; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeEnum({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.elements, - required this.format, - this.xdefault, - }); + AttributeEnum({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.elements, + required this.format, + this.xdefault, + }); - factory AttributeEnum.fromMap(Map map) { - return AttributeEnum( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - elements: List.from(map['elements'] ?? []), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeEnum.fromMap(Map map) { + return AttributeEnum( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + elements: List.from(map['elements'] ?? []), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "elements": elements, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "elements": elements, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_float.dart b/lib/src/models/attribute_float.dart index 03ba94c7..c6eecadd 100644 --- a/lib/src/models/attribute_float.dart +++ b/lib/src/models/attribute_float.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeFloat class AttributeFloat implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final double? min; + /// Minimum value to enforce for new documents. + final double? min; - /// Maximum value to enforce for new documents. - final double? max; + /// Maximum value to enforce for new documents. + final double? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final double? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final double? xdefault; - AttributeFloat({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeFloat({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeFloat.fromMap(Map map) { - return AttributeFloat( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min']?.toDouble(), - max: map['max']?.toDouble(), - xdefault: map['default']?.toDouble(), - ); - } + factory AttributeFloat.fromMap(Map map) { + return AttributeFloat( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min']?.toDouble(), + max: map['max']?.toDouble(), + xdefault: map['default']?.toDouble(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_integer.dart b/lib/src/models/attribute_integer.dart index 8a5aa89d..1ef48332 100644 --- a/lib/src/models/attribute_integer.dart +++ b/lib/src/models/attribute_integer.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// AttributeInteger class AttributeInteger implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Minimum value to enforce for new documents. - final int? min; + /// Minimum value to enforce for new documents. + final int? min; - /// Maximum value to enforce for new documents. - final int? max; + /// Maximum value to enforce for new documents. + final int? max; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final int? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final int? xdefault; - AttributeInteger({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - this.min, - this.max, - this.xdefault, - }); + AttributeInteger({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + this.min, + this.max, + this.xdefault, + }); - factory AttributeInteger.fromMap(Map map) { - return AttributeInteger( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - min: map['min'], - max: map['max'], - xdefault: map['default'], - ); - } + factory AttributeInteger.fromMap(Map map) { + return AttributeInteger( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + min: map['min'], + max: map['max'], + xdefault: map['default'], + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "min": min, - "max": max, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "min": min, + "max": max, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_ip.dart b/lib/src/models/attribute_ip.dart index d17f414a..8c8fcb73 100644 --- a/lib/src/models/attribute_ip.dart +++ b/lib/src/models/attribute_ip.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeIP class AttributeIp implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeIp({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeIp({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeIp.fromMap(Map map) { - return AttributeIp( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeIp.fromMap(Map map) { + return AttributeIp( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_list.dart b/lib/src/models/attribute_list.dart index 4098a5a1..c5fa6adc 100644 --- a/lib/src/models/attribute_list.dart +++ b/lib/src/models/attribute_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Attributes List class AttributeList implements Model { - /// Total number of attributes in the given collection. - final int total; + /// Total number of attributes in the given collection. + final int total; - /// List of attributes. - final List attributes; + /// List of attributes. + final List attributes; - AttributeList({ - required this.total, - required this.attributes, - }); + AttributeList({required this.total, required this.attributes}); - factory AttributeList.fromMap(Map map) { - return AttributeList( - total: map['total'], - attributes: List.from(map['attributes'] ?? []), - ); - } + factory AttributeList.fromMap(Map map) { + return AttributeList( + total: map['total'], + attributes: List.from(map['attributes'] ?? []), + ); + } - Map toMap() { - return { - "total": total, - "attributes": attributes, - }; - } + Map toMap() { + return {"total": total, "attributes": attributes}; + } } diff --git a/lib/src/models/attribute_relationship.dart b/lib/src/models/attribute_relationship.dart index 050cbe14..903c6290 100644 --- a/lib/src/models/attribute_relationship.dart +++ b/lib/src/models/attribute_relationship.dart @@ -2,100 +2,100 @@ part of '../../models.dart'; /// AttributeRelationship class AttributeRelationship implements Model { - /// Attribute Key. - final String key; - - /// Attribute type. - final String type; - - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; - - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; - - /// Is attribute required? - final bool xrequired; - - /// Is attribute an array? - final bool? array; - - /// Attribute creation date in ISO 8601 format. - final String $createdAt; - - /// Attribute update date in ISO 8601 format. - final String $updatedAt; - - /// The ID of the related collection. - final String relatedCollection; - - /// The type of the relationship. - final String relationType; - - /// Is the relationship two-way? - final bool twoWay; - - /// The key of the two-way relationship. - final String twoWayKey; - - /// How deleting the parent document will propagate to child documents. - final String onDelete; - - /// Whether this is the parent or child side of the relationship - final String side; - - AttributeRelationship({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.relatedCollection, - required this.relationType, - required this.twoWay, - required this.twoWayKey, - required this.onDelete, - required this.side, - }); - - factory AttributeRelationship.fromMap(Map map) { - return AttributeRelationship( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - relatedCollection: map['relatedCollection'].toString(), - relationType: map['relationType'].toString(), - twoWay: map['twoWay'], - twoWayKey: map['twoWayKey'].toString(), - onDelete: map['onDelete'].toString(), - side: map['side'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "relatedCollection": relatedCollection, - "relationType": relationType, - "twoWay": twoWay, - "twoWayKey": twoWayKey, - "onDelete": onDelete, - "side": side, - }; - } + /// Attribute Key. + final String key; + + /// Attribute type. + final String type; + + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; + + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; + + /// Is attribute required? + final bool xrequired; + + /// Is attribute an array? + final bool? array; + + /// Attribute creation date in ISO 8601 format. + final String $createdAt; + + /// Attribute update date in ISO 8601 format. + final String $updatedAt; + + /// The ID of the related collection. + final String relatedCollection; + + /// The type of the relationship. + final String relationType; + + /// Is the relationship two-way? + final bool twoWay; + + /// The key of the two-way relationship. + final String twoWayKey; + + /// How deleting the parent document will propagate to child documents. + final String onDelete; + + /// Whether this is the parent or child side of the relationship + final String side; + + AttributeRelationship({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.relatedCollection, + required this.relationType, + required this.twoWay, + required this.twoWayKey, + required this.onDelete, + required this.side, + }); + + factory AttributeRelationship.fromMap(Map map) { + return AttributeRelationship( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + relatedCollection: map['relatedCollection'].toString(), + relationType: map['relationType'].toString(), + twoWay: map['twoWay'], + twoWayKey: map['twoWayKey'].toString(), + onDelete: map['onDelete'].toString(), + side: map['side'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "relatedCollection": relatedCollection, + "relationType": relationType, + "twoWay": twoWay, + "twoWayKey": twoWayKey, + "onDelete": onDelete, + "side": side, + }; + } } diff --git a/lib/src/models/attribute_string.dart b/lib/src/models/attribute_string.dart index 89de3a57..d32b6829 100644 --- a/lib/src/models/attribute_string.dart +++ b/lib/src/models/attribute_string.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeString class AttributeString implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// Attribute size. - final int size; + /// Attribute size. + final int size; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeString({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.size, - this.xdefault, - }); + AttributeString({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.size, + this.xdefault, + }); - factory AttributeString.fromMap(Map map) { - return AttributeString( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - size: map['size'], - xdefault: map['default']?.toString(), - ); - } + factory AttributeString.fromMap(Map map) { + return AttributeString( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + size: map['size'], + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "size": size, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "size": size, + "default": xdefault, + }; + } } diff --git a/lib/src/models/attribute_url.dart b/lib/src/models/attribute_url.dart index 0c3ddf9e..f0bc295e 100644 --- a/lib/src/models/attribute_url.dart +++ b/lib/src/models/attribute_url.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// AttributeURL class AttributeUrl implements Model { - /// Attribute Key. - final String key; + /// Attribute Key. + final String key; - /// Attribute type. - final String type; + /// Attribute type. + final String type; - /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an attribute. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an attribute. + final String error; - /// Is attribute required? - final bool xrequired; + /// Is attribute required? + final bool xrequired; - /// Is attribute an array? - final bool? array; + /// Is attribute an array? + final bool? array; - /// Attribute creation date in ISO 8601 format. - final String $createdAt; + /// Attribute creation date in ISO 8601 format. + final String $createdAt; - /// Attribute update date in ISO 8601 format. - final String $updatedAt; + /// Attribute update date in ISO 8601 format. + final String $updatedAt; - /// String format. - final String format; + /// String format. + final String format; - /// Default value for attribute when not provided. Cannot be set when attribute is required. - final String? xdefault; + /// Default value for attribute when not provided. Cannot be set when attribute is required. + final String? xdefault; - AttributeUrl({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.xrequired, - this.array, - required this.$createdAt, - required this.$updatedAt, - required this.format, - this.xdefault, - }); + AttributeUrl({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.xrequired, + this.array, + required this.$createdAt, + required this.$updatedAt, + required this.format, + this.xdefault, + }); - factory AttributeUrl.fromMap(Map map) { - return AttributeUrl( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - xrequired: map['required'], - array: map['array'], - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - format: map['format'].toString(), - xdefault: map['default']?.toString(), - ); - } + factory AttributeUrl.fromMap(Map map) { + return AttributeUrl( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + xrequired: map['required'], + array: map['array'], + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + format: map['format'].toString(), + xdefault: map['default']?.toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "required": xrequired, - "array": array, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "format": format, - "default": xdefault, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "required": xrequired, + "array": array, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "format": format, + "default": xdefault, + }; + } } diff --git a/lib/src/models/bucket.dart b/lib/src/models/bucket.dart index 3bb374be..b8fb5e48 100644 --- a/lib/src/models/bucket.dart +++ b/lib/src/models/bucket.dart @@ -2,88 +2,88 @@ part of '../../models.dart'; /// Bucket class Bucket implements Model { - /// Bucket ID. - final String $id; + /// Bucket ID. + final String $id; - /// Bucket creation time in ISO 8601 format. - final String $createdAt; + /// Bucket creation time in ISO 8601 format. + final String $createdAt; - /// Bucket update date in ISO 8601 format. - final String $updatedAt; + /// Bucket update date in ISO 8601 format. + final String $updatedAt; - /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Bucket permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool fileSecurity; + /// Whether file-level security is enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool fileSecurity; - /// Bucket name. - final String name; + /// Bucket name. + final String name; - /// Bucket enabled. - final bool enabled; + /// Bucket enabled. + final bool enabled; - /// Maximum file size supported. - final int maximumFileSize; + /// Maximum file size supported. + final int maximumFileSize; - /// Allowed file extensions. - final List allowedFileExtensions; + /// Allowed file extensions. + final List allowedFileExtensions; - /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). - final String compression; + /// Compression algorithm choosen for compression. Will be one of none, [gzip](https://en.wikipedia.org/wiki/Gzip), or [zstd](https://en.wikipedia.org/wiki/Zstd). + final String compression; - /// Bucket is encrypted. - final bool encryption; + /// Bucket is encrypted. + final bool encryption; - /// Virus scanning is enabled. - final bool antivirus; + /// Virus scanning is enabled. + final bool antivirus; - Bucket({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.fileSecurity, - required this.name, - required this.enabled, - required this.maximumFileSize, - required this.allowedFileExtensions, - required this.compression, - required this.encryption, - required this.antivirus, - }); + Bucket({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.fileSecurity, + required this.name, + required this.enabled, + required this.maximumFileSize, + required this.allowedFileExtensions, + required this.compression, + required this.encryption, + required this.antivirus, + }); - factory Bucket.fromMap(Map map) { - return Bucket( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - fileSecurity: map['fileSecurity'], - name: map['name'].toString(), - enabled: map['enabled'], - maximumFileSize: map['maximumFileSize'], - allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), - compression: map['compression'].toString(), - encryption: map['encryption'], - antivirus: map['antivirus'], - ); - } + factory Bucket.fromMap(Map map) { + return Bucket( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + fileSecurity: map['fileSecurity'], + name: map['name'].toString(), + enabled: map['enabled'], + maximumFileSize: map['maximumFileSize'], + allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []), + compression: map['compression'].toString(), + encryption: map['encryption'], + antivirus: map['antivirus'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "fileSecurity": fileSecurity, - "name": name, - "enabled": enabled, - "maximumFileSize": maximumFileSize, - "allowedFileExtensions": allowedFileExtensions, - "compression": compression, - "encryption": encryption, - "antivirus": antivirus, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "fileSecurity": fileSecurity, + "name": name, + "enabled": enabled, + "maximumFileSize": maximumFileSize, + "allowedFileExtensions": allowedFileExtensions, + "compression": compression, + "encryption": encryption, + "antivirus": antivirus, + }; + } } diff --git a/lib/src/models/bucket_list.dart b/lib/src/models/bucket_list.dart index 366d80f9..224c910d 100644 --- a/lib/src/models/bucket_list.dart +++ b/lib/src/models/bucket_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Buckets List class BucketList implements Model { - /// Total number of buckets documents that matched your query. - final int total; + /// Total number of buckets documents that matched your query. + final int total; - /// List of buckets. - final List buckets; + /// List of buckets. + final List buckets; - BucketList({ - required this.total, - required this.buckets, - }); + BucketList({required this.total, required this.buckets}); - factory BucketList.fromMap(Map map) { - return BucketList( - total: map['total'], - buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), - ); - } + factory BucketList.fromMap(Map map) { + return BucketList( + total: map['total'], + buckets: List.from(map['buckets'].map((p) => Bucket.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "buckets": buckets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "buckets": buckets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/collection.dart b/lib/src/models/collection.dart index c55110cf..72de429d 100644 --- a/lib/src/models/collection.dart +++ b/lib/src/models/collection.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Collection class Collection implements Model { - /// Collection ID. - final String $id; + /// Collection ID. + final String $id; - /// Collection creation date in ISO 8601 format. - final String $createdAt; + /// Collection creation date in ISO 8601 format. + final String $createdAt; - /// Collection update date in ISO 8601 format. - final String $updatedAt; + /// Collection update date in ISO 8601 format. + final String $updatedAt; - /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// Collection permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// Database ID. - final String databaseId; + /// Database ID. + final String databaseId; - /// Collection name. - final String name; + /// Collection name. + final String name; - /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; + /// Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; - /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). - final bool documentSecurity; + /// Whether document-level permissions are enabled. [Learn more about permissions](https://appwrite.io/docs/permissions). + final bool documentSecurity; - /// Collection attributes. - final List attributes; + /// Collection attributes. + final List attributes; - /// Collection indexes. - final List indexes; + /// Collection indexes. + final List indexes; - Collection({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.databaseId, - required this.name, - required this.enabled, - required this.documentSecurity, - required this.attributes, - required this.indexes, - }); + Collection({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.databaseId, + required this.name, + required this.enabled, + required this.documentSecurity, + required this.attributes, + required this.indexes, + }); - factory Collection.fromMap(Map map) { - return Collection( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - databaseId: map['databaseId'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - documentSecurity: map['documentSecurity'], - attributes: List.from(map['attributes'] ?? []), - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory Collection.fromMap(Map map) { + return Collection( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + databaseId: map['databaseId'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + documentSecurity: map['documentSecurity'], + attributes: List.from(map['attributes'] ?? []), + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "databaseId": databaseId, - "name": name, - "enabled": enabled, - "documentSecurity": documentSecurity, - "attributes": attributes, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "databaseId": databaseId, + "name": name, + "enabled": enabled, + "documentSecurity": documentSecurity, + "attributes": attributes, + "indexes": indexes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/collection_list.dart b/lib/src/models/collection_list.dart index aad4d44a..49785e2b 100644 --- a/lib/src/models/collection_list.dart +++ b/lib/src/models/collection_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Collections List class CollectionList implements Model { - /// Total number of collections documents that matched your query. - final int total; + /// Total number of collections documents that matched your query. + final int total; - /// List of collections. - final List collections; + /// List of collections. + final List collections; - CollectionList({ - required this.total, - required this.collections, - }); + CollectionList({required this.total, required this.collections}); - factory CollectionList.fromMap(Map map) { - return CollectionList( - total: map['total'], - collections: List.from(map['collections'].map((p) => Collection.fromMap(p))), - ); - } + factory CollectionList.fromMap(Map map) { + return CollectionList( + total: map['total'], + collections: List.from( + map['collections'].map((p) => Collection.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "collections": collections.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "collections": collections.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/continent.dart b/lib/src/models/continent.dart index 1a9c5038..7318b7ad 100644 --- a/lib/src/models/continent.dart +++ b/lib/src/models/continent.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Continent class Continent implements Model { - /// Continent name. - final String name; + /// Continent name. + final String name; - /// Continent two letter code. - final String code; + /// Continent two letter code. + final String code; - Continent({ - required this.name, - required this.code, - }); + Continent({required this.name, required this.code}); - factory Continent.fromMap(Map map) { - return Continent( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Continent.fromMap(Map map) { + return Continent( + name: map['name'].toString(), + code: map['code'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/continent_list.dart b/lib/src/models/continent_list.dart index 7a1eb84c..2c605d3b 100644 --- a/lib/src/models/continent_list.dart +++ b/lib/src/models/continent_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Continents List class ContinentList implements Model { - /// Total number of continents documents that matched your query. - final int total; + /// Total number of continents documents that matched your query. + final int total; - /// List of continents. - final List continents; + /// List of continents. + final List continents; - ContinentList({ - required this.total, - required this.continents, - }); + ContinentList({required this.total, required this.continents}); - factory ContinentList.fromMap(Map map) { - return ContinentList( - total: map['total'], - continents: List.from(map['continents'].map((p) => Continent.fromMap(p))), - ); - } + factory ContinentList.fromMap(Map map) { + return ContinentList( + total: map['total'], + continents: List.from( + map['continents'].map((p) => Continent.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "continents": continents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "continents": continents.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/country.dart b/lib/src/models/country.dart index 565b1d66..c52b50f2 100644 --- a/lib/src/models/country.dart +++ b/lib/src/models/country.dart @@ -2,28 +2,19 @@ part of '../../models.dart'; /// Country class Country implements Model { - /// Country name. - final String name; + /// Country name. + final String name; - /// Country two-character ISO 3166-1 alpha code. - final String code; + /// Country two-character ISO 3166-1 alpha code. + final String code; - Country({ - required this.name, - required this.code, - }); + Country({required this.name, required this.code}); - factory Country.fromMap(Map map) { - return Country( - name: map['name'].toString(), - code: map['code'].toString(), - ); - } + factory Country.fromMap(Map map) { + return Country(name: map['name'].toString(), code: map['code'].toString()); + } - Map toMap() { - return { - "name": name, - "code": code, - }; - } + Map toMap() { + return {"name": name, "code": code}; + } } diff --git a/lib/src/models/country_list.dart b/lib/src/models/country_list.dart index e0b8f29f..6ef8ec42 100644 --- a/lib/src/models/country_list.dart +++ b/lib/src/models/country_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Countries List class CountryList implements Model { - /// Total number of countries documents that matched your query. - final int total; + /// Total number of countries documents that matched your query. + final int total; - /// List of countries. - final List countries; + /// List of countries. + final List countries; - CountryList({ - required this.total, - required this.countries, - }); + CountryList({required this.total, required this.countries}); - factory CountryList.fromMap(Map map) { - return CountryList( - total: map['total'], - countries: List.from(map['countries'].map((p) => Country.fromMap(p))), - ); - } + factory CountryList.fromMap(Map map) { + return CountryList( + total: map['total'], + countries: List.from( + map['countries'].map((p) => Country.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "countries": countries.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "countries": countries.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/currency.dart b/lib/src/models/currency.dart index deafffe3..27eef0c1 100644 --- a/lib/src/models/currency.dart +++ b/lib/src/models/currency.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Currency class Currency implements Model { - /// Currency symbol. - final String symbol; - - /// Currency name. - final String name; - - /// Currency native symbol. - final String symbolNative; - - /// Number of decimal digits. - final int decimalDigits; - - /// Currency digit rounding. - final double rounding; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. - final String code; - - /// Currency plural name - final String namePlural; - - Currency({ - required this.symbol, - required this.name, - required this.symbolNative, - required this.decimalDigits, - required this.rounding, - required this.code, - required this.namePlural, - }); - - factory Currency.fromMap(Map map) { - return Currency( - symbol: map['symbol'].toString(), - name: map['name'].toString(), - symbolNative: map['symbolNative'].toString(), - decimalDigits: map['decimalDigits'], - rounding: map['rounding'].toDouble(), - code: map['code'].toString(), - namePlural: map['namePlural'].toString(), - ); - } - - Map toMap() { - return { - "symbol": symbol, - "name": name, - "symbolNative": symbolNative, - "decimalDigits": decimalDigits, - "rounding": rounding, - "code": code, - "namePlural": namePlural, - }; - } + /// Currency symbol. + final String symbol; + + /// Currency name. + final String name; + + /// Currency native symbol. + final String symbolNative; + + /// Number of decimal digits. + final int decimalDigits; + + /// Currency digit rounding. + final double rounding; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format. + final String code; + + /// Currency plural name + final String namePlural; + + Currency({ + required this.symbol, + required this.name, + required this.symbolNative, + required this.decimalDigits, + required this.rounding, + required this.code, + required this.namePlural, + }); + + factory Currency.fromMap(Map map) { + return Currency( + symbol: map['symbol'].toString(), + name: map['name'].toString(), + symbolNative: map['symbolNative'].toString(), + decimalDigits: map['decimalDigits'], + rounding: map['rounding'].toDouble(), + code: map['code'].toString(), + namePlural: map['namePlural'].toString(), + ); + } + + Map toMap() { + return { + "symbol": symbol, + "name": name, + "symbolNative": symbolNative, + "decimalDigits": decimalDigits, + "rounding": rounding, + "code": code, + "namePlural": namePlural, + }; + } } diff --git a/lib/src/models/currency_list.dart b/lib/src/models/currency_list.dart index f67049ae..acb515e3 100644 --- a/lib/src/models/currency_list.dart +++ b/lib/src/models/currency_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Currencies List class CurrencyList implements Model { - /// Total number of currencies documents that matched your query. - final int total; + /// Total number of currencies documents that matched your query. + final int total; - /// List of currencies. - final List currencies; + /// List of currencies. + final List currencies; - CurrencyList({ - required this.total, - required this.currencies, - }); + CurrencyList({required this.total, required this.currencies}); - factory CurrencyList.fromMap(Map map) { - return CurrencyList( - total: map['total'], - currencies: List.from(map['currencies'].map((p) => Currency.fromMap(p))), - ); - } + factory CurrencyList.fromMap(Map map) { + return CurrencyList( + total: map['total'], + currencies: List.from( + map['currencies'].map((p) => Currency.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "currencies": currencies.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "currencies": currencies.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/database.dart b/lib/src/models/database.dart index 09ee2aae..298a46a3 100644 --- a/lib/src/models/database.dart +++ b/lib/src/models/database.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Database class Database implements Model { - /// Database ID. - final String $id; - - /// Database name. - final String name; - - /// Database creation date in ISO 8601 format. - final String $createdAt; - - /// Database update date in ISO 8601 format. - final String $updatedAt; - - /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. - final bool enabled; - - Database({ - required this.$id, - required this.name, - required this.$createdAt, - required this.$updatedAt, - required this.enabled, - }); - - factory Database.fromMap(Map map) { - return Database( - $id: map['\$id'].toString(), - name: map['name'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - enabled: map['enabled'], - ); - } - - Map toMap() { - return { - "\$id": $id, - "name": name, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "enabled": enabled, - }; - } + /// Database ID. + final String $id; + + /// Database name. + final String name; + + /// Database creation date in ISO 8601 format. + final String $createdAt; + + /// Database update date in ISO 8601 format. + final String $updatedAt; + + /// If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys. + final bool enabled; + + Database({ + required this.$id, + required this.name, + required this.$createdAt, + required this.$updatedAt, + required this.enabled, + }); + + factory Database.fromMap(Map map) { + return Database( + $id: map['\$id'].toString(), + name: map['name'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + enabled: map['enabled'], + ); + } + + Map toMap() { + return { + "\$id": $id, + "name": name, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "enabled": enabled, + }; + } } diff --git a/lib/src/models/database_list.dart b/lib/src/models/database_list.dart index 03b959db..5b6df8d4 100644 --- a/lib/src/models/database_list.dart +++ b/lib/src/models/database_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Databases List class DatabaseList implements Model { - /// Total number of databases documents that matched your query. - final int total; + /// Total number of databases documents that matched your query. + final int total; - /// List of databases. - final List databases; + /// List of databases. + final List databases; - DatabaseList({ - required this.total, - required this.databases, - }); + DatabaseList({required this.total, required this.databases}); - factory DatabaseList.fromMap(Map map) { - return DatabaseList( - total: map['total'], - databases: List.from(map['databases'].map((p) => Database.fromMap(p))), - ); - } + factory DatabaseList.fromMap(Map map) { + return DatabaseList( + total: map['total'], + databases: List.from( + map['databases'].map((p) => Database.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "databases": databases.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "databases": databases.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/deployment.dart b/lib/src/models/deployment.dart index ecf7e791..448c62c7 100644 --- a/lib/src/models/deployment.dart +++ b/lib/src/models/deployment.dart @@ -2,178 +2,178 @@ part of '../../models.dart'; /// Deployment class Deployment implements Model { - /// Deployment ID. - final String $id; + /// Deployment ID. + final String $id; - /// Deployment creation date in ISO 8601 format. - final String $createdAt; + /// Deployment creation date in ISO 8601 format. + final String $createdAt; - /// Deployment update date in ISO 8601 format. - final String $updatedAt; + /// Deployment update date in ISO 8601 format. + final String $updatedAt; - /// Type of deployment. - final String type; + /// Type of deployment. + final String type; - /// Resource ID. - final String resourceId; + /// Resource ID. + final String resourceId; - /// Resource type. - final String resourceType; - - /// The entrypoint file to use to execute the deployment code. - final String entrypoint; - - /// The code size in bytes. - final int sourceSize; - - /// The build output size in bytes. - final int buildSize; - - /// The total size in bytes (source and build output). - final int totalSize; - - /// The current build ID. - final String buildId; - - /// Whether the deployment should be automatically activated. - final bool activate; - - /// Screenshot with light theme preference file ID. - final String screenshotLight; - - /// Screenshot with dark theme preference file ID. - final String screenshotDark; - - /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String status; - - /// The build logs. - final String buildLogs; - - /// The current build time in seconds. - final int buildDuration; - - /// The name of the vcs provider repository - final String providerRepositoryName; - - /// The name of the vcs provider repository owner - final String providerRepositoryOwner; - - /// The url of the vcs provider repository - final String providerRepositoryUrl; - - /// The branch of the vcs repository - final String providerBranch; - - /// The commit hash of the vcs commit - final String providerCommitHash; - - /// The url of vcs commit author - final String providerCommitAuthorUrl; - - /// The name of vcs commit author - final String providerCommitAuthor; - - /// The commit message - final String providerCommitMessage; - - /// The url of the vcs commit - final String providerCommitUrl; - - /// The branch of the vcs repository - final String providerBranchUrl; - - Deployment({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.type, - required this.resourceId, - required this.resourceType, - required this.entrypoint, - required this.sourceSize, - required this.buildSize, - required this.totalSize, - required this.buildId, - required this.activate, - required this.screenshotLight, - required this.screenshotDark, - required this.status, - required this.buildLogs, - required this.buildDuration, - required this.providerRepositoryName, - required this.providerRepositoryOwner, - required this.providerRepositoryUrl, - required this.providerBranch, - required this.providerCommitHash, - required this.providerCommitAuthorUrl, - required this.providerCommitAuthor, - required this.providerCommitMessage, - required this.providerCommitUrl, - required this.providerBranchUrl, - }); - - factory Deployment.fromMap(Map map) { - return Deployment( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - type: map['type'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - entrypoint: map['entrypoint'].toString(), - sourceSize: map['sourceSize'], - buildSize: map['buildSize'], - totalSize: map['totalSize'], - buildId: map['buildId'].toString(), - activate: map['activate'], - screenshotLight: map['screenshotLight'].toString(), - screenshotDark: map['screenshotDark'].toString(), - status: map['status'].toString(), - buildLogs: map['buildLogs'].toString(), - buildDuration: map['buildDuration'], - providerRepositoryName: map['providerRepositoryName'].toString(), - providerRepositoryOwner: map['providerRepositoryOwner'].toString(), - providerRepositoryUrl: map['providerRepositoryUrl'].toString(), - providerBranch: map['providerBranch'].toString(), - providerCommitHash: map['providerCommitHash'].toString(), - providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), - providerCommitAuthor: map['providerCommitAuthor'].toString(), - providerCommitMessage: map['providerCommitMessage'].toString(), - providerCommitUrl: map['providerCommitUrl'].toString(), - providerBranchUrl: map['providerBranchUrl'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "type": type, - "resourceId": resourceId, - "resourceType": resourceType, - "entrypoint": entrypoint, - "sourceSize": sourceSize, - "buildSize": buildSize, - "totalSize": totalSize, - "buildId": buildId, - "activate": activate, - "screenshotLight": screenshotLight, - "screenshotDark": screenshotDark, - "status": status, - "buildLogs": buildLogs, - "buildDuration": buildDuration, - "providerRepositoryName": providerRepositoryName, - "providerRepositoryOwner": providerRepositoryOwner, - "providerRepositoryUrl": providerRepositoryUrl, - "providerBranch": providerBranch, - "providerCommitHash": providerCommitHash, - "providerCommitAuthorUrl": providerCommitAuthorUrl, - "providerCommitAuthor": providerCommitAuthor, - "providerCommitMessage": providerCommitMessage, - "providerCommitUrl": providerCommitUrl, - "providerBranchUrl": providerBranchUrl, - }; - } + /// Resource type. + final String resourceType; + + /// The entrypoint file to use to execute the deployment code. + final String entrypoint; + + /// The code size in bytes. + final int sourceSize; + + /// The build output size in bytes. + final int buildSize; + + /// The total size in bytes (source and build output). + final int totalSize; + + /// The current build ID. + final String buildId; + + /// Whether the deployment should be automatically activated. + final bool activate; + + /// Screenshot with light theme preference file ID. + final String screenshotLight; + + /// Screenshot with dark theme preference file ID. + final String screenshotDark; + + /// The deployment status. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String status; + + /// The build logs. + final String buildLogs; + + /// The current build time in seconds. + final int buildDuration; + + /// The name of the vcs provider repository + final String providerRepositoryName; + + /// The name of the vcs provider repository owner + final String providerRepositoryOwner; + + /// The url of the vcs provider repository + final String providerRepositoryUrl; + + /// The branch of the vcs repository + final String providerBranch; + + /// The commit hash of the vcs commit + final String providerCommitHash; + + /// The url of vcs commit author + final String providerCommitAuthorUrl; + + /// The name of vcs commit author + final String providerCommitAuthor; + + /// The commit message + final String providerCommitMessage; + + /// The url of the vcs commit + final String providerCommitUrl; + + /// The branch of the vcs repository + final String providerBranchUrl; + + Deployment({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.type, + required this.resourceId, + required this.resourceType, + required this.entrypoint, + required this.sourceSize, + required this.buildSize, + required this.totalSize, + required this.buildId, + required this.activate, + required this.screenshotLight, + required this.screenshotDark, + required this.status, + required this.buildLogs, + required this.buildDuration, + required this.providerRepositoryName, + required this.providerRepositoryOwner, + required this.providerRepositoryUrl, + required this.providerBranch, + required this.providerCommitHash, + required this.providerCommitAuthorUrl, + required this.providerCommitAuthor, + required this.providerCommitMessage, + required this.providerCommitUrl, + required this.providerBranchUrl, + }); + + factory Deployment.fromMap(Map map) { + return Deployment( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + type: map['type'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + entrypoint: map['entrypoint'].toString(), + sourceSize: map['sourceSize'], + buildSize: map['buildSize'], + totalSize: map['totalSize'], + buildId: map['buildId'].toString(), + activate: map['activate'], + screenshotLight: map['screenshotLight'].toString(), + screenshotDark: map['screenshotDark'].toString(), + status: map['status'].toString(), + buildLogs: map['buildLogs'].toString(), + buildDuration: map['buildDuration'], + providerRepositoryName: map['providerRepositoryName'].toString(), + providerRepositoryOwner: map['providerRepositoryOwner'].toString(), + providerRepositoryUrl: map['providerRepositoryUrl'].toString(), + providerBranch: map['providerBranch'].toString(), + providerCommitHash: map['providerCommitHash'].toString(), + providerCommitAuthorUrl: map['providerCommitAuthorUrl'].toString(), + providerCommitAuthor: map['providerCommitAuthor'].toString(), + providerCommitMessage: map['providerCommitMessage'].toString(), + providerCommitUrl: map['providerCommitUrl'].toString(), + providerBranchUrl: map['providerBranchUrl'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "type": type, + "resourceId": resourceId, + "resourceType": resourceType, + "entrypoint": entrypoint, + "sourceSize": sourceSize, + "buildSize": buildSize, + "totalSize": totalSize, + "buildId": buildId, + "activate": activate, + "screenshotLight": screenshotLight, + "screenshotDark": screenshotDark, + "status": status, + "buildLogs": buildLogs, + "buildDuration": buildDuration, + "providerRepositoryName": providerRepositoryName, + "providerRepositoryOwner": providerRepositoryOwner, + "providerRepositoryUrl": providerRepositoryUrl, + "providerBranch": providerBranch, + "providerCommitHash": providerCommitHash, + "providerCommitAuthorUrl": providerCommitAuthorUrl, + "providerCommitAuthor": providerCommitAuthor, + "providerCommitMessage": providerCommitMessage, + "providerCommitUrl": providerCommitUrl, + "providerBranchUrl": providerBranchUrl, + }; + } } diff --git a/lib/src/models/deployment_list.dart b/lib/src/models/deployment_list.dart index 508bb705..15a93ef4 100644 --- a/lib/src/models/deployment_list.dart +++ b/lib/src/models/deployment_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Deployments List class DeploymentList implements Model { - /// Total number of deployments documents that matched your query. - final int total; + /// Total number of deployments documents that matched your query. + final int total; - /// List of deployments. - final List deployments; + /// List of deployments. + final List deployments; - DeploymentList({ - required this.total, - required this.deployments, - }); + DeploymentList({required this.total, required this.deployments}); - factory DeploymentList.fromMap(Map map) { - return DeploymentList( - total: map['total'], - deployments: List.from(map['deployments'].map((p) => Deployment.fromMap(p))), - ); - } + factory DeploymentList.fromMap(Map map) { + return DeploymentList( + total: map['total'], + deployments: List.from( + map['deployments'].map((p) => Deployment.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "deployments": deployments.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "deployments": deployments.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/document.dart b/lib/src/models/document.dart index b6454aae..37fb2b7b 100644 --- a/lib/src/models/document.dart +++ b/lib/src/models/document.dart @@ -2,59 +2,59 @@ part of '../../models.dart'; /// Document class Document implements Model { - /// Document ID. - final String $id; - - /// Collection ID. - final String $collectionId; - - /// Database ID. - final String $databaseId; - - /// Document creation date in ISO 8601 format. - final String $createdAt; - - /// Document update date in ISO 8601 format. - final String $updatedAt; - - /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; - - final Map data; - - Document({ - required this.$id, - required this.$collectionId, - required this.$databaseId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.data, - }); - - factory Document.fromMap(Map map) { - return Document( - $id: map['\$id'].toString(), - $collectionId: map['\$collectionId'].toString(), - $databaseId: map['\$databaseId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - data: map, - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$collectionId": $collectionId, - "\$databaseId": $databaseId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "data": data, - }; - } - - T convertTo(T Function(Map) fromJson) => fromJson(data); + /// Document ID. + final String $id; + + /// Collection ID. + final String $collectionId; + + /// Database ID. + final String $databaseId; + + /// Document creation date in ISO 8601 format. + final String $createdAt; + + /// Document update date in ISO 8601 format. + final String $updatedAt; + + /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; + + final Map data; + + Document({ + required this.$id, + required this.$collectionId, + required this.$databaseId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.data, + }); + + factory Document.fromMap(Map map) { + return Document( + $id: map['\$id'].toString(), + $collectionId: map['\$collectionId'].toString(), + $databaseId: map['\$databaseId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + data: map, + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$collectionId": $collectionId, + "\$databaseId": $databaseId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "data": data, + }; + } + + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/document_list.dart b/lib/src/models/document_list.dart index 8af34256..126ad805 100644 --- a/lib/src/models/document_list.dart +++ b/lib/src/models/document_list.dart @@ -2,31 +2,30 @@ part of '../../models.dart'; /// Documents List class DocumentList implements Model { - /// Total number of documents documents that matched your query. - final int total; + /// Total number of documents documents that matched your query. + final int total; - /// List of documents. - final List documents; + /// List of documents. + final List documents; - DocumentList({ - required this.total, - required this.documents, - }); + DocumentList({required this.total, required this.documents}); - factory DocumentList.fromMap(Map map) { - return DocumentList( - total: map['total'], - documents: List.from(map['documents'].map((p) => Document.fromMap(p))), - ); - } + factory DocumentList.fromMap(Map map) { + return DocumentList( + total: map['total'], + documents: List.from( + map['documents'].map((p) => Document.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "documents": documents.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "documents": documents.map((p) => p.toMap()).toList(), + }; + } - List convertTo(T Function(Map) fromJson) => - documents.map((d) => d.convertTo(fromJson)).toList(); + List convertTo(T Function(Map) fromJson) => + documents.map((d) => d.convertTo(fromJson)).toList(); } diff --git a/lib/src/models/execution.dart b/lib/src/models/execution.dart index 0cfdbb4e..8618bcd6 100644 --- a/lib/src/models/execution.dart +++ b/lib/src/models/execution.dart @@ -2,118 +2,122 @@ part of '../../models.dart'; /// Execution class Execution implements Model { - /// Execution ID. - final String $id; - - /// Execution creation date in ISO 8601 format. - final String $createdAt; - - /// Execution upate date in ISO 8601 format. - final String $updatedAt; - - /// Execution roles. - final List $permissions; - - /// Function ID. - final String functionId; - - /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. - final String trigger; - - /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. - final String status; - - /// HTTP request method type. - final String requestMethod; - - /// HTTP request path and query. - final String requestPath; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List requestHeaders; - - /// HTTP response status code. - final int responseStatusCode; - - /// HTTP response body. This will return empty unless execution is created as synchronous. - final String responseBody; - - /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. - final List responseHeaders; - - /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String logs; - - /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String errors; - - /// Resource(function/site) execution duration in seconds. - final double duration; - - /// The scheduled time for execution. If left empty, execution will be queued immediately. - final String? scheduledAt; - - Execution({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.functionId, - required this.trigger, - required this.status, - required this.requestMethod, - required this.requestPath, - required this.requestHeaders, - required this.responseStatusCode, - required this.responseBody, - required this.responseHeaders, - required this.logs, - required this.errors, - required this.duration, - this.scheduledAt, - }); - - factory Execution.fromMap(Map map) { - return Execution( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - functionId: map['functionId'].toString(), - trigger: map['trigger'].toString(), - status: map['status'].toString(), - requestMethod: map['requestMethod'].toString(), - requestPath: map['requestPath'].toString(), - requestHeaders: List.from(map['requestHeaders'].map((p) => Headers.fromMap(p))), - responseStatusCode: map['responseStatusCode'], - responseBody: map['responseBody'].toString(), - responseHeaders: List.from(map['responseHeaders'].map((p) => Headers.fromMap(p))), - logs: map['logs'].toString(), - errors: map['errors'].toString(), - duration: map['duration'].toDouble(), - scheduledAt: map['scheduledAt']?.toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "functionId": functionId, - "trigger": trigger, - "status": status, - "requestMethod": requestMethod, - "requestPath": requestPath, - "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), - "responseStatusCode": responseStatusCode, - "responseBody": responseBody, - "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), - "logs": logs, - "errors": errors, - "duration": duration, - "scheduledAt": scheduledAt, - }; - } + /// Execution ID. + final String $id; + + /// Execution creation date in ISO 8601 format. + final String $createdAt; + + /// Execution upate date in ISO 8601 format. + final String $updatedAt; + + /// Execution roles. + final List $permissions; + + /// Function ID. + final String functionId; + + /// The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`. + final String trigger; + + /// The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`. + final String status; + + /// HTTP request method type. + final String requestMethod; + + /// HTTP request path and query. + final String requestPath; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List requestHeaders; + + /// HTTP response status code. + final int responseStatusCode; + + /// HTTP response body. This will return empty unless execution is created as synchronous. + final String responseBody; + + /// HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous. + final List responseHeaders; + + /// Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String logs; + + /// Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String errors; + + /// Resource(function/site) execution duration in seconds. + final double duration; + + /// The scheduled time for execution. If left empty, execution will be queued immediately. + final String? scheduledAt; + + Execution({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.functionId, + required this.trigger, + required this.status, + required this.requestMethod, + required this.requestPath, + required this.requestHeaders, + required this.responseStatusCode, + required this.responseBody, + required this.responseHeaders, + required this.logs, + required this.errors, + required this.duration, + this.scheduledAt, + }); + + factory Execution.fromMap(Map map) { + return Execution( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + functionId: map['functionId'].toString(), + trigger: map['trigger'].toString(), + status: map['status'].toString(), + requestMethod: map['requestMethod'].toString(), + requestPath: map['requestPath'].toString(), + requestHeaders: List.from( + map['requestHeaders'].map((p) => Headers.fromMap(p)), + ), + responseStatusCode: map['responseStatusCode'], + responseBody: map['responseBody'].toString(), + responseHeaders: List.from( + map['responseHeaders'].map((p) => Headers.fromMap(p)), + ), + logs: map['logs'].toString(), + errors: map['errors'].toString(), + duration: map['duration'].toDouble(), + scheduledAt: map['scheduledAt']?.toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "functionId": functionId, + "trigger": trigger, + "status": status, + "requestMethod": requestMethod, + "requestPath": requestPath, + "requestHeaders": requestHeaders.map((p) => p.toMap()).toList(), + "responseStatusCode": responseStatusCode, + "responseBody": responseBody, + "responseHeaders": responseHeaders.map((p) => p.toMap()).toList(), + "logs": logs, + "errors": errors, + "duration": duration, + "scheduledAt": scheduledAt, + }; + } } diff --git a/lib/src/models/execution_list.dart b/lib/src/models/execution_list.dart index 0bcbad6a..2a2ef056 100644 --- a/lib/src/models/execution_list.dart +++ b/lib/src/models/execution_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Executions List class ExecutionList implements Model { - /// Total number of executions documents that matched your query. - final int total; + /// Total number of executions documents that matched your query. + final int total; - /// List of executions. - final List executions; + /// List of executions. + final List executions; - ExecutionList({ - required this.total, - required this.executions, - }); + ExecutionList({required this.total, required this.executions}); - factory ExecutionList.fromMap(Map map) { - return ExecutionList( - total: map['total'], - executions: List.from(map['executions'].map((p) => Execution.fromMap(p))), - ); - } + factory ExecutionList.fromMap(Map map) { + return ExecutionList( + total: map['total'], + executions: List.from( + map['executions'].map((p) => Execution.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "executions": executions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "executions": executions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/file.dart b/lib/src/models/file.dart index de8439ec..a6a9fa46 100644 --- a/lib/src/models/file.dart +++ b/lib/src/models/file.dart @@ -2,82 +2,82 @@ part of '../../models.dart'; /// File class File implements Model { - /// File ID. - final String $id; + /// File ID. + final String $id; - /// Bucket ID. - final String bucketId; + /// Bucket ID. + final String bucketId; - /// File creation date in ISO 8601 format. - final String $createdAt; + /// File creation date in ISO 8601 format. + final String $createdAt; - /// File update date in ISO 8601 format. - final String $updatedAt; + /// File update date in ISO 8601 format. + final String $updatedAt; - /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). - final List $permissions; + /// File permissions. [Learn more about permissions](https://appwrite.io/docs/permissions). + final List $permissions; - /// File name. - final String name; + /// File name. + final String name; - /// File MD5 signature. - final String signature; + /// File MD5 signature. + final String signature; - /// File mime type. - final String mimeType; + /// File mime type. + final String mimeType; - /// File original size in bytes. - final int sizeOriginal; + /// File original size in bytes. + final int sizeOriginal; - /// Total number of chunks available - final int chunksTotal; + /// Total number of chunks available + final int chunksTotal; - /// Total number of chunks uploaded - final int chunksUploaded; + /// Total number of chunks uploaded + final int chunksUploaded; - File({ - required this.$id, - required this.bucketId, - required this.$createdAt, - required this.$updatedAt, - required this.$permissions, - required this.name, - required this.signature, - required this.mimeType, - required this.sizeOriginal, - required this.chunksTotal, - required this.chunksUploaded, - }); + File({ + required this.$id, + required this.bucketId, + required this.$createdAt, + required this.$updatedAt, + required this.$permissions, + required this.name, + required this.signature, + required this.mimeType, + required this.sizeOriginal, + required this.chunksTotal, + required this.chunksUploaded, + }); - factory File.fromMap(Map map) { - return File( - $id: map['\$id'].toString(), - bucketId: map['bucketId'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - $permissions: List.from(map['\$permissions'] ?? []), - name: map['name'].toString(), - signature: map['signature'].toString(), - mimeType: map['mimeType'].toString(), - sizeOriginal: map['sizeOriginal'], - chunksTotal: map['chunksTotal'], - chunksUploaded: map['chunksUploaded'], - ); - } + factory File.fromMap(Map map) { + return File( + $id: map['\$id'].toString(), + bucketId: map['bucketId'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + $permissions: List.from(map['\$permissions'] ?? []), + name: map['name'].toString(), + signature: map['signature'].toString(), + mimeType: map['mimeType'].toString(), + sizeOriginal: map['sizeOriginal'], + chunksTotal: map['chunksTotal'], + chunksUploaded: map['chunksUploaded'], + ); + } - Map toMap() { - return { - "\$id": $id, - "bucketId": bucketId, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "\$permissions": $permissions, - "name": name, - "signature": signature, - "mimeType": mimeType, - "sizeOriginal": sizeOriginal, - "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded, - }; - } + Map toMap() { + return { + "\$id": $id, + "bucketId": bucketId, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "\$permissions": $permissions, + "name": name, + "signature": signature, + "mimeType": mimeType, + "sizeOriginal": sizeOriginal, + "chunksTotal": chunksTotal, + "chunksUploaded": chunksUploaded, + }; + } } diff --git a/lib/src/models/file_list.dart b/lib/src/models/file_list.dart index 28bc6fcf..9f01530b 100644 --- a/lib/src/models/file_list.dart +++ b/lib/src/models/file_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Files List class FileList implements Model { - /// Total number of files documents that matched your query. - final int total; + /// Total number of files documents that matched your query. + final int total; - /// List of files. - final List files; + /// List of files. + final List files; - FileList({ - required this.total, - required this.files, - }); + FileList({required this.total, required this.files}); - factory FileList.fromMap(Map map) { - return FileList( - total: map['total'], - files: List.from(map['files'].map((p) => File.fromMap(p))), - ); - } + factory FileList.fromMap(Map map) { + return FileList( + total: map['total'], + files: List.from(map['files'].map((p) => File.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "files": files.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "files": files.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/framework.dart b/lib/src/models/framework.dart index ea6b601a..693c9b07 100644 --- a/lib/src/models/framework.dart +++ b/lib/src/models/framework.dart @@ -2,46 +2,48 @@ part of '../../models.dart'; /// Framework class Framework implements Model { - /// Framework key. - final String key; - - /// Framework Name. - final String name; - - /// Default runtime version. - final String buildRuntime; - - /// List of supported runtime versions. - final List runtimes; - - /// List of supported adapters. - final List adapters; - - Framework({ - required this.key, - required this.name, - required this.buildRuntime, - required this.runtimes, - required this.adapters, - }); - - factory Framework.fromMap(Map map) { - return Framework( - key: map['key'].toString(), - name: map['name'].toString(), - buildRuntime: map['buildRuntime'].toString(), - runtimes: List.from(map['runtimes'] ?? []), - adapters: List.from(map['adapters'].map((p) => FrameworkAdapter.fromMap(p))), - ); - } - - Map toMap() { - return { - "key": key, - "name": name, - "buildRuntime": buildRuntime, - "runtimes": runtimes, - "adapters": adapters.map((p) => p.toMap()).toList(), - }; - } + /// Framework key. + final String key; + + /// Framework Name. + final String name; + + /// Default runtime version. + final String buildRuntime; + + /// List of supported runtime versions. + final List runtimes; + + /// List of supported adapters. + final List adapters; + + Framework({ + required this.key, + required this.name, + required this.buildRuntime, + required this.runtimes, + required this.adapters, + }); + + factory Framework.fromMap(Map map) { + return Framework( + key: map['key'].toString(), + name: map['name'].toString(), + buildRuntime: map['buildRuntime'].toString(), + runtimes: List.from(map['runtimes'] ?? []), + adapters: List.from( + map['adapters'].map((p) => FrameworkAdapter.fromMap(p)), + ), + ); + } + + Map toMap() { + return { + "key": key, + "name": name, + "buildRuntime": buildRuntime, + "runtimes": runtimes, + "adapters": adapters.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/framework_adapter.dart b/lib/src/models/framework_adapter.dart index 7614616a..0b908240 100644 --- a/lib/src/models/framework_adapter.dart +++ b/lib/src/models/framework_adapter.dart @@ -2,46 +2,46 @@ part of '../../models.dart'; /// Framework Adapter class FrameworkAdapter implements Model { - /// Adapter key. - final String key; - - /// Default command to download dependencies. - final String installCommand; - - /// Default command to build site into output directory. - final String buildCommand; - - /// Default output directory of build. - final String outputDirectory; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - FrameworkAdapter({ - required this.key, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.fallbackFile, - }); - - factory FrameworkAdapter.fromMap(Map map) { - return FrameworkAdapter( - key: map['key'].toString(), - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "key": key, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "fallbackFile": fallbackFile, - }; - } + /// Adapter key. + final String key; + + /// Default command to download dependencies. + final String installCommand; + + /// Default command to build site into output directory. + final String buildCommand; + + /// Default output directory of build. + final String outputDirectory; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + FrameworkAdapter({ + required this.key, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.fallbackFile, + }); + + factory FrameworkAdapter.fromMap(Map map) { + return FrameworkAdapter( + key: map['key'].toString(), + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "key": key, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/framework_list.dart b/lib/src/models/framework_list.dart index deb19e62..266d8edf 100644 --- a/lib/src/models/framework_list.dart +++ b/lib/src/models/framework_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Frameworks List class FrameworkList implements Model { - /// Total number of frameworks documents that matched your query. - final int total; + /// Total number of frameworks documents that matched your query. + final int total; - /// List of frameworks. - final List frameworks; + /// List of frameworks. + final List frameworks; - FrameworkList({ - required this.total, - required this.frameworks, - }); + FrameworkList({required this.total, required this.frameworks}); - factory FrameworkList.fromMap(Map map) { - return FrameworkList( - total: map['total'], - frameworks: List.from(map['frameworks'].map((p) => Framework.fromMap(p))), - ); - } + factory FrameworkList.fromMap(Map map) { + return FrameworkList( + total: map['total'], + frameworks: List.from( + map['frameworks'].map((p) => Framework.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "frameworks": frameworks.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "frameworks": frameworks.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/function.dart b/lib/src/models/function.dart index 64401c3f..56c2eded 100644 --- a/lib/src/models/function.dart +++ b/lib/src/models/function.dart @@ -2,184 +2,184 @@ part of '../../models.dart'; /// Function class Func implements Model { - /// Function ID. - final String $id; + /// Function ID. + final String $id; - /// Function creation date in ISO 8601 format. - final String $createdAt; + /// Function creation date in ISO 8601 format. + final String $createdAt; - /// Function update date in ISO 8601 format. - final String $updatedAt; + /// Function update date in ISO 8601 format. + final String $updatedAt; - /// Execution permissions. - final List execute; + /// Execution permissions. + final List execute; - /// Function name. - final String name; + /// Function name. + final String name; - /// Function enabled. - final bool enabled; + /// Function enabled. + final bool enabled; - /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. - final bool live; - - /// When disabled, executions will exclude logs and errors, and will be slightly faster. - final bool logging; - - /// Function execution and build runtime. - final String runtime; - - /// Function's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Function's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Allowed permission scopes. - final List scopes; - - /// Function variables. - final List vars; - - /// Function trigger events. - final List events; - - /// Function execution schedule in CRON format. - final String schedule; - - /// Function execution timeout in seconds. - final int timeout; - - /// The entrypoint file used to execute the deployment. - final String entrypoint; - - /// The build command used to build the deployment. - final String commands; - - /// Version of Open Runtimes used for the function. - final String version; - - /// Function VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to function in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - Func({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.execute, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.runtime, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.scopes, - required this.vars, - required this.events, - required this.schedule, - required this.timeout, - required this.entrypoint, - required this.commands, - required this.version, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - }); - - factory Func.fromMap(Map map) { - return Func( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - execute: List.from(map['execute'] ?? []), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - runtime: map['runtime'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - scopes: List.from(map['scopes'] ?? []), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - events: List.from(map['events'] ?? []), - schedule: map['schedule'].toString(), - timeout: map['timeout'], - entrypoint: map['entrypoint'].toString(), - commands: map['commands'].toString(), - version: map['version'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "execute": execute, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "runtime": runtime, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "scopes": scopes, - "vars": vars.map((p) => p.toMap()).toList(), - "events": events, - "schedule": schedule, - "timeout": timeout, - "entrypoint": entrypoint, - "commands": commands, - "version": version, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - }; - } + /// Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration. + final bool live; + + /// When disabled, executions will exclude logs and errors, and will be slightly faster. + final bool logging; + + /// Function execution and build runtime. + final String runtime; + + /// Function's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Function's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Allowed permission scopes. + final List scopes; + + /// Function variables. + final List vars; + + /// Function trigger events. + final List events; + + /// Function execution schedule in CRON format. + final String schedule; + + /// Function execution timeout in seconds. + final int timeout; + + /// The entrypoint file used to execute the deployment. + final String entrypoint; + + /// The build command used to build the deployment. + final String commands; + + /// Version of Open Runtimes used for the function. + final String version; + + /// Function VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to function in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + Func({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.execute, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.runtime, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.scopes, + required this.vars, + required this.events, + required this.schedule, + required this.timeout, + required this.entrypoint, + required this.commands, + required this.version, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + }); + + factory Func.fromMap(Map map) { + return Func( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + execute: List.from(map['execute'] ?? []), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + runtime: map['runtime'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + scopes: List.from(map['scopes'] ?? []), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + events: List.from(map['events'] ?? []), + schedule: map['schedule'].toString(), + timeout: map['timeout'], + entrypoint: map['entrypoint'].toString(), + commands: map['commands'].toString(), + version: map['version'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "execute": execute, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "runtime": runtime, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "scopes": scopes, + "vars": vars.map((p) => p.toMap()).toList(), + "events": events, + "schedule": schedule, + "timeout": timeout, + "entrypoint": entrypoint, + "commands": commands, + "version": version, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + }; + } } diff --git a/lib/src/models/function_list.dart b/lib/src/models/function_list.dart index 8f0b8928..c37f0615 100644 --- a/lib/src/models/function_list.dart +++ b/lib/src/models/function_list.dart @@ -2,28 +2,25 @@ part of '../../models.dart'; /// Functions List class FunctionList implements Model { - /// Total number of functions documents that matched your query. - final int total; + /// Total number of functions documents that matched your query. + final int total; - /// List of functions. - final List functions; + /// List of functions. + final List functions; - FunctionList({ - required this.total, - required this.functions, - }); + FunctionList({required this.total, required this.functions}); - factory FunctionList.fromMap(Map map) { - return FunctionList( - total: map['total'], - functions: List.from(map['functions'].map((p) => Func.fromMap(p))), - ); - } + factory FunctionList.fromMap(Map map) { + return FunctionList( + total: map['total'], + functions: List.from(map['functions'].map((p) => Func.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "functions": functions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "functions": functions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/headers.dart b/lib/src/models/headers.dart index ecf0a178..463cf696 100644 --- a/lib/src/models/headers.dart +++ b/lib/src/models/headers.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Headers class Headers implements Model { - /// Header name. - final String name; + /// Header name. + final String name; - /// Header value. - final String value; + /// Header value. + final String value; - Headers({ - required this.name, - required this.value, - }); + Headers({required this.name, required this.value}); - factory Headers.fromMap(Map map) { - return Headers( - name: map['name'].toString(), - value: map['value'].toString(), - ); - } + factory Headers.fromMap(Map map) { + return Headers( + name: map['name'].toString(), + value: map['value'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "value": value, - }; - } + Map toMap() { + return {"name": name, "value": value}; + } } diff --git a/lib/src/models/health_antivirus.dart b/lib/src/models/health_antivirus.dart index 54c31e70..fa402e97 100644 --- a/lib/src/models/health_antivirus.dart +++ b/lib/src/models/health_antivirus.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Health Antivirus class HealthAntivirus implements Model { - /// Antivirus version. - final String version; + /// Antivirus version. + final String version; - /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` - final String status; + /// Antivirus status. Possible values can are: `disabled`, `offline`, `online` + final String status; - HealthAntivirus({ - required this.version, - required this.status, - }); + HealthAntivirus({required this.version, required this.status}); - factory HealthAntivirus.fromMap(Map map) { - return HealthAntivirus( - version: map['version'].toString(), - status: map['status'].toString(), - ); - } + factory HealthAntivirus.fromMap(Map map) { + return HealthAntivirus( + version: map['version'].toString(), + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "version": version, - "status": status, - }; - } + Map toMap() { + return {"version": version, "status": status}; + } } diff --git a/lib/src/models/health_certificate.dart b/lib/src/models/health_certificate.dart index 0a5b6ce9..d412eba9 100644 --- a/lib/src/models/health_certificate.dart +++ b/lib/src/models/health_certificate.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Health Certificate class HealthCertificate implements Model { - /// Certificate name - final String name; - - /// Subject SN - final String subjectSN; - - /// Issuer organisation - final String issuerOrganisation; - - /// Valid from - final String validFrom; - - /// Valid to - final String validTo; - - /// Signature type SN - final String signatureTypeSN; - - HealthCertificate({ - required this.name, - required this.subjectSN, - required this.issuerOrganisation, - required this.validFrom, - required this.validTo, - required this.signatureTypeSN, - }); - - factory HealthCertificate.fromMap(Map map) { - return HealthCertificate( - name: map['name'].toString(), - subjectSN: map['subjectSN'].toString(), - issuerOrganisation: map['issuerOrganisation'].toString(), - validFrom: map['validFrom'].toString(), - validTo: map['validTo'].toString(), - signatureTypeSN: map['signatureTypeSN'].toString(), - ); - } - - Map toMap() { - return { - "name": name, - "subjectSN": subjectSN, - "issuerOrganisation": issuerOrganisation, - "validFrom": validFrom, - "validTo": validTo, - "signatureTypeSN": signatureTypeSN, - }; - } + /// Certificate name + final String name; + + /// Subject SN + final String subjectSN; + + /// Issuer organisation + final String issuerOrganisation; + + /// Valid from + final String validFrom; + + /// Valid to + final String validTo; + + /// Signature type SN + final String signatureTypeSN; + + HealthCertificate({ + required this.name, + required this.subjectSN, + required this.issuerOrganisation, + required this.validFrom, + required this.validTo, + required this.signatureTypeSN, + }); + + factory HealthCertificate.fromMap(Map map) { + return HealthCertificate( + name: map['name'].toString(), + subjectSN: map['subjectSN'].toString(), + issuerOrganisation: map['issuerOrganisation'].toString(), + validFrom: map['validFrom'].toString(), + validTo: map['validTo'].toString(), + signatureTypeSN: map['signatureTypeSN'].toString(), + ); + } + + Map toMap() { + return { + "name": name, + "subjectSN": subjectSN, + "issuerOrganisation": issuerOrganisation, + "validFrom": validFrom, + "validTo": validTo, + "signatureTypeSN": signatureTypeSN, + }; + } } diff --git a/lib/src/models/health_queue.dart b/lib/src/models/health_queue.dart index 95da1235..5f06906b 100644 --- a/lib/src/models/health_queue.dart +++ b/lib/src/models/health_queue.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// Health Queue class HealthQueue implements Model { - /// Amount of actions in the queue. - final int size; + /// Amount of actions in the queue. + final int size; - HealthQueue({ - required this.size, - }); + HealthQueue({required this.size}); - factory HealthQueue.fromMap(Map map) { - return HealthQueue( - size: map['size'], - ); - } + factory HealthQueue.fromMap(Map map) { + return HealthQueue(size: map['size']); + } - Map toMap() { - return { - "size": size, - }; - } + Map toMap() { + return {"size": size}; + } } diff --git a/lib/src/models/health_status.dart b/lib/src/models/health_status.dart index 0d6e7216..59b7092c 100644 --- a/lib/src/models/health_status.dart +++ b/lib/src/models/health_status.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Health Status class HealthStatus implements Model { - /// Name of the service. - final String name; + /// Name of the service. + final String name; - /// Duration in milliseconds how long the health check took. - final int ping; + /// Duration in milliseconds how long the health check took. + final int ping; - /// Service status. Possible values can are: `pass`, `fail` - final String status; + /// Service status. Possible values can are: `pass`, `fail` + final String status; - HealthStatus({ - required this.name, - required this.ping, - required this.status, - }); + HealthStatus({required this.name, required this.ping, required this.status}); - factory HealthStatus.fromMap(Map map) { - return HealthStatus( - name: map['name'].toString(), - ping: map['ping'], - status: map['status'].toString(), - ); - } + factory HealthStatus.fromMap(Map map) { + return HealthStatus( + name: map['name'].toString(), + ping: map['ping'], + status: map['status'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "ping": ping, - "status": status, - }; - } + Map toMap() { + return {"name": name, "ping": ping, "status": status}; + } } diff --git a/lib/src/models/health_time.dart b/lib/src/models/health_time.dart index 102dfe77..dec2d54f 100644 --- a/lib/src/models/health_time.dart +++ b/lib/src/models/health_time.dart @@ -2,34 +2,30 @@ part of '../../models.dart'; /// Health Time class HealthTime implements Model { - /// Current unix timestamp on trustful remote server. - final int remoteTime; + /// Current unix timestamp on trustful remote server. + final int remoteTime; - /// Current unix timestamp of local server where Appwrite runs. - final int localTime; + /// Current unix timestamp of local server where Appwrite runs. + final int localTime; - /// Difference of unix remote and local timestamps in milliseconds. - final int diff; + /// Difference of unix remote and local timestamps in milliseconds. + final int diff; - HealthTime({ - required this.remoteTime, - required this.localTime, - required this.diff, - }); + HealthTime({ + required this.remoteTime, + required this.localTime, + required this.diff, + }); - factory HealthTime.fromMap(Map map) { - return HealthTime( - remoteTime: map['remoteTime'], - localTime: map['localTime'], - diff: map['diff'], - ); - } + factory HealthTime.fromMap(Map map) { + return HealthTime( + remoteTime: map['remoteTime'], + localTime: map['localTime'], + diff: map['diff'], + ); + } - Map toMap() { - return { - "remoteTime": remoteTime, - "localTime": localTime, - "diff": diff, - }; - } + Map toMap() { + return {"remoteTime": remoteTime, "localTime": localTime, "diff": diff}; + } } diff --git a/lib/src/models/identity.dart b/lib/src/models/identity.dart index c43c4d57..807bdfd0 100644 --- a/lib/src/models/identity.dart +++ b/lib/src/models/identity.dart @@ -2,76 +2,76 @@ part of '../../models.dart'; /// Identity class Identity implements Model { - /// Identity ID. - final String $id; + /// Identity ID. + final String $id; - /// Identity creation date in ISO 8601 format. - final String $createdAt; + /// Identity creation date in ISO 8601 format. + final String $createdAt; - /// Identity update date in ISO 8601 format. - final String $updatedAt; + /// Identity update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Identity Provider. - final String provider; + /// Identity Provider. + final String provider; - /// ID of the User in the Identity Provider. - final String providerUid; + /// ID of the User in the Identity Provider. + final String providerUid; - /// Email of the User in the Identity Provider. - final String providerEmail; + /// Email of the User in the Identity Provider. + final String providerEmail; - /// Identity Provider Access Token. - final String providerAccessToken; + /// Identity Provider Access Token. + final String providerAccessToken; - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; - /// Identity Provider Refresh Token. - final String providerRefreshToken; + /// Identity Provider Refresh Token. + final String providerRefreshToken; - Identity({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.provider, - required this.providerUid, - required this.providerEmail, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - }); + Identity({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.provider, + required this.providerUid, + required this.providerEmail, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + }); - factory Identity.fromMap(Map map) { - return Identity( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerEmail: map['providerEmail'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ); - } + factory Identity.fromMap(Map map) { + return Identity( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerEmail: map['providerEmail'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "provider": provider, - "providerUid": providerUid, - "providerEmail": providerEmail, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "provider": provider, + "providerUid": providerUid, + "providerEmail": providerEmail, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + }; + } } diff --git a/lib/src/models/identity_list.dart b/lib/src/models/identity_list.dart index e92e36cc..f38eaf66 100644 --- a/lib/src/models/identity_list.dart +++ b/lib/src/models/identity_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Identities List class IdentityList implements Model { - /// Total number of identities documents that matched your query. - final int total; + /// Total number of identities documents that matched your query. + final int total; - /// List of identities. - final List identities; + /// List of identities. + final List identities; - IdentityList({ - required this.total, - required this.identities, - }); + IdentityList({required this.total, required this.identities}); - factory IdentityList.fromMap(Map map) { - return IdentityList( - total: map['total'], - identities: List.from(map['identities'].map((p) => Identity.fromMap(p))), - ); - } + factory IdentityList.fromMap(Map map) { + return IdentityList( + total: map['total'], + identities: List.from( + map['identities'].map((p) => Identity.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "identities": identities.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "identities": identities.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/index.dart b/lib/src/models/index.dart index 07d22743..961b9e5e 100644 --- a/lib/src/models/index.dart +++ b/lib/src/models/index.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Index class Index implements Model { - /// Index Key. - final String key; + /// Index Key. + final String key; - /// Index type. - final String type; + /// Index type. + final String type; - /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` - final String status; + /// Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed` + final String status; - /// Error message. Displays error generated on failure of creating or deleting an index. - final String error; + /// Error message. Displays error generated on failure of creating or deleting an index. + final String error; - /// Index attributes. - final List attributes; + /// Index attributes. + final List attributes; - /// Index attributes length. - final List lengths; + /// Index attributes length. + final List lengths; - /// Index orders. - final List? orders; + /// Index orders. + final List? orders; - /// Index creation date in ISO 8601 format. - final String $createdAt; + /// Index creation date in ISO 8601 format. + final String $createdAt; - /// Index update date in ISO 8601 format. - final String $updatedAt; + /// Index update date in ISO 8601 format. + final String $updatedAt; - Index({ - required this.key, - required this.type, - required this.status, - required this.error, - required this.attributes, - required this.lengths, - this.orders, - required this.$createdAt, - required this.$updatedAt, - }); + Index({ + required this.key, + required this.type, + required this.status, + required this.error, + required this.attributes, + required this.lengths, + this.orders, + required this.$createdAt, + required this.$updatedAt, + }); - factory Index.fromMap(Map map) { - return Index( - key: map['key'].toString(), - type: map['type'].toString(), - status: map['status'].toString(), - error: map['error'].toString(), - attributes: List.from(map['attributes'] ?? []), - lengths: List.from(map['lengths'] ?? []), - orders: List.from(map['orders'] ?? []), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - ); - } + factory Index.fromMap(Map map) { + return Index( + key: map['key'].toString(), + type: map['type'].toString(), + status: map['status'].toString(), + error: map['error'].toString(), + attributes: List.from(map['attributes'] ?? []), + lengths: List.from(map['lengths'] ?? []), + orders: List.from(map['orders'] ?? []), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + ); + } - Map toMap() { - return { - "key": key, - "type": type, - "status": status, - "error": error, - "attributes": attributes, - "lengths": lengths, - "orders": orders, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - }; - } + Map toMap() { + return { + "key": key, + "type": type, + "status": status, + "error": error, + "attributes": attributes, + "lengths": lengths, + "orders": orders, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + }; + } } diff --git a/lib/src/models/index_list.dart b/lib/src/models/index_list.dart index 8eac7956..dc759dfb 100644 --- a/lib/src/models/index_list.dart +++ b/lib/src/models/index_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Indexes List class IndexList implements Model { - /// Total number of indexes documents that matched your query. - final int total; + /// Total number of indexes documents that matched your query. + final int total; - /// List of indexes. - final List indexes; + /// List of indexes. + final List indexes; - IndexList({ - required this.total, - required this.indexes, - }); + IndexList({required this.total, required this.indexes}); - factory IndexList.fromMap(Map map) { - return IndexList( - total: map['total'], - indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), - ); - } + factory IndexList.fromMap(Map map) { + return IndexList( + total: map['total'], + indexes: List.from(map['indexes'].map((p) => Index.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "indexes": indexes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "indexes": indexes.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/jwt.dart b/lib/src/models/jwt.dart index 1b4ff7de..490a1824 100644 --- a/lib/src/models/jwt.dart +++ b/lib/src/models/jwt.dart @@ -2,22 +2,16 @@ part of '../../models.dart'; /// JWT class Jwt implements Model { - /// JWT encoded string. - final String jwt; + /// JWT encoded string. + final String jwt; - Jwt({ - required this.jwt, - }); + Jwt({required this.jwt}); - factory Jwt.fromMap(Map map) { - return Jwt( - jwt: map['jwt'].toString(), - ); - } + factory Jwt.fromMap(Map map) { + return Jwt(jwt: map['jwt'].toString()); + } - Map toMap() { - return { - "jwt": jwt, - }; - } + Map toMap() { + return {"jwt": jwt}; + } } diff --git a/lib/src/models/language.dart b/lib/src/models/language.dart index 43eaad08..9c45adb1 100644 --- a/lib/src/models/language.dart +++ b/lib/src/models/language.dart @@ -2,34 +2,26 @@ part of '../../models.dart'; /// Language class Language implements Model { - /// Language name. - final String name; + /// Language name. + final String name; - /// Language two-character ISO 639-1 codes. - final String code; + /// Language two-character ISO 639-1 codes. + final String code; - /// Language native name. - final String nativeName; + /// Language native name. + final String nativeName; - Language({ - required this.name, - required this.code, - required this.nativeName, - }); + Language({required this.name, required this.code, required this.nativeName}); - factory Language.fromMap(Map map) { - return Language( - name: map['name'].toString(), - code: map['code'].toString(), - nativeName: map['nativeName'].toString(), - ); - } + factory Language.fromMap(Map map) { + return Language( + name: map['name'].toString(), + code: map['code'].toString(), + nativeName: map['nativeName'].toString(), + ); + } - Map toMap() { - return { - "name": name, - "code": code, - "nativeName": nativeName, - }; - } + Map toMap() { + return {"name": name, "code": code, "nativeName": nativeName}; + } } diff --git a/lib/src/models/language_list.dart b/lib/src/models/language_list.dart index fe271118..046b879e 100644 --- a/lib/src/models/language_list.dart +++ b/lib/src/models/language_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Languages List class LanguageList implements Model { - /// Total number of languages documents that matched your query. - final int total; + /// Total number of languages documents that matched your query. + final int total; - /// List of languages. - final List languages; + /// List of languages. + final List languages; - LanguageList({ - required this.total, - required this.languages, - }); + LanguageList({required this.total, required this.languages}); - factory LanguageList.fromMap(Map map) { - return LanguageList( - total: map['total'], - languages: List.from(map['languages'].map((p) => Language.fromMap(p))), - ); - } + factory LanguageList.fromMap(Map map) { + return LanguageList( + total: map['total'], + languages: List.from( + map['languages'].map((p) => Language.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "languages": languages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "languages": languages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/locale.dart b/lib/src/models/locale.dart index b5e9ad1a..084475bf 100644 --- a/lib/src/models/locale.dart +++ b/lib/src/models/locale.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// Locale class Locale implements Model { - /// User IP address. - final String ip; - - /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format - final String countryCode; - - /// Country name. This field support localization. - final String country; - - /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. - final String continentCode; - - /// Continent name. This field support localization. - final String continent; - - /// True if country is part of the European Union. - final bool eu; - - /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format - final String currency; - - Locale({ - required this.ip, - required this.countryCode, - required this.country, - required this.continentCode, - required this.continent, - required this.eu, - required this.currency, - }); - - factory Locale.fromMap(Map map) { - return Locale( - ip: map['ip'].toString(), - countryCode: map['countryCode'].toString(), - country: map['country'].toString(), - continentCode: map['continentCode'].toString(), - continent: map['continent'].toString(), - eu: map['eu'], - currency: map['currency'].toString(), - ); - } - - Map toMap() { - return { - "ip": ip, - "countryCode": countryCode, - "country": country, - "continentCode": continentCode, - "continent": continent, - "eu": eu, - "currency": currency, - }; - } + /// User IP address. + final String ip; + + /// Country code in [ISO 3166-1](http://en.wikipedia.org/wiki/ISO_3166-1) two-character format + final String countryCode; + + /// Country name. This field support localization. + final String country; + + /// Continent code. A two character continent code "AF" for Africa, "AN" for Antarctica, "AS" for Asia, "EU" for Europe, "NA" for North America, "OC" for Oceania, and "SA" for South America. + final String continentCode; + + /// Continent name. This field support localization. + final String continent; + + /// True if country is part of the European Union. + final bool eu; + + /// Currency code in [ISO 4217-1](http://en.wikipedia.org/wiki/ISO_4217) three-character format + final String currency; + + Locale({ + required this.ip, + required this.countryCode, + required this.country, + required this.continentCode, + required this.continent, + required this.eu, + required this.currency, + }); + + factory Locale.fromMap(Map map) { + return Locale( + ip: map['ip'].toString(), + countryCode: map['countryCode'].toString(), + country: map['country'].toString(), + continentCode: map['continentCode'].toString(), + continent: map['continent'].toString(), + eu: map['eu'], + currency: map['currency'].toString(), + ); + } + + Map toMap() { + return { + "ip": ip, + "countryCode": countryCode, + "country": country, + "continentCode": continentCode, + "continent": continent, + "eu": eu, + "currency": currency, + }; + } } diff --git a/lib/src/models/locale_code.dart b/lib/src/models/locale_code.dart index 10499ef5..cd5a1155 100644 --- a/lib/src/models/locale_code.dart +++ b/lib/src/models/locale_code.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// LocaleCode class LocaleCode implements Model { - /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) - final String code; + /// Locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) + final String code; - /// Locale name - final String name; + /// Locale name + final String name; - LocaleCode({ - required this.code, - required this.name, - }); + LocaleCode({required this.code, required this.name}); - factory LocaleCode.fromMap(Map map) { - return LocaleCode( - code: map['code'].toString(), - name: map['name'].toString(), - ); - } + factory LocaleCode.fromMap(Map map) { + return LocaleCode( + code: map['code'].toString(), + name: map['name'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "name": name, - }; - } + Map toMap() { + return {"code": code, "name": name}; + } } diff --git a/lib/src/models/locale_code_list.dart b/lib/src/models/locale_code_list.dart index 839474d7..662fee4f 100644 --- a/lib/src/models/locale_code_list.dart +++ b/lib/src/models/locale_code_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Locale codes list class LocaleCodeList implements Model { - /// Total number of localeCodes documents that matched your query. - final int total; + /// Total number of localeCodes documents that matched your query. + final int total; - /// List of localeCodes. - final List localeCodes; + /// List of localeCodes. + final List localeCodes; - LocaleCodeList({ - required this.total, - required this.localeCodes, - }); + LocaleCodeList({required this.total, required this.localeCodes}); - factory LocaleCodeList.fromMap(Map map) { - return LocaleCodeList( - total: map['total'], - localeCodes: List.from(map['localeCodes'].map((p) => LocaleCode.fromMap(p))), - ); - } + factory LocaleCodeList.fromMap(Map map) { + return LocaleCodeList( + total: map['total'], + localeCodes: List.from( + map['localeCodes'].map((p) => LocaleCode.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "localeCodes": localeCodes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "localeCodes": localeCodes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/log.dart b/lib/src/models/log.dart index cb567bd7..7fb3f364 100644 --- a/lib/src/models/log.dart +++ b/lib/src/models/log.dart @@ -2,142 +2,142 @@ part of '../../models.dart'; /// Log class Log implements Model { - /// Event name. - final String event; - - /// User ID. - final String userId; - - /// User Email. - final String userEmail; - - /// User Name. - final String userName; - - /// API mode when event triggered. - final String mode; - - /// IP session in use when the session was created. - final String ip; - - /// Log creation date in ISO 8601 format. - final String time; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - Log({ - required this.event, - required this.userId, - required this.userEmail, - required this.userName, - required this.mode, - required this.ip, - required this.time, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - }); - - factory Log.fromMap(Map map) { - return Log( - event: map['event'].toString(), - userId: map['userId'].toString(), - userEmail: map['userEmail'].toString(), - userName: map['userName'].toString(), - mode: map['mode'].toString(), - ip: map['ip'].toString(), - time: map['time'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } - - Map toMap() { - return { - "event": event, - "userId": userId, - "userEmail": userEmail, - "userName": userName, - "mode": mode, - "ip": ip, - "time": time, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - }; - } + /// Event name. + final String event; + + /// User ID. + final String userId; + + /// User Email. + final String userEmail; + + /// User Name. + final String userName; + + /// API mode when event triggered. + final String mode; + + /// IP session in use when the session was created. + final String ip; + + /// Log creation date in ISO 8601 format. + final String time; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + Log({ + required this.event, + required this.userId, + required this.userEmail, + required this.userName, + required this.mode, + required this.ip, + required this.time, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + }); + + factory Log.fromMap(Map map) { + return Log( + event: map['event'].toString(), + userId: map['userId'].toString(), + userEmail: map['userEmail'].toString(), + userName: map['userName'].toString(), + mode: map['mode'].toString(), + ip: map['ip'].toString(), + time: map['time'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } + + Map toMap() { + return { + "event": event, + "userId": userId, + "userEmail": userEmail, + "userName": userName, + "mode": mode, + "ip": ip, + "time": time, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/log_list.dart b/lib/src/models/log_list.dart index 91d024d0..628237fa 100644 --- a/lib/src/models/log_list.dart +++ b/lib/src/models/log_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Logs List class LogList implements Model { - /// Total number of logs documents that matched your query. - final int total; + /// Total number of logs documents that matched your query. + final int total; - /// List of logs. - final List logs; + /// List of logs. + final List logs; - LogList({ - required this.total, - required this.logs, - }); + LogList({required this.total, required this.logs}); - factory LogList.fromMap(Map map) { - return LogList( - total: map['total'], - logs: List.from(map['logs'].map((p) => Log.fromMap(p))), - ); - } + factory LogList.fromMap(Map map) { + return LogList( + total: map['total'], + logs: List.from(map['logs'].map((p) => Log.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "logs": logs.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "logs": logs.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/membership.dart b/lib/src/models/membership.dart index 26610e46..8ee142ad 100644 --- a/lib/src/models/membership.dart +++ b/lib/src/models/membership.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Membership class Membership implements Model { - /// Membership ID. - final String $id; - - /// Membership creation date in ISO 8601 format. - final String $createdAt; - - /// Membership update date in ISO 8601 format. - final String $updatedAt; - - /// User ID. - final String userId; - - /// User name. Hide this attribute by toggling membership privacy in the Console. - final String userName; - - /// User email address. Hide this attribute by toggling membership privacy in the Console. - final String userEmail; - - /// Team ID. - final String teamId; - - /// Team name. - final String teamName; - - /// Date, the user has been invited to join the team in ISO 8601 format. - final String invited; - - /// Date, the user has accepted the invitation to join the team in ISO 8601 format. - final String joined; - - /// User confirmation status, true if the user has joined the team or false otherwise. - final bool confirm; - - /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. - final bool mfa; - - /// User list of roles - final List roles; - - Membership({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.userName, - required this.userEmail, - required this.teamId, - required this.teamName, - required this.invited, - required this.joined, - required this.confirm, - required this.mfa, - required this.roles, - }); - - factory Membership.fromMap(Map map) { - return Membership( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - userEmail: map['userEmail'].toString(), - teamId: map['teamId'].toString(), - teamName: map['teamName'].toString(), - invited: map['invited'].toString(), - joined: map['joined'].toString(), - confirm: map['confirm'], - mfa: map['mfa'], - roles: List.from(map['roles'] ?? []), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "userName": userName, - "userEmail": userEmail, - "teamId": teamId, - "teamName": teamName, - "invited": invited, - "joined": joined, - "confirm": confirm, - "mfa": mfa, - "roles": roles, - }; - } + /// Membership ID. + final String $id; + + /// Membership creation date in ISO 8601 format. + final String $createdAt; + + /// Membership update date in ISO 8601 format. + final String $updatedAt; + + /// User ID. + final String userId; + + /// User name. Hide this attribute by toggling membership privacy in the Console. + final String userName; + + /// User email address. Hide this attribute by toggling membership privacy in the Console. + final String userEmail; + + /// Team ID. + final String teamId; + + /// Team name. + final String teamName; + + /// Date, the user has been invited to join the team in ISO 8601 format. + final String invited; + + /// Date, the user has accepted the invitation to join the team in ISO 8601 format. + final String joined; + + /// User confirmation status, true if the user has joined the team or false otherwise. + final bool confirm; + + /// Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console. + final bool mfa; + + /// User list of roles + final List roles; + + Membership({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.userName, + required this.userEmail, + required this.teamId, + required this.teamName, + required this.invited, + required this.joined, + required this.confirm, + required this.mfa, + required this.roles, + }); + + factory Membership.fromMap(Map map) { + return Membership( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + userEmail: map['userEmail'].toString(), + teamId: map['teamId'].toString(), + teamName: map['teamName'].toString(), + invited: map['invited'].toString(), + joined: map['joined'].toString(), + confirm: map['confirm'], + mfa: map['mfa'], + roles: List.from(map['roles'] ?? []), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "userName": userName, + "userEmail": userEmail, + "teamId": teamId, + "teamName": teamName, + "invited": invited, + "joined": joined, + "confirm": confirm, + "mfa": mfa, + "roles": roles, + }; + } } diff --git a/lib/src/models/membership_list.dart b/lib/src/models/membership_list.dart index 409cdbfb..46468a3a 100644 --- a/lib/src/models/membership_list.dart +++ b/lib/src/models/membership_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Memberships List class MembershipList implements Model { - /// Total number of memberships documents that matched your query. - final int total; + /// Total number of memberships documents that matched your query. + final int total; - /// List of memberships. - final List memberships; + /// List of memberships. + final List memberships; - MembershipList({ - required this.total, - required this.memberships, - }); + MembershipList({required this.total, required this.memberships}); - factory MembershipList.fromMap(Map map) { - return MembershipList( - total: map['total'], - memberships: List.from(map['memberships'].map((p) => Membership.fromMap(p))), - ); - } + factory MembershipList.fromMap(Map map) { + return MembershipList( + total: map['total'], + memberships: List.from( + map['memberships'].map((p) => Membership.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "memberships": memberships.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "memberships": memberships.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/message.dart b/lib/src/models/message.dart index c4e9e858..9b93b00d 100644 --- a/lib/src/models/message.dart +++ b/lib/src/models/message.dart @@ -2,94 +2,94 @@ part of '../../models.dart'; /// Message class Message implements Model { - /// Message ID. - final String $id; - - /// Message creation time in ISO 8601 format. - final String $createdAt; - - /// Message update date in ISO 8601 format. - final String $updatedAt; - - /// Message provider type. - final String providerType; - - /// Topic IDs set as recipients. - final List topics; - - /// User IDs set as recipients. - final List users; - - /// Target IDs set as recipients. - final List targets; - - /// The scheduled time for message. - final String? scheduledAt; - - /// The time when the message was delivered. - final String? deliveredAt; - - /// Delivery errors if any. - final List? deliveryErrors; - - /// Number of recipients the message was delivered to. - final int deliveredTotal; - - /// Data of the message. - final Map data; - - /// Status of delivery. - final String status; - - Message({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.providerType, - required this.topics, - required this.users, - required this.targets, - this.scheduledAt, - this.deliveredAt, - this.deliveryErrors, - required this.deliveredTotal, - required this.data, - required this.status, - }); - - factory Message.fromMap(Map map) { - return Message( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - providerType: map['providerType'].toString(), - topics: List.from(map['topics'] ?? []), - users: List.from(map['users'] ?? []), - targets: List.from(map['targets'] ?? []), - scheduledAt: map['scheduledAt']?.toString(), - deliveredAt: map['deliveredAt']?.toString(), - deliveryErrors: List.from(map['deliveryErrors'] ?? []), - deliveredTotal: map['deliveredTotal'], - data: map['data'], - status: map['status'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "providerType": providerType, - "topics": topics, - "users": users, - "targets": targets, - "scheduledAt": scheduledAt, - "deliveredAt": deliveredAt, - "deliveryErrors": deliveryErrors, - "deliveredTotal": deliveredTotal, - "data": data, - "status": status, - }; - } + /// Message ID. + final String $id; + + /// Message creation time in ISO 8601 format. + final String $createdAt; + + /// Message update date in ISO 8601 format. + final String $updatedAt; + + /// Message provider type. + final String providerType; + + /// Topic IDs set as recipients. + final List topics; + + /// User IDs set as recipients. + final List users; + + /// Target IDs set as recipients. + final List targets; + + /// The scheduled time for message. + final String? scheduledAt; + + /// The time when the message was delivered. + final String? deliveredAt; + + /// Delivery errors if any. + final List? deliveryErrors; + + /// Number of recipients the message was delivered to. + final int deliveredTotal; + + /// Data of the message. + final Map data; + + /// Status of delivery. + final String status; + + Message({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.providerType, + required this.topics, + required this.users, + required this.targets, + this.scheduledAt, + this.deliveredAt, + this.deliveryErrors, + required this.deliveredTotal, + required this.data, + required this.status, + }); + + factory Message.fromMap(Map map) { + return Message( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + providerType: map['providerType'].toString(), + topics: List.from(map['topics'] ?? []), + users: List.from(map['users'] ?? []), + targets: List.from(map['targets'] ?? []), + scheduledAt: map['scheduledAt']?.toString(), + deliveredAt: map['deliveredAt']?.toString(), + deliveryErrors: List.from(map['deliveryErrors'] ?? []), + deliveredTotal: map['deliveredTotal'], + data: map['data'], + status: map['status'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "providerType": providerType, + "topics": topics, + "users": users, + "targets": targets, + "scheduledAt": scheduledAt, + "deliveredAt": deliveredAt, + "deliveryErrors": deliveryErrors, + "deliveredTotal": deliveredTotal, + "data": data, + "status": status, + }; + } } diff --git a/lib/src/models/message_list.dart b/lib/src/models/message_list.dart index 702c912b..7bd0891f 100644 --- a/lib/src/models/message_list.dart +++ b/lib/src/models/message_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Message list class MessageList implements Model { - /// Total number of messages documents that matched your query. - final int total; + /// Total number of messages documents that matched your query. + final int total; - /// List of messages. - final List messages; + /// List of messages. + final List messages; - MessageList({ - required this.total, - required this.messages, - }); + MessageList({required this.total, required this.messages}); - factory MessageList.fromMap(Map map) { - return MessageList( - total: map['total'], - messages: List.from(map['messages'].map((p) => Message.fromMap(p))), - ); - } + factory MessageList.fromMap(Map map) { + return MessageList( + total: map['total'], + messages: List.from( + map['messages'].map((p) => Message.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "messages": messages.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "messages": messages.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/mfa_challenge.dart b/lib/src/models/mfa_challenge.dart index 46c166fb..96bf3c65 100644 --- a/lib/src/models/mfa_challenge.dart +++ b/lib/src/models/mfa_challenge.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFA Challenge class MfaChallenge implements Model { - /// Token ID. - final String $id; + /// Token ID. + final String $id; - /// Token creation date in ISO 8601 format. - final String $createdAt; + /// Token creation date in ISO 8601 format. + final String $createdAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Token expiration date in ISO 8601 format. - final String expire; + /// Token expiration date in ISO 8601 format. + final String expire; - MfaChallenge({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.expire, - }); + MfaChallenge({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.expire, + }); - factory MfaChallenge.fromMap(Map map) { - return MfaChallenge( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - ); - } + factory MfaChallenge.fromMap(Map map) { + return MfaChallenge( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "expire": expire, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "expire": expire, + }; + } } diff --git a/lib/src/models/mfa_factors.dart b/lib/src/models/mfa_factors.dart index d49989d8..c930a23e 100644 --- a/lib/src/models/mfa_factors.dart +++ b/lib/src/models/mfa_factors.dart @@ -2,40 +2,40 @@ part of '../../models.dart'; /// MFAFactors class MfaFactors implements Model { - /// Can TOTP be used for MFA challenge for this account. - final bool totp; + /// Can TOTP be used for MFA challenge for this account. + final bool totp; - /// Can phone (SMS) be used for MFA challenge for this account. - final bool phone; + /// Can phone (SMS) be used for MFA challenge for this account. + final bool phone; - /// Can email be used for MFA challenge for this account. - final bool email; + /// Can email be used for MFA challenge for this account. + final bool email; - /// Can recovery code be used for MFA challenge for this account. - final bool recoveryCode; + /// Can recovery code be used for MFA challenge for this account. + final bool recoveryCode; - MfaFactors({ - required this.totp, - required this.phone, - required this.email, - required this.recoveryCode, - }); + MfaFactors({ + required this.totp, + required this.phone, + required this.email, + required this.recoveryCode, + }); - factory MfaFactors.fromMap(Map map) { - return MfaFactors( - totp: map['totp'], - phone: map['phone'], - email: map['email'], - recoveryCode: map['recoveryCode'], - ); - } + factory MfaFactors.fromMap(Map map) { + return MfaFactors( + totp: map['totp'], + phone: map['phone'], + email: map['email'], + recoveryCode: map['recoveryCode'], + ); + } - Map toMap() { - return { - "totp": totp, - "phone": phone, - "email": email, - "recoveryCode": recoveryCode, - }; - } + Map toMap() { + return { + "totp": totp, + "phone": phone, + "email": email, + "recoveryCode": recoveryCode, + }; + } } diff --git a/lib/src/models/mfa_recovery_codes.dart b/lib/src/models/mfa_recovery_codes.dart index 6c8b4e36..63411988 100644 --- a/lib/src/models/mfa_recovery_codes.dart +++ b/lib/src/models/mfa_recovery_codes.dart @@ -2,22 +2,18 @@ part of '../../models.dart'; /// MFA Recovery Codes class MfaRecoveryCodes implements Model { - /// Recovery codes. - final List recoveryCodes; + /// Recovery codes. + final List recoveryCodes; - MfaRecoveryCodes({ - required this.recoveryCodes, - }); + MfaRecoveryCodes({required this.recoveryCodes}); - factory MfaRecoveryCodes.fromMap(Map map) { - return MfaRecoveryCodes( - recoveryCodes: List.from(map['recoveryCodes'] ?? []), - ); - } + factory MfaRecoveryCodes.fromMap(Map map) { + return MfaRecoveryCodes( + recoveryCodes: List.from(map['recoveryCodes'] ?? []), + ); + } - Map toMap() { - return { - "recoveryCodes": recoveryCodes, - }; - } + Map toMap() { + return {"recoveryCodes": recoveryCodes}; + } } diff --git a/lib/src/models/mfa_type.dart b/lib/src/models/mfa_type.dart index 01cf0857..fa57cb8b 100644 --- a/lib/src/models/mfa_type.dart +++ b/lib/src/models/mfa_type.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// MFAType class MfaType implements Model { - /// Secret token used for TOTP factor. - final String secret; + /// Secret token used for TOTP factor. + final String secret; - /// URI for authenticator apps. - final String uri; + /// URI for authenticator apps. + final String uri; - MfaType({ - required this.secret, - required this.uri, - }); + MfaType({required this.secret, required this.uri}); - factory MfaType.fromMap(Map map) { - return MfaType( - secret: map['secret'].toString(), - uri: map['uri'].toString(), - ); - } + factory MfaType.fromMap(Map map) { + return MfaType( + secret: map['secret'].toString(), + uri: map['uri'].toString(), + ); + } - Map toMap() { - return { - "secret": secret, - "uri": uri, - }; - } + Map toMap() { + return {"secret": secret, "uri": uri}; + } } diff --git a/lib/src/models/model.dart b/lib/src/models/model.dart index 48e5b84a..f810a35b 100644 --- a/lib/src/models/model.dart +++ b/lib/src/models/model.dart @@ -2,4 +2,4 @@ part of '../../models.dart'; abstract class Model { Map toMap(); -} \ No newline at end of file +} diff --git a/lib/src/models/phone.dart b/lib/src/models/phone.dart index c8bbb95b..40f7bcd2 100644 --- a/lib/src/models/phone.dart +++ b/lib/src/models/phone.dart @@ -2,34 +2,34 @@ part of '../../models.dart'; /// Phone class Phone implements Model { - /// Phone code. - final String code; + /// Phone code. + final String code; - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; - /// Country name. - final String countryName; + /// Country name. + final String countryName; - Phone({ - required this.code, - required this.countryCode, - required this.countryName, - }); + Phone({ + required this.code, + required this.countryCode, + required this.countryName, + }); - factory Phone.fromMap(Map map) { - return Phone( - code: map['code'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - ); - } + factory Phone.fromMap(Map map) { + return Phone( + code: map['code'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + ); + } - Map toMap() { - return { - "code": code, - "countryCode": countryCode, - "countryName": countryName, - }; - } + Map toMap() { + return { + "code": code, + "countryCode": countryCode, + "countryName": countryName, + }; + } } diff --git a/lib/src/models/phone_list.dart b/lib/src/models/phone_list.dart index beab76e8..18d2803d 100644 --- a/lib/src/models/phone_list.dart +++ b/lib/src/models/phone_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Phones List class PhoneList implements Model { - /// Total number of phones documents that matched your query. - final int total; + /// Total number of phones documents that matched your query. + final int total; - /// List of phones. - final List phones; + /// List of phones. + final List phones; - PhoneList({ - required this.total, - required this.phones, - }); + PhoneList({required this.total, required this.phones}); - factory PhoneList.fromMap(Map map) { - return PhoneList( - total: map['total'], - phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), - ); - } + factory PhoneList.fromMap(Map map) { + return PhoneList( + total: map['total'], + phones: List.from(map['phones'].map((p) => Phone.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "phones": phones.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "phones": phones.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/preferences.dart b/lib/src/models/preferences.dart index 3c62f86d..48163dfc 100644 --- a/lib/src/models/preferences.dart +++ b/lib/src/models/preferences.dart @@ -2,23 +2,17 @@ part of '../../models.dart'; /// Preferences class Preferences implements Model { - final Map data; + final Map data; - Preferences({ - required this.data, - }); + Preferences({required this.data}); - factory Preferences.fromMap(Map map) { - return Preferences( - data: map, - ); - } + factory Preferences.fromMap(Map map) { + return Preferences(data: map); + } - Map toMap() { - return { - "data": data, - }; - } + Map toMap() { + return {"data": data}; + } - T convertTo(T Function(Map) fromJson) => fromJson(data); + T convertTo(T Function(Map) fromJson) => fromJson(data); } diff --git a/lib/src/models/provider.dart b/lib/src/models/provider.dart index 4295c486..1a762f85 100644 --- a/lib/src/models/provider.dart +++ b/lib/src/models/provider.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Provider class Provider implements Model { - /// Provider ID. - final String $id; + /// Provider ID. + final String $id; - /// Provider creation time in ISO 8601 format. - final String $createdAt; + /// Provider creation time in ISO 8601 format. + final String $createdAt; - /// Provider update date in ISO 8601 format. - final String $updatedAt; + /// Provider update date in ISO 8601 format. + final String $updatedAt; - /// The name for the provider instance. - final String name; + /// The name for the provider instance. + final String name; - /// The name of the provider service. - final String provider; + /// The name of the provider service. + final String provider; - /// Is provider enabled? - final bool enabled; + /// Is provider enabled? + final bool enabled; - /// Type of provider. - final String type; + /// Type of provider. + final String type; - /// Provider credentials. - final Map credentials; + /// Provider credentials. + final Map credentials; - /// Provider options. - final Map? options; + /// Provider options. + final Map? options; - Provider({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.provider, - required this.enabled, - required this.type, - required this.credentials, - this.options, - }); + Provider({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.provider, + required this.enabled, + required this.type, + required this.credentials, + this.options, + }); - factory Provider.fromMap(Map map) { - return Provider( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - provider: map['provider'].toString(), - enabled: map['enabled'], - type: map['type'].toString(), - credentials: map['credentials'], - options: map['options'], - ); - } + factory Provider.fromMap(Map map) { + return Provider( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + provider: map['provider'].toString(), + enabled: map['enabled'], + type: map['type'].toString(), + credentials: map['credentials'], + options: map['options'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "provider": provider, - "enabled": enabled, - "type": type, - "credentials": credentials, - "options": options, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "provider": provider, + "enabled": enabled, + "type": type, + "credentials": credentials, + "options": options, + }; + } } diff --git a/lib/src/models/provider_list.dart b/lib/src/models/provider_list.dart index 7c09eb56..aeb28ecd 100644 --- a/lib/src/models/provider_list.dart +++ b/lib/src/models/provider_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Provider list class ProviderList implements Model { - /// Total number of providers documents that matched your query. - final int total; + /// Total number of providers documents that matched your query. + final int total; - /// List of providers. - final List providers; + /// List of providers. + final List providers; - ProviderList({ - required this.total, - required this.providers, - }); + ProviderList({required this.total, required this.providers}); - factory ProviderList.fromMap(Map map) { - return ProviderList( - total: map['total'], - providers: List.from(map['providers'].map((p) => Provider.fromMap(p))), - ); - } + factory ProviderList.fromMap(Map map) { + return ProviderList( + total: map['total'], + providers: List.from( + map['providers'].map((p) => Provider.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "providers": providers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "providers": providers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/resource_token.dart b/lib/src/models/resource_token.dart index ed520cc4..dad35dcc 100644 --- a/lib/src/models/resource_token.dart +++ b/lib/src/models/resource_token.dart @@ -2,58 +2,58 @@ part of '../../models.dart'; /// ResourceToken class ResourceToken implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// Resource ID. - final String resourceId; - - /// Resource type. - final String resourceType; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// JWT encoded string. - final String secret; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - ResourceToken({ - required this.$id, - required this.$createdAt, - required this.resourceId, - required this.resourceType, - required this.expire, - required this.secret, - required this.accessedAt, - }); - - factory ResourceToken.fromMap(Map map) { - return ResourceToken( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - resourceId: map['resourceId'].toString(), - resourceType: map['resourceType'].toString(), - expire: map['expire'].toString(), - secret: map['secret'].toString(), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "resourceId": resourceId, - "resourceType": resourceType, - "expire": expire, - "secret": secret, - "accessedAt": accessedAt, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// Resource ID. + final String resourceId; + + /// Resource type. + final String resourceType; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// JWT encoded string. + final String secret; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + ResourceToken({ + required this.$id, + required this.$createdAt, + required this.resourceId, + required this.resourceType, + required this.expire, + required this.secret, + required this.accessedAt, + }); + + factory ResourceToken.fromMap(Map map) { + return ResourceToken( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + resourceId: map['resourceId'].toString(), + resourceType: map['resourceType'].toString(), + expire: map['expire'].toString(), + secret: map['secret'].toString(), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "resourceId": resourceId, + "resourceType": resourceType, + "expire": expire, + "secret": secret, + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/resource_token_list.dart b/lib/src/models/resource_token_list.dart index ba8f0d89..f30531f4 100644 --- a/lib/src/models/resource_token_list.dart +++ b/lib/src/models/resource_token_list.dart @@ -2,28 +2,24 @@ part of '../../models.dart'; /// Resource Tokens List class ResourceTokenList implements Model { - /// Total number of tokens documents that matched your query. - final int total; + /// Total number of tokens documents that matched your query. + final int total; - /// List of tokens. - final List tokens; + /// List of tokens. + final List tokens; - ResourceTokenList({ - required this.total, - required this.tokens, - }); + ResourceTokenList({required this.total, required this.tokens}); - factory ResourceTokenList.fromMap(Map map) { - return ResourceTokenList( - total: map['total'], - tokens: List.from(map['tokens'].map((p) => ResourceToken.fromMap(p))), - ); - } + factory ResourceTokenList.fromMap(Map map) { + return ResourceTokenList( + total: map['total'], + tokens: List.from( + map['tokens'].map((p) => ResourceToken.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "tokens": tokens.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "tokens": tokens.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/runtime.dart b/lib/src/models/runtime.dart index 35f82cfa..7c9677d8 100644 --- a/lib/src/models/runtime.dart +++ b/lib/src/models/runtime.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Runtime class Runtime implements Model { - /// Runtime ID. - final String $id; + /// Runtime ID. + final String $id; - /// Parent runtime key. - final String key; + /// Parent runtime key. + final String key; - /// Runtime Name. - final String name; + /// Runtime Name. + final String name; - /// Runtime version. - final String version; + /// Runtime version. + final String version; - /// Base Docker image used to build the runtime. - final String base; + /// Base Docker image used to build the runtime. + final String base; - /// Image name of Docker Hub. - final String image; + /// Image name of Docker Hub. + final String image; - /// Name of the logo image. - final String logo; + /// Name of the logo image. + final String logo; - /// List of supported architectures. - final List supports; + /// List of supported architectures. + final List supports; - Runtime({ - required this.$id, - required this.key, - required this.name, - required this.version, - required this.base, - required this.image, - required this.logo, - required this.supports, - }); + Runtime({ + required this.$id, + required this.key, + required this.name, + required this.version, + required this.base, + required this.image, + required this.logo, + required this.supports, + }); - factory Runtime.fromMap(Map map) { - return Runtime( - $id: map['\$id'].toString(), - key: map['key'].toString(), - name: map['name'].toString(), - version: map['version'].toString(), - base: map['base'].toString(), - image: map['image'].toString(), - logo: map['logo'].toString(), - supports: List.from(map['supports'] ?? []), - ); - } + factory Runtime.fromMap(Map map) { + return Runtime( + $id: map['\$id'].toString(), + key: map['key'].toString(), + name: map['name'].toString(), + version: map['version'].toString(), + base: map['base'].toString(), + image: map['image'].toString(), + logo: map['logo'].toString(), + supports: List.from(map['supports'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "key": key, - "name": name, - "version": version, - "base": base, - "image": image, - "logo": logo, - "supports": supports, - }; - } + Map toMap() { + return { + "\$id": $id, + "key": key, + "name": name, + "version": version, + "base": base, + "image": image, + "logo": logo, + "supports": supports, + }; + } } diff --git a/lib/src/models/runtime_list.dart b/lib/src/models/runtime_list.dart index 7615fd9e..02c7b2e5 100644 --- a/lib/src/models/runtime_list.dart +++ b/lib/src/models/runtime_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Runtimes List class RuntimeList implements Model { - /// Total number of runtimes documents that matched your query. - final int total; + /// Total number of runtimes documents that matched your query. + final int total; - /// List of runtimes. - final List runtimes; + /// List of runtimes. + final List runtimes; - RuntimeList({ - required this.total, - required this.runtimes, - }); + RuntimeList({required this.total, required this.runtimes}); - factory RuntimeList.fromMap(Map map) { - return RuntimeList( - total: map['total'], - runtimes: List.from(map['runtimes'].map((p) => Runtime.fromMap(p))), - ); - } + factory RuntimeList.fromMap(Map map) { + return RuntimeList( + total: map['total'], + runtimes: List.from( + map['runtimes'].map((p) => Runtime.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "runtimes": runtimes.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "runtimes": runtimes.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/session.dart b/lib/src/models/session.dart index 3a1d955f..d2fe4f64 100644 --- a/lib/src/models/session.dart +++ b/lib/src/models/session.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Session class Session implements Model { - /// Session ID. - final String $id; + /// Session ID. + final String $id; - /// Session creation date in ISO 8601 format. - final String $createdAt; + /// Session creation date in ISO 8601 format. + final String $createdAt; - /// Session update date in ISO 8601 format. - final String $updatedAt; + /// Session update date in ISO 8601 format. + final String $updatedAt; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Session expiration date in ISO 8601 format. - final String expire; + /// Session expiration date in ISO 8601 format. + final String expire; - /// Session Provider. - final String provider; + /// Session Provider. + final String provider; - /// Session Provider User ID. - final String providerUid; + /// Session Provider User ID. + final String providerUid; - /// Session Provider Access Token. - final String providerAccessToken; - - /// The date of when the access token expires in ISO 8601 format. - final String providerAccessTokenExpiry; - - /// Session Provider Refresh Token. - final String providerRefreshToken; - - /// IP in use when the session was created. - final String ip; - - /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). - final String osCode; - - /// Operating system name. - final String osName; - - /// Operating system version. - final String osVersion; - - /// Client type. - final String clientType; - - /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). - final String clientCode; - - /// Client name. - final String clientName; - - /// Client version. - final String clientVersion; - - /// Client engine name. - final String clientEngine; - - /// Client engine name. - final String clientEngineVersion; - - /// Device name. - final String deviceName; - - /// Device brand name. - final String deviceBrand; - - /// Device model name. - final String deviceModel; - - /// Country two-character ISO 3166-1 alpha code. - final String countryCode; - - /// Country name. - final String countryName; - - /// Returns true if this the current user session. - final bool current; - - /// Returns a list of active session factors. - final List factors; - - /// Secret used to authenticate the user. Only included if the request was made with an API key - final String secret; - - /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. - final String mfaUpdatedAt; - - Session({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.userId, - required this.expire, - required this.provider, - required this.providerUid, - required this.providerAccessToken, - required this.providerAccessTokenExpiry, - required this.providerRefreshToken, - required this.ip, - required this.osCode, - required this.osName, - required this.osVersion, - required this.clientType, - required this.clientCode, - required this.clientName, - required this.clientVersion, - required this.clientEngine, - required this.clientEngineVersion, - required this.deviceName, - required this.deviceBrand, - required this.deviceModel, - required this.countryCode, - required this.countryName, - required this.current, - required this.factors, - required this.secret, - required this.mfaUpdatedAt, - }); - - factory Session.fromMap(Map map) { - return Session( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - userId: map['userId'].toString(), - expire: map['expire'].toString(), - provider: map['provider'].toString(), - providerUid: map['providerUid'].toString(), - providerAccessToken: map['providerAccessToken'].toString(), - providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), - providerRefreshToken: map['providerRefreshToken'].toString(), - ip: map['ip'].toString(), - osCode: map['osCode'].toString(), - osName: map['osName'].toString(), - osVersion: map['osVersion'].toString(), - clientType: map['clientType'].toString(), - clientCode: map['clientCode'].toString(), - clientName: map['clientName'].toString(), - clientVersion: map['clientVersion'].toString(), - clientEngine: map['clientEngine'].toString(), - clientEngineVersion: map['clientEngineVersion'].toString(), - deviceName: map['deviceName'].toString(), - deviceBrand: map['deviceBrand'].toString(), - deviceModel: map['deviceModel'].toString(), - countryCode: map['countryCode'].toString(), - countryName: map['countryName'].toString(), - current: map['current'], - factors: List.from(map['factors'] ?? []), - secret: map['secret'].toString(), - mfaUpdatedAt: map['mfaUpdatedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "userId": userId, - "expire": expire, - "provider": provider, - "providerUid": providerUid, - "providerAccessToken": providerAccessToken, - "providerAccessTokenExpiry": providerAccessTokenExpiry, - "providerRefreshToken": providerRefreshToken, - "ip": ip, - "osCode": osCode, - "osName": osName, - "osVersion": osVersion, - "clientType": clientType, - "clientCode": clientCode, - "clientName": clientName, - "clientVersion": clientVersion, - "clientEngine": clientEngine, - "clientEngineVersion": clientEngineVersion, - "deviceName": deviceName, - "deviceBrand": deviceBrand, - "deviceModel": deviceModel, - "countryCode": countryCode, - "countryName": countryName, - "current": current, - "factors": factors, - "secret": secret, - "mfaUpdatedAt": mfaUpdatedAt, - }; - } + /// Session Provider Access Token. + final String providerAccessToken; + + /// The date of when the access token expires in ISO 8601 format. + final String providerAccessTokenExpiry; + + /// Session Provider Refresh Token. + final String providerRefreshToken; + + /// IP in use when the session was created. + final String ip; + + /// Operating system code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/os.json). + final String osCode; + + /// Operating system name. + final String osName; + + /// Operating system version. + final String osVersion; + + /// Client type. + final String clientType; + + /// Client code name. View list of [available options](https://github.com/appwrite/appwrite/blob/master/docs/lists/clients.json). + final String clientCode; + + /// Client name. + final String clientName; + + /// Client version. + final String clientVersion; + + /// Client engine name. + final String clientEngine; + + /// Client engine name. + final String clientEngineVersion; + + /// Device name. + final String deviceName; + + /// Device brand name. + final String deviceBrand; + + /// Device model name. + final String deviceModel; + + /// Country two-character ISO 3166-1 alpha code. + final String countryCode; + + /// Country name. + final String countryName; + + /// Returns true if this the current user session. + final bool current; + + /// Returns a list of active session factors. + final List factors; + + /// Secret used to authenticate the user. Only included if the request was made with an API key + final String secret; + + /// Most recent date in ISO 8601 format when the session successfully passed MFA challenge. + final String mfaUpdatedAt; + + Session({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.userId, + required this.expire, + required this.provider, + required this.providerUid, + required this.providerAccessToken, + required this.providerAccessTokenExpiry, + required this.providerRefreshToken, + required this.ip, + required this.osCode, + required this.osName, + required this.osVersion, + required this.clientType, + required this.clientCode, + required this.clientName, + required this.clientVersion, + required this.clientEngine, + required this.clientEngineVersion, + required this.deviceName, + required this.deviceBrand, + required this.deviceModel, + required this.countryCode, + required this.countryName, + required this.current, + required this.factors, + required this.secret, + required this.mfaUpdatedAt, + }); + + factory Session.fromMap(Map map) { + return Session( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + userId: map['userId'].toString(), + expire: map['expire'].toString(), + provider: map['provider'].toString(), + providerUid: map['providerUid'].toString(), + providerAccessToken: map['providerAccessToken'].toString(), + providerAccessTokenExpiry: map['providerAccessTokenExpiry'].toString(), + providerRefreshToken: map['providerRefreshToken'].toString(), + ip: map['ip'].toString(), + osCode: map['osCode'].toString(), + osName: map['osName'].toString(), + osVersion: map['osVersion'].toString(), + clientType: map['clientType'].toString(), + clientCode: map['clientCode'].toString(), + clientName: map['clientName'].toString(), + clientVersion: map['clientVersion'].toString(), + clientEngine: map['clientEngine'].toString(), + clientEngineVersion: map['clientEngineVersion'].toString(), + deviceName: map['deviceName'].toString(), + deviceBrand: map['deviceBrand'].toString(), + deviceModel: map['deviceModel'].toString(), + countryCode: map['countryCode'].toString(), + countryName: map['countryName'].toString(), + current: map['current'], + factors: List.from(map['factors'] ?? []), + secret: map['secret'].toString(), + mfaUpdatedAt: map['mfaUpdatedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "userId": userId, + "expire": expire, + "provider": provider, + "providerUid": providerUid, + "providerAccessToken": providerAccessToken, + "providerAccessTokenExpiry": providerAccessTokenExpiry, + "providerRefreshToken": providerRefreshToken, + "ip": ip, + "osCode": osCode, + "osName": osName, + "osVersion": osVersion, + "clientType": clientType, + "clientCode": clientCode, + "clientName": clientName, + "clientVersion": clientVersion, + "clientEngine": clientEngine, + "clientEngineVersion": clientEngineVersion, + "deviceName": deviceName, + "deviceBrand": deviceBrand, + "deviceModel": deviceModel, + "countryCode": countryCode, + "countryName": countryName, + "current": current, + "factors": factors, + "secret": secret, + "mfaUpdatedAt": mfaUpdatedAt, + }; + } } diff --git a/lib/src/models/session_list.dart b/lib/src/models/session_list.dart index 6d26d6a8..479272b9 100644 --- a/lib/src/models/session_list.dart +++ b/lib/src/models/session_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Sessions List class SessionList implements Model { - /// Total number of sessions documents that matched your query. - final int total; + /// Total number of sessions documents that matched your query. + final int total; - /// List of sessions. - final List sessions; + /// List of sessions. + final List sessions; - SessionList({ - required this.total, - required this.sessions, - }); + SessionList({required this.total, required this.sessions}); - factory SessionList.fromMap(Map map) { - return SessionList( - total: map['total'], - sessions: List.from(map['sessions'].map((p) => Session.fromMap(p))), - ); - } + factory SessionList.fromMap(Map map) { + return SessionList( + total: map['total'], + sessions: List.from( + map['sessions'].map((p) => Session.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "sessions": sessions.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "sessions": sessions.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/site.dart b/lib/src/models/site.dart index 5cda6acc..1449f8bd 100644 --- a/lib/src/models/site.dart +++ b/lib/src/models/site.dart @@ -2,190 +2,190 @@ part of '../../models.dart'; /// Site class Site implements Model { - /// Site ID. - final String $id; + /// Site ID. + final String $id; - /// Site creation date in ISO 8601 format. - final String $createdAt; + /// Site creation date in ISO 8601 format. + final String $createdAt; - /// Site update date in ISO 8601 format. - final String $updatedAt; + /// Site update date in ISO 8601 format. + final String $updatedAt; - /// Site name. - final String name; + /// Site name. + final String name; - /// Site enabled. - final bool enabled; + /// Site enabled. + final bool enabled; - /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. - final bool live; + /// Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration. + final bool live; - /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. - final bool logging; + /// When disabled, request logs will exclude logs and errors, and site responses will be slightly faster. + final bool logging; - /// Site framework. - final String framework; - - /// Site's active deployment ID. - final String deploymentId; - - /// Active deployment creation date in ISO 8601 format. - final String deploymentCreatedAt; - - /// Screenshot of active deployment with light theme preference file ID. - final String deploymentScreenshotLight; - - /// Screenshot of active deployment with dark theme preference file ID. - final String deploymentScreenshotDark; - - /// Site's latest deployment ID. - final String latestDeploymentId; - - /// Latest deployment creation date in ISO 8601 format. - final String latestDeploymentCreatedAt; - - /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". - final String latestDeploymentStatus; - - /// Site variables. - final List vars; - - /// Site request timeout in seconds. - final int timeout; - - /// The install command used to install the site dependencies. - final String installCommand; - - /// The build command used to build the site. - final String buildCommand; - - /// The directory where the site build output is located. - final String outputDirectory; - - /// Site VCS (Version Control System) installation id. - final String installationId; - - /// VCS (Version Control System) Repository ID - final String providerRepositoryId; - - /// VCS (Version Control System) branch name - final String providerBranch; - - /// Path to site in VCS (Version Control System) repository - final String providerRootDirectory; - - /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests - final bool providerSilentMode; - - /// Machine specification for builds and executions. - final String specification; - - /// Site build runtime. - final String buildRuntime; - - /// Site framework adapter. - final String adapter; - - /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. - final String fallbackFile; - - Site({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.enabled, - required this.live, - required this.logging, - required this.framework, - required this.deploymentId, - required this.deploymentCreatedAt, - required this.deploymentScreenshotLight, - required this.deploymentScreenshotDark, - required this.latestDeploymentId, - required this.latestDeploymentCreatedAt, - required this.latestDeploymentStatus, - required this.vars, - required this.timeout, - required this.installCommand, - required this.buildCommand, - required this.outputDirectory, - required this.installationId, - required this.providerRepositoryId, - required this.providerBranch, - required this.providerRootDirectory, - required this.providerSilentMode, - required this.specification, - required this.buildRuntime, - required this.adapter, - required this.fallbackFile, - }); - - factory Site.fromMap(Map map) { - return Site( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - enabled: map['enabled'], - live: map['live'], - logging: map['logging'], - framework: map['framework'].toString(), - deploymentId: map['deploymentId'].toString(), - deploymentCreatedAt: map['deploymentCreatedAt'].toString(), - deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), - deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), - latestDeploymentId: map['latestDeploymentId'].toString(), - latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), - latestDeploymentStatus: map['latestDeploymentStatus'].toString(), - vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), - timeout: map['timeout'], - installCommand: map['installCommand'].toString(), - buildCommand: map['buildCommand'].toString(), - outputDirectory: map['outputDirectory'].toString(), - installationId: map['installationId'].toString(), - providerRepositoryId: map['providerRepositoryId'].toString(), - providerBranch: map['providerBranch'].toString(), - providerRootDirectory: map['providerRootDirectory'].toString(), - providerSilentMode: map['providerSilentMode'], - specification: map['specification'].toString(), - buildRuntime: map['buildRuntime'].toString(), - adapter: map['adapter'].toString(), - fallbackFile: map['fallbackFile'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "enabled": enabled, - "live": live, - "logging": logging, - "framework": framework, - "deploymentId": deploymentId, - "deploymentCreatedAt": deploymentCreatedAt, - "deploymentScreenshotLight": deploymentScreenshotLight, - "deploymentScreenshotDark": deploymentScreenshotDark, - "latestDeploymentId": latestDeploymentId, - "latestDeploymentCreatedAt": latestDeploymentCreatedAt, - "latestDeploymentStatus": latestDeploymentStatus, - "vars": vars.map((p) => p.toMap()).toList(), - "timeout": timeout, - "installCommand": installCommand, - "buildCommand": buildCommand, - "outputDirectory": outputDirectory, - "installationId": installationId, - "providerRepositoryId": providerRepositoryId, - "providerBranch": providerBranch, - "providerRootDirectory": providerRootDirectory, - "providerSilentMode": providerSilentMode, - "specification": specification, - "buildRuntime": buildRuntime, - "adapter": adapter, - "fallbackFile": fallbackFile, - }; - } + /// Site framework. + final String framework; + + /// Site's active deployment ID. + final String deploymentId; + + /// Active deployment creation date in ISO 8601 format. + final String deploymentCreatedAt; + + /// Screenshot of active deployment with light theme preference file ID. + final String deploymentScreenshotLight; + + /// Screenshot of active deployment with dark theme preference file ID. + final String deploymentScreenshotDark; + + /// Site's latest deployment ID. + final String latestDeploymentId; + + /// Latest deployment creation date in ISO 8601 format. + final String latestDeploymentCreatedAt; + + /// Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed". + final String latestDeploymentStatus; + + /// Site variables. + final List vars; + + /// Site request timeout in seconds. + final int timeout; + + /// The install command used to install the site dependencies. + final String installCommand; + + /// The build command used to build the site. + final String buildCommand; + + /// The directory where the site build output is located. + final String outputDirectory; + + /// Site VCS (Version Control System) installation id. + final String installationId; + + /// VCS (Version Control System) Repository ID + final String providerRepositoryId; + + /// VCS (Version Control System) branch name + final String providerBranch; + + /// Path to site in VCS (Version Control System) repository + final String providerRootDirectory; + + /// Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests + final bool providerSilentMode; + + /// Machine specification for builds and executions. + final String specification; + + /// Site build runtime. + final String buildRuntime; + + /// Site framework adapter. + final String adapter; + + /// Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed. + final String fallbackFile; + + Site({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.enabled, + required this.live, + required this.logging, + required this.framework, + required this.deploymentId, + required this.deploymentCreatedAt, + required this.deploymentScreenshotLight, + required this.deploymentScreenshotDark, + required this.latestDeploymentId, + required this.latestDeploymentCreatedAt, + required this.latestDeploymentStatus, + required this.vars, + required this.timeout, + required this.installCommand, + required this.buildCommand, + required this.outputDirectory, + required this.installationId, + required this.providerRepositoryId, + required this.providerBranch, + required this.providerRootDirectory, + required this.providerSilentMode, + required this.specification, + required this.buildRuntime, + required this.adapter, + required this.fallbackFile, + }); + + factory Site.fromMap(Map map) { + return Site( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + enabled: map['enabled'], + live: map['live'], + logging: map['logging'], + framework: map['framework'].toString(), + deploymentId: map['deploymentId'].toString(), + deploymentCreatedAt: map['deploymentCreatedAt'].toString(), + deploymentScreenshotLight: map['deploymentScreenshotLight'].toString(), + deploymentScreenshotDark: map['deploymentScreenshotDark'].toString(), + latestDeploymentId: map['latestDeploymentId'].toString(), + latestDeploymentCreatedAt: map['latestDeploymentCreatedAt'].toString(), + latestDeploymentStatus: map['latestDeploymentStatus'].toString(), + vars: List.from(map['vars'].map((p) => Variable.fromMap(p))), + timeout: map['timeout'], + installCommand: map['installCommand'].toString(), + buildCommand: map['buildCommand'].toString(), + outputDirectory: map['outputDirectory'].toString(), + installationId: map['installationId'].toString(), + providerRepositoryId: map['providerRepositoryId'].toString(), + providerBranch: map['providerBranch'].toString(), + providerRootDirectory: map['providerRootDirectory'].toString(), + providerSilentMode: map['providerSilentMode'], + specification: map['specification'].toString(), + buildRuntime: map['buildRuntime'].toString(), + adapter: map['adapter'].toString(), + fallbackFile: map['fallbackFile'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "enabled": enabled, + "live": live, + "logging": logging, + "framework": framework, + "deploymentId": deploymentId, + "deploymentCreatedAt": deploymentCreatedAt, + "deploymentScreenshotLight": deploymentScreenshotLight, + "deploymentScreenshotDark": deploymentScreenshotDark, + "latestDeploymentId": latestDeploymentId, + "latestDeploymentCreatedAt": latestDeploymentCreatedAt, + "latestDeploymentStatus": latestDeploymentStatus, + "vars": vars.map((p) => p.toMap()).toList(), + "timeout": timeout, + "installCommand": installCommand, + "buildCommand": buildCommand, + "outputDirectory": outputDirectory, + "installationId": installationId, + "providerRepositoryId": providerRepositoryId, + "providerBranch": providerBranch, + "providerRootDirectory": providerRootDirectory, + "providerSilentMode": providerSilentMode, + "specification": specification, + "buildRuntime": buildRuntime, + "adapter": adapter, + "fallbackFile": fallbackFile, + }; + } } diff --git a/lib/src/models/site_list.dart b/lib/src/models/site_list.dart index 02a6a2be..a403dd5b 100644 --- a/lib/src/models/site_list.dart +++ b/lib/src/models/site_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Sites List class SiteList implements Model { - /// Total number of sites documents that matched your query. - final int total; + /// Total number of sites documents that matched your query. + final int total; - /// List of sites. - final List sites; + /// List of sites. + final List sites; - SiteList({ - required this.total, - required this.sites, - }); + SiteList({required this.total, required this.sites}); - factory SiteList.fromMap(Map map) { - return SiteList( - total: map['total'], - sites: List.from(map['sites'].map((p) => Site.fromMap(p))), - ); - } + factory SiteList.fromMap(Map map) { + return SiteList( + total: map['total'], + sites: List.from(map['sites'].map((p) => Site.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "sites": sites.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "sites": sites.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/specification.dart b/lib/src/models/specification.dart index e49d399c..e8fb8c75 100644 --- a/lib/src/models/specification.dart +++ b/lib/src/models/specification.dart @@ -2,40 +2,35 @@ part of '../../models.dart'; /// Specification class Specification implements Model { - /// Memory size in MB. - final int memory; + /// Memory size in MB. + final int memory; - /// Number of CPUs. - final double cpus; + /// Number of CPUs. + final double cpus; - /// Is size enabled. - final bool enabled; + /// Is size enabled. + final bool enabled; - /// Size slug. - final String slug; + /// Size slug. + final String slug; - Specification({ - required this.memory, - required this.cpus, - required this.enabled, - required this.slug, - }); + Specification({ + required this.memory, + required this.cpus, + required this.enabled, + required this.slug, + }); - factory Specification.fromMap(Map map) { - return Specification( - memory: map['memory'], - cpus: map['cpus'].toDouble(), - enabled: map['enabled'], - slug: map['slug'].toString(), - ); - } + factory Specification.fromMap(Map map) { + return Specification( + memory: map['memory'], + cpus: map['cpus'].toDouble(), + enabled: map['enabled'], + slug: map['slug'].toString(), + ); + } - Map toMap() { - return { - "memory": memory, - "cpus": cpus, - "enabled": enabled, - "slug": slug, - }; - } + Map toMap() { + return {"memory": memory, "cpus": cpus, "enabled": enabled, "slug": slug}; + } } diff --git a/lib/src/models/specification_list.dart b/lib/src/models/specification_list.dart index 72703f84..e4bef89b 100644 --- a/lib/src/models/specification_list.dart +++ b/lib/src/models/specification_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Specifications List class SpecificationList implements Model { - /// Total number of specifications documents that matched your query. - final int total; + /// Total number of specifications documents that matched your query. + final int total; - /// List of specifications. - final List specifications; + /// List of specifications. + final List specifications; - SpecificationList({ - required this.total, - required this.specifications, - }); + SpecificationList({required this.total, required this.specifications}); - factory SpecificationList.fromMap(Map map) { - return SpecificationList( - total: map['total'], - specifications: List.from(map['specifications'].map((p) => Specification.fromMap(p))), - ); - } + factory SpecificationList.fromMap(Map map) { + return SpecificationList( + total: map['total'], + specifications: List.from( + map['specifications'].map((p) => Specification.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "specifications": specifications.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "specifications": specifications.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/subscriber.dart b/lib/src/models/subscriber.dart index 36e18a7e..0c926297 100644 --- a/lib/src/models/subscriber.dart +++ b/lib/src/models/subscriber.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Subscriber class Subscriber implements Model { - /// Subscriber ID. - final String $id; + /// Subscriber ID. + final String $id; - /// Subscriber creation time in ISO 8601 format. - final String $createdAt; + /// Subscriber creation time in ISO 8601 format. + final String $createdAt; - /// Subscriber update date in ISO 8601 format. - final String $updatedAt; + /// Subscriber update date in ISO 8601 format. + final String $updatedAt; - /// Target ID. - final String targetId; + /// Target ID. + final String targetId; - /// Target. - final Target target; + /// Target. + final Target target; - /// Topic ID. - final String userId; + /// Topic ID. + final String userId; - /// User Name. - final String userName; + /// User Name. + final String userName; - /// Topic ID. - final String topicId; + /// Topic ID. + final String topicId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - Subscriber({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.targetId, - required this.target, - required this.userId, - required this.userName, - required this.topicId, - required this.providerType, - }); + Subscriber({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.targetId, + required this.target, + required this.userId, + required this.userName, + required this.topicId, + required this.providerType, + }); - factory Subscriber.fromMap(Map map) { - return Subscriber( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - targetId: map['targetId'].toString(), - target: Target.fromMap(map['target']), - userId: map['userId'].toString(), - userName: map['userName'].toString(), - topicId: map['topicId'].toString(), - providerType: map['providerType'].toString(), - ); - } + factory Subscriber.fromMap(Map map) { + return Subscriber( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + targetId: map['targetId'].toString(), + target: Target.fromMap(map['target']), + userId: map['userId'].toString(), + userName: map['userName'].toString(), + topicId: map['topicId'].toString(), + providerType: map['providerType'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "targetId": targetId, - "target": target.toMap(), - "userId": userId, - "userName": userName, - "topicId": topicId, - "providerType": providerType, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "targetId": targetId, + "target": target.toMap(), + "userId": userId, + "userName": userName, + "topicId": topicId, + "providerType": providerType, + }; + } } diff --git a/lib/src/models/subscriber_list.dart b/lib/src/models/subscriber_list.dart index d7d3c3e3..7030fa0a 100644 --- a/lib/src/models/subscriber_list.dart +++ b/lib/src/models/subscriber_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Subscriber list class SubscriberList implements Model { - /// Total number of subscribers documents that matched your query. - final int total; + /// Total number of subscribers documents that matched your query. + final int total; - /// List of subscribers. - final List subscribers; + /// List of subscribers. + final List subscribers; - SubscriberList({ - required this.total, - required this.subscribers, - }); + SubscriberList({required this.total, required this.subscribers}); - factory SubscriberList.fromMap(Map map) { - return SubscriberList( - total: map['total'], - subscribers: List.from(map['subscribers'].map((p) => Subscriber.fromMap(p))), - ); - } + factory SubscriberList.fromMap(Map map) { + return SubscriberList( + total: map['total'], + subscribers: List.from( + map['subscribers'].map((p) => Subscriber.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "subscribers": subscribers.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "subscribers": subscribers.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/models/target.dart b/lib/src/models/target.dart index f2b3b6b4..4be8b545 100644 --- a/lib/src/models/target.dart +++ b/lib/src/models/target.dart @@ -2,70 +2,70 @@ part of '../../models.dart'; /// Target class Target implements Model { - /// Target ID. - final String $id; + /// Target ID. + final String $id; - /// Target creation time in ISO 8601 format. - final String $createdAt; + /// Target creation time in ISO 8601 format. + final String $createdAt; - /// Target update date in ISO 8601 format. - final String $updatedAt; + /// Target update date in ISO 8601 format. + final String $updatedAt; - /// Target Name. - final String name; + /// Target Name. + final String name; - /// User ID. - final String userId; + /// User ID. + final String userId; - /// Provider ID. - final String? providerId; + /// Provider ID. + final String? providerId; - /// The target provider type. Can be one of the following: `email`, `sms` or `push`. - final String providerType; + /// The target provider type. Can be one of the following: `email`, `sms` or `push`. + final String providerType; - /// The target identifier. - final String identifier; + /// The target identifier. + final String identifier; - /// Is the target expired. - final bool expired; + /// Is the target expired. + final bool expired; - Target({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.userId, - this.providerId, - required this.providerType, - required this.identifier, - required this.expired, - }); + Target({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.userId, + this.providerId, + required this.providerType, + required this.identifier, + required this.expired, + }); - factory Target.fromMap(Map map) { - return Target( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - userId: map['userId'].toString(), - providerId: map['providerId']?.toString(), - providerType: map['providerType'].toString(), - identifier: map['identifier'].toString(), - expired: map['expired'], - ); - } + factory Target.fromMap(Map map) { + return Target( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + userId: map['userId'].toString(), + providerId: map['providerId']?.toString(), + providerType: map['providerType'].toString(), + identifier: map['identifier'].toString(), + expired: map['expired'], + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "userId": userId, - "providerId": providerId, - "providerType": providerType, - "identifier": identifier, - "expired": expired, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "userId": userId, + "providerId": providerId, + "providerType": providerType, + "identifier": identifier, + "expired": expired, + }; + } } diff --git a/lib/src/models/target_list.dart b/lib/src/models/target_list.dart index 2d38efe5..1042e5a2 100644 --- a/lib/src/models/target_list.dart +++ b/lib/src/models/target_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Target list class TargetList implements Model { - /// Total number of targets documents that matched your query. - final int total; + /// Total number of targets documents that matched your query. + final int total; - /// List of targets. - final List targets; + /// List of targets. + final List targets; - TargetList({ - required this.total, - required this.targets, - }); + TargetList({required this.total, required this.targets}); - factory TargetList.fromMap(Map map) { - return TargetList( - total: map['total'], - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - ); - } + factory TargetList.fromMap(Map map) { + return TargetList( + total: map['total'], + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "targets": targets.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "targets": targets.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/team.dart b/lib/src/models/team.dart index e9058b5b..43df33a8 100644 --- a/lib/src/models/team.dart +++ b/lib/src/models/team.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Team class Team implements Model { - /// Team ID. - final String $id; - - /// Team creation date in ISO 8601 format. - final String $createdAt; - - /// Team update date in ISO 8601 format. - final String $updatedAt; - - /// Team name. - final String name; - - /// Total number of team members. - final int total; - - /// Team preferences as a key-value object - final Preferences prefs; - - Team({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.total, - required this.prefs, - }); - - factory Team.fromMap(Map map) { - return Team( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - total: map['total'], - prefs: Preferences.fromMap(map['prefs']), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "total": total, - "prefs": prefs.toMap(), - }; - } + /// Team ID. + final String $id; + + /// Team creation date in ISO 8601 format. + final String $createdAt; + + /// Team update date in ISO 8601 format. + final String $updatedAt; + + /// Team name. + final String name; + + /// Total number of team members. + final int total; + + /// Team preferences as a key-value object + final Preferences prefs; + + Team({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.total, + required this.prefs, + }); + + factory Team.fromMap(Map map) { + return Team( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + total: map['total'], + prefs: Preferences.fromMap(map['prefs']), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "total": total, + "prefs": prefs.toMap(), + }; + } } diff --git a/lib/src/models/team_list.dart b/lib/src/models/team_list.dart index 2fb3611e..e604f192 100644 --- a/lib/src/models/team_list.dart +++ b/lib/src/models/team_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Teams List class TeamList implements Model { - /// Total number of teams documents that matched your query. - final int total; + /// Total number of teams documents that matched your query. + final int total; - /// List of teams. - final List teams; + /// List of teams. + final List teams; - TeamList({ - required this.total, - required this.teams, - }); + TeamList({required this.total, required this.teams}); - factory TeamList.fromMap(Map map) { - return TeamList( - total: map['total'], - teams: List.from(map['teams'].map((p) => Team.fromMap(p))), - ); - } + factory TeamList.fromMap(Map map) { + return TeamList( + total: map['total'], + teams: List.from(map['teams'].map((p) => Team.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "teams": teams.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "teams": teams.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/token.dart b/lib/src/models/token.dart index 4f6b8454..35115467 100644 --- a/lib/src/models/token.dart +++ b/lib/src/models/token.dart @@ -2,52 +2,52 @@ part of '../../models.dart'; /// Token class Token implements Model { - /// Token ID. - final String $id; - - /// Token creation date in ISO 8601 format. - final String $createdAt; - - /// User ID. - final String userId; - - /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. - final String secret; - - /// Token expiration date in ISO 8601 format. - final String expire; - - /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. - final String phrase; - - Token({ - required this.$id, - required this.$createdAt, - required this.userId, - required this.secret, - required this.expire, - required this.phrase, - }); - - factory Token.fromMap(Map map) { - return Token( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - userId: map['userId'].toString(), - secret: map['secret'].toString(), - expire: map['expire'].toString(), - phrase: map['phrase'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "userId": userId, - "secret": secret, - "expire": expire, - "phrase": phrase, - }; - } + /// Token ID. + final String $id; + + /// Token creation date in ISO 8601 format. + final String $createdAt; + + /// User ID. + final String userId; + + /// Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload. + final String secret; + + /// Token expiration date in ISO 8601 format. + final String expire; + + /// Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email. + final String phrase; + + Token({ + required this.$id, + required this.$createdAt, + required this.userId, + required this.secret, + required this.expire, + required this.phrase, + }); + + factory Token.fromMap(Map map) { + return Token( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + userId: map['userId'].toString(), + secret: map['secret'].toString(), + expire: map['expire'].toString(), + phrase: map['phrase'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "userId": userId, + "secret": secret, + "expire": expire, + "phrase": phrase, + }; + } } diff --git a/lib/src/models/topic.dart b/lib/src/models/topic.dart index 461d5694..430d44ac 100644 --- a/lib/src/models/topic.dart +++ b/lib/src/models/topic.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Topic class Topic implements Model { - /// Topic ID. - final String $id; + /// Topic ID. + final String $id; - /// Topic creation time in ISO 8601 format. - final String $createdAt; + /// Topic creation time in ISO 8601 format. + final String $createdAt; - /// Topic update date in ISO 8601 format. - final String $updatedAt; + /// Topic update date in ISO 8601 format. + final String $updatedAt; - /// The name of the topic. - final String name; + /// The name of the topic. + final String name; - /// Total count of email subscribers subscribed to the topic. - final int emailTotal; + /// Total count of email subscribers subscribed to the topic. + final int emailTotal; - /// Total count of SMS subscribers subscribed to the topic. - final int smsTotal; + /// Total count of SMS subscribers subscribed to the topic. + final int smsTotal; - /// Total count of push subscribers subscribed to the topic. - final int pushTotal; + /// Total count of push subscribers subscribed to the topic. + final int pushTotal; - /// Subscribe permissions. - final List subscribe; + /// Subscribe permissions. + final List subscribe; - Topic({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - required this.emailTotal, - required this.smsTotal, - required this.pushTotal, - required this.subscribe, - }); + Topic({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + required this.emailTotal, + required this.smsTotal, + required this.pushTotal, + required this.subscribe, + }); - factory Topic.fromMap(Map map) { - return Topic( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - emailTotal: map['emailTotal'], - smsTotal: map['smsTotal'], - pushTotal: map['pushTotal'], - subscribe: List.from(map['subscribe'] ?? []), - ); - } + factory Topic.fromMap(Map map) { + return Topic( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + emailTotal: map['emailTotal'], + smsTotal: map['smsTotal'], + pushTotal: map['pushTotal'], + subscribe: List.from(map['subscribe'] ?? []), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "emailTotal": emailTotal, - "smsTotal": smsTotal, - "pushTotal": pushTotal, - "subscribe": subscribe, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "emailTotal": emailTotal, + "smsTotal": smsTotal, + "pushTotal": pushTotal, + "subscribe": subscribe, + }; + } } diff --git a/lib/src/models/topic_list.dart b/lib/src/models/topic_list.dart index e57ef05f..a4d1f44f 100644 --- a/lib/src/models/topic_list.dart +++ b/lib/src/models/topic_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Topic list class TopicList implements Model { - /// Total number of topics documents that matched your query. - final int total; + /// Total number of topics documents that matched your query. + final int total; - /// List of topics. - final List topics; + /// List of topics. + final List topics; - TopicList({ - required this.total, - required this.topics, - }); + TopicList({required this.total, required this.topics}); - factory TopicList.fromMap(Map map) { - return TopicList( - total: map['total'], - topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), - ); - } + factory TopicList.fromMap(Map map) { + return TopicList( + total: map['total'], + topics: List.from(map['topics'].map((p) => Topic.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "topics": topics.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "topics": topics.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/user.dart b/lib/src/models/user.dart index effc397c..50bfb3ce 100644 --- a/lib/src/models/user.dart +++ b/lib/src/models/user.dart @@ -2,130 +2,130 @@ part of '../../models.dart'; /// User class User implements Model { - /// User ID. - final String $id; - - /// User creation date in ISO 8601 format. - final String $createdAt; - - /// User update date in ISO 8601 format. - final String $updatedAt; - - /// User name. - final String name; - - /// Hashed user password. - final String? password; - - /// Password hashing algorithm. - final String? hash; - - /// Password hashing algorithm configuration. - final Map? hashOptions; - - /// User registration date in ISO 8601 format. - final String registration; - - /// User status. Pass `true` for enabled and `false` for disabled. - final bool status; - - /// Labels for the user. - final List labels; - - /// Password update time in ISO 8601 format. - final String passwordUpdate; - - /// User email address. - final String email; - - /// User phone number in E.164 format. - final String phone; - - /// Email verification status. - final bool emailVerification; - - /// Phone verification status. - final bool phoneVerification; - - /// Multi factor authentication status. - final bool mfa; - - /// User preferences as a key-value object - final Preferences prefs; - - /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. - final List targets; - - /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. - final String accessedAt; - - User({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.name, - this.password, - this.hash, - this.hashOptions, - required this.registration, - required this.status, - required this.labels, - required this.passwordUpdate, - required this.email, - required this.phone, - required this.emailVerification, - required this.phoneVerification, - required this.mfa, - required this.prefs, - required this.targets, - required this.accessedAt, - }); - - factory User.fromMap(Map map) { - return User( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - name: map['name'].toString(), - password: map['password']?.toString(), - hash: map['hash']?.toString(), - hashOptions: map['hashOptions'], - registration: map['registration'].toString(), - status: map['status'], - labels: List.from(map['labels'] ?? []), - passwordUpdate: map['passwordUpdate'].toString(), - email: map['email'].toString(), - phone: map['phone'].toString(), - emailVerification: map['emailVerification'], - phoneVerification: map['phoneVerification'], - mfa: map['mfa'], - prefs: Preferences.fromMap(map['prefs']), - targets: List.from(map['targets'].map((p) => Target.fromMap(p))), - accessedAt: map['accessedAt'].toString(), - ); - } - - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "name": name, - "password": password, - "hash": hash, - "hashOptions": hashOptions, - "registration": registration, - "status": status, - "labels": labels, - "passwordUpdate": passwordUpdate, - "email": email, - "phone": phone, - "emailVerification": emailVerification, - "phoneVerification": phoneVerification, - "mfa": mfa, - "prefs": prefs.toMap(), - "targets": targets.map((p) => p.toMap()).toList(), - "accessedAt": accessedAt, - }; - } + /// User ID. + final String $id; + + /// User creation date in ISO 8601 format. + final String $createdAt; + + /// User update date in ISO 8601 format. + final String $updatedAt; + + /// User name. + final String name; + + /// Hashed user password. + final String? password; + + /// Password hashing algorithm. + final String? hash; + + /// Password hashing algorithm configuration. + final Map? hashOptions; + + /// User registration date in ISO 8601 format. + final String registration; + + /// User status. Pass `true` for enabled and `false` for disabled. + final bool status; + + /// Labels for the user. + final List labels; + + /// Password update time in ISO 8601 format. + final String passwordUpdate; + + /// User email address. + final String email; + + /// User phone number in E.164 format. + final String phone; + + /// Email verification status. + final bool emailVerification; + + /// Phone verification status. + final bool phoneVerification; + + /// Multi factor authentication status. + final bool mfa; + + /// User preferences as a key-value object + final Preferences prefs; + + /// A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider. + final List targets; + + /// Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours. + final String accessedAt; + + User({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.name, + this.password, + this.hash, + this.hashOptions, + required this.registration, + required this.status, + required this.labels, + required this.passwordUpdate, + required this.email, + required this.phone, + required this.emailVerification, + required this.phoneVerification, + required this.mfa, + required this.prefs, + required this.targets, + required this.accessedAt, + }); + + factory User.fromMap(Map map) { + return User( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + name: map['name'].toString(), + password: map['password']?.toString(), + hash: map['hash']?.toString(), + hashOptions: map['hashOptions'], + registration: map['registration'].toString(), + status: map['status'], + labels: List.from(map['labels'] ?? []), + passwordUpdate: map['passwordUpdate'].toString(), + email: map['email'].toString(), + phone: map['phone'].toString(), + emailVerification: map['emailVerification'], + phoneVerification: map['phoneVerification'], + mfa: map['mfa'], + prefs: Preferences.fromMap(map['prefs']), + targets: List.from(map['targets'].map((p) => Target.fromMap(p))), + accessedAt: map['accessedAt'].toString(), + ); + } + + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "name": name, + "password": password, + "hash": hash, + "hashOptions": hashOptions, + "registration": registration, + "status": status, + "labels": labels, + "passwordUpdate": passwordUpdate, + "email": email, + "phone": phone, + "emailVerification": emailVerification, + "phoneVerification": phoneVerification, + "mfa": mfa, + "prefs": prefs.toMap(), + "targets": targets.map((p) => p.toMap()).toList(), + "accessedAt": accessedAt, + }; + } } diff --git a/lib/src/models/user_list.dart b/lib/src/models/user_list.dart index 55dfcf77..03e55cc6 100644 --- a/lib/src/models/user_list.dart +++ b/lib/src/models/user_list.dart @@ -2,28 +2,22 @@ part of '../../models.dart'; /// Users List class UserList implements Model { - /// Total number of users documents that matched your query. - final int total; + /// Total number of users documents that matched your query. + final int total; - /// List of users. - final List users; + /// List of users. + final List users; - UserList({ - required this.total, - required this.users, - }); + UserList({required this.total, required this.users}); - factory UserList.fromMap(Map map) { - return UserList( - total: map['total'], - users: List.from(map['users'].map((p) => User.fromMap(p))), - ); - } + factory UserList.fromMap(Map map) { + return UserList( + total: map['total'], + users: List.from(map['users'].map((p) => User.fromMap(p))), + ); + } - Map toMap() { - return { - "total": total, - "users": users.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return {"total": total, "users": users.map((p) => p.toMap()).toList()}; + } } diff --git a/lib/src/models/variable.dart b/lib/src/models/variable.dart index 58882a9f..2a8e276a 100644 --- a/lib/src/models/variable.dart +++ b/lib/src/models/variable.dart @@ -2,64 +2,64 @@ part of '../../models.dart'; /// Variable class Variable implements Model { - /// Variable ID. - final String $id; + /// Variable ID. + final String $id; - /// Variable creation date in ISO 8601 format. - final String $createdAt; + /// Variable creation date in ISO 8601 format. + final String $createdAt; - /// Variable creation date in ISO 8601 format. - final String $updatedAt; + /// Variable creation date in ISO 8601 format. + final String $updatedAt; - /// Variable key. - final String key; + /// Variable key. + final String key; - /// Variable value. - final String value; + /// Variable value. + final String value; - /// Variable secret flag. Secret variables can only be updated or deleted, but never read. - final bool secret; + /// Variable secret flag. Secret variables can only be updated or deleted, but never read. + final bool secret; - /// Service to which the variable belongs. Possible values are "project", "function" - final String resourceType; + /// Service to which the variable belongs. Possible values are "project", "function" + final String resourceType; - /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. - final String resourceId; + /// ID of resource to which the variable belongs. If resourceType is "project", it is empty. If resourceType is "function", it is ID of the function. + final String resourceId; - Variable({ - required this.$id, - required this.$createdAt, - required this.$updatedAt, - required this.key, - required this.value, - required this.secret, - required this.resourceType, - required this.resourceId, - }); + Variable({ + required this.$id, + required this.$createdAt, + required this.$updatedAt, + required this.key, + required this.value, + required this.secret, + required this.resourceType, + required this.resourceId, + }); - factory Variable.fromMap(Map map) { - return Variable( - $id: map['\$id'].toString(), - $createdAt: map['\$createdAt'].toString(), - $updatedAt: map['\$updatedAt'].toString(), - key: map['key'].toString(), - value: map['value'].toString(), - secret: map['secret'], - resourceType: map['resourceType'].toString(), - resourceId: map['resourceId'].toString(), - ); - } + factory Variable.fromMap(Map map) { + return Variable( + $id: map['\$id'].toString(), + $createdAt: map['\$createdAt'].toString(), + $updatedAt: map['\$updatedAt'].toString(), + key: map['key'].toString(), + value: map['value'].toString(), + secret: map['secret'], + resourceType: map['resourceType'].toString(), + resourceId: map['resourceId'].toString(), + ); + } - Map toMap() { - return { - "\$id": $id, - "\$createdAt": $createdAt, - "\$updatedAt": $updatedAt, - "key": key, - "value": value, - "secret": secret, - "resourceType": resourceType, - "resourceId": resourceId, - }; - } + Map toMap() { + return { + "\$id": $id, + "\$createdAt": $createdAt, + "\$updatedAt": $updatedAt, + "key": key, + "value": value, + "secret": secret, + "resourceType": resourceType, + "resourceId": resourceId, + }; + } } diff --git a/lib/src/models/variable_list.dart b/lib/src/models/variable_list.dart index b6da02cc..4ff3e189 100644 --- a/lib/src/models/variable_list.dart +++ b/lib/src/models/variable_list.dart @@ -2,28 +2,27 @@ part of '../../models.dart'; /// Variables List class VariableList implements Model { - /// Total number of variables documents that matched your query. - final int total; + /// Total number of variables documents that matched your query. + final int total; - /// List of variables. - final List variables; + /// List of variables. + final List variables; - VariableList({ - required this.total, - required this.variables, - }); + VariableList({required this.total, required this.variables}); - factory VariableList.fromMap(Map map) { - return VariableList( - total: map['total'], - variables: List.from(map['variables'].map((p) => Variable.fromMap(p))), - ); - } + factory VariableList.fromMap(Map map) { + return VariableList( + total: map['total'], + variables: List.from( + map['variables'].map((p) => Variable.fromMap(p)), + ), + ); + } - Map toMap() { - return { - "total": total, - "variables": variables.map((p) => p.toMap()).toList(), - }; - } + Map toMap() { + return { + "total": total, + "variables": variables.map((p) => p.toMap()).toList(), + }; + } } diff --git a/lib/src/upload_progress.dart b/lib/src/upload_progress.dart index 44cde383..5a19b0fc 100644 --- a/lib/src/upload_progress.dart +++ b/lib/src/upload_progress.dart @@ -44,7 +44,7 @@ class UploadProgress { "progress": progress, "sizeUploaded": sizeUploaded, "chunksTotal": chunksTotal, - "chunksUploaded": chunksUploaded + "chunksUploaded": chunksUploaded, }; }