appwrite 27.0.0 → 28.0.0.rc1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/appwrite/client.rb +27 -24
- data/lib/appwrite/enums/adapter.rb +1 -1
- data/lib/appwrite/enums/attribute_status.rb +1 -1
- data/lib/appwrite/enums/authentication_factor.rb +1 -1
- data/lib/appwrite/enums/authenticator_type.rb +1 -1
- data/lib/appwrite/enums/backup_services.rb +1 -1
- data/lib/appwrite/enums/billing_plan_group.rb +1 -1
- data/lib/appwrite/enums/browser.rb +1 -1
- data/lib/appwrite/enums/browser_permission.rb +1 -1
- data/lib/appwrite/enums/browser_theme.rb +1 -1
- data/lib/appwrite/enums/build_runtime.rb +2 -1
- data/lib/appwrite/enums/column_status.rb +1 -1
- data/lib/appwrite/enums/compression.rb +1 -1
- data/lib/appwrite/enums/credit_card.rb +1 -1
- data/lib/appwrite/enums/database_status.rb +1 -1
- data/lib/appwrite/enums/database_type.rb +1 -1
- data/lib/appwrite/enums/databases_index_type.rb +1 -1
- data/lib/appwrite/enums/deployment_download_type.rb +1 -1
- data/lib/appwrite/enums/deployment_status.rb +1 -1
- data/lib/appwrite/enums/documents_db_index_type.rb +9 -0
- data/lib/appwrite/enums/embedding_model.rb +1 -3
- data/lib/appwrite/enums/execution_method.rb +1 -1
- data/lib/appwrite/enums/execution_resource_type.rb +8 -0
- data/lib/appwrite/enums/execution_status.rb +1 -1
- data/lib/appwrite/enums/execution_trigger.rb +1 -1
- data/lib/appwrite/enums/flag.rb +1 -1
- data/lib/appwrite/enums/framework.rb +1 -1
- data/lib/appwrite/enums/image_format.rb +1 -1
- data/lib/appwrite/enums/image_gravity.rb +1 -1
- data/lib/appwrite/enums/index_status.rb +1 -1
- data/lib/appwrite/enums/invalidation_type.rb +1 -1
- data/lib/appwrite/enums/message_priority.rb +1 -1
- data/lib/appwrite/enums/message_status.rb +1 -1
- data/lib/appwrite/enums/messaging_provider_type.rb +1 -1
- data/lib/appwrite/enums/o_auth2_google_prompt.rb +1 -1
- data/lib/appwrite/enums/o_auth2_oidc_prompt.rb +1 -1
- data/lib/appwrite/enums/o_auth_provider.rb +2 -1
- data/lib/appwrite/enums/order_by.rb +1 -1
- data/lib/appwrite/enums/organization_key_scopes.rb +1 -1
- data/lib/appwrite/enums/password_hash.rb +1 -1
- data/lib/appwrite/enums/platform_type.rb +1 -1
- data/lib/appwrite/enums/project_auth_method_id.rb +1 -1
- data/lib/appwrite/enums/project_email_template_id.rb +1 -1
- data/lib/appwrite/enums/project_email_template_locale.rb +1 -1
- data/lib/appwrite/enums/project_key_scopes.rb +14 -3
- data/lib/appwrite/enums/project_o_auth2_google_prompt.rb +1 -1
- data/lib/appwrite/enums/project_o_auth2_oidc_prompt.rb +1 -1
- data/lib/appwrite/enums/project_o_auth_provider_id.rb +2 -1
- data/lib/appwrite/enums/project_policy_id.rb +1 -1
- data/lib/appwrite/enums/project_protocol_id.rb +1 -1
- data/lib/appwrite/enums/project_service_id.rb +1 -1
- data/lib/appwrite/enums/project_smtp_secure.rb +1 -1
- data/lib/appwrite/enums/proxy_resource_type.rb +1 -1
- data/lib/appwrite/enums/proxy_rule_deployment_resource_type.rb +1 -1
- data/lib/appwrite/enums/proxy_rule_status.rb +1 -1
- data/lib/appwrite/enums/region.rb +1 -1
- data/lib/appwrite/enums/relation_mutate.rb +1 -1
- data/lib/appwrite/enums/relationship_type.rb +1 -1
- data/lib/appwrite/enums/runtime.rb +2 -1
- data/lib/appwrite/enums/smtp_encryption.rb +1 -1
- data/lib/appwrite/enums/status_code.rb +1 -1
- data/lib/appwrite/enums/tables_db_index_type.rb +1 -1
- data/lib/appwrite/enums/template_reference_type.rb +1 -1
- data/lib/appwrite/enums/timezone.rb +1 -1
- data/lib/appwrite/enums/vcs_reference_type.rb +1 -1
- data/lib/appwrite/enums/vectors_db_index_type.rb +12 -0
- data/lib/appwrite/exception.rb +1 -1
- data/lib/appwrite/id.rb +3 -3
- data/lib/appwrite/input_file.rb +1 -1
- data/lib/appwrite/models/activity_event.rb +1 -1
- data/lib/appwrite/models/activity_event_list.rb +1 -1
- data/lib/appwrite/models/additional_resource.rb +1 -1
- data/lib/appwrite/models/algo_argon2.rb +1 -1
- data/lib/appwrite/models/algo_bcrypt.rb +1 -1
- data/lib/appwrite/models/algo_md5.rb +1 -1
- data/lib/appwrite/models/algo_phpass.rb +1 -1
- data/lib/appwrite/models/algo_scrypt.rb +1 -1
- data/lib/appwrite/models/algo_scrypt_modified.rb +1 -1
- data/lib/appwrite/models/algo_sha.rb +1 -1
- data/lib/appwrite/models/app.rb +1 -1
- data/lib/appwrite/models/app_installation.rb +2 -2
- data/lib/appwrite/models/app_installation_list.rb +1 -1
- data/lib/appwrite/models/app_key.rb +2 -2
- data/lib/appwrite/models/app_key_list.rb +1 -1
- data/lib/appwrite/models/app_scope.rb +1 -1
- data/lib/appwrite/models/app_scope_list.rb +1 -1
- data/lib/appwrite/models/app_secret.rb +2 -2
- data/lib/appwrite/models/app_secret_list.rb +1 -1
- data/lib/appwrite/models/app_secret_plaintext.rb +2 -2
- data/lib/appwrite/models/apps_list.rb +1 -1
- data/lib/appwrite/models/attribute_bigint.rb +5 -6
- data/lib/appwrite/models/attribute_boolean.rb +3 -4
- data/lib/appwrite/models/attribute_datetime.rb +3 -4
- data/lib/appwrite/models/attribute_email.rb +3 -4
- data/lib/appwrite/models/attribute_enum.rb +3 -4
- data/lib/appwrite/models/attribute_float.rb +5 -6
- data/lib/appwrite/models/attribute_integer.rb +5 -6
- data/lib/appwrite/models/attribute_ip.rb +3 -4
- data/lib/appwrite/models/attribute_line.rb +3 -4
- data/lib/appwrite/models/attribute_list.rb +1 -1
- data/lib/appwrite/models/attribute_longtext.rb +4 -5
- data/lib/appwrite/models/attribute_mediumtext.rb +4 -5
- data/lib/appwrite/models/attribute_object.rb +80 -0
- data/lib/appwrite/models/attribute_point.rb +3 -4
- data/lib/appwrite/models/attribute_polygon.rb +3 -4
- data/lib/appwrite/models/attribute_relationship.rb +2 -3
- data/lib/appwrite/models/attribute_string.rb +4 -5
- data/lib/appwrite/models/attribute_text.rb +4 -5
- data/lib/appwrite/models/attribute_url.rb +3 -4
- data/lib/appwrite/models/attribute_varchar.rb +4 -5
- data/lib/appwrite/models/attribute_vector.rb +85 -0
- data/lib/appwrite/models/backup_archive.rb +3 -3
- data/lib/appwrite/models/backup_archive_list.rb +1 -1
- data/lib/appwrite/models/backup_policy.rb +3 -3
- data/lib/appwrite/models/backup_policy_list.rb +1 -1
- data/lib/appwrite/models/backup_restoration.rb +1 -1
- data/lib/appwrite/models/backup_restoration_list.rb +1 -1
- data/lib/appwrite/models/billing_limits.rb +9 -9
- data/lib/appwrite/models/billing_plan.rb +19 -10
- data/lib/appwrite/models/billing_plan_addon.rb +3 -3
- data/lib/appwrite/models/billing_plan_addon_details.rb +2 -2
- data/lib/appwrite/models/billing_plan_dedicated_database_limits.rb +20 -20
- data/lib/appwrite/models/billing_plan_limits.rb +3 -3
- data/lib/appwrite/models/billing_plan_supported_addons.rb +1 -1
- data/lib/appwrite/models/block.rb +3 -3
- data/lib/appwrite/models/bucket.rb +1 -1
- data/lib/appwrite/models/bucket_list.rb +1 -1
- data/lib/appwrite/models/collection.rb +1 -1
- data/lib/appwrite/models/collection_list.rb +1 -1
- data/lib/appwrite/models/column_bigint.rb +5 -6
- data/lib/appwrite/models/column_boolean.rb +3 -4
- data/lib/appwrite/models/column_datetime.rb +3 -4
- data/lib/appwrite/models/column_email.rb +3 -4
- data/lib/appwrite/models/column_enum.rb +3 -4
- data/lib/appwrite/models/column_float.rb +5 -6
- data/lib/appwrite/models/column_index.rb +2 -2
- data/lib/appwrite/models/column_index_list.rb +1 -1
- data/lib/appwrite/models/column_integer.rb +5 -6
- data/lib/appwrite/models/column_ip.rb +3 -4
- data/lib/appwrite/models/column_line.rb +3 -4
- data/lib/appwrite/models/column_list.rb +1 -1
- data/lib/appwrite/models/column_longtext.rb +4 -5
- data/lib/appwrite/models/column_mediumtext.rb +4 -5
- data/lib/appwrite/models/column_point.rb +3 -4
- data/lib/appwrite/models/column_polygon.rb +3 -4
- data/lib/appwrite/models/column_relationship.rb +2 -3
- data/lib/appwrite/models/column_string.rb +4 -5
- data/lib/appwrite/models/column_text.rb +4 -5
- data/lib/appwrite/models/column_url.rb +3 -4
- data/lib/appwrite/models/column_varchar.rb +4 -5
- data/lib/appwrite/models/continent.rb +1 -1
- data/lib/appwrite/models/continent_list.rb +1 -1
- data/lib/appwrite/models/country.rb +1 -1
- data/lib/appwrite/models/country_list.rb +1 -1
- data/lib/appwrite/models/currency.rb +1 -1
- data/lib/appwrite/models/currency_list.rb +1 -1
- data/lib/appwrite/models/database.rb +22 -8
- data/lib/appwrite/models/database_list.rb +1 -1
- data/lib/appwrite/models/database_migration.rb +6 -1
- data/lib/appwrite/models/database_migration_list.rb +1 -1
- data/lib/appwrite/models/database_status.rb +3 -3
- data/lib/appwrite/models/database_status_connections.rb +1 -1
- data/lib/appwrite/models/database_status_replica.rb +7 -2
- data/lib/appwrite/models/database_status_volume.rb +1 -1
- data/lib/appwrite/models/dedicated_database.rb +3 -3
- data/lib/appwrite/models/dedicated_database_backup.rb +107 -0
- data/lib/appwrite/models/dedicated_database_backup_list.rb +32 -0
- data/lib/appwrite/models/dedicated_database_backup_storage.rb +47 -0
- data/lib/appwrite/models/dedicated_database_branch.rb +82 -0
- data/lib/appwrite/models/dedicated_database_branch_list.rb +32 -0
- data/lib/appwrite/models/dedicated_database_execution.rb +52 -0
- data/lib/appwrite/models/dedicated_database_execution_column.rb +32 -0
- data/lib/appwrite/models/dedicated_database_extensions.rb +37 -0
- data/lib/appwrite/models/dedicated_database_list.rb +32 -0
- data/lib/appwrite/models/dedicated_database_member.rb +7 -2
- data/lib/appwrite/models/dedicated_database_operation.rb +4 -4
- data/lib/appwrite/models/dedicated_database_operation_list.rb +1 -1
- data/lib/appwrite/models/dedicated_database_pitr_windows.rb +32 -0
- data/lib/appwrite/models/dedicated_database_pooler.rb +72 -0
- data/lib/appwrite/models/dedicated_database_replicas.rb +3 -3
- data/lib/appwrite/models/dedicated_database_restoration.rb +82 -0
- data/lib/appwrite/models/dedicated_database_restoration_list.rb +32 -0
- data/lib/appwrite/models/dedicated_database_specification.rb +1 -1
- data/lib/appwrite/models/dedicated_database_specification_list.rb +1 -1
- data/lib/appwrite/models/dedicated_database_specification_pricing.rb +1 -1
- data/lib/appwrite/models/deployment.rb +1 -2
- data/lib/appwrite/models/deployment_list.rb +1 -1
- data/lib/appwrite/models/dev_key.rb +1 -1
- data/lib/appwrite/models/document.rb +1 -1
- data/lib/appwrite/models/document_list.rb +1 -1
- data/lib/appwrite/models/email_template.rb +1 -1
- data/lib/appwrite/models/email_template_list.rb +1 -1
- data/lib/appwrite/models/embedding.rb +1 -1
- data/lib/appwrite/models/embedding_list.rb +1 -1
- data/lib/appwrite/models/ephemeral_key.rb +1 -1
- data/lib/appwrite/models/execution.rb +25 -8
- data/lib/appwrite/models/execution_list.rb +1 -1
- data/lib/appwrite/models/file.rb +1 -1
- data/lib/appwrite/models/file_list.rb +1 -1
- data/lib/appwrite/models/framework.rb +1 -1
- data/lib/appwrite/models/framework_adapter.rb +1 -1
- data/lib/appwrite/models/framework_list.rb +1 -1
- data/lib/appwrite/models/function.rb +1 -1
- data/lib/appwrite/models/function_list.rb +1 -1
- data/lib/appwrite/models/headers.rb +1 -1
- data/lib/appwrite/models/identity.rb +1 -1
- data/lib/appwrite/models/identity_list.rb +1 -1
- data/lib/appwrite/models/index.rb +2 -3
- data/lib/appwrite/models/index_list.rb +1 -1
- data/lib/appwrite/models/insight.rb +4 -4
- data/lib/appwrite/models/insight_cta.rb +1 -1
- data/lib/appwrite/models/insight_list.rb +1 -1
- data/lib/appwrite/models/jwt.rb +1 -1
- data/lib/appwrite/models/key.rb +1 -1
- data/lib/appwrite/models/key_list.rb +1 -1
- data/lib/appwrite/models/language.rb +1 -1
- data/lib/appwrite/models/language_list.rb +1 -1
- data/lib/appwrite/models/locale.rb +12 -12
- data/lib/appwrite/models/locale_code.rb +1 -1
- data/lib/appwrite/models/locale_code_list.rb +1 -1
- data/lib/appwrite/models/log.rb +1 -1
- data/lib/appwrite/models/log_list.rb +1 -1
- data/lib/appwrite/models/membership.rb +1 -1
- data/lib/appwrite/models/membership_list.rb +1 -1
- data/lib/appwrite/models/message.rb +4 -5
- data/lib/appwrite/models/message_list.rb +1 -1
- data/lib/appwrite/models/mfa_challenge.rb +1 -1
- data/lib/appwrite/models/mfa_challenge_secret.rb +1 -1
- data/lib/appwrite/models/mfa_factors.rb +1 -1
- data/lib/appwrite/models/mfa_recovery_codes.rb +1 -1
- data/lib/appwrite/models/mfa_type.rb +1 -1
- data/lib/appwrite/models/mock_number.rb +1 -1
- data/lib/appwrite/models/mock_number_list.rb +1 -1
- data/lib/appwrite/models/o_auth2_amazon.rb +1 -1
- data/lib/appwrite/models/o_auth2_apple.rb +1 -1
- data/lib/appwrite/models/o_auth2_appwrite.rb +1 -1
- data/lib/appwrite/models/o_auth2_auth0.rb +1 -1
- data/lib/appwrite/models/o_auth2_authentik.rb +1 -1
- data/lib/appwrite/models/o_auth2_autodesk.rb +1 -1
- data/lib/appwrite/models/o_auth2_bitbucket.rb +1 -1
- data/lib/appwrite/models/o_auth2_bitly.rb +1 -1
- data/lib/appwrite/models/o_auth2_box.rb +1 -1
- data/lib/appwrite/models/o_auth2_dailymotion.rb +1 -1
- data/lib/appwrite/models/o_auth2_discord.rb +1 -1
- data/lib/appwrite/models/o_auth2_disqus.rb +1 -1
- data/lib/appwrite/models/o_auth2_dropbox.rb +1 -1
- data/lib/appwrite/models/o_auth2_etsy.rb +1 -1
- data/lib/appwrite/models/o_auth2_facebook.rb +1 -1
- data/lib/appwrite/models/o_auth2_figma.rb +1 -1
- data/lib/appwrite/models/o_auth2_fusion_auth.rb +1 -1
- data/lib/appwrite/models/o_auth2_github.rb +1 -1
- data/lib/appwrite/models/o_auth2_gitlab.rb +1 -1
- data/lib/appwrite/models/o_auth2_google.rb +18 -2
- data/lib/appwrite/models/o_auth2_hugging_face.rb +42 -0
- data/lib/appwrite/models/o_auth2_keycloak.rb +1 -1
- data/lib/appwrite/models/o_auth2_kick.rb +1 -1
- data/lib/appwrite/models/o_auth2_linkedin.rb +1 -1
- data/lib/appwrite/models/o_auth2_microsoft.rb +1 -1
- data/lib/appwrite/models/o_auth2_notion.rb +1 -1
- data/lib/appwrite/models/o_auth2_oidc.rb +20 -3
- data/lib/appwrite/models/o_auth2_okta.rb +1 -1
- data/lib/appwrite/models/o_auth2_paypal.rb +1 -1
- data/lib/appwrite/models/o_auth2_podio.rb +1 -1
- data/lib/appwrite/models/o_auth2_provider_list.rb +1 -1
- data/lib/appwrite/models/o_auth2_salesforce.rb +1 -1
- data/lib/appwrite/models/o_auth2_slack.rb +1 -1
- data/lib/appwrite/models/o_auth2_spotify.rb +1 -1
- data/lib/appwrite/models/o_auth2_stripe.rb +1 -1
- data/lib/appwrite/models/o_auth2_tradeshift.rb +1 -1
- data/lib/appwrite/models/o_auth2_twitch.rb +1 -1
- data/lib/appwrite/models/o_auth2_word_press.rb +1 -1
- data/lib/appwrite/models/o_auth2_x.rb +1 -1
- data/lib/appwrite/models/o_auth2_yahoo.rb +1 -1
- data/lib/appwrite/models/o_auth2_yandex.rb +1 -1
- data/lib/appwrite/models/o_auth2_zoho.rb +1 -1
- data/lib/appwrite/models/o_auth2_zoom.rb +1 -1
- data/lib/appwrite/models/oauth2_approve.rb +1 -1
- data/lib/appwrite/models/oauth2_authorize.rb +1 -1
- data/lib/appwrite/models/oauth2_consent.rb +1 -1
- data/lib/appwrite/models/oauth2_consent_list.rb +1 -1
- data/lib/appwrite/models/oauth2_consent_token.rb +1 -1
- data/lib/appwrite/models/oauth2_consent_token_list.rb +1 -1
- data/lib/appwrite/models/oauth2_device_authorization.rb +1 -1
- data/lib/appwrite/models/oauth2_grant.rb +1 -1
- data/lib/appwrite/models/oauth2_organization.rb +1 -1
- data/lib/appwrite/models/oauth2_organization_list.rb +1 -1
- data/lib/appwrite/models/oauth2_par.rb +1 -1
- data/lib/appwrite/models/oauth2_project.rb +1 -1
- data/lib/appwrite/models/oauth2_project_list.rb +1 -1
- data/lib/appwrite/models/oauth2_reject.rb +1 -1
- data/lib/appwrite/models/oauth2_token.rb +3 -3
- data/lib/appwrite/models/organization.rb +14 -14
- data/lib/appwrite/models/phone.rb +1 -1
- data/lib/appwrite/models/phone_list.rb +1 -1
- data/lib/appwrite/models/platform_android.rb +1 -2
- data/lib/appwrite/models/platform_apple.rb +1 -2
- data/lib/appwrite/models/platform_linux.rb +1 -2
- data/lib/appwrite/models/platform_list.rb +1 -1
- data/lib/appwrite/models/platform_web.rb +1 -2
- data/lib/appwrite/models/platform_windows.rb +1 -2
- data/lib/appwrite/models/policy_deny_aliased_email.rb +1 -1
- data/lib/appwrite/models/policy_deny_corporate_email.rb +1 -1
- data/lib/appwrite/models/policy_deny_disposable_email.rb +1 -1
- data/lib/appwrite/models/policy_deny_free_email.rb +1 -1
- data/lib/appwrite/models/policy_list.rb +1 -1
- data/lib/appwrite/models/policy_membership_privacy.rb +1 -1
- data/lib/appwrite/models/policy_mfa_factors.rb +1 -1
- data/lib/appwrite/models/policy_password_dictionary.rb +1 -1
- data/lib/appwrite/models/policy_password_history.rb +1 -1
- data/lib/appwrite/models/policy_password_personal_data.rb +1 -1
- data/lib/appwrite/models/policy_password_strength.rb +1 -1
- data/lib/appwrite/models/policy_session_alert.rb +1 -1
- data/lib/appwrite/models/policy_session_duration.rb +1 -1
- data/lib/appwrite/models/policy_session_invalidation.rb +1 -1
- data/lib/appwrite/models/policy_session_limit.rb +1 -1
- data/lib/appwrite/models/policy_user_limit.rb +1 -1
- data/lib/appwrite/models/postgres_extension.rb +42 -0
- data/lib/appwrite/models/preferences.rb +1 -1
- data/lib/appwrite/models/presence.rb +4 -4
- data/lib/appwrite/models/presence_list.rb +1 -1
- data/lib/appwrite/models/program.rb +1 -1
- data/lib/appwrite/models/project.rb +19 -19
- data/lib/appwrite/models/project_auth_method.rb +1 -2
- data/lib/appwrite/models/project_list.rb +1 -1
- data/lib/appwrite/models/project_protocol.rb +1 -2
- data/lib/appwrite/models/project_service.rb +1 -2
- data/lib/appwrite/models/provider.rb +2 -2
- data/lib/appwrite/models/provider_list.rb +1 -1
- data/lib/appwrite/models/proxy_invalidation.rb +1 -1
- data/lib/appwrite/models/proxy_rule.rb +2 -3
- data/lib/appwrite/models/proxy_rule_list.rb +1 -1
- data/lib/appwrite/models/report.rb +2 -2
- data/lib/appwrite/models/report_list.rb +1 -1
- data/lib/appwrite/models/resource_token.rb +1 -1
- data/lib/appwrite/models/resource_token_list.rb +1 -1
- data/lib/appwrite/models/row.rb +1 -1
- data/lib/appwrite/models/row_list.rb +1 -1
- data/lib/appwrite/models/runtime.rb +1 -1
- data/lib/appwrite/models/runtime_list.rb +1 -1
- data/lib/appwrite/models/session.rb +1 -1
- data/lib/appwrite/models/session_list.rb +1 -1
- data/lib/appwrite/models/site.rb +6 -1
- data/lib/appwrite/models/site_list.rb +1 -1
- data/lib/appwrite/models/specification.rb +1 -1
- data/lib/appwrite/models/specification_list.rb +1 -1
- data/lib/appwrite/models/subscriber.rb +1 -1
- data/lib/appwrite/models/subscriber_list.rb +1 -1
- data/lib/appwrite/models/table.rb +1 -1
- data/lib/appwrite/models/table_list.rb +1 -1
- data/lib/appwrite/models/target.rb +2 -2
- data/lib/appwrite/models/target_list.rb +1 -1
- data/lib/appwrite/models/team.rb +1 -1
- data/lib/appwrite/models/team_list.rb +1 -1
- data/lib/appwrite/models/token.rb +1 -1
- data/lib/appwrite/models/topic.rb +1 -1
- data/lib/appwrite/models/topic_list.rb +1 -1
- data/lib/appwrite/models/transaction.rb +1 -1
- data/lib/appwrite/models/transaction_list.rb +1 -1
- data/lib/appwrite/models/usage_billing_plan.rb +4 -4
- data/lib/appwrite/models/user.rb +11 -11
- data/lib/appwrite/models/user_list.rb +1 -1
- data/lib/appwrite/models/variable.rb +1 -1
- data/lib/appwrite/models/variable_list.rb +1 -1
- data/lib/appwrite/models/vectorsdb_collection.rb +87 -0
- data/lib/appwrite/models/vectorsdb_collection_list.rb +32 -0
- data/lib/appwrite/models/webhook.rb +1 -1
- data/lib/appwrite/models/webhook_list.rb +1 -1
- data/lib/appwrite/operator.rb +6 -0
- data/lib/appwrite/permission.rb +4 -0
- data/lib/appwrite/query.rb +4 -4
- data/lib/appwrite/role.rb +12 -14
- data/lib/appwrite/service.rb +1 -1
- data/lib/appwrite/services/account.rb +328 -289
- data/lib/appwrite/services/activities.rb +13 -14
- data/lib/appwrite/services/advisor.rb +41 -37
- data/lib/appwrite/services/apps.rb +185 -130
- data/lib/appwrite/services/avatars.rb +156 -55
- data/lib/appwrite/services/backups.rb +102 -83
- data/lib/appwrite/services/databases.rb +871 -512
- data/lib/appwrite/services/documents_db.rb +1683 -0
- data/lib/appwrite/services/embeddings.rb +9 -9
- data/lib/appwrite/services/functions.rb +276 -172
- data/lib/appwrite/services/graphql.rb +12 -12
- data/lib/appwrite/services/locale.rb +19 -37
- data/lib/appwrite/services/messaging.rb +544 -259
- data/lib/appwrite/services/mongo.rb +1359 -0
- data/lib/appwrite/services/mysql.rb +1503 -0
- data/lib/appwrite/services/oauth2.rb +122 -53
- data/lib/appwrite/services/organization.rb +153 -123
- data/lib/appwrite/services/postgresql.rb +1615 -0
- data/lib/appwrite/services/presences.rb +49 -35
- data/lib/appwrite/services/project.rb +842 -528
- data/lib/appwrite/services/proxy.rb +73 -58
- data/lib/appwrite/services/sites.rb +269 -164
- data/lib/appwrite/services/storage.rb +151 -92
- data/lib/appwrite/services/tables_db.rb +947 -568
- data/lib/appwrite/services/teams.rb +161 -122
- data/lib/appwrite/services/tokens.rb +38 -31
- data/lib/appwrite/services/users.rb +376 -274
- data/lib/appwrite/services/vectors_db.rb +1614 -0
- data/lib/appwrite/services/webhooks.rb +59 -40
- data/lib/appwrite.rb +27 -0
- metadata +31 -4
|
@@ -1,8 +1,7 @@
|
|
|
1
|
-
#frozen_string_literal: true
|
|
1
|
+
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
module Appwrite
|
|
4
4
|
class Project < Service
|
|
5
|
-
|
|
6
5
|
def initialize(client)
|
|
7
6
|
@client = client
|
|
8
7
|
end
|
|
@@ -14,9 +13,8 @@ module Appwrite
|
|
|
14
13
|
def get()
|
|
15
14
|
api_path = '/project'
|
|
16
15
|
|
|
17
|
-
api_params = {
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
api_params = {}
|
|
17
|
+
|
|
20
18
|
api_headers = {
|
|
21
19
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
22
20
|
}
|
|
@@ -28,7 +26,6 @@ module Appwrite
|
|
|
28
26
|
params: api_params,
|
|
29
27
|
response_type: Models::Project
|
|
30
28
|
)
|
|
31
|
-
|
|
32
29
|
end
|
|
33
30
|
|
|
34
31
|
# Delete a project.
|
|
@@ -38,9 +35,8 @@ module Appwrite
|
|
|
38
35
|
def delete()
|
|
39
36
|
api_path = '/project'
|
|
40
37
|
|
|
41
|
-
api_params = {
|
|
42
|
-
|
|
43
|
-
|
|
38
|
+
api_params = {}
|
|
39
|
+
|
|
44
40
|
api_headers = {
|
|
45
41
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
46
42
|
"content-type": 'application/json',
|
|
@@ -52,32 +48,34 @@ module Appwrite
|
|
|
52
48
|
headers: api_headers,
|
|
53
49
|
params: api_params,
|
|
54
50
|
)
|
|
55
|
-
|
|
56
51
|
end
|
|
57
52
|
|
|
58
53
|
# Update properties of a specific auth method. Use this endpoint to enable or
|
|
59
|
-
# disable a method in your project.
|
|
54
|
+
# disable a method in your project.
|
|
60
55
|
#
|
|
61
56
|
# @param [ProjectAuthMethodId] method_id Auth Method ID. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone
|
|
62
57
|
# @param [] enabled Auth method status.
|
|
63
58
|
#
|
|
64
59
|
# @return [Project]
|
|
65
|
-
def update_auth_method(
|
|
60
|
+
def update_auth_method(
|
|
61
|
+
method_id:,
|
|
62
|
+
enabled:
|
|
63
|
+
)
|
|
66
64
|
api_path = '/project/auth-methods/{methodId}'
|
|
67
65
|
.gsub('{methodId}', method_id)
|
|
68
66
|
|
|
69
67
|
if method_id.nil?
|
|
70
|
-
|
|
68
|
+
raise Appwrite::Exception.new('Missing required parameter: "methodId"')
|
|
71
69
|
end
|
|
72
70
|
|
|
73
71
|
if enabled.nil?
|
|
74
|
-
|
|
72
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
75
73
|
end
|
|
76
74
|
|
|
77
75
|
api_params = {
|
|
78
76
|
enabled: enabled,
|
|
79
77
|
}
|
|
80
|
-
|
|
78
|
+
|
|
81
79
|
api_headers = {
|
|
82
80
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
83
81
|
"content-type": 'application/json',
|
|
@@ -91,7 +89,6 @@ module Appwrite
|
|
|
91
89
|
params: api_params,
|
|
92
90
|
response_type: Models::Project
|
|
93
91
|
)
|
|
94
|
-
|
|
95
92
|
end
|
|
96
93
|
|
|
97
94
|
# Get a list of all API keys from the current project.
|
|
@@ -100,14 +97,17 @@ module Appwrite
|
|
|
100
97
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
101
98
|
#
|
|
102
99
|
# @return [KeyList]
|
|
103
|
-
def list_keys(
|
|
100
|
+
def list_keys(
|
|
101
|
+
queries: nil,
|
|
102
|
+
total: nil
|
|
103
|
+
)
|
|
104
104
|
api_path = '/project/keys'
|
|
105
105
|
|
|
106
106
|
api_params = {
|
|
107
107
|
queries: queries,
|
|
108
108
|
total: total,
|
|
109
109
|
}
|
|
110
|
-
|
|
110
|
+
|
|
111
111
|
api_headers = {
|
|
112
112
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
113
113
|
"accept": 'application/json',
|
|
@@ -120,12 +120,11 @@ module Appwrite
|
|
|
120
120
|
params: api_params,
|
|
121
121
|
response_type: Models::KeyList
|
|
122
122
|
)
|
|
123
|
-
|
|
124
123
|
end
|
|
125
124
|
|
|
126
|
-
# Create a new ephemeral API key. It
|
|
125
|
+
# Create a new ephemeral API key. It's recommended to have multiple API keys
|
|
127
126
|
# with strict scopes for separate functions within your project.
|
|
128
|
-
#
|
|
127
|
+
#
|
|
129
128
|
# You can also create a standard API key if you need a longer-lived key
|
|
130
129
|
# instead.
|
|
131
130
|
#
|
|
@@ -133,22 +132,25 @@ module Appwrite
|
|
|
133
132
|
# @param [Integer] duration Time in seconds before ephemeral key expires. Maximum duration is 3600 seconds.
|
|
134
133
|
#
|
|
135
134
|
# @return [EphemeralKey]
|
|
136
|
-
def create_ephemeral_key(
|
|
135
|
+
def create_ephemeral_key(
|
|
136
|
+
scopes:,
|
|
137
|
+
duration:
|
|
138
|
+
)
|
|
137
139
|
api_path = '/project/keys/ephemeral'
|
|
138
140
|
|
|
139
141
|
if scopes.nil?
|
|
140
|
-
|
|
142
|
+
raise Appwrite::Exception.new('Missing required parameter: "scopes"')
|
|
141
143
|
end
|
|
142
144
|
|
|
143
145
|
if duration.nil?
|
|
144
|
-
|
|
146
|
+
raise Appwrite::Exception.new('Missing required parameter: "duration"')
|
|
145
147
|
end
|
|
146
148
|
|
|
147
149
|
api_params = {
|
|
148
150
|
scopes: scopes,
|
|
149
151
|
duration: duration,
|
|
150
152
|
}
|
|
151
|
-
|
|
153
|
+
|
|
152
154
|
api_headers = {
|
|
153
155
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
154
156
|
"content-type": 'application/json',
|
|
@@ -162,25 +164,25 @@ module Appwrite
|
|
|
162
164
|
params: api_params,
|
|
163
165
|
response_type: Models::EphemeralKey
|
|
164
166
|
)
|
|
165
|
-
|
|
166
167
|
end
|
|
167
168
|
|
|
168
|
-
# Get a key by its unique ID.
|
|
169
|
+
# Get a key by its unique ID.
|
|
169
170
|
#
|
|
170
171
|
# @param [String] key_id Key ID.
|
|
171
172
|
#
|
|
172
173
|
# @return [Key]
|
|
173
|
-
def get_key(
|
|
174
|
+
def get_key(
|
|
175
|
+
key_id:
|
|
176
|
+
)
|
|
174
177
|
api_path = '/project/keys/{keyId}'
|
|
175
178
|
.gsub('{keyId}', key_id)
|
|
176
179
|
|
|
177
180
|
if key_id.nil?
|
|
178
|
-
|
|
181
|
+
raise Appwrite::Exception.new('Missing required parameter: "keyId"')
|
|
179
182
|
end
|
|
180
183
|
|
|
181
|
-
api_params = {
|
|
182
|
-
|
|
183
|
-
|
|
184
|
+
api_params = {}
|
|
185
|
+
|
|
184
186
|
api_headers = {
|
|
185
187
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
186
188
|
"accept": 'application/json',
|
|
@@ -193,7 +195,6 @@ module Appwrite
|
|
|
193
195
|
params: api_params,
|
|
194
196
|
response_type: Models::Key
|
|
195
197
|
)
|
|
196
|
-
|
|
197
198
|
end
|
|
198
199
|
|
|
199
200
|
# Update a key by its unique ID. Use this endpoint to update the name,
|
|
@@ -205,20 +206,25 @@ module Appwrite
|
|
|
205
206
|
# @param [String] expire Expiration time in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.
|
|
206
207
|
#
|
|
207
208
|
# @return [Key]
|
|
208
|
-
def update_key(
|
|
209
|
+
def update_key(
|
|
210
|
+
key_id:,
|
|
211
|
+
name:,
|
|
212
|
+
scopes:,
|
|
213
|
+
expire: nil
|
|
214
|
+
)
|
|
209
215
|
api_path = '/project/keys/{keyId}'
|
|
210
216
|
.gsub('{keyId}', key_id)
|
|
211
217
|
|
|
212
218
|
if key_id.nil?
|
|
213
|
-
|
|
219
|
+
raise Appwrite::Exception.new('Missing required parameter: "keyId"')
|
|
214
220
|
end
|
|
215
221
|
|
|
216
222
|
if name.nil?
|
|
217
|
-
|
|
223
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
218
224
|
end
|
|
219
225
|
|
|
220
226
|
if scopes.nil?
|
|
221
|
-
|
|
227
|
+
raise Appwrite::Exception.new('Missing required parameter: "scopes"')
|
|
222
228
|
end
|
|
223
229
|
|
|
224
230
|
api_params = {
|
|
@@ -226,7 +232,7 @@ module Appwrite
|
|
|
226
232
|
scopes: scopes,
|
|
227
233
|
expire: expire,
|
|
228
234
|
}
|
|
229
|
-
|
|
235
|
+
|
|
230
236
|
api_headers = {
|
|
231
237
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
232
238
|
"content-type": 'application/json',
|
|
@@ -240,7 +246,6 @@ module Appwrite
|
|
|
240
246
|
params: api_params,
|
|
241
247
|
response_type: Models::Key
|
|
242
248
|
)
|
|
243
|
-
|
|
244
249
|
end
|
|
245
250
|
|
|
246
251
|
# Delete a key by its unique ID. Once deleted, the key can no longer be used
|
|
@@ -249,17 +254,18 @@ module Appwrite
|
|
|
249
254
|
# @param [String] key_id Key ID.
|
|
250
255
|
#
|
|
251
256
|
# @return []
|
|
252
|
-
def delete_key(
|
|
257
|
+
def delete_key(
|
|
258
|
+
key_id:
|
|
259
|
+
)
|
|
253
260
|
api_path = '/project/keys/{keyId}'
|
|
254
261
|
.gsub('{keyId}', key_id)
|
|
255
262
|
|
|
256
263
|
if key_id.nil?
|
|
257
|
-
|
|
264
|
+
raise Appwrite::Exception.new('Missing required parameter: "keyId"')
|
|
258
265
|
end
|
|
259
266
|
|
|
260
|
-
api_params = {
|
|
261
|
-
|
|
262
|
-
|
|
267
|
+
api_params = {}
|
|
268
|
+
|
|
263
269
|
api_headers = {
|
|
264
270
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
265
271
|
"content-type": 'application/json',
|
|
@@ -271,7 +277,6 @@ module Appwrite
|
|
|
271
277
|
headers: api_headers,
|
|
272
278
|
params: api_params,
|
|
273
279
|
)
|
|
274
|
-
|
|
275
280
|
end
|
|
276
281
|
|
|
277
282
|
# Update the project labels. Labels can be used to easily filter projects in
|
|
@@ -280,17 +285,19 @@ module Appwrite
|
|
|
280
285
|
# @param [Array] labels Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.
|
|
281
286
|
#
|
|
282
287
|
# @return [Project]
|
|
283
|
-
def update_labels(
|
|
288
|
+
def update_labels(
|
|
289
|
+
labels:
|
|
290
|
+
)
|
|
284
291
|
api_path = '/project/labels'
|
|
285
292
|
|
|
286
293
|
if labels.nil?
|
|
287
|
-
|
|
294
|
+
raise Appwrite::Exception.new('Missing required parameter: "labels"')
|
|
288
295
|
end
|
|
289
296
|
|
|
290
297
|
api_params = {
|
|
291
298
|
labels: labels,
|
|
292
299
|
}
|
|
293
|
-
|
|
300
|
+
|
|
294
301
|
api_headers = {
|
|
295
302
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
296
303
|
"content-type": 'application/json',
|
|
@@ -304,7 +311,6 @@ module Appwrite
|
|
|
304
311
|
params: api_params,
|
|
305
312
|
response_type: Models::Project
|
|
306
313
|
)
|
|
307
|
-
|
|
308
314
|
end
|
|
309
315
|
|
|
310
316
|
# Get a list of all mock phones in the project. This endpoint returns an
|
|
@@ -314,14 +320,17 @@ module Appwrite
|
|
|
314
320
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
315
321
|
#
|
|
316
322
|
# @return [MockNumberList]
|
|
317
|
-
def list_mock_phones(
|
|
323
|
+
def list_mock_phones(
|
|
324
|
+
queries: nil,
|
|
325
|
+
total: nil
|
|
326
|
+
)
|
|
318
327
|
api_path = '/project/mock-phones'
|
|
319
328
|
|
|
320
329
|
api_params = {
|
|
321
330
|
queries: queries,
|
|
322
331
|
total: total,
|
|
323
332
|
}
|
|
324
|
-
|
|
333
|
+
|
|
325
334
|
api_headers = {
|
|
326
335
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
327
336
|
"accept": 'application/json',
|
|
@@ -334,7 +343,6 @@ module Appwrite
|
|
|
334
343
|
params: api_params,
|
|
335
344
|
response_type: Models::MockNumberList
|
|
336
345
|
)
|
|
337
|
-
|
|
338
346
|
end
|
|
339
347
|
|
|
340
348
|
# Create a new mock phone for your project. Use this endpoint to register a
|
|
@@ -344,22 +352,25 @@ module Appwrite
|
|
|
344
352
|
# @param [String] otp One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
345
353
|
#
|
|
346
354
|
# @return [MockNumber]
|
|
347
|
-
def create_mock_phone(
|
|
355
|
+
def create_mock_phone(
|
|
356
|
+
number:,
|
|
357
|
+
otp:
|
|
358
|
+
)
|
|
348
359
|
api_path = '/project/mock-phones'
|
|
349
360
|
|
|
350
361
|
if number.nil?
|
|
351
|
-
|
|
362
|
+
raise Appwrite::Exception.new('Missing required parameter: "number"')
|
|
352
363
|
end
|
|
353
364
|
|
|
354
365
|
if otp.nil?
|
|
355
|
-
|
|
366
|
+
raise Appwrite::Exception.new('Missing required parameter: "otp"')
|
|
356
367
|
end
|
|
357
368
|
|
|
358
369
|
api_params = {
|
|
359
370
|
number: number,
|
|
360
371
|
otp: otp,
|
|
361
372
|
}
|
|
362
|
-
|
|
373
|
+
|
|
363
374
|
api_headers = {
|
|
364
375
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
365
376
|
"content-type": 'application/json',
|
|
@@ -373,26 +384,26 @@ module Appwrite
|
|
|
373
384
|
params: api_params,
|
|
374
385
|
response_type: Models::MockNumber
|
|
375
386
|
)
|
|
376
|
-
|
|
377
387
|
end
|
|
378
388
|
|
|
379
389
|
# Get a mock phone by its unique number. This endpoint returns the mock
|
|
380
|
-
# phone
|
|
390
|
+
# phone's OTP.
|
|
381
391
|
#
|
|
382
392
|
# @param [String] number Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
383
393
|
#
|
|
384
394
|
# @return [MockNumber]
|
|
385
|
-
def get_mock_phone(
|
|
395
|
+
def get_mock_phone(
|
|
396
|
+
number:
|
|
397
|
+
)
|
|
386
398
|
api_path = '/project/mock-phones/{number}'
|
|
387
399
|
.gsub('{number}', number)
|
|
388
400
|
|
|
389
401
|
if number.nil?
|
|
390
|
-
|
|
402
|
+
raise Appwrite::Exception.new('Missing required parameter: "number"')
|
|
391
403
|
end
|
|
392
404
|
|
|
393
|
-
api_params = {
|
|
394
|
-
|
|
395
|
-
|
|
405
|
+
api_params = {}
|
|
406
|
+
|
|
396
407
|
api_headers = {
|
|
397
408
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
398
409
|
"accept": 'application/json',
|
|
@@ -405,32 +416,34 @@ module Appwrite
|
|
|
405
416
|
params: api_params,
|
|
406
417
|
response_type: Models::MockNumber
|
|
407
418
|
)
|
|
408
|
-
|
|
409
419
|
end
|
|
410
420
|
|
|
411
421
|
# Update a mock phone by its unique number. Use this endpoint to update the
|
|
412
|
-
# mock phone
|
|
422
|
+
# mock phone's OTP.
|
|
413
423
|
#
|
|
414
424
|
# @param [String] number Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
415
425
|
# @param [String] otp One-time password (OTP) to associate with the mock phone. Must be a 6-digit numeric code.
|
|
416
426
|
#
|
|
417
427
|
# @return [MockNumber]
|
|
418
|
-
def update_mock_phone(
|
|
428
|
+
def update_mock_phone(
|
|
429
|
+
number:,
|
|
430
|
+
otp:
|
|
431
|
+
)
|
|
419
432
|
api_path = '/project/mock-phones/{number}'
|
|
420
433
|
.gsub('{number}', number)
|
|
421
434
|
|
|
422
435
|
if number.nil?
|
|
423
|
-
|
|
436
|
+
raise Appwrite::Exception.new('Missing required parameter: "number"')
|
|
424
437
|
end
|
|
425
438
|
|
|
426
439
|
if otp.nil?
|
|
427
|
-
|
|
440
|
+
raise Appwrite::Exception.new('Missing required parameter: "otp"')
|
|
428
441
|
end
|
|
429
442
|
|
|
430
443
|
api_params = {
|
|
431
444
|
otp: otp,
|
|
432
445
|
}
|
|
433
|
-
|
|
446
|
+
|
|
434
447
|
api_headers = {
|
|
435
448
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
436
449
|
"content-type": 'application/json',
|
|
@@ -444,7 +457,6 @@ module Appwrite
|
|
|
444
457
|
params: api_params,
|
|
445
458
|
response_type: Models::MockNumber
|
|
446
459
|
)
|
|
447
|
-
|
|
448
460
|
end
|
|
449
461
|
|
|
450
462
|
# Delete a mock phone by its unique number. This endpoint removes the mock
|
|
@@ -453,17 +465,18 @@ module Appwrite
|
|
|
453
465
|
# @param [String] number Phone number associated with the mock phone. Must be a valid E.164 formatted phone number.
|
|
454
466
|
#
|
|
455
467
|
# @return []
|
|
456
|
-
def delete_mock_phone(
|
|
468
|
+
def delete_mock_phone(
|
|
469
|
+
number:
|
|
470
|
+
)
|
|
457
471
|
api_path = '/project/mock-phones/{number}'
|
|
458
472
|
.gsub('{number}', number)
|
|
459
473
|
|
|
460
474
|
if number.nil?
|
|
461
|
-
|
|
475
|
+
raise Appwrite::Exception.new('Missing required parameter: "number"')
|
|
462
476
|
end
|
|
463
477
|
|
|
464
|
-
api_params = {
|
|
465
|
-
|
|
466
|
-
|
|
478
|
+
api_params = {}
|
|
479
|
+
|
|
467
480
|
api_headers = {
|
|
468
481
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
469
482
|
"content-type": 'application/json',
|
|
@@ -475,25 +488,27 @@ module Appwrite
|
|
|
475
488
|
headers: api_headers,
|
|
476
489
|
params: api_params,
|
|
477
490
|
)
|
|
478
|
-
|
|
479
491
|
end
|
|
480
492
|
|
|
481
493
|
# Get a list of all OAuth2 providers supported by the server, along with the
|
|
482
|
-
# project
|
|
494
|
+
# project's configuration for each. Credential fields are write-only and
|
|
483
495
|
# always returned empty.
|
|
484
496
|
#
|
|
485
497
|
# @param [Array] queries Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Only supported methods are limit and offset
|
|
486
498
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
487
499
|
#
|
|
488
500
|
# @return [OAuth2ProviderList]
|
|
489
|
-
def list_o_auth2_providers(
|
|
501
|
+
def list_o_auth2_providers(
|
|
502
|
+
queries: nil,
|
|
503
|
+
total: nil
|
|
504
|
+
)
|
|
490
505
|
api_path = '/project/oauth2'
|
|
491
506
|
|
|
492
507
|
api_params = {
|
|
493
508
|
queries: queries,
|
|
494
509
|
total: total,
|
|
495
510
|
}
|
|
496
|
-
|
|
511
|
+
|
|
497
512
|
api_headers = {
|
|
498
513
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
499
514
|
"accept": 'application/json',
|
|
@@ -506,7 +521,6 @@ module Appwrite
|
|
|
506
521
|
params: api_params,
|
|
507
522
|
response_type: Models::OAuth2ProviderList
|
|
508
523
|
)
|
|
509
|
-
|
|
510
524
|
end
|
|
511
525
|
|
|
512
526
|
# Update the OAuth2 server (OIDC provider) configuration.
|
|
@@ -529,15 +543,32 @@ module Appwrite
|
|
|
529
543
|
# @param [Array] installation_scopes List of scopes an application may request when installed on a team. Omitting the parameter clears the list, so no installation scopes can be granted. Maximum of 100 scopes are allowed, each up to 128 characters long.
|
|
530
544
|
#
|
|
531
545
|
# @return [Project]
|
|
532
|
-
def update_o_auth2_server(
|
|
546
|
+
def update_o_auth2_server(
|
|
547
|
+
enabled:,
|
|
548
|
+
authorization_url:,
|
|
549
|
+
scopes: nil,
|
|
550
|
+
authorization_details_types: nil,
|
|
551
|
+
access_token_duration: nil,
|
|
552
|
+
refresh_token_duration: nil,
|
|
553
|
+
public_access_token_duration: nil,
|
|
554
|
+
public_refresh_token_duration: nil,
|
|
555
|
+
installation_access_token_duration: nil,
|
|
556
|
+
confidential_pkce: nil,
|
|
557
|
+
verification_url: nil,
|
|
558
|
+
user_code_length: nil,
|
|
559
|
+
user_code_format: nil,
|
|
560
|
+
device_code_duration: nil,
|
|
561
|
+
default_scopes: nil,
|
|
562
|
+
installation_scopes: nil
|
|
563
|
+
)
|
|
533
564
|
api_path = '/project/oauth2-server'
|
|
534
565
|
|
|
535
566
|
if enabled.nil?
|
|
536
|
-
|
|
567
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
537
568
|
end
|
|
538
569
|
|
|
539
570
|
if authorization_url.nil?
|
|
540
|
-
|
|
571
|
+
raise Appwrite::Exception.new('Missing required parameter: "authorizationUrl"')
|
|
541
572
|
end
|
|
542
573
|
|
|
543
574
|
api_params = {
|
|
@@ -558,7 +589,7 @@ module Appwrite
|
|
|
558
589
|
defaultScopes: default_scopes,
|
|
559
590
|
installationScopes: installation_scopes,
|
|
560
591
|
}
|
|
561
|
-
|
|
592
|
+
|
|
562
593
|
api_headers = {
|
|
563
594
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
564
595
|
"content-type": 'application/json',
|
|
@@ -572,17 +603,20 @@ module Appwrite
|
|
|
572
603
|
params: api_params,
|
|
573
604
|
response_type: Models::Project
|
|
574
605
|
)
|
|
575
|
-
|
|
576
606
|
end
|
|
577
607
|
|
|
578
608
|
# Update the project OAuth2 Amazon configuration.
|
|
579
609
|
#
|
|
580
|
-
# @param [String] client_id
|
|
581
|
-
# @param [String] client_secret
|
|
610
|
+
# @param [String] client_id 'Client ID' of Amazon OAuth2 app. For example: amzn1.application-oa2-client.87400c00000000000000000000063d5b2
|
|
611
|
+
# @param [String] client_secret 'Client Secret' of Amazon OAuth2 app. For example: 79ffe4000000000000000000000000000000000000000000000000000002de55
|
|
582
612
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
583
613
|
#
|
|
584
614
|
# @return [OAuth2Amazon]
|
|
585
|
-
def update_o_auth2_amazon(
|
|
615
|
+
def update_o_auth2_amazon(
|
|
616
|
+
client_id: nil,
|
|
617
|
+
client_secret: nil,
|
|
618
|
+
enabled: nil
|
|
619
|
+
)
|
|
586
620
|
api_path = '/project/oauth2/amazon'
|
|
587
621
|
|
|
588
622
|
api_params = {
|
|
@@ -590,7 +624,7 @@ module Appwrite
|
|
|
590
624
|
clientSecret: client_secret,
|
|
591
625
|
enabled: enabled,
|
|
592
626
|
}
|
|
593
|
-
|
|
627
|
+
|
|
594
628
|
api_headers = {
|
|
595
629
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
596
630
|
"content-type": 'application/json',
|
|
@@ -604,19 +638,24 @@ module Appwrite
|
|
|
604
638
|
params: api_params,
|
|
605
639
|
response_type: Models::OAuth2Amazon
|
|
606
640
|
)
|
|
607
|
-
|
|
608
641
|
end
|
|
609
642
|
|
|
610
643
|
# Update the project OAuth2 Apple configuration.
|
|
611
644
|
#
|
|
612
|
-
# @param [String] service_id
|
|
613
|
-
# @param [String] key_id
|
|
614
|
-
# @param [String] team_id
|
|
645
|
+
# @param [String] service_id 'Service ID' of Apple OAuth2 app. For example: ip.appwrite.app.web
|
|
646
|
+
# @param [String] key_id 'Key ID' of Apple OAuth2 app. For example: P4000000N8
|
|
647
|
+
# @param [String] team_id 'Team ID' of Apple OAuth2 app. For example: D4000000R6
|
|
615
648
|
# @param [String] p8_file Contents of the Apple OAuth2 app .p8 private key file. The secret key wrapped by the PEM markers is 200 characters long. For example: -----BEGIN PRIVATE KEY-----MIGTAg...jy2Xbna-----END PRIVATE KEY-----
|
|
616
649
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
617
650
|
#
|
|
618
651
|
# @return [OAuth2Apple]
|
|
619
|
-
def update_o_auth2_apple(
|
|
652
|
+
def update_o_auth2_apple(
|
|
653
|
+
service_id: nil,
|
|
654
|
+
key_id: nil,
|
|
655
|
+
team_id: nil,
|
|
656
|
+
p8_file: nil,
|
|
657
|
+
enabled: nil
|
|
658
|
+
)
|
|
620
659
|
api_path = '/project/oauth2/apple'
|
|
621
660
|
|
|
622
661
|
api_params = {
|
|
@@ -626,7 +665,7 @@ module Appwrite
|
|
|
626
665
|
p8File: p8_file,
|
|
627
666
|
enabled: enabled,
|
|
628
667
|
}
|
|
629
|
-
|
|
668
|
+
|
|
630
669
|
api_headers = {
|
|
631
670
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
632
671
|
"content-type": 'application/json',
|
|
@@ -640,17 +679,20 @@ module Appwrite
|
|
|
640
679
|
params: api_params,
|
|
641
680
|
response_type: Models::OAuth2Apple
|
|
642
681
|
)
|
|
643
|
-
|
|
644
682
|
end
|
|
645
683
|
|
|
646
684
|
# Update the project OAuth2 Appwrite configuration.
|
|
647
685
|
#
|
|
648
|
-
# @param [String] client_id
|
|
649
|
-
# @param [String] client_secret
|
|
686
|
+
# @param [String] client_id 'Client ID' of Appwrite OAuth2 app. For example: 6a42000000000000b5a0
|
|
687
|
+
# @param [String] client_secret 'Client Secret' of Appwrite OAuth2 app. For example: b86afd000000000000000000000000000000000000000000000000000ced5f93
|
|
650
688
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
651
689
|
#
|
|
652
690
|
# @return [OAuth2Appwrite]
|
|
653
|
-
def update_o_auth2_appwrite(
|
|
691
|
+
def update_o_auth2_appwrite(
|
|
692
|
+
client_id: nil,
|
|
693
|
+
client_secret: nil,
|
|
694
|
+
enabled: nil
|
|
695
|
+
)
|
|
654
696
|
api_path = '/project/oauth2/appwrite'
|
|
655
697
|
|
|
656
698
|
api_params = {
|
|
@@ -658,7 +700,7 @@ module Appwrite
|
|
|
658
700
|
clientSecret: client_secret,
|
|
659
701
|
enabled: enabled,
|
|
660
702
|
}
|
|
661
|
-
|
|
703
|
+
|
|
662
704
|
api_headers = {
|
|
663
705
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
664
706
|
"content-type": 'application/json',
|
|
@@ -672,18 +714,22 @@ module Appwrite
|
|
|
672
714
|
params: api_params,
|
|
673
715
|
response_type: Models::OAuth2Appwrite
|
|
674
716
|
)
|
|
675
|
-
|
|
676
717
|
end
|
|
677
718
|
|
|
678
719
|
# Update the project OAuth2 Auth0 configuration.
|
|
679
720
|
#
|
|
680
|
-
# @param [String] client_id
|
|
681
|
-
# @param [String] client_secret
|
|
721
|
+
# @param [String] client_id 'Client ID' of Auth0 OAuth2 app. For example: OaOkIA000000000000000000005KLSYq
|
|
722
|
+
# @param [String] client_secret 'Client Secret' of Auth0 OAuth2 app. For example: zXz0000-00000000000000000000000000000-00000000000000000000PJafnF
|
|
682
723
|
# @param [String] endpoint Domain of Auth0 instance. For example: example.us.auth0.com
|
|
683
724
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
684
725
|
#
|
|
685
726
|
# @return [OAuth2Auth0]
|
|
686
|
-
def update_o_auth2_auth0(
|
|
727
|
+
def update_o_auth2_auth0(
|
|
728
|
+
client_id: nil,
|
|
729
|
+
client_secret: nil,
|
|
730
|
+
endpoint: nil,
|
|
731
|
+
enabled: nil
|
|
732
|
+
)
|
|
687
733
|
api_path = '/project/oauth2/auth0'
|
|
688
734
|
|
|
689
735
|
api_params = {
|
|
@@ -692,7 +738,7 @@ module Appwrite
|
|
|
692
738
|
endpoint: endpoint,
|
|
693
739
|
enabled: enabled,
|
|
694
740
|
}
|
|
695
|
-
|
|
741
|
+
|
|
696
742
|
api_headers = {
|
|
697
743
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
698
744
|
"content-type": 'application/json',
|
|
@@ -706,18 +752,22 @@ module Appwrite
|
|
|
706
752
|
params: api_params,
|
|
707
753
|
response_type: Models::OAuth2Auth0
|
|
708
754
|
)
|
|
709
|
-
|
|
710
755
|
end
|
|
711
756
|
|
|
712
757
|
# Update the project OAuth2 Authentik configuration.
|
|
713
758
|
#
|
|
714
|
-
# @param [String] client_id
|
|
715
|
-
# @param [String] client_secret
|
|
759
|
+
# @param [String] client_id 'Client ID' of Authentik OAuth2 app. For example: dTKOPa0000000000000000000000000000e7G8hv
|
|
760
|
+
# @param [String] client_secret 'Client Secret' of Authentik OAuth2 app. For example: ntQadq000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000Hp5WK
|
|
716
761
|
# @param [String] endpoint Domain of Authentik instance. For example: example.authentik.com
|
|
717
762
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
718
763
|
#
|
|
719
764
|
# @return [OAuth2Authentik]
|
|
720
|
-
def update_o_auth2_authentik(
|
|
765
|
+
def update_o_auth2_authentik(
|
|
766
|
+
client_id: nil,
|
|
767
|
+
client_secret: nil,
|
|
768
|
+
endpoint: nil,
|
|
769
|
+
enabled: nil
|
|
770
|
+
)
|
|
721
771
|
api_path = '/project/oauth2/authentik'
|
|
722
772
|
|
|
723
773
|
api_params = {
|
|
@@ -726,7 +776,7 @@ module Appwrite
|
|
|
726
776
|
endpoint: endpoint,
|
|
727
777
|
enabled: enabled,
|
|
728
778
|
}
|
|
729
|
-
|
|
779
|
+
|
|
730
780
|
api_headers = {
|
|
731
781
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
732
782
|
"content-type": 'application/json',
|
|
@@ -740,17 +790,20 @@ module Appwrite
|
|
|
740
790
|
params: api_params,
|
|
741
791
|
response_type: Models::OAuth2Authentik
|
|
742
792
|
)
|
|
743
|
-
|
|
744
793
|
end
|
|
745
794
|
|
|
746
795
|
# Update the project OAuth2 Autodesk configuration.
|
|
747
796
|
#
|
|
748
|
-
# @param [String] client_id
|
|
749
|
-
# @param [String] client_secret
|
|
797
|
+
# @param [String] client_id 'Client ID' of Autodesk OAuth2 app. For example: 5zw90v00000000000000000000kVYXN7
|
|
798
|
+
# @param [String] client_secret 'Client Secret' of Autodesk OAuth2 app. For example: 7I000000000000MW
|
|
750
799
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
751
800
|
#
|
|
752
801
|
# @return [OAuth2Autodesk]
|
|
753
|
-
def update_o_auth2_autodesk(
|
|
802
|
+
def update_o_auth2_autodesk(
|
|
803
|
+
client_id: nil,
|
|
804
|
+
client_secret: nil,
|
|
805
|
+
enabled: nil
|
|
806
|
+
)
|
|
754
807
|
api_path = '/project/oauth2/autodesk'
|
|
755
808
|
|
|
756
809
|
api_params = {
|
|
@@ -758,7 +811,7 @@ module Appwrite
|
|
|
758
811
|
clientSecret: client_secret,
|
|
759
812
|
enabled: enabled,
|
|
760
813
|
}
|
|
761
|
-
|
|
814
|
+
|
|
762
815
|
api_headers = {
|
|
763
816
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
764
817
|
"content-type": 'application/json',
|
|
@@ -772,17 +825,20 @@ module Appwrite
|
|
|
772
825
|
params: api_params,
|
|
773
826
|
response_type: Models::OAuth2Autodesk
|
|
774
827
|
)
|
|
775
|
-
|
|
776
828
|
end
|
|
777
829
|
|
|
778
830
|
# Update the project OAuth2 Bitbucket configuration.
|
|
779
831
|
#
|
|
780
|
-
# @param [String] key
|
|
781
|
-
# @param [String] secret
|
|
832
|
+
# @param [String] key 'Key' of Bitbucket OAuth2 app. For example: Knt70000000000ByRc
|
|
833
|
+
# @param [String] secret 'Secret' of Bitbucket OAuth2 app. For example: NMfLZJ00000000000000000000TLQdDx
|
|
782
834
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
783
835
|
#
|
|
784
836
|
# @return [OAuth2Bitbucket]
|
|
785
|
-
def update_o_auth2_bitbucket(
|
|
837
|
+
def update_o_auth2_bitbucket(
|
|
838
|
+
key: nil,
|
|
839
|
+
secret: nil,
|
|
840
|
+
enabled: nil
|
|
841
|
+
)
|
|
786
842
|
api_path = '/project/oauth2/bitbucket'
|
|
787
843
|
|
|
788
844
|
api_params = {
|
|
@@ -790,7 +846,7 @@ module Appwrite
|
|
|
790
846
|
secret: secret,
|
|
791
847
|
enabled: enabled,
|
|
792
848
|
}
|
|
793
|
-
|
|
849
|
+
|
|
794
850
|
api_headers = {
|
|
795
851
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
796
852
|
"content-type": 'application/json',
|
|
@@ -804,17 +860,20 @@ module Appwrite
|
|
|
804
860
|
params: api_params,
|
|
805
861
|
response_type: Models::OAuth2Bitbucket
|
|
806
862
|
)
|
|
807
|
-
|
|
808
863
|
end
|
|
809
864
|
|
|
810
865
|
# Update the project OAuth2 Bitly configuration.
|
|
811
866
|
#
|
|
812
|
-
# @param [String] client_id
|
|
813
|
-
# @param [String] client_secret
|
|
867
|
+
# @param [String] client_id 'Client ID' of Bitly OAuth2 app. For example: d95151000000000000000000000000000067af9b
|
|
868
|
+
# @param [String] client_secret 'Client Secret' of Bitly OAuth2 app. For example: a13e250000000000000000000000000000d73095
|
|
814
869
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
815
870
|
#
|
|
816
871
|
# @return [OAuth2Bitly]
|
|
817
|
-
def update_o_auth2_bitly(
|
|
872
|
+
def update_o_auth2_bitly(
|
|
873
|
+
client_id: nil,
|
|
874
|
+
client_secret: nil,
|
|
875
|
+
enabled: nil
|
|
876
|
+
)
|
|
818
877
|
api_path = '/project/oauth2/bitly'
|
|
819
878
|
|
|
820
879
|
api_params = {
|
|
@@ -822,7 +881,7 @@ module Appwrite
|
|
|
822
881
|
clientSecret: client_secret,
|
|
823
882
|
enabled: enabled,
|
|
824
883
|
}
|
|
825
|
-
|
|
884
|
+
|
|
826
885
|
api_headers = {
|
|
827
886
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
828
887
|
"content-type": 'application/json',
|
|
@@ -836,17 +895,20 @@ module Appwrite
|
|
|
836
895
|
params: api_params,
|
|
837
896
|
response_type: Models::OAuth2Bitly
|
|
838
897
|
)
|
|
839
|
-
|
|
840
898
|
end
|
|
841
899
|
|
|
842
900
|
# Update the project OAuth2 Box configuration.
|
|
843
901
|
#
|
|
844
|
-
# @param [String] client_id
|
|
845
|
-
# @param [String] client_secret
|
|
902
|
+
# @param [String] client_id 'Client ID' of Box OAuth2 app. For example: deglcs00000000000000000000x2og6y
|
|
903
|
+
# @param [String] client_secret 'Client Secret' of Box OAuth2 app. For example: OKM1f100000000000000000000eshEif
|
|
846
904
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
847
905
|
#
|
|
848
906
|
# @return [OAuth2Box]
|
|
849
|
-
def update_o_auth2_box(
|
|
907
|
+
def update_o_auth2_box(
|
|
908
|
+
client_id: nil,
|
|
909
|
+
client_secret: nil,
|
|
910
|
+
enabled: nil
|
|
911
|
+
)
|
|
850
912
|
api_path = '/project/oauth2/box'
|
|
851
913
|
|
|
852
914
|
api_params = {
|
|
@@ -854,7 +916,7 @@ module Appwrite
|
|
|
854
916
|
clientSecret: client_secret,
|
|
855
917
|
enabled: enabled,
|
|
856
918
|
}
|
|
857
|
-
|
|
919
|
+
|
|
858
920
|
api_headers = {
|
|
859
921
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
860
922
|
"content-type": 'application/json',
|
|
@@ -868,17 +930,20 @@ module Appwrite
|
|
|
868
930
|
params: api_params,
|
|
869
931
|
response_type: Models::OAuth2Box
|
|
870
932
|
)
|
|
871
|
-
|
|
872
933
|
end
|
|
873
934
|
|
|
874
935
|
# Update the project OAuth2 Dailymotion configuration.
|
|
875
936
|
#
|
|
876
|
-
# @param [String] api_key
|
|
877
|
-
# @param [String] api_secret
|
|
937
|
+
# @param [String] api_key 'API Key' of Dailymotion OAuth2 app. For example: 07a9000000000000067f
|
|
938
|
+
# @param [String] api_secret 'API Secret' of Dailymotion OAuth2 app. For example: a399a90000000000000000000000000000d90639
|
|
878
939
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
879
940
|
#
|
|
880
941
|
# @return [OAuth2Dailymotion]
|
|
881
|
-
def update_o_auth2_dailymotion(
|
|
942
|
+
def update_o_auth2_dailymotion(
|
|
943
|
+
api_key: nil,
|
|
944
|
+
api_secret: nil,
|
|
945
|
+
enabled: nil
|
|
946
|
+
)
|
|
882
947
|
api_path = '/project/oauth2/dailymotion'
|
|
883
948
|
|
|
884
949
|
api_params = {
|
|
@@ -886,7 +951,7 @@ module Appwrite
|
|
|
886
951
|
apiSecret: api_secret,
|
|
887
952
|
enabled: enabled,
|
|
888
953
|
}
|
|
889
|
-
|
|
954
|
+
|
|
890
955
|
api_headers = {
|
|
891
956
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
892
957
|
"content-type": 'application/json',
|
|
@@ -900,17 +965,20 @@ module Appwrite
|
|
|
900
965
|
params: api_params,
|
|
901
966
|
response_type: Models::OAuth2Dailymotion
|
|
902
967
|
)
|
|
903
|
-
|
|
904
968
|
end
|
|
905
969
|
|
|
906
970
|
# Update the project OAuth2 Discord configuration.
|
|
907
971
|
#
|
|
908
|
-
# @param [String] client_id
|
|
909
|
-
# @param [String] client_secret
|
|
972
|
+
# @param [String] client_id 'Client ID' of Discord OAuth2 app. For example: 950722000000343754
|
|
973
|
+
# @param [String] client_secret 'Client Secret' of Discord OAuth2 app. For example: YmPXnM000000000000000000002zFg5D
|
|
910
974
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
911
975
|
#
|
|
912
976
|
# @return [OAuth2Discord]
|
|
913
|
-
def update_o_auth2_discord(
|
|
977
|
+
def update_o_auth2_discord(
|
|
978
|
+
client_id: nil,
|
|
979
|
+
client_secret: nil,
|
|
980
|
+
enabled: nil
|
|
981
|
+
)
|
|
914
982
|
api_path = '/project/oauth2/discord'
|
|
915
983
|
|
|
916
984
|
api_params = {
|
|
@@ -918,7 +986,7 @@ module Appwrite
|
|
|
918
986
|
clientSecret: client_secret,
|
|
919
987
|
enabled: enabled,
|
|
920
988
|
}
|
|
921
|
-
|
|
989
|
+
|
|
922
990
|
api_headers = {
|
|
923
991
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
924
992
|
"content-type": 'application/json',
|
|
@@ -932,17 +1000,20 @@ module Appwrite
|
|
|
932
1000
|
params: api_params,
|
|
933
1001
|
response_type: Models::OAuth2Discord
|
|
934
1002
|
)
|
|
935
|
-
|
|
936
1003
|
end
|
|
937
1004
|
|
|
938
1005
|
# Update the project OAuth2 Disqus configuration.
|
|
939
1006
|
#
|
|
940
|
-
# @param [String] public_key
|
|
941
|
-
# @param [String] secret_key
|
|
1007
|
+
# @param [String] public_key 'Public Key, also known as API Key' of Disqus OAuth2 app. For example: cgegH70000000000000000000000000000000000000000000000000000Hr1nYX
|
|
1008
|
+
# @param [String] secret_key 'Secret Key, also known as API Secret' of Disqus OAuth2 app. For example: W7Bykj00000000000000000000000000000000000000000000000000003o43w9
|
|
942
1009
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
943
1010
|
#
|
|
944
1011
|
# @return [OAuth2Disqus]
|
|
945
|
-
def update_o_auth2_disqus(
|
|
1012
|
+
def update_o_auth2_disqus(
|
|
1013
|
+
public_key: nil,
|
|
1014
|
+
secret_key: nil,
|
|
1015
|
+
enabled: nil
|
|
1016
|
+
)
|
|
946
1017
|
api_path = '/project/oauth2/disqus'
|
|
947
1018
|
|
|
948
1019
|
api_params = {
|
|
@@ -950,7 +1021,7 @@ module Appwrite
|
|
|
950
1021
|
secretKey: secret_key,
|
|
951
1022
|
enabled: enabled,
|
|
952
1023
|
}
|
|
953
|
-
|
|
1024
|
+
|
|
954
1025
|
api_headers = {
|
|
955
1026
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
956
1027
|
"content-type": 'application/json',
|
|
@@ -964,17 +1035,20 @@ module Appwrite
|
|
|
964
1035
|
params: api_params,
|
|
965
1036
|
response_type: Models::OAuth2Disqus
|
|
966
1037
|
)
|
|
967
|
-
|
|
968
1038
|
end
|
|
969
1039
|
|
|
970
1040
|
# Update the project OAuth2 Dropbox configuration.
|
|
971
1041
|
#
|
|
972
|
-
# @param [String] app_key
|
|
973
|
-
# @param [String] app_secret
|
|
1042
|
+
# @param [String] app_key 'App Key' of Dropbox OAuth2 app. For example: jl000000000009t
|
|
1043
|
+
# @param [String] app_secret 'App Secret' of Dropbox OAuth2 app. For example: g200000000000vw
|
|
974
1044
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
975
1045
|
#
|
|
976
1046
|
# @return [OAuth2Dropbox]
|
|
977
|
-
def update_o_auth2_dropbox(
|
|
1047
|
+
def update_o_auth2_dropbox(
|
|
1048
|
+
app_key: nil,
|
|
1049
|
+
app_secret: nil,
|
|
1050
|
+
enabled: nil
|
|
1051
|
+
)
|
|
978
1052
|
api_path = '/project/oauth2/dropbox'
|
|
979
1053
|
|
|
980
1054
|
api_params = {
|
|
@@ -982,7 +1056,7 @@ module Appwrite
|
|
|
982
1056
|
appSecret: app_secret,
|
|
983
1057
|
enabled: enabled,
|
|
984
1058
|
}
|
|
985
|
-
|
|
1059
|
+
|
|
986
1060
|
api_headers = {
|
|
987
1061
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
988
1062
|
"content-type": 'application/json',
|
|
@@ -996,17 +1070,20 @@ module Appwrite
|
|
|
996
1070
|
params: api_params,
|
|
997
1071
|
response_type: Models::OAuth2Dropbox
|
|
998
1072
|
)
|
|
999
|
-
|
|
1000
1073
|
end
|
|
1001
1074
|
|
|
1002
1075
|
# Update the project OAuth2 Etsy configuration.
|
|
1003
1076
|
#
|
|
1004
|
-
# @param [String] key_string
|
|
1005
|
-
# @param [String] shared_secret
|
|
1077
|
+
# @param [String] key_string 'Keystring' of Etsy OAuth2 app. For example: nsgzxh0000000000008j85a2
|
|
1078
|
+
# @param [String] shared_secret 'Shared Secret' of Etsy OAuth2 app. For example: tp000000ru
|
|
1006
1079
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1007
1080
|
#
|
|
1008
1081
|
# @return [OAuth2Etsy]
|
|
1009
|
-
def update_o_auth2_etsy(
|
|
1082
|
+
def update_o_auth2_etsy(
|
|
1083
|
+
key_string: nil,
|
|
1084
|
+
shared_secret: nil,
|
|
1085
|
+
enabled: nil
|
|
1086
|
+
)
|
|
1010
1087
|
api_path = '/project/oauth2/etsy'
|
|
1011
1088
|
|
|
1012
1089
|
api_params = {
|
|
@@ -1014,7 +1091,7 @@ module Appwrite
|
|
|
1014
1091
|
sharedSecret: shared_secret,
|
|
1015
1092
|
enabled: enabled,
|
|
1016
1093
|
}
|
|
1017
|
-
|
|
1094
|
+
|
|
1018
1095
|
api_headers = {
|
|
1019
1096
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1020
1097
|
"content-type": 'application/json',
|
|
@@ -1028,17 +1105,20 @@ module Appwrite
|
|
|
1028
1105
|
params: api_params,
|
|
1029
1106
|
response_type: Models::OAuth2Etsy
|
|
1030
1107
|
)
|
|
1031
|
-
|
|
1032
1108
|
end
|
|
1033
1109
|
|
|
1034
1110
|
# Update the project OAuth2 Facebook configuration.
|
|
1035
1111
|
#
|
|
1036
|
-
# @param [String] app_id
|
|
1037
|
-
# @param [String] app_secret
|
|
1112
|
+
# @param [String] app_id 'App ID' of Facebook OAuth2 app. For example: 260600000007694
|
|
1113
|
+
# @param [String] app_secret 'App Secret' of Facebook OAuth2 app. For example: 2d0b2800000000000000000000d38af4
|
|
1038
1114
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1039
1115
|
#
|
|
1040
1116
|
# @return [OAuth2Facebook]
|
|
1041
|
-
def update_o_auth2_facebook(
|
|
1117
|
+
def update_o_auth2_facebook(
|
|
1118
|
+
app_id: nil,
|
|
1119
|
+
app_secret: nil,
|
|
1120
|
+
enabled: nil
|
|
1121
|
+
)
|
|
1042
1122
|
api_path = '/project/oauth2/facebook'
|
|
1043
1123
|
|
|
1044
1124
|
api_params = {
|
|
@@ -1046,7 +1126,7 @@ module Appwrite
|
|
|
1046
1126
|
appSecret: app_secret,
|
|
1047
1127
|
enabled: enabled,
|
|
1048
1128
|
}
|
|
1049
|
-
|
|
1129
|
+
|
|
1050
1130
|
api_headers = {
|
|
1051
1131
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1052
1132
|
"content-type": 'application/json',
|
|
@@ -1060,17 +1140,20 @@ module Appwrite
|
|
|
1060
1140
|
params: api_params,
|
|
1061
1141
|
response_type: Models::OAuth2Facebook
|
|
1062
1142
|
)
|
|
1063
|
-
|
|
1064
1143
|
end
|
|
1065
1144
|
|
|
1066
1145
|
# Update the project OAuth2 Figma configuration.
|
|
1067
1146
|
#
|
|
1068
|
-
# @param [String] client_id
|
|
1069
|
-
# @param [String] client_secret
|
|
1147
|
+
# @param [String] client_id 'Client ID' of Figma OAuth2 app. For example: byay5H0000000000VtiI40
|
|
1148
|
+
# @param [String] client_secret 'Client Secret' of Figma OAuth2 app. For example: yEpOYn0000000000000000004iIsU5
|
|
1070
1149
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1071
1150
|
#
|
|
1072
1151
|
# @return [OAuth2Figma]
|
|
1073
|
-
def update_o_auth2_figma(
|
|
1152
|
+
def update_o_auth2_figma(
|
|
1153
|
+
client_id: nil,
|
|
1154
|
+
client_secret: nil,
|
|
1155
|
+
enabled: nil
|
|
1156
|
+
)
|
|
1074
1157
|
api_path = '/project/oauth2/figma'
|
|
1075
1158
|
|
|
1076
1159
|
api_params = {
|
|
@@ -1078,7 +1161,7 @@ module Appwrite
|
|
|
1078
1161
|
clientSecret: client_secret,
|
|
1079
1162
|
enabled: enabled,
|
|
1080
1163
|
}
|
|
1081
|
-
|
|
1164
|
+
|
|
1082
1165
|
api_headers = {
|
|
1083
1166
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1084
1167
|
"content-type": 'application/json',
|
|
@@ -1092,18 +1175,22 @@ module Appwrite
|
|
|
1092
1175
|
params: api_params,
|
|
1093
1176
|
response_type: Models::OAuth2Figma
|
|
1094
1177
|
)
|
|
1095
|
-
|
|
1096
1178
|
end
|
|
1097
1179
|
|
|
1098
1180
|
# Update the project OAuth2 FusionAuth configuration.
|
|
1099
1181
|
#
|
|
1100
|
-
# @param [String] client_id
|
|
1101
|
-
# @param [String] client_secret
|
|
1182
|
+
# @param [String] client_id 'Client ID' of FusionAuth OAuth2 app. For example: b2222c00-0000-0000-0000-000000862097
|
|
1183
|
+
# @param [String] client_secret 'Client Secret' of FusionAuth OAuth2 app. For example: Jx4s0C0000000000000000000000000000000wGqLsc
|
|
1102
1184
|
# @param [String] endpoint Domain of FusionAuth instance. For example: example.fusionauth.io
|
|
1103
1185
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1104
1186
|
#
|
|
1105
1187
|
# @return [OAuth2FusionAuth]
|
|
1106
|
-
def update_o_auth2_fusion_auth(
|
|
1188
|
+
def update_o_auth2_fusion_auth(
|
|
1189
|
+
client_id: nil,
|
|
1190
|
+
client_secret: nil,
|
|
1191
|
+
endpoint: nil,
|
|
1192
|
+
enabled: nil
|
|
1193
|
+
)
|
|
1107
1194
|
api_path = '/project/oauth2/fusionauth'
|
|
1108
1195
|
|
|
1109
1196
|
api_params = {
|
|
@@ -1112,7 +1199,7 @@ module Appwrite
|
|
|
1112
1199
|
endpoint: endpoint,
|
|
1113
1200
|
enabled: enabled,
|
|
1114
1201
|
}
|
|
1115
|
-
|
|
1202
|
+
|
|
1116
1203
|
api_headers = {
|
|
1117
1204
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1118
1205
|
"content-type": 'application/json',
|
|
@@ -1126,17 +1213,20 @@ module Appwrite
|
|
|
1126
1213
|
params: api_params,
|
|
1127
1214
|
response_type: Models::OAuth2FusionAuth
|
|
1128
1215
|
)
|
|
1129
|
-
|
|
1130
1216
|
end
|
|
1131
1217
|
|
|
1132
1218
|
# Update the project OAuth2 GitHub configuration.
|
|
1133
1219
|
#
|
|
1134
|
-
# @param [String] client_id
|
|
1135
|
-
# @param [String] client_secret
|
|
1220
|
+
# @param [String] client_id 'OAuth2 app Client ID, or App ID' of GitHub OAuth2 app. For example: e4d87900000000540733. Example of wrong value: 370006
|
|
1221
|
+
# @param [String] client_secret 'Client Secret' of GitHub OAuth2 app. For example: 5e07c00000000000000000000000000000198bcc
|
|
1136
1222
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1137
1223
|
#
|
|
1138
1224
|
# @return [OAuth2Github]
|
|
1139
|
-
def update_o_auth2_git_hub(
|
|
1225
|
+
def update_o_auth2_git_hub(
|
|
1226
|
+
client_id: nil,
|
|
1227
|
+
client_secret: nil,
|
|
1228
|
+
enabled: nil
|
|
1229
|
+
)
|
|
1140
1230
|
api_path = '/project/oauth2/github'
|
|
1141
1231
|
|
|
1142
1232
|
api_params = {
|
|
@@ -1144,7 +1234,7 @@ module Appwrite
|
|
|
1144
1234
|
clientSecret: client_secret,
|
|
1145
1235
|
enabled: enabled,
|
|
1146
1236
|
}
|
|
1147
|
-
|
|
1237
|
+
|
|
1148
1238
|
api_headers = {
|
|
1149
1239
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1150
1240
|
"content-type": 'application/json',
|
|
@@ -1158,18 +1248,22 @@ module Appwrite
|
|
|
1158
1248
|
params: api_params,
|
|
1159
1249
|
response_type: Models::OAuth2Github
|
|
1160
1250
|
)
|
|
1161
|
-
|
|
1162
1251
|
end
|
|
1163
1252
|
|
|
1164
1253
|
# Update the project OAuth2 Gitlab configuration.
|
|
1165
1254
|
#
|
|
1166
|
-
# @param [String] application_id
|
|
1167
|
-
# @param [String] secret
|
|
1255
|
+
# @param [String] application_id 'Application ID' of Gitlab OAuth2 app. For example: d41ffe0000000000000000000000000000000000000000000000000000d5e252
|
|
1256
|
+
# @param [String] secret 'Secret' of Gitlab OAuth2 app. For example: gloas-838cfa0000000000000000000000000000000000000000000000000000ecbb38
|
|
1168
1257
|
# @param [String] endpoint Endpoint URL of self-hosted GitLab instance. For example: https://gitlab.com
|
|
1169
1258
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1170
1259
|
#
|
|
1171
1260
|
# @return [OAuth2Gitlab]
|
|
1172
|
-
def update_o_auth2_gitlab(
|
|
1261
|
+
def update_o_auth2_gitlab(
|
|
1262
|
+
application_id: nil,
|
|
1263
|
+
secret: nil,
|
|
1264
|
+
endpoint: nil,
|
|
1265
|
+
enabled: nil
|
|
1266
|
+
)
|
|
1173
1267
|
api_path = '/project/oauth2/gitlab'
|
|
1174
1268
|
|
|
1175
1269
|
api_params = {
|
|
@@ -1178,7 +1272,7 @@ module Appwrite
|
|
|
1178
1272
|
endpoint: endpoint,
|
|
1179
1273
|
enabled: enabled,
|
|
1180
1274
|
}
|
|
1181
|
-
|
|
1275
|
+
|
|
1182
1276
|
api_headers = {
|
|
1183
1277
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1184
1278
|
"content-type": 'application/json',
|
|
@@ -1192,18 +1286,22 @@ module Appwrite
|
|
|
1192
1286
|
params: api_params,
|
|
1193
1287
|
response_type: Models::OAuth2Gitlab
|
|
1194
1288
|
)
|
|
1195
|
-
|
|
1196
1289
|
end
|
|
1197
1290
|
|
|
1198
1291
|
# Update the project OAuth2 Google configuration.
|
|
1199
1292
|
#
|
|
1200
|
-
# @param [String] client_id
|
|
1201
|
-
# @param [String] client_secret
|
|
1202
|
-
# @param [Array] prompt Array of Google OAuth2 prompt values. If
|
|
1293
|
+
# @param [String] client_id 'Client ID' of Google OAuth2 app. For example: 120000000095-92ifjb00000000000000000000g7ijfb.apps.googleusercontent.com
|
|
1294
|
+
# @param [String] client_secret 'Client Secret' of Google OAuth2 app. For example: GOCSPX-2k8gsR0000000000000000VNahJj
|
|
1295
|
+
# @param [Array] prompt Array of Google OAuth2 prompt values. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. Must not be specified with other values. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
1203
1296
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1204
1297
|
#
|
|
1205
1298
|
# @return [OAuth2Google]
|
|
1206
|
-
def update_o_auth2_google(
|
|
1299
|
+
def update_o_auth2_google(
|
|
1300
|
+
client_id: nil,
|
|
1301
|
+
client_secret: nil,
|
|
1302
|
+
prompt: nil,
|
|
1303
|
+
enabled: nil
|
|
1304
|
+
)
|
|
1207
1305
|
api_path = '/project/oauth2/google'
|
|
1208
1306
|
|
|
1209
1307
|
api_params = {
|
|
@@ -1212,7 +1310,7 @@ module Appwrite
|
|
|
1212
1310
|
prompt: prompt,
|
|
1213
1311
|
enabled: enabled,
|
|
1214
1312
|
}
|
|
1215
|
-
|
|
1313
|
+
|
|
1216
1314
|
api_headers = {
|
|
1217
1315
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1218
1316
|
"content-type": 'application/json',
|
|
@@ -1226,19 +1324,59 @@ module Appwrite
|
|
|
1226
1324
|
params: api_params,
|
|
1227
1325
|
response_type: Models::OAuth2Google
|
|
1228
1326
|
)
|
|
1327
|
+
end
|
|
1328
|
+
|
|
1329
|
+
# Update the project OAuth2 Hugging Face configuration.
|
|
1330
|
+
#
|
|
1331
|
+
# @param [String] client_id 'Client ID' of Hugging Face OAuth2 app. For example: 2ab9cff9-d711-40ad-a91e-b08a49c42d24
|
|
1332
|
+
# @param [String] client_secret 'Client Secret' of Hugging Face OAuth2 app. For example: oauth_app_secret_wcLhRtl000000000000000000000xbNdLt
|
|
1333
|
+
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1334
|
+
#
|
|
1335
|
+
# @return [OAuth2HuggingFace]
|
|
1336
|
+
def update_o_auth2_hugging_face(
|
|
1337
|
+
client_id: nil,
|
|
1338
|
+
client_secret: nil,
|
|
1339
|
+
enabled: nil
|
|
1340
|
+
)
|
|
1341
|
+
api_path = '/project/oauth2/huggingface'
|
|
1342
|
+
|
|
1343
|
+
api_params = {
|
|
1344
|
+
clientId: client_id,
|
|
1345
|
+
clientSecret: client_secret,
|
|
1346
|
+
enabled: enabled,
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1349
|
+
api_headers = {
|
|
1350
|
+
"X-Appwrite-Project": @client.get_config('project'),
|
|
1351
|
+
"content-type": 'application/json',
|
|
1352
|
+
"accept": 'application/json',
|
|
1353
|
+
}
|
|
1229
1354
|
|
|
1355
|
+
@client.call(
|
|
1356
|
+
method: 'PATCH',
|
|
1357
|
+
path: api_path,
|
|
1358
|
+
headers: api_headers,
|
|
1359
|
+
params: api_params,
|
|
1360
|
+
response_type: Models::OAuth2HuggingFace
|
|
1361
|
+
)
|
|
1230
1362
|
end
|
|
1231
1363
|
|
|
1232
1364
|
# Update the project OAuth2 Keycloak configuration.
|
|
1233
1365
|
#
|
|
1234
|
-
# @param [String] client_id
|
|
1235
|
-
# @param [String] client_secret
|
|
1366
|
+
# @param [String] client_id 'Client ID' of Keycloak OAuth2 app. For example: appwrite-o0000000st-app
|
|
1367
|
+
# @param [String] client_secret 'Client Secret' of Keycloak OAuth2 app. For example: jdjrJd00000000000000000000HUsaZO
|
|
1236
1368
|
# @param [String] endpoint Domain of Keycloak instance. For example: keycloak.example.com
|
|
1237
1369
|
# @param [String] realm_name Keycloak realm name. For example: appwrite-realm
|
|
1238
1370
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1239
1371
|
#
|
|
1240
1372
|
# @return [OAuth2Keycloak]
|
|
1241
|
-
def update_o_auth2_keycloak(
|
|
1373
|
+
def update_o_auth2_keycloak(
|
|
1374
|
+
client_id: nil,
|
|
1375
|
+
client_secret: nil,
|
|
1376
|
+
endpoint: nil,
|
|
1377
|
+
realm_name: nil,
|
|
1378
|
+
enabled: nil
|
|
1379
|
+
)
|
|
1242
1380
|
api_path = '/project/oauth2/keycloak'
|
|
1243
1381
|
|
|
1244
1382
|
api_params = {
|
|
@@ -1248,7 +1386,7 @@ module Appwrite
|
|
|
1248
1386
|
realmName: realm_name,
|
|
1249
1387
|
enabled: enabled,
|
|
1250
1388
|
}
|
|
1251
|
-
|
|
1389
|
+
|
|
1252
1390
|
api_headers = {
|
|
1253
1391
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1254
1392
|
"content-type": 'application/json',
|
|
@@ -1262,17 +1400,20 @@ module Appwrite
|
|
|
1262
1400
|
params: api_params,
|
|
1263
1401
|
response_type: Models::OAuth2Keycloak
|
|
1264
1402
|
)
|
|
1265
|
-
|
|
1266
1403
|
end
|
|
1267
1404
|
|
|
1268
1405
|
# Update the project OAuth2 Kick configuration.
|
|
1269
1406
|
#
|
|
1270
|
-
# @param [String] client_id
|
|
1271
|
-
# @param [String] client_secret
|
|
1407
|
+
# @param [String] client_id 'Client ID' of Kick OAuth2 app. For example: 01KQ7C00000000000001MFHS32
|
|
1408
|
+
# @param [String] client_secret 'Client Secret' of Kick OAuth2 app. For example: 34ac5600000000000000000000000000000000000000000000000000e830c8b
|
|
1272
1409
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1273
1410
|
#
|
|
1274
1411
|
# @return [OAuth2Kick]
|
|
1275
|
-
def update_o_auth2_kick(
|
|
1412
|
+
def update_o_auth2_kick(
|
|
1413
|
+
client_id: nil,
|
|
1414
|
+
client_secret: nil,
|
|
1415
|
+
enabled: nil
|
|
1416
|
+
)
|
|
1276
1417
|
api_path = '/project/oauth2/kick'
|
|
1277
1418
|
|
|
1278
1419
|
api_params = {
|
|
@@ -1280,7 +1421,7 @@ module Appwrite
|
|
|
1280
1421
|
clientSecret: client_secret,
|
|
1281
1422
|
enabled: enabled,
|
|
1282
1423
|
}
|
|
1283
|
-
|
|
1424
|
+
|
|
1284
1425
|
api_headers = {
|
|
1285
1426
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1286
1427
|
"content-type": 'application/json',
|
|
@@ -1294,17 +1435,20 @@ module Appwrite
|
|
|
1294
1435
|
params: api_params,
|
|
1295
1436
|
response_type: Models::OAuth2Kick
|
|
1296
1437
|
)
|
|
1297
|
-
|
|
1298
1438
|
end
|
|
1299
1439
|
|
|
1300
1440
|
# Update the project OAuth2 Linkedin configuration.
|
|
1301
1441
|
#
|
|
1302
|
-
# @param [String] client_id
|
|
1303
|
-
# @param [String] primary_client_secret
|
|
1442
|
+
# @param [String] client_id 'Client ID' of Linkedin OAuth2 app. For example: 770000000000dv
|
|
1443
|
+
# @param [String] primary_client_secret 'Primary Client Secret or Secondary Client Secret' of Linkedin OAuth2 app. For example: WPL_AP1.2Bf0000000000000./HtlYw==
|
|
1304
1444
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1305
1445
|
#
|
|
1306
1446
|
# @return [OAuth2Linkedin]
|
|
1307
|
-
def update_o_auth2_linkedin(
|
|
1447
|
+
def update_o_auth2_linkedin(
|
|
1448
|
+
client_id: nil,
|
|
1449
|
+
primary_client_secret: nil,
|
|
1450
|
+
enabled: nil
|
|
1451
|
+
)
|
|
1308
1452
|
api_path = '/project/oauth2/linkedin'
|
|
1309
1453
|
|
|
1310
1454
|
api_params = {
|
|
@@ -1312,7 +1456,7 @@ module Appwrite
|
|
|
1312
1456
|
primaryClientSecret: primary_client_secret,
|
|
1313
1457
|
enabled: enabled,
|
|
1314
1458
|
}
|
|
1315
|
-
|
|
1459
|
+
|
|
1316
1460
|
api_headers = {
|
|
1317
1461
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1318
1462
|
"content-type": 'application/json',
|
|
@@ -1326,18 +1470,22 @@ module Appwrite
|
|
|
1326
1470
|
params: api_params,
|
|
1327
1471
|
response_type: Models::OAuth2Linkedin
|
|
1328
1472
|
)
|
|
1329
|
-
|
|
1330
1473
|
end
|
|
1331
1474
|
|
|
1332
1475
|
# Update the project OAuth2 Microsoft configuration.
|
|
1333
1476
|
#
|
|
1334
|
-
# @param [String] application_id
|
|
1335
|
-
# @param [String] application_secret
|
|
1336
|
-
# @param [String] tenant Microsoft Entra ID tenant identifier. Use
|
|
1477
|
+
# @param [String] application_id 'Entra ID Application ID, also known as Client ID' of Microsoft OAuth2 app. For example: 00001111-aaaa-2222-bbbb-3333cccc4444
|
|
1478
|
+
# @param [String] application_secret 'Entra ID Application Secret, also known as Client Secret' of Microsoft OAuth2 app. For example: A1bC2dE3fH4iJ5kL6mN7oP8qR9sT0u
|
|
1479
|
+
# @param [String] tenant Microsoft Entra ID tenant identifier. Use 'common', 'organizations', 'consumers' or a specific tenant ID. For example: common
|
|
1337
1480
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1338
1481
|
#
|
|
1339
1482
|
# @return [OAuth2Microsoft]
|
|
1340
|
-
def update_o_auth2_microsoft(
|
|
1483
|
+
def update_o_auth2_microsoft(
|
|
1484
|
+
application_id: nil,
|
|
1485
|
+
application_secret: nil,
|
|
1486
|
+
tenant: nil,
|
|
1487
|
+
enabled: nil
|
|
1488
|
+
)
|
|
1341
1489
|
api_path = '/project/oauth2/microsoft'
|
|
1342
1490
|
|
|
1343
1491
|
api_params = {
|
|
@@ -1346,7 +1494,7 @@ module Appwrite
|
|
|
1346
1494
|
tenant: tenant,
|
|
1347
1495
|
enabled: enabled,
|
|
1348
1496
|
}
|
|
1349
|
-
|
|
1497
|
+
|
|
1350
1498
|
api_headers = {
|
|
1351
1499
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1352
1500
|
"content-type": 'application/json',
|
|
@@ -1360,17 +1508,20 @@ module Appwrite
|
|
|
1360
1508
|
params: api_params,
|
|
1361
1509
|
response_type: Models::OAuth2Microsoft
|
|
1362
1510
|
)
|
|
1363
|
-
|
|
1364
1511
|
end
|
|
1365
1512
|
|
|
1366
1513
|
# Update the project OAuth2 Notion configuration.
|
|
1367
1514
|
#
|
|
1368
|
-
# @param [String] oauth_client_id
|
|
1369
|
-
# @param [String] oauth_client_secret
|
|
1515
|
+
# @param [String] oauth_client_id 'OAuth Client ID' of Notion OAuth2 app. For example: 341d8700-0000-0000-0000-000000446ee3
|
|
1516
|
+
# @param [String] oauth_client_secret 'OAuth Client Secret' of Notion OAuth2 app. For example: secret_dLUr4b000000000000000000000000000000lFHAa9
|
|
1370
1517
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1371
1518
|
#
|
|
1372
1519
|
# @return [OAuth2Notion]
|
|
1373
|
-
def update_o_auth2_notion(
|
|
1520
|
+
def update_o_auth2_notion(
|
|
1521
|
+
oauth_client_id: nil,
|
|
1522
|
+
oauth_client_secret: nil,
|
|
1523
|
+
enabled: nil
|
|
1524
|
+
)
|
|
1374
1525
|
api_path = '/project/oauth2/notion'
|
|
1375
1526
|
|
|
1376
1527
|
api_params = {
|
|
@@ -1378,7 +1529,7 @@ module Appwrite
|
|
|
1378
1529
|
oauthClientSecret: oauth_client_secret,
|
|
1379
1530
|
enabled: enabled,
|
|
1380
1531
|
}
|
|
1381
|
-
|
|
1532
|
+
|
|
1382
1533
|
api_headers = {
|
|
1383
1534
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1384
1535
|
"content-type": 'application/json',
|
|
@@ -1392,23 +1543,32 @@ module Appwrite
|
|
|
1392
1543
|
params: api_params,
|
|
1393
1544
|
response_type: Models::OAuth2Notion
|
|
1394
1545
|
)
|
|
1395
|
-
|
|
1396
1546
|
end
|
|
1397
1547
|
|
|
1398
1548
|
# Update the project OAuth2 Oidc configuration.
|
|
1399
1549
|
#
|
|
1400
|
-
# @param [String] client_id
|
|
1401
|
-
# @param [String] client_secret
|
|
1550
|
+
# @param [String] client_id 'Client ID' of Oidc OAuth2 app. For example: qibI2x0000000000000000000000000006L2YFoG
|
|
1551
|
+
# @param [String] client_secret 'Client Secret' of Oidc OAuth2 app. For example: Ah68ed000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000003qpcHV
|
|
1402
1552
|
# @param [String] well_known_url OpenID Connect well-known configuration URL. When provided, authorization, token, and user info endpoints can be discovered automatically. For example: https://myoauth.com/.well-known/openid-configuration
|
|
1403
1553
|
# @param [String] authorization_url OpenID Connect authorization endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/authorize
|
|
1404
1554
|
# @param [String] token_url OpenID Connect token endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/token
|
|
1405
1555
|
# @param [String] user_info_url OpenID Connect user info endpoint URL. Required when wellKnownURL is not provided. For example: https://myoauth.com/oauth2/userinfo
|
|
1406
|
-
# @param [Array] prompt Array of OpenID Connect prompt values controlling the authentication and consent screens. If
|
|
1556
|
+
# @param [Array] prompt Array of OpenID Connect prompt values controlling the authentication and consent screens. If "none" is included, it must be the only element. "none" means: don't display any authentication or consent screens. "login" means: prompt the user to re-authenticate. "consent" means: prompt the user for consent. "select_account" means: prompt the user to select an account.
|
|
1407
1557
|
# @param [Integer] max_age Maximum authentication age in seconds. When set, the user must have authenticated within this many seconds, otherwise they are prompted to re-authenticate.
|
|
1408
1558
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1409
1559
|
#
|
|
1410
1560
|
# @return [OAuth2Oidc]
|
|
1411
|
-
def update_o_auth2_oidc(
|
|
1561
|
+
def update_o_auth2_oidc(
|
|
1562
|
+
client_id: nil,
|
|
1563
|
+
client_secret: nil,
|
|
1564
|
+
well_known_url: nil,
|
|
1565
|
+
authorization_url: nil,
|
|
1566
|
+
token_url: nil,
|
|
1567
|
+
user_info_url: nil,
|
|
1568
|
+
prompt: nil,
|
|
1569
|
+
max_age: nil,
|
|
1570
|
+
enabled: nil
|
|
1571
|
+
)
|
|
1412
1572
|
api_path = '/project/oauth2/oidc'
|
|
1413
1573
|
|
|
1414
1574
|
api_params = {
|
|
@@ -1422,7 +1582,7 @@ module Appwrite
|
|
|
1422
1582
|
maxAge: max_age,
|
|
1423
1583
|
enabled: enabled,
|
|
1424
1584
|
}
|
|
1425
|
-
|
|
1585
|
+
|
|
1426
1586
|
api_headers = {
|
|
1427
1587
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1428
1588
|
"content-type": 'application/json',
|
|
@@ -1436,19 +1596,24 @@ module Appwrite
|
|
|
1436
1596
|
params: api_params,
|
|
1437
1597
|
response_type: Models::OAuth2Oidc
|
|
1438
1598
|
)
|
|
1439
|
-
|
|
1440
1599
|
end
|
|
1441
1600
|
|
|
1442
1601
|
# Update the project OAuth2 Okta configuration.
|
|
1443
1602
|
#
|
|
1444
|
-
# @param [String] client_id
|
|
1445
|
-
# @param [String] client_secret
|
|
1603
|
+
# @param [String] client_id 'Client ID' of Okta OAuth2 app. For example: 0oa00000000000000698
|
|
1604
|
+
# @param [String] client_secret 'Client Secret' of Okta OAuth2 app. For example: Kiq0000000000000000000000000000000000000-00000000000H2L5-3SJ-vRV
|
|
1446
1605
|
# @param [String] domain Okta company domain. Required when enabling the provider. For example: trial-6400025.okta.com. Example of wrong value: trial-6400025-admin.okta.com, or https://trial-6400025.okta.com/
|
|
1447
1606
|
# @param [String] authorization_server_id Custom Authorization Servers. Optional, can be left empty or unconfigured. For example: aus000000000000000h7z
|
|
1448
1607
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1449
1608
|
#
|
|
1450
1609
|
# @return [OAuth2Okta]
|
|
1451
|
-
def update_o_auth2_okta(
|
|
1610
|
+
def update_o_auth2_okta(
|
|
1611
|
+
client_id: nil,
|
|
1612
|
+
client_secret: nil,
|
|
1613
|
+
domain: nil,
|
|
1614
|
+
authorization_server_id: nil,
|
|
1615
|
+
enabled: nil
|
|
1616
|
+
)
|
|
1452
1617
|
api_path = '/project/oauth2/okta'
|
|
1453
1618
|
|
|
1454
1619
|
api_params = {
|
|
@@ -1458,7 +1623,7 @@ module Appwrite
|
|
|
1458
1623
|
authorizationServerId: authorization_server_id,
|
|
1459
1624
|
enabled: enabled,
|
|
1460
1625
|
}
|
|
1461
|
-
|
|
1626
|
+
|
|
1462
1627
|
api_headers = {
|
|
1463
1628
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1464
1629
|
"content-type": 'application/json',
|
|
@@ -1472,17 +1637,20 @@ module Appwrite
|
|
|
1472
1637
|
params: api_params,
|
|
1473
1638
|
response_type: Models::OAuth2Okta
|
|
1474
1639
|
)
|
|
1475
|
-
|
|
1476
1640
|
end
|
|
1477
1641
|
|
|
1478
1642
|
# Update the project OAuth2 Paypal configuration.
|
|
1479
1643
|
#
|
|
1480
|
-
# @param [String] client_id
|
|
1481
|
-
# @param [String] secret_key
|
|
1644
|
+
# @param [String] client_id 'Client ID' of Paypal OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1645
|
+
# @param [String] secret_key 'Secret Key 1 or Secret Key 2' of Paypal OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1482
1646
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1483
1647
|
#
|
|
1484
1648
|
# @return [OAuth2Paypal]
|
|
1485
|
-
def update_o_auth2_paypal(
|
|
1649
|
+
def update_o_auth2_paypal(
|
|
1650
|
+
client_id: nil,
|
|
1651
|
+
secret_key: nil,
|
|
1652
|
+
enabled: nil
|
|
1653
|
+
)
|
|
1486
1654
|
api_path = '/project/oauth2/paypal'
|
|
1487
1655
|
|
|
1488
1656
|
api_params = {
|
|
@@ -1490,7 +1658,7 @@ module Appwrite
|
|
|
1490
1658
|
secretKey: secret_key,
|
|
1491
1659
|
enabled: enabled,
|
|
1492
1660
|
}
|
|
1493
|
-
|
|
1661
|
+
|
|
1494
1662
|
api_headers = {
|
|
1495
1663
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1496
1664
|
"content-type": 'application/json',
|
|
@@ -1504,17 +1672,20 @@ module Appwrite
|
|
|
1504
1672
|
params: api_params,
|
|
1505
1673
|
response_type: Models::OAuth2Paypal
|
|
1506
1674
|
)
|
|
1507
|
-
|
|
1508
1675
|
end
|
|
1509
1676
|
|
|
1510
1677
|
# Update the project OAuth2 PaypalSandbox configuration.
|
|
1511
1678
|
#
|
|
1512
|
-
# @param [String] client_id
|
|
1513
|
-
# @param [String] secret_key
|
|
1679
|
+
# @param [String] client_id 'Client ID' of PaypalSandbox OAuth2 app. For example: AdhIEG7-000000000000-0000000000000000000000000000000-0000000000000000000000-2pyB
|
|
1680
|
+
# @param [String] secret_key 'Secret Key 1 or Secret Key 2' of PaypalSandbox OAuth2 app. For example: EH8KCXtew--000000000000000000000000000000000000000_C-1_5UP_000000000000000CB7KDp
|
|
1514
1681
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1515
1682
|
#
|
|
1516
1683
|
# @return [OAuth2Paypal]
|
|
1517
|
-
def update_o_auth2_paypal_sandbox(
|
|
1684
|
+
def update_o_auth2_paypal_sandbox(
|
|
1685
|
+
client_id: nil,
|
|
1686
|
+
secret_key: nil,
|
|
1687
|
+
enabled: nil
|
|
1688
|
+
)
|
|
1518
1689
|
api_path = '/project/oauth2/paypalSandbox'
|
|
1519
1690
|
|
|
1520
1691
|
api_params = {
|
|
@@ -1522,7 +1693,7 @@ module Appwrite
|
|
|
1522
1693
|
secretKey: secret_key,
|
|
1523
1694
|
enabled: enabled,
|
|
1524
1695
|
}
|
|
1525
|
-
|
|
1696
|
+
|
|
1526
1697
|
api_headers = {
|
|
1527
1698
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1528
1699
|
"content-type": 'application/json',
|
|
@@ -1536,17 +1707,20 @@ module Appwrite
|
|
|
1536
1707
|
params: api_params,
|
|
1537
1708
|
response_type: Models::OAuth2Paypal
|
|
1538
1709
|
)
|
|
1539
|
-
|
|
1540
1710
|
end
|
|
1541
1711
|
|
|
1542
1712
|
# Update the project OAuth2 Podio configuration.
|
|
1543
1713
|
#
|
|
1544
|
-
# @param [String] client_id
|
|
1545
|
-
# @param [String] client_secret
|
|
1714
|
+
# @param [String] client_id 'Client ID' of Podio OAuth2 app. For example: appwrite-o0000000st-app
|
|
1715
|
+
# @param [String] client_secret 'Client Secret' of Podio OAuth2 app. For example: Rn247T0000000000000000000000000000000000000000000000000000W2zWTN
|
|
1546
1716
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1547
1717
|
#
|
|
1548
1718
|
# @return [OAuth2Podio]
|
|
1549
|
-
def update_o_auth2_podio(
|
|
1719
|
+
def update_o_auth2_podio(
|
|
1720
|
+
client_id: nil,
|
|
1721
|
+
client_secret: nil,
|
|
1722
|
+
enabled: nil
|
|
1723
|
+
)
|
|
1550
1724
|
api_path = '/project/oauth2/podio'
|
|
1551
1725
|
|
|
1552
1726
|
api_params = {
|
|
@@ -1554,7 +1728,7 @@ module Appwrite
|
|
|
1554
1728
|
clientSecret: client_secret,
|
|
1555
1729
|
enabled: enabled,
|
|
1556
1730
|
}
|
|
1557
|
-
|
|
1731
|
+
|
|
1558
1732
|
api_headers = {
|
|
1559
1733
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1560
1734
|
"content-type": 'application/json',
|
|
@@ -1568,17 +1742,20 @@ module Appwrite
|
|
|
1568
1742
|
params: api_params,
|
|
1569
1743
|
response_type: Models::OAuth2Podio
|
|
1570
1744
|
)
|
|
1571
|
-
|
|
1572
1745
|
end
|
|
1573
1746
|
|
|
1574
1747
|
# Update the project OAuth2 Salesforce configuration.
|
|
1575
1748
|
#
|
|
1576
|
-
# @param [String] customer_key
|
|
1577
|
-
# @param [String] customer_secret
|
|
1749
|
+
# @param [String] customer_key 'Consumer Key' of Salesforce OAuth2 app. For example: 3MVG9I0000000000000000000000000000000000000000000000000000000000000000000000000C5Aejq
|
|
1750
|
+
# @param [String] customer_secret 'Consumer Secret' of Salesforce OAuth2 app. For example: 3w000000000000e2
|
|
1578
1751
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1579
1752
|
#
|
|
1580
1753
|
# @return [OAuth2Salesforce]
|
|
1581
|
-
def update_o_auth2_salesforce(
|
|
1754
|
+
def update_o_auth2_salesforce(
|
|
1755
|
+
customer_key: nil,
|
|
1756
|
+
customer_secret: nil,
|
|
1757
|
+
enabled: nil
|
|
1758
|
+
)
|
|
1582
1759
|
api_path = '/project/oauth2/salesforce'
|
|
1583
1760
|
|
|
1584
1761
|
api_params = {
|
|
@@ -1586,7 +1763,7 @@ module Appwrite
|
|
|
1586
1763
|
customerSecret: customer_secret,
|
|
1587
1764
|
enabled: enabled,
|
|
1588
1765
|
}
|
|
1589
|
-
|
|
1766
|
+
|
|
1590
1767
|
api_headers = {
|
|
1591
1768
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1592
1769
|
"content-type": 'application/json',
|
|
@@ -1600,17 +1777,20 @@ module Appwrite
|
|
|
1600
1777
|
params: api_params,
|
|
1601
1778
|
response_type: Models::OAuth2Salesforce
|
|
1602
1779
|
)
|
|
1603
|
-
|
|
1604
1780
|
end
|
|
1605
1781
|
|
|
1606
1782
|
# Update the project OAuth2 Slack configuration.
|
|
1607
1783
|
#
|
|
1608
|
-
# @param [String] client_id
|
|
1609
|
-
# @param [String] client_secret
|
|
1784
|
+
# @param [String] client_id 'Client ID' of Slack OAuth2 app. For example: 23000000089.15000000000023
|
|
1785
|
+
# @param [String] client_secret 'Client Secret' of Slack OAuth2 app. For example: 81656000000000000000000000f3d2fd
|
|
1610
1786
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1611
1787
|
#
|
|
1612
1788
|
# @return [OAuth2Slack]
|
|
1613
|
-
def update_o_auth2_slack(
|
|
1789
|
+
def update_o_auth2_slack(
|
|
1790
|
+
client_id: nil,
|
|
1791
|
+
client_secret: nil,
|
|
1792
|
+
enabled: nil
|
|
1793
|
+
)
|
|
1614
1794
|
api_path = '/project/oauth2/slack'
|
|
1615
1795
|
|
|
1616
1796
|
api_params = {
|
|
@@ -1618,7 +1798,7 @@ module Appwrite
|
|
|
1618
1798
|
clientSecret: client_secret,
|
|
1619
1799
|
enabled: enabled,
|
|
1620
1800
|
}
|
|
1621
|
-
|
|
1801
|
+
|
|
1622
1802
|
api_headers = {
|
|
1623
1803
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1624
1804
|
"content-type": 'application/json',
|
|
@@ -1632,17 +1812,20 @@ module Appwrite
|
|
|
1632
1812
|
params: api_params,
|
|
1633
1813
|
response_type: Models::OAuth2Slack
|
|
1634
1814
|
)
|
|
1635
|
-
|
|
1636
1815
|
end
|
|
1637
1816
|
|
|
1638
1817
|
# Update the project OAuth2 Spotify configuration.
|
|
1639
1818
|
#
|
|
1640
|
-
# @param [String] client_id
|
|
1641
|
-
# @param [String] client_secret
|
|
1819
|
+
# @param [String] client_id 'Client ID' of Spotify OAuth2 app. For example: 6ec271000000000000000000009beace
|
|
1820
|
+
# @param [String] client_secret 'Client Secret' of Spotify OAuth2 app. For example: db068a000000000000000000008b5b9f
|
|
1642
1821
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1643
1822
|
#
|
|
1644
1823
|
# @return [OAuth2Spotify]
|
|
1645
|
-
def update_o_auth2_spotify(
|
|
1824
|
+
def update_o_auth2_spotify(
|
|
1825
|
+
client_id: nil,
|
|
1826
|
+
client_secret: nil,
|
|
1827
|
+
enabled: nil
|
|
1828
|
+
)
|
|
1646
1829
|
api_path = '/project/oauth2/spotify'
|
|
1647
1830
|
|
|
1648
1831
|
api_params = {
|
|
@@ -1650,7 +1833,7 @@ module Appwrite
|
|
|
1650
1833
|
clientSecret: client_secret,
|
|
1651
1834
|
enabled: enabled,
|
|
1652
1835
|
}
|
|
1653
|
-
|
|
1836
|
+
|
|
1654
1837
|
api_headers = {
|
|
1655
1838
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1656
1839
|
"content-type": 'application/json',
|
|
@@ -1664,17 +1847,20 @@ module Appwrite
|
|
|
1664
1847
|
params: api_params,
|
|
1665
1848
|
response_type: Models::OAuth2Spotify
|
|
1666
1849
|
)
|
|
1667
|
-
|
|
1668
1850
|
end
|
|
1669
1851
|
|
|
1670
1852
|
# Update the project OAuth2 Stripe configuration.
|
|
1671
1853
|
#
|
|
1672
|
-
# @param [String] client_id
|
|
1673
|
-
# @param [String] api_secret_key
|
|
1854
|
+
# @param [String] client_id 'Client ID' of Stripe OAuth2 app. For example: ca_UKibXX0000000000000000000006byvR
|
|
1855
|
+
# @param [String] api_secret_key 'API Secret Key' of Stripe OAuth2 app. For example: sk_51SfOd000000000000000000000000000000000000000000000000000000000000000000000000000000000000000QGWYfp
|
|
1674
1856
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1675
1857
|
#
|
|
1676
1858
|
# @return [OAuth2Stripe]
|
|
1677
|
-
def update_o_auth2_stripe(
|
|
1859
|
+
def update_o_auth2_stripe(
|
|
1860
|
+
client_id: nil,
|
|
1861
|
+
api_secret_key: nil,
|
|
1862
|
+
enabled: nil
|
|
1863
|
+
)
|
|
1678
1864
|
api_path = '/project/oauth2/stripe'
|
|
1679
1865
|
|
|
1680
1866
|
api_params = {
|
|
@@ -1682,7 +1868,7 @@ module Appwrite
|
|
|
1682
1868
|
apiSecretKey: api_secret_key,
|
|
1683
1869
|
enabled: enabled,
|
|
1684
1870
|
}
|
|
1685
|
-
|
|
1871
|
+
|
|
1686
1872
|
api_headers = {
|
|
1687
1873
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1688
1874
|
"content-type": 'application/json',
|
|
@@ -1696,17 +1882,20 @@ module Appwrite
|
|
|
1696
1882
|
params: api_params,
|
|
1697
1883
|
response_type: Models::OAuth2Stripe
|
|
1698
1884
|
)
|
|
1699
|
-
|
|
1700
1885
|
end
|
|
1701
1886
|
|
|
1702
1887
|
# Update the project OAuth2 Tradeshift configuration.
|
|
1703
1888
|
#
|
|
1704
|
-
# @param [String] oauth2_client_id
|
|
1705
|
-
# @param [String] oauth2_client_secret
|
|
1889
|
+
# @param [String] oauth2_client_id 'OAuth2 Client ID' of Tradeshift OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1890
|
+
# @param [String] oauth2_client_secret 'OAuth2 Client Secret' of Tradeshift OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1706
1891
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1707
1892
|
#
|
|
1708
1893
|
# @return [OAuth2Tradeshift]
|
|
1709
|
-
def update_o_auth2_tradeshift(
|
|
1894
|
+
def update_o_auth2_tradeshift(
|
|
1895
|
+
oauth2_client_id: nil,
|
|
1896
|
+
oauth2_client_secret: nil,
|
|
1897
|
+
enabled: nil
|
|
1898
|
+
)
|
|
1710
1899
|
api_path = '/project/oauth2/tradeshift'
|
|
1711
1900
|
|
|
1712
1901
|
api_params = {
|
|
@@ -1714,7 +1903,7 @@ module Appwrite
|
|
|
1714
1903
|
oauth2ClientSecret: oauth2_client_secret,
|
|
1715
1904
|
enabled: enabled,
|
|
1716
1905
|
}
|
|
1717
|
-
|
|
1906
|
+
|
|
1718
1907
|
api_headers = {
|
|
1719
1908
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1720
1909
|
"content-type": 'application/json',
|
|
@@ -1728,17 +1917,20 @@ module Appwrite
|
|
|
1728
1917
|
params: api_params,
|
|
1729
1918
|
response_type: Models::OAuth2Tradeshift
|
|
1730
1919
|
)
|
|
1731
|
-
|
|
1732
1920
|
end
|
|
1733
1921
|
|
|
1734
1922
|
# Update the project OAuth2 Tradeshift Sandbox configuration.
|
|
1735
1923
|
#
|
|
1736
|
-
# @param [String] oauth2_client_id
|
|
1737
|
-
# @param [String] oauth2_client_secret
|
|
1924
|
+
# @param [String] oauth2_client_id 'OAuth2 Client ID' of Tradeshift Sandbox OAuth2 app. For example: appwrite-tes00000.0000000000est-app
|
|
1925
|
+
# @param [String] oauth2_client_secret 'OAuth2 Client Secret' of Tradeshift Sandbox OAuth2 app. For example: 7cb52700-0000-0000-0000-000000ca5b83
|
|
1738
1926
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1739
1927
|
#
|
|
1740
1928
|
# @return [OAuth2Tradeshift]
|
|
1741
|
-
def update_o_auth2_tradeshift_sandbox(
|
|
1929
|
+
def update_o_auth2_tradeshift_sandbox(
|
|
1930
|
+
oauth2_client_id: nil,
|
|
1931
|
+
oauth2_client_secret: nil,
|
|
1932
|
+
enabled: nil
|
|
1933
|
+
)
|
|
1742
1934
|
api_path = '/project/oauth2/tradeshiftBox'
|
|
1743
1935
|
|
|
1744
1936
|
api_params = {
|
|
@@ -1746,7 +1938,7 @@ module Appwrite
|
|
|
1746
1938
|
oauth2ClientSecret: oauth2_client_secret,
|
|
1747
1939
|
enabled: enabled,
|
|
1748
1940
|
}
|
|
1749
|
-
|
|
1941
|
+
|
|
1750
1942
|
api_headers = {
|
|
1751
1943
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1752
1944
|
"content-type": 'application/json',
|
|
@@ -1760,17 +1952,20 @@ module Appwrite
|
|
|
1760
1952
|
params: api_params,
|
|
1761
1953
|
response_type: Models::OAuth2Tradeshift
|
|
1762
1954
|
)
|
|
1763
|
-
|
|
1764
1955
|
end
|
|
1765
1956
|
|
|
1766
1957
|
# Update the project OAuth2 Twitch configuration.
|
|
1767
1958
|
#
|
|
1768
|
-
# @param [String] client_id
|
|
1769
|
-
# @param [String] client_secret
|
|
1959
|
+
# @param [String] client_id 'Client ID' of Twitch OAuth2 app. For example: vvi0in000000000000000000ikmt9p
|
|
1960
|
+
# @param [String] client_secret 'Client Secret' of Twitch OAuth2 app. For example: pmapue000000000000000000zylw3v
|
|
1770
1961
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1771
1962
|
#
|
|
1772
1963
|
# @return [OAuth2Twitch]
|
|
1773
|
-
def update_o_auth2_twitch(
|
|
1964
|
+
def update_o_auth2_twitch(
|
|
1965
|
+
client_id: nil,
|
|
1966
|
+
client_secret: nil,
|
|
1967
|
+
enabled: nil
|
|
1968
|
+
)
|
|
1774
1969
|
api_path = '/project/oauth2/twitch'
|
|
1775
1970
|
|
|
1776
1971
|
api_params = {
|
|
@@ -1778,7 +1973,7 @@ module Appwrite
|
|
|
1778
1973
|
clientSecret: client_secret,
|
|
1779
1974
|
enabled: enabled,
|
|
1780
1975
|
}
|
|
1781
|
-
|
|
1976
|
+
|
|
1782
1977
|
api_headers = {
|
|
1783
1978
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1784
1979
|
"content-type": 'application/json',
|
|
@@ -1792,17 +1987,20 @@ module Appwrite
|
|
|
1792
1987
|
params: api_params,
|
|
1793
1988
|
response_type: Models::OAuth2Twitch
|
|
1794
1989
|
)
|
|
1795
|
-
|
|
1796
1990
|
end
|
|
1797
1991
|
|
|
1798
1992
|
# Update the project OAuth2 WordPress configuration.
|
|
1799
1993
|
#
|
|
1800
|
-
# @param [String] client_id
|
|
1801
|
-
# @param [String] client_secret
|
|
1994
|
+
# @param [String] client_id 'Client ID' of WordPress OAuth2 app. For example: 130005
|
|
1995
|
+
# @param [String] client_secret 'Client Secret' of WordPress OAuth2 app. For example: PlBfJS0000000000000000000000000000000000000000000000000000EdUZJk
|
|
1802
1996
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1803
1997
|
#
|
|
1804
1998
|
# @return [OAuth2WordPress]
|
|
1805
|
-
def update_o_auth2_word_press(
|
|
1999
|
+
def update_o_auth2_word_press(
|
|
2000
|
+
client_id: nil,
|
|
2001
|
+
client_secret: nil,
|
|
2002
|
+
enabled: nil
|
|
2003
|
+
)
|
|
1806
2004
|
api_path = '/project/oauth2/wordpress'
|
|
1807
2005
|
|
|
1808
2006
|
api_params = {
|
|
@@ -1810,7 +2008,7 @@ module Appwrite
|
|
|
1810
2008
|
clientSecret: client_secret,
|
|
1811
2009
|
enabled: enabled,
|
|
1812
2010
|
}
|
|
1813
|
-
|
|
2011
|
+
|
|
1814
2012
|
api_headers = {
|
|
1815
2013
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1816
2014
|
"content-type": 'application/json',
|
|
@@ -1824,17 +2022,20 @@ module Appwrite
|
|
|
1824
2022
|
params: api_params,
|
|
1825
2023
|
response_type: Models::OAuth2WordPress
|
|
1826
2024
|
)
|
|
1827
|
-
|
|
1828
2025
|
end
|
|
1829
2026
|
|
|
1830
2027
|
# Update the project OAuth2 X configuration.
|
|
1831
2028
|
#
|
|
1832
|
-
# @param [String] customer_key
|
|
1833
|
-
# @param [String] secret_key
|
|
2029
|
+
# @param [String] customer_key 'Customer Key' of X OAuth2 app. For example: slzZV0000000000000NFLaWT
|
|
2030
|
+
# @param [String] secret_key 'Secret Key' of X OAuth2 app. For example: tkEPkp00000000000000000000000000000000000000FTxbI9
|
|
1834
2031
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1835
2032
|
#
|
|
1836
2033
|
# @return [OAuth2X]
|
|
1837
|
-
def update_o_auth2_x(
|
|
2034
|
+
def update_o_auth2_x(
|
|
2035
|
+
customer_key: nil,
|
|
2036
|
+
secret_key: nil,
|
|
2037
|
+
enabled: nil
|
|
2038
|
+
)
|
|
1838
2039
|
api_path = '/project/oauth2/x'
|
|
1839
2040
|
|
|
1840
2041
|
api_params = {
|
|
@@ -1842,7 +2043,7 @@ module Appwrite
|
|
|
1842
2043
|
secretKey: secret_key,
|
|
1843
2044
|
enabled: enabled,
|
|
1844
2045
|
}
|
|
1845
|
-
|
|
2046
|
+
|
|
1846
2047
|
api_headers = {
|
|
1847
2048
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1848
2049
|
"content-type": 'application/json',
|
|
@@ -1856,17 +2057,20 @@ module Appwrite
|
|
|
1856
2057
|
params: api_params,
|
|
1857
2058
|
response_type: Models::OAuth2X
|
|
1858
2059
|
)
|
|
1859
|
-
|
|
1860
2060
|
end
|
|
1861
2061
|
|
|
1862
2062
|
# Update the project OAuth2 Yahoo configuration.
|
|
1863
2063
|
#
|
|
1864
|
-
# @param [String] client_id
|
|
1865
|
-
# @param [String] client_secret
|
|
2064
|
+
# @param [String] client_id 'Client ID, also known as Customer Key' of Yahoo OAuth2 app. For example: dj0yJm000000000000000000000000000000000000000000000000000000000000000000000000000000000000Z4PWRm
|
|
2065
|
+
# @param [String] client_secret 'Client Secret, also known as Customer Secret' of Yahoo OAuth2 app. For example: cf978f0000000000000000000000000000c5e2e9
|
|
1866
2066
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1867
2067
|
#
|
|
1868
2068
|
# @return [OAuth2Yahoo]
|
|
1869
|
-
def update_o_auth2_yahoo(
|
|
2069
|
+
def update_o_auth2_yahoo(
|
|
2070
|
+
client_id: nil,
|
|
2071
|
+
client_secret: nil,
|
|
2072
|
+
enabled: nil
|
|
2073
|
+
)
|
|
1870
2074
|
api_path = '/project/oauth2/yahoo'
|
|
1871
2075
|
|
|
1872
2076
|
api_params = {
|
|
@@ -1874,7 +2078,7 @@ module Appwrite
|
|
|
1874
2078
|
clientSecret: client_secret,
|
|
1875
2079
|
enabled: enabled,
|
|
1876
2080
|
}
|
|
1877
|
-
|
|
2081
|
+
|
|
1878
2082
|
api_headers = {
|
|
1879
2083
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1880
2084
|
"content-type": 'application/json',
|
|
@@ -1888,17 +2092,20 @@ module Appwrite
|
|
|
1888
2092
|
params: api_params,
|
|
1889
2093
|
response_type: Models::OAuth2Yahoo
|
|
1890
2094
|
)
|
|
1891
|
-
|
|
1892
2095
|
end
|
|
1893
2096
|
|
|
1894
2097
|
# Update the project OAuth2 Yandex configuration.
|
|
1895
2098
|
#
|
|
1896
|
-
# @param [String] client_id
|
|
1897
|
-
# @param [String] client_secret
|
|
2099
|
+
# @param [String] client_id 'Client ID' of Yandex OAuth2 app. For example: 6a8a6a0000000000000000000091483c
|
|
2100
|
+
# @param [String] client_secret 'Client Secret' of Yandex OAuth2 app. For example: bbf98500000000000000000000c75a63
|
|
1898
2101
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1899
2102
|
#
|
|
1900
2103
|
# @return [OAuth2Yandex]
|
|
1901
|
-
def update_o_auth2_yandex(
|
|
2104
|
+
def update_o_auth2_yandex(
|
|
2105
|
+
client_id: nil,
|
|
2106
|
+
client_secret: nil,
|
|
2107
|
+
enabled: nil
|
|
2108
|
+
)
|
|
1902
2109
|
api_path = '/project/oauth2/yandex'
|
|
1903
2110
|
|
|
1904
2111
|
api_params = {
|
|
@@ -1906,7 +2113,7 @@ module Appwrite
|
|
|
1906
2113
|
clientSecret: client_secret,
|
|
1907
2114
|
enabled: enabled,
|
|
1908
2115
|
}
|
|
1909
|
-
|
|
2116
|
+
|
|
1910
2117
|
api_headers = {
|
|
1911
2118
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1912
2119
|
"content-type": 'application/json',
|
|
@@ -1920,17 +2127,20 @@ module Appwrite
|
|
|
1920
2127
|
params: api_params,
|
|
1921
2128
|
response_type: Models::OAuth2Yandex
|
|
1922
2129
|
)
|
|
1923
|
-
|
|
1924
2130
|
end
|
|
1925
2131
|
|
|
1926
2132
|
# Update the project OAuth2 Zoho configuration.
|
|
1927
2133
|
#
|
|
1928
|
-
# @param [String] client_id
|
|
1929
|
-
# @param [String] client_secret
|
|
2134
|
+
# @param [String] client_id 'Client ID' of Zoho OAuth2 app. For example: 1000.83C178000000000000000000RPNX0B
|
|
2135
|
+
# @param [String] client_secret 'Client Secret' of Zoho OAuth2 app. For example: fb5cac000000000000000000000000000000a68f6e
|
|
1930
2136
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1931
2137
|
#
|
|
1932
2138
|
# @return [OAuth2Zoho]
|
|
1933
|
-
def update_o_auth2_zoho(
|
|
2139
|
+
def update_o_auth2_zoho(
|
|
2140
|
+
client_id: nil,
|
|
2141
|
+
client_secret: nil,
|
|
2142
|
+
enabled: nil
|
|
2143
|
+
)
|
|
1934
2144
|
api_path = '/project/oauth2/zoho'
|
|
1935
2145
|
|
|
1936
2146
|
api_params = {
|
|
@@ -1938,7 +2148,7 @@ module Appwrite
|
|
|
1938
2148
|
clientSecret: client_secret,
|
|
1939
2149
|
enabled: enabled,
|
|
1940
2150
|
}
|
|
1941
|
-
|
|
2151
|
+
|
|
1942
2152
|
api_headers = {
|
|
1943
2153
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1944
2154
|
"content-type": 'application/json',
|
|
@@ -1952,17 +2162,20 @@ module Appwrite
|
|
|
1952
2162
|
params: api_params,
|
|
1953
2163
|
response_type: Models::OAuth2Zoho
|
|
1954
2164
|
)
|
|
1955
|
-
|
|
1956
2165
|
end
|
|
1957
2166
|
|
|
1958
2167
|
# Update the project OAuth2 Zoom configuration.
|
|
1959
2168
|
#
|
|
1960
|
-
# @param [String] client_id
|
|
1961
|
-
# @param [String] client_secret
|
|
2169
|
+
# @param [String] client_id 'Client ID' of Zoom OAuth2 app. For example: QMAC00000000000000w0AQ
|
|
2170
|
+
# @param [String] client_secret 'Client Secret' of Zoom OAuth2 app. For example: GAWsG4000000000000000000007U01ON
|
|
1962
2171
|
# @param [] enabled OAuth2 sign-in method status. Set to true to enable new session creation. Setting to true will trigger end-to-end credentials validation, and will throw if the credentials are invalid.
|
|
1963
2172
|
#
|
|
1964
2173
|
# @return [OAuth2Zoom]
|
|
1965
|
-
def update_o_auth2_zoom(
|
|
2174
|
+
def update_o_auth2_zoom(
|
|
2175
|
+
client_id: nil,
|
|
2176
|
+
client_secret: nil,
|
|
2177
|
+
enabled: nil
|
|
2178
|
+
)
|
|
1966
2179
|
api_path = '/project/oauth2/zoom'
|
|
1967
2180
|
|
|
1968
2181
|
api_params = {
|
|
@@ -1970,7 +2183,7 @@ module Appwrite
|
|
|
1970
2183
|
clientSecret: client_secret,
|
|
1971
2184
|
enabled: enabled,
|
|
1972
2185
|
}
|
|
1973
|
-
|
|
2186
|
+
|
|
1974
2187
|
api_headers = {
|
|
1975
2188
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
1976
2189
|
"content-type": 'application/json',
|
|
@@ -1984,7 +2197,6 @@ module Appwrite
|
|
|
1984
2197
|
params: api_params,
|
|
1985
2198
|
response_type: Models::OAuth2Zoom
|
|
1986
2199
|
)
|
|
1987
|
-
|
|
1988
2200
|
end
|
|
1989
2201
|
|
|
1990
2202
|
# Get a single OAuth2 provider configuration. Credential fields (client
|
|
@@ -1992,18 +2204,19 @@ module Appwrite
|
|
|
1992
2204
|
#
|
|
1993
2205
|
# @param [ProjectOAuthProviderId] provider_id OAuth2 provider key. For example: github, google, apple.
|
|
1994
2206
|
#
|
|
1995
|
-
# @return [OAuth2Github, OAuth2Discord, OAuth2Figma, OAuth2Dropbox, OAuth2Dailymotion, OAuth2Bitbucket, OAuth2Bitly, OAuth2Box, OAuth2Autodesk, OAuth2Google, OAuth2Zoom, OAuth2Zoho, OAuth2Yandex, OAuth2X, OAuth2WordPress, OAuth2Twitch, OAuth2Stripe, OAuth2Spotify, OAuth2Slack, OAuth2Podio, OAuth2Notion, OAuth2Salesforce, OAuth2Yahoo, OAuth2Linkedin, OAuth2Disqus, OAuth2Amazon, OAuth2Etsy, OAuth2Facebook, OAuth2Tradeshift, OAuth2Paypal, OAuth2Gitlab, OAuth2Authentik, OAuth2Auth0, OAuth2FusionAuth, OAuth2Keycloak, OAuth2Oidc, OAuth2Apple, OAuth2Okta, OAuth2Kick, OAuth2Microsoft]
|
|
1996
|
-
def get_o_auth2_provider(
|
|
2207
|
+
# @return [OAuth2Github, OAuth2Discord, OAuth2Figma, OAuth2Dropbox, OAuth2Dailymotion, OAuth2Bitbucket, OAuth2Bitly, OAuth2Box, OAuth2Autodesk, OAuth2Google, OAuth2Zoom, OAuth2Zoho, OAuth2Yandex, OAuth2X, OAuth2WordPress, OAuth2Twitch, OAuth2Stripe, OAuth2Spotify, OAuth2Slack, OAuth2Podio, OAuth2Notion, OAuth2Salesforce, OAuth2Yahoo, OAuth2HuggingFace, OAuth2Linkedin, OAuth2Disqus, OAuth2Amazon, OAuth2Etsy, OAuth2Facebook, OAuth2Tradeshift, OAuth2Paypal, OAuth2Gitlab, OAuth2Authentik, OAuth2Auth0, OAuth2FusionAuth, OAuth2Keycloak, OAuth2Oidc, OAuth2Apple, OAuth2Okta, OAuth2Kick, OAuth2Microsoft]
|
|
2208
|
+
def get_o_auth2_provider(
|
|
2209
|
+
provider_id:
|
|
2210
|
+
)
|
|
1997
2211
|
api_path = '/project/oauth2/{providerId}'
|
|
1998
2212
|
.gsub('{providerId}', provider_id)
|
|
1999
2213
|
|
|
2000
2214
|
if provider_id.nil?
|
|
2001
|
-
|
|
2215
|
+
raise Appwrite::Exception.new('Missing required parameter: "providerId"')
|
|
2002
2216
|
end
|
|
2003
2217
|
|
|
2004
|
-
api_params = {
|
|
2005
|
-
|
|
2006
|
-
|
|
2218
|
+
api_params = {}
|
|
2219
|
+
|
|
2007
2220
|
api_headers = {
|
|
2008
2221
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2009
2222
|
"accept": 'application/json',
|
|
@@ -2135,6 +2348,11 @@ module Appwrite
|
|
|
2135
2348
|
return Models::OAuth2Yahoo.from(map: response)
|
|
2136
2349
|
end
|
|
2137
2350
|
|
|
2351
|
+
if response['$id'] == 'huggingface'
|
|
2352
|
+
|
|
2353
|
+
return Models::OAuth2HuggingFace.from(map: response)
|
|
2354
|
+
end
|
|
2355
|
+
|
|
2138
2356
|
if response['$id'] == 'linkedin'
|
|
2139
2357
|
|
|
2140
2358
|
return Models::OAuth2Linkedin.from(map: response)
|
|
@@ -2221,7 +2439,6 @@ module Appwrite
|
|
|
2221
2439
|
end
|
|
2222
2440
|
|
|
2223
2441
|
raise Exception, "Unable to match response to any expected response model"
|
|
2224
|
-
|
|
2225
2442
|
end
|
|
2226
2443
|
|
|
2227
2444
|
# Get a list of all platforms in the project. This endpoint returns an array
|
|
@@ -2231,14 +2448,17 @@ module Appwrite
|
|
|
2231
2448
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
2232
2449
|
#
|
|
2233
2450
|
# @return [PlatformList]
|
|
2234
|
-
def list_platforms(
|
|
2451
|
+
def list_platforms(
|
|
2452
|
+
queries: nil,
|
|
2453
|
+
total: nil
|
|
2454
|
+
)
|
|
2235
2455
|
api_path = '/project/platforms'
|
|
2236
2456
|
|
|
2237
2457
|
api_params = {
|
|
2238
2458
|
queries: queries,
|
|
2239
2459
|
total: total,
|
|
2240
2460
|
}
|
|
2241
|
-
|
|
2461
|
+
|
|
2242
2462
|
api_headers = {
|
|
2243
2463
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2244
2464
|
"accept": 'application/json',
|
|
@@ -2251,31 +2471,34 @@ module Appwrite
|
|
|
2251
2471
|
params: api_params,
|
|
2252
2472
|
response_type: Models::PlatformList
|
|
2253
2473
|
)
|
|
2254
|
-
|
|
2255
2474
|
end
|
|
2256
2475
|
|
|
2257
2476
|
# Create a new Android platform for your project. Use this endpoint to
|
|
2258
2477
|
# register a new Android platform where your users will run your application
|
|
2259
2478
|
# which will interact with the Appwrite API.
|
|
2260
2479
|
#
|
|
2261
|
-
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
2480
|
+
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2262
2481
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2263
2482
|
# @param [String] application_id Android application ID. Max length: 256 chars.
|
|
2264
2483
|
#
|
|
2265
2484
|
# @return [PlatformAndroid]
|
|
2266
|
-
def create_android_platform(
|
|
2485
|
+
def create_android_platform(
|
|
2486
|
+
platform_id:,
|
|
2487
|
+
name:,
|
|
2488
|
+
application_id:
|
|
2489
|
+
)
|
|
2267
2490
|
api_path = '/project/platforms/android'
|
|
2268
2491
|
|
|
2269
2492
|
if platform_id.nil?
|
|
2270
|
-
|
|
2493
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2271
2494
|
end
|
|
2272
2495
|
|
|
2273
2496
|
if name.nil?
|
|
2274
|
-
|
|
2497
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2275
2498
|
end
|
|
2276
2499
|
|
|
2277
2500
|
if application_id.nil?
|
|
2278
|
-
|
|
2501
|
+
raise Appwrite::Exception.new('Missing required parameter: "applicationId"')
|
|
2279
2502
|
end
|
|
2280
2503
|
|
|
2281
2504
|
api_params = {
|
|
@@ -2283,7 +2506,7 @@ module Appwrite
|
|
|
2283
2506
|
name: name,
|
|
2284
2507
|
applicationId: application_id,
|
|
2285
2508
|
}
|
|
2286
|
-
|
|
2509
|
+
|
|
2287
2510
|
api_headers = {
|
|
2288
2511
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2289
2512
|
"content-type": 'application/json',
|
|
@@ -2297,38 +2520,41 @@ module Appwrite
|
|
|
2297
2520
|
params: api_params,
|
|
2298
2521
|
response_type: Models::PlatformAndroid
|
|
2299
2522
|
)
|
|
2300
|
-
|
|
2301
2523
|
end
|
|
2302
2524
|
|
|
2303
2525
|
# Update an Android platform by its unique ID. Use this endpoint to update
|
|
2304
|
-
# the platform
|
|
2526
|
+
# the platform's name or application ID.
|
|
2305
2527
|
#
|
|
2306
2528
|
# @param [String] platform_id Platform ID.
|
|
2307
2529
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2308
2530
|
# @param [String] application_id Android application ID. Max length: 256 chars.
|
|
2309
2531
|
#
|
|
2310
2532
|
# @return [PlatformAndroid]
|
|
2311
|
-
def update_android_platform(
|
|
2533
|
+
def update_android_platform(
|
|
2534
|
+
platform_id:,
|
|
2535
|
+
name:,
|
|
2536
|
+
application_id:
|
|
2537
|
+
)
|
|
2312
2538
|
api_path = '/project/platforms/android/{platformId}'
|
|
2313
2539
|
.gsub('{platformId}', platform_id)
|
|
2314
2540
|
|
|
2315
2541
|
if platform_id.nil?
|
|
2316
|
-
|
|
2542
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2317
2543
|
end
|
|
2318
2544
|
|
|
2319
2545
|
if name.nil?
|
|
2320
|
-
|
|
2546
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2321
2547
|
end
|
|
2322
2548
|
|
|
2323
2549
|
if application_id.nil?
|
|
2324
|
-
|
|
2550
|
+
raise Appwrite::Exception.new('Missing required parameter: "applicationId"')
|
|
2325
2551
|
end
|
|
2326
2552
|
|
|
2327
2553
|
api_params = {
|
|
2328
2554
|
name: name,
|
|
2329
2555
|
applicationId: application_id,
|
|
2330
2556
|
}
|
|
2331
|
-
|
|
2557
|
+
|
|
2332
2558
|
api_headers = {
|
|
2333
2559
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2334
2560
|
"content-type": 'application/json',
|
|
@@ -2342,31 +2568,34 @@ module Appwrite
|
|
|
2342
2568
|
params: api_params,
|
|
2343
2569
|
response_type: Models::PlatformAndroid
|
|
2344
2570
|
)
|
|
2345
|
-
|
|
2346
2571
|
end
|
|
2347
2572
|
|
|
2348
2573
|
# Create a new Apple platform for your project. Use this endpoint to register
|
|
2349
2574
|
# a new Apple platform where your users will run your application which will
|
|
2350
2575
|
# interact with the Appwrite API.
|
|
2351
2576
|
#
|
|
2352
|
-
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
2577
|
+
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2353
2578
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2354
2579
|
# @param [String] bundle_identifier Apple bundle identifier. Max length: 256 chars.
|
|
2355
2580
|
#
|
|
2356
2581
|
# @return [PlatformApple]
|
|
2357
|
-
def create_apple_platform(
|
|
2582
|
+
def create_apple_platform(
|
|
2583
|
+
platform_id:,
|
|
2584
|
+
name:,
|
|
2585
|
+
bundle_identifier:
|
|
2586
|
+
)
|
|
2358
2587
|
api_path = '/project/platforms/apple'
|
|
2359
2588
|
|
|
2360
2589
|
if platform_id.nil?
|
|
2361
|
-
|
|
2590
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2362
2591
|
end
|
|
2363
2592
|
|
|
2364
2593
|
if name.nil?
|
|
2365
|
-
|
|
2594
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2366
2595
|
end
|
|
2367
2596
|
|
|
2368
2597
|
if bundle_identifier.nil?
|
|
2369
|
-
|
|
2598
|
+
raise Appwrite::Exception.new('Missing required parameter: "bundleIdentifier"')
|
|
2370
2599
|
end
|
|
2371
2600
|
|
|
2372
2601
|
api_params = {
|
|
@@ -2374,7 +2603,7 @@ module Appwrite
|
|
|
2374
2603
|
name: name,
|
|
2375
2604
|
bundleIdentifier: bundle_identifier,
|
|
2376
2605
|
}
|
|
2377
|
-
|
|
2606
|
+
|
|
2378
2607
|
api_headers = {
|
|
2379
2608
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2380
2609
|
"content-type": 'application/json',
|
|
@@ -2388,38 +2617,41 @@ module Appwrite
|
|
|
2388
2617
|
params: api_params,
|
|
2389
2618
|
response_type: Models::PlatformApple
|
|
2390
2619
|
)
|
|
2391
|
-
|
|
2392
2620
|
end
|
|
2393
2621
|
|
|
2394
2622
|
# Update an Apple platform by its unique ID. Use this endpoint to update the
|
|
2395
|
-
# platform
|
|
2623
|
+
# platform's name or bundle identifier.
|
|
2396
2624
|
#
|
|
2397
2625
|
# @param [String] platform_id Platform ID.
|
|
2398
2626
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2399
2627
|
# @param [String] bundle_identifier Apple bundle identifier. Max length: 256 chars.
|
|
2400
2628
|
#
|
|
2401
2629
|
# @return [PlatformApple]
|
|
2402
|
-
def update_apple_platform(
|
|
2630
|
+
def update_apple_platform(
|
|
2631
|
+
platform_id:,
|
|
2632
|
+
name:,
|
|
2633
|
+
bundle_identifier:
|
|
2634
|
+
)
|
|
2403
2635
|
api_path = '/project/platforms/apple/{platformId}'
|
|
2404
2636
|
.gsub('{platformId}', platform_id)
|
|
2405
2637
|
|
|
2406
2638
|
if platform_id.nil?
|
|
2407
|
-
|
|
2639
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2408
2640
|
end
|
|
2409
2641
|
|
|
2410
2642
|
if name.nil?
|
|
2411
|
-
|
|
2643
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2412
2644
|
end
|
|
2413
2645
|
|
|
2414
2646
|
if bundle_identifier.nil?
|
|
2415
|
-
|
|
2647
|
+
raise Appwrite::Exception.new('Missing required parameter: "bundleIdentifier"')
|
|
2416
2648
|
end
|
|
2417
2649
|
|
|
2418
2650
|
api_params = {
|
|
2419
2651
|
name: name,
|
|
2420
2652
|
bundleIdentifier: bundle_identifier,
|
|
2421
2653
|
}
|
|
2422
|
-
|
|
2654
|
+
|
|
2423
2655
|
api_headers = {
|
|
2424
2656
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2425
2657
|
"content-type": 'application/json',
|
|
@@ -2433,31 +2665,34 @@ module Appwrite
|
|
|
2433
2665
|
params: api_params,
|
|
2434
2666
|
response_type: Models::PlatformApple
|
|
2435
2667
|
)
|
|
2436
|
-
|
|
2437
2668
|
end
|
|
2438
2669
|
|
|
2439
2670
|
# Create a new Linux platform for your project. Use this endpoint to register
|
|
2440
2671
|
# a new Linux platform where your users will run your application which will
|
|
2441
2672
|
# interact with the Appwrite API.
|
|
2442
2673
|
#
|
|
2443
|
-
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
2674
|
+
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2444
2675
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2445
2676
|
# @param [String] package_name Linux package name. Max length: 256 chars.
|
|
2446
2677
|
#
|
|
2447
2678
|
# @return [PlatformLinux]
|
|
2448
|
-
def create_linux_platform(
|
|
2679
|
+
def create_linux_platform(
|
|
2680
|
+
platform_id:,
|
|
2681
|
+
name:,
|
|
2682
|
+
package_name:
|
|
2683
|
+
)
|
|
2449
2684
|
api_path = '/project/platforms/linux'
|
|
2450
2685
|
|
|
2451
2686
|
if platform_id.nil?
|
|
2452
|
-
|
|
2687
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2453
2688
|
end
|
|
2454
2689
|
|
|
2455
2690
|
if name.nil?
|
|
2456
|
-
|
|
2691
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2457
2692
|
end
|
|
2458
2693
|
|
|
2459
2694
|
if package_name.nil?
|
|
2460
|
-
|
|
2695
|
+
raise Appwrite::Exception.new('Missing required parameter: "packageName"')
|
|
2461
2696
|
end
|
|
2462
2697
|
|
|
2463
2698
|
api_params = {
|
|
@@ -2465,7 +2700,7 @@ module Appwrite
|
|
|
2465
2700
|
name: name,
|
|
2466
2701
|
packageName: package_name,
|
|
2467
2702
|
}
|
|
2468
|
-
|
|
2703
|
+
|
|
2469
2704
|
api_headers = {
|
|
2470
2705
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2471
2706
|
"content-type": 'application/json',
|
|
@@ -2479,38 +2714,41 @@ module Appwrite
|
|
|
2479
2714
|
params: api_params,
|
|
2480
2715
|
response_type: Models::PlatformLinux
|
|
2481
2716
|
)
|
|
2482
|
-
|
|
2483
2717
|
end
|
|
2484
2718
|
|
|
2485
2719
|
# Update a Linux platform by its unique ID. Use this endpoint to update the
|
|
2486
|
-
# platform
|
|
2720
|
+
# platform's name or package name.
|
|
2487
2721
|
#
|
|
2488
2722
|
# @param [String] platform_id Platform ID.
|
|
2489
2723
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2490
2724
|
# @param [String] package_name Linux package name. Max length: 256 chars.
|
|
2491
2725
|
#
|
|
2492
2726
|
# @return [PlatformLinux]
|
|
2493
|
-
def update_linux_platform(
|
|
2727
|
+
def update_linux_platform(
|
|
2728
|
+
platform_id:,
|
|
2729
|
+
name:,
|
|
2730
|
+
package_name:
|
|
2731
|
+
)
|
|
2494
2732
|
api_path = '/project/platforms/linux/{platformId}'
|
|
2495
2733
|
.gsub('{platformId}', platform_id)
|
|
2496
2734
|
|
|
2497
2735
|
if platform_id.nil?
|
|
2498
|
-
|
|
2736
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2499
2737
|
end
|
|
2500
2738
|
|
|
2501
2739
|
if name.nil?
|
|
2502
|
-
|
|
2740
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2503
2741
|
end
|
|
2504
2742
|
|
|
2505
2743
|
if package_name.nil?
|
|
2506
|
-
|
|
2744
|
+
raise Appwrite::Exception.new('Missing required parameter: "packageName"')
|
|
2507
2745
|
end
|
|
2508
2746
|
|
|
2509
2747
|
api_params = {
|
|
2510
2748
|
name: name,
|
|
2511
2749
|
packageName: package_name,
|
|
2512
2750
|
}
|
|
2513
|
-
|
|
2751
|
+
|
|
2514
2752
|
api_headers = {
|
|
2515
2753
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2516
2754
|
"content-type": 'application/json',
|
|
@@ -2524,31 +2762,34 @@ module Appwrite
|
|
|
2524
2762
|
params: api_params,
|
|
2525
2763
|
response_type: Models::PlatformLinux
|
|
2526
2764
|
)
|
|
2527
|
-
|
|
2528
2765
|
end
|
|
2529
2766
|
|
|
2530
2767
|
# Create a new web platform for your project. Use this endpoint to register a
|
|
2531
2768
|
# new platform where your users will run your application which will interact
|
|
2532
2769
|
# with the Appwrite API.
|
|
2533
2770
|
#
|
|
2534
|
-
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
2771
|
+
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2535
2772
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2536
2773
|
# @param [String] hostname Platform web hostname. Max length: 256 chars.
|
|
2537
2774
|
#
|
|
2538
2775
|
# @return [PlatformWeb]
|
|
2539
|
-
def create_web_platform(
|
|
2776
|
+
def create_web_platform(
|
|
2777
|
+
platform_id:,
|
|
2778
|
+
name:,
|
|
2779
|
+
hostname:
|
|
2780
|
+
)
|
|
2540
2781
|
api_path = '/project/platforms/web'
|
|
2541
2782
|
|
|
2542
2783
|
if platform_id.nil?
|
|
2543
|
-
|
|
2784
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2544
2785
|
end
|
|
2545
2786
|
|
|
2546
2787
|
if name.nil?
|
|
2547
|
-
|
|
2788
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2548
2789
|
end
|
|
2549
2790
|
|
|
2550
2791
|
if hostname.nil?
|
|
2551
|
-
|
|
2792
|
+
raise Appwrite::Exception.new('Missing required parameter: "hostname"')
|
|
2552
2793
|
end
|
|
2553
2794
|
|
|
2554
2795
|
api_params = {
|
|
@@ -2556,7 +2797,7 @@ module Appwrite
|
|
|
2556
2797
|
name: name,
|
|
2557
2798
|
hostname: hostname,
|
|
2558
2799
|
}
|
|
2559
|
-
|
|
2800
|
+
|
|
2560
2801
|
api_headers = {
|
|
2561
2802
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2562
2803
|
"content-type": 'application/json',
|
|
@@ -2570,38 +2811,41 @@ module Appwrite
|
|
|
2570
2811
|
params: api_params,
|
|
2571
2812
|
response_type: Models::PlatformWeb
|
|
2572
2813
|
)
|
|
2573
|
-
|
|
2574
2814
|
end
|
|
2575
2815
|
|
|
2576
2816
|
# Update a web platform by its unique ID. Use this endpoint to update the
|
|
2577
|
-
# platform
|
|
2817
|
+
# platform's name or hostname.
|
|
2578
2818
|
#
|
|
2579
2819
|
# @param [String] platform_id Platform ID.
|
|
2580
2820
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2581
2821
|
# @param [String] hostname Platform web hostname. Max length: 256 chars.
|
|
2582
2822
|
#
|
|
2583
2823
|
# @return [PlatformWeb]
|
|
2584
|
-
def update_web_platform(
|
|
2824
|
+
def update_web_platform(
|
|
2825
|
+
platform_id:,
|
|
2826
|
+
name:,
|
|
2827
|
+
hostname:
|
|
2828
|
+
)
|
|
2585
2829
|
api_path = '/project/platforms/web/{platformId}'
|
|
2586
2830
|
.gsub('{platformId}', platform_id)
|
|
2587
2831
|
|
|
2588
2832
|
if platform_id.nil?
|
|
2589
|
-
|
|
2833
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2590
2834
|
end
|
|
2591
2835
|
|
|
2592
2836
|
if name.nil?
|
|
2593
|
-
|
|
2837
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2594
2838
|
end
|
|
2595
2839
|
|
|
2596
2840
|
if hostname.nil?
|
|
2597
|
-
|
|
2841
|
+
raise Appwrite::Exception.new('Missing required parameter: "hostname"')
|
|
2598
2842
|
end
|
|
2599
2843
|
|
|
2600
2844
|
api_params = {
|
|
2601
2845
|
name: name,
|
|
2602
2846
|
hostname: hostname,
|
|
2603
2847
|
}
|
|
2604
|
-
|
|
2848
|
+
|
|
2605
2849
|
api_headers = {
|
|
2606
2850
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2607
2851
|
"content-type": 'application/json',
|
|
@@ -2615,31 +2859,34 @@ module Appwrite
|
|
|
2615
2859
|
params: api_params,
|
|
2616
2860
|
response_type: Models::PlatformWeb
|
|
2617
2861
|
)
|
|
2618
|
-
|
|
2619
2862
|
end
|
|
2620
2863
|
|
|
2621
2864
|
# Create a new Windows platform for your project. Use this endpoint to
|
|
2622
2865
|
# register a new Windows platform where your users will run your application
|
|
2623
2866
|
# which will interact with the Appwrite API.
|
|
2624
2867
|
#
|
|
2625
|
-
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
2868
|
+
# @param [String] platform_id Platform ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
2626
2869
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2627
2870
|
# @param [String] package_identifier_name Windows package identifier name. Max length: 256 chars.
|
|
2628
2871
|
#
|
|
2629
2872
|
# @return [PlatformWindows]
|
|
2630
|
-
def create_windows_platform(
|
|
2873
|
+
def create_windows_platform(
|
|
2874
|
+
platform_id:,
|
|
2875
|
+
name:,
|
|
2876
|
+
package_identifier_name:
|
|
2877
|
+
)
|
|
2631
2878
|
api_path = '/project/platforms/windows'
|
|
2632
2879
|
|
|
2633
2880
|
if platform_id.nil?
|
|
2634
|
-
|
|
2881
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2635
2882
|
end
|
|
2636
2883
|
|
|
2637
2884
|
if name.nil?
|
|
2638
|
-
|
|
2885
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2639
2886
|
end
|
|
2640
2887
|
|
|
2641
2888
|
if package_identifier_name.nil?
|
|
2642
|
-
|
|
2889
|
+
raise Appwrite::Exception.new('Missing required parameter: "packageIdentifierName"')
|
|
2643
2890
|
end
|
|
2644
2891
|
|
|
2645
2892
|
api_params = {
|
|
@@ -2647,7 +2894,7 @@ module Appwrite
|
|
|
2647
2894
|
name: name,
|
|
2648
2895
|
packageIdentifierName: package_identifier_name,
|
|
2649
2896
|
}
|
|
2650
|
-
|
|
2897
|
+
|
|
2651
2898
|
api_headers = {
|
|
2652
2899
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2653
2900
|
"content-type": 'application/json',
|
|
@@ -2661,38 +2908,41 @@ module Appwrite
|
|
|
2661
2908
|
params: api_params,
|
|
2662
2909
|
response_type: Models::PlatformWindows
|
|
2663
2910
|
)
|
|
2664
|
-
|
|
2665
2911
|
end
|
|
2666
2912
|
|
|
2667
2913
|
# Update a Windows platform by its unique ID. Use this endpoint to update the
|
|
2668
|
-
# platform
|
|
2914
|
+
# platform's name or package identifier name.
|
|
2669
2915
|
#
|
|
2670
2916
|
# @param [String] platform_id Platform ID.
|
|
2671
2917
|
# @param [String] name Platform name. Max length: 128 chars.
|
|
2672
2918
|
# @param [String] package_identifier_name Windows package identifier name. Max length: 256 chars.
|
|
2673
2919
|
#
|
|
2674
2920
|
# @return [PlatformWindows]
|
|
2675
|
-
def update_windows_platform(
|
|
2921
|
+
def update_windows_platform(
|
|
2922
|
+
platform_id:,
|
|
2923
|
+
name:,
|
|
2924
|
+
package_identifier_name:
|
|
2925
|
+
)
|
|
2676
2926
|
api_path = '/project/platforms/windows/{platformId}'
|
|
2677
2927
|
.gsub('{platformId}', platform_id)
|
|
2678
2928
|
|
|
2679
2929
|
if platform_id.nil?
|
|
2680
|
-
|
|
2930
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2681
2931
|
end
|
|
2682
2932
|
|
|
2683
2933
|
if name.nil?
|
|
2684
|
-
|
|
2934
|
+
raise Appwrite::Exception.new('Missing required parameter: "name"')
|
|
2685
2935
|
end
|
|
2686
2936
|
|
|
2687
2937
|
if package_identifier_name.nil?
|
|
2688
|
-
|
|
2938
|
+
raise Appwrite::Exception.new('Missing required parameter: "packageIdentifierName"')
|
|
2689
2939
|
end
|
|
2690
2940
|
|
|
2691
2941
|
api_params = {
|
|
2692
2942
|
name: name,
|
|
2693
2943
|
packageIdentifierName: package_identifier_name,
|
|
2694
2944
|
}
|
|
2695
|
-
|
|
2945
|
+
|
|
2696
2946
|
api_headers = {
|
|
2697
2947
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2698
2948
|
"content-type": 'application/json',
|
|
@@ -2706,26 +2956,26 @@ module Appwrite
|
|
|
2706
2956
|
params: api_params,
|
|
2707
2957
|
response_type: Models::PlatformWindows
|
|
2708
2958
|
)
|
|
2709
|
-
|
|
2710
2959
|
end
|
|
2711
2960
|
|
|
2712
|
-
# Get a platform by its unique ID. This endpoint returns the platform
|
|
2961
|
+
# Get a platform by its unique ID. This endpoint returns the platform's
|
|
2713
2962
|
# details, including its name, type, and key configurations.
|
|
2714
2963
|
#
|
|
2715
2964
|
# @param [String] platform_id Platform ID.
|
|
2716
2965
|
#
|
|
2717
2966
|
# @return [PlatformWeb, PlatformApple, PlatformAndroid, PlatformWindows, PlatformLinux]
|
|
2718
|
-
def get_platform(
|
|
2967
|
+
def get_platform(
|
|
2968
|
+
platform_id:
|
|
2969
|
+
)
|
|
2719
2970
|
api_path = '/project/platforms/{platformId}'
|
|
2720
2971
|
.gsub('{platformId}', platform_id)
|
|
2721
2972
|
|
|
2722
2973
|
if platform_id.nil?
|
|
2723
|
-
|
|
2974
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2724
2975
|
end
|
|
2725
2976
|
|
|
2726
|
-
api_params = {
|
|
2727
|
-
|
|
2728
|
-
|
|
2977
|
+
api_params = {}
|
|
2978
|
+
|
|
2729
2979
|
api_headers = {
|
|
2730
2980
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2731
2981
|
"accept": 'application/json',
|
|
@@ -2768,7 +3018,6 @@ module Appwrite
|
|
|
2768
3018
|
end
|
|
2769
3019
|
|
|
2770
3020
|
raise Exception, "Unable to match response to any expected response model"
|
|
2771
|
-
|
|
2772
3021
|
end
|
|
2773
3022
|
|
|
2774
3023
|
# Delete a platform by its unique ID. This endpoint removes the platform and
|
|
@@ -2777,17 +3026,18 @@ module Appwrite
|
|
|
2777
3026
|
# @param [String] platform_id Platform ID.
|
|
2778
3027
|
#
|
|
2779
3028
|
# @return []
|
|
2780
|
-
def delete_platform(
|
|
3029
|
+
def delete_platform(
|
|
3030
|
+
platform_id:
|
|
3031
|
+
)
|
|
2781
3032
|
api_path = '/project/platforms/{platformId}'
|
|
2782
3033
|
.gsub('{platformId}', platform_id)
|
|
2783
3034
|
|
|
2784
3035
|
if platform_id.nil?
|
|
2785
|
-
|
|
3036
|
+
raise Appwrite::Exception.new('Missing required parameter: "platformId"')
|
|
2786
3037
|
end
|
|
2787
3038
|
|
|
2788
|
-
api_params = {
|
|
2789
|
-
|
|
2790
|
-
|
|
3039
|
+
api_params = {}
|
|
3040
|
+
|
|
2791
3041
|
api_headers = {
|
|
2792
3042
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2793
3043
|
"content-type": 'application/json',
|
|
@@ -2799,7 +3049,6 @@ module Appwrite
|
|
|
2799
3049
|
headers: api_headers,
|
|
2800
3050
|
params: api_params,
|
|
2801
3051
|
)
|
|
2802
|
-
|
|
2803
3052
|
end
|
|
2804
3053
|
|
|
2805
3054
|
# Get a list of all project policies and their current configuration.
|
|
@@ -2808,14 +3057,17 @@ module Appwrite
|
|
|
2808
3057
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
2809
3058
|
#
|
|
2810
3059
|
# @return [PolicyList]
|
|
2811
|
-
def list_policies(
|
|
3060
|
+
def list_policies(
|
|
3061
|
+
queries: nil,
|
|
3062
|
+
total: nil
|
|
3063
|
+
)
|
|
2812
3064
|
api_path = '/project/policies'
|
|
2813
3065
|
|
|
2814
3066
|
api_params = {
|
|
2815
3067
|
queries: queries,
|
|
2816
3068
|
total: total,
|
|
2817
3069
|
}
|
|
2818
|
-
|
|
3070
|
+
|
|
2819
3071
|
api_headers = {
|
|
2820
3072
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2821
3073
|
"accept": 'application/json',
|
|
@@ -2828,7 +3080,6 @@ module Appwrite
|
|
|
2828
3080
|
params: api_params,
|
|
2829
3081
|
response_type: Models::PolicyList
|
|
2830
3082
|
)
|
|
2831
|
-
|
|
2832
3083
|
end
|
|
2833
3084
|
|
|
2834
3085
|
# Configures if aliased emails such as subaddresses and emails with suffixes
|
|
@@ -2837,17 +3088,19 @@ module Appwrite
|
|
|
2837
3088
|
# @param [] enabled Set whether or not to block aliased emails during signup and email updates.
|
|
2838
3089
|
#
|
|
2839
3090
|
# @return [Project]
|
|
2840
|
-
def update_deny_aliased_email_policy(
|
|
3091
|
+
def update_deny_aliased_email_policy(
|
|
3092
|
+
enabled:
|
|
3093
|
+
)
|
|
2841
3094
|
api_path = '/project/policies/deny-aliased-email'
|
|
2842
3095
|
|
|
2843
3096
|
if enabled.nil?
|
|
2844
|
-
|
|
3097
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
2845
3098
|
end
|
|
2846
3099
|
|
|
2847
3100
|
api_params = {
|
|
2848
3101
|
enabled: enabled,
|
|
2849
3102
|
}
|
|
2850
|
-
|
|
3103
|
+
|
|
2851
3104
|
api_headers = {
|
|
2852
3105
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2853
3106
|
"content-type": 'application/json',
|
|
@@ -2861,7 +3114,6 @@ module Appwrite
|
|
|
2861
3114
|
params: api_params,
|
|
2862
3115
|
response_type: Models::Project
|
|
2863
3116
|
)
|
|
2864
|
-
|
|
2865
3117
|
end
|
|
2866
3118
|
|
|
2867
3119
|
# Configures if only corporate email addresses (non-free and non-disposable
|
|
@@ -2870,17 +3122,19 @@ module Appwrite
|
|
|
2870
3122
|
# @param [] enabled Set whether or not to restrict sign-ups and email updates to corporate email addresses only.
|
|
2871
3123
|
#
|
|
2872
3124
|
# @return [Project]
|
|
2873
|
-
def update_deny_corporate_email_policy(
|
|
3125
|
+
def update_deny_corporate_email_policy(
|
|
3126
|
+
enabled:
|
|
3127
|
+
)
|
|
2874
3128
|
api_path = '/project/policies/deny-corporate-email'
|
|
2875
3129
|
|
|
2876
3130
|
if enabled.nil?
|
|
2877
|
-
|
|
3131
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
2878
3132
|
end
|
|
2879
3133
|
|
|
2880
3134
|
api_params = {
|
|
2881
3135
|
enabled: enabled,
|
|
2882
3136
|
}
|
|
2883
|
-
|
|
3137
|
+
|
|
2884
3138
|
api_headers = {
|
|
2885
3139
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2886
3140
|
"content-type": 'application/json',
|
|
@@ -2894,7 +3148,6 @@ module Appwrite
|
|
|
2894
3148
|
params: api_params,
|
|
2895
3149
|
response_type: Models::Project
|
|
2896
3150
|
)
|
|
2897
|
-
|
|
2898
3151
|
end
|
|
2899
3152
|
|
|
2900
3153
|
# Configures if disposable emails from known temporary domains are denied
|
|
@@ -2903,17 +3156,19 @@ module Appwrite
|
|
|
2903
3156
|
# @param [] enabled Set whether or not to block disposable email addresses during signup and email updates.
|
|
2904
3157
|
#
|
|
2905
3158
|
# @return [Project]
|
|
2906
|
-
def update_deny_disposable_email_policy(
|
|
3159
|
+
def update_deny_disposable_email_policy(
|
|
3160
|
+
enabled:
|
|
3161
|
+
)
|
|
2907
3162
|
api_path = '/project/policies/deny-disposable-email'
|
|
2908
3163
|
|
|
2909
3164
|
if enabled.nil?
|
|
2910
|
-
|
|
3165
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
2911
3166
|
end
|
|
2912
3167
|
|
|
2913
3168
|
api_params = {
|
|
2914
3169
|
enabled: enabled,
|
|
2915
3170
|
}
|
|
2916
|
-
|
|
3171
|
+
|
|
2917
3172
|
api_headers = {
|
|
2918
3173
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2919
3174
|
"content-type": 'application/json',
|
|
@@ -2927,7 +3182,6 @@ module Appwrite
|
|
|
2927
3182
|
params: api_params,
|
|
2928
3183
|
response_type: Models::Project
|
|
2929
3184
|
)
|
|
2930
|
-
|
|
2931
3185
|
end
|
|
2932
3186
|
|
|
2933
3187
|
# Configures if emails from free providers such as Gmail or Yahoo are denied
|
|
@@ -2936,17 +3190,19 @@ module Appwrite
|
|
|
2936
3190
|
# @param [] enabled Set whether or not to block free email addresses during signup and email updates.
|
|
2937
3191
|
#
|
|
2938
3192
|
# @return [Project]
|
|
2939
|
-
def update_deny_free_email_policy(
|
|
3193
|
+
def update_deny_free_email_policy(
|
|
3194
|
+
enabled:
|
|
3195
|
+
)
|
|
2940
3196
|
api_path = '/project/policies/deny-free-email'
|
|
2941
3197
|
|
|
2942
3198
|
if enabled.nil?
|
|
2943
|
-
|
|
3199
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
2944
3200
|
end
|
|
2945
3201
|
|
|
2946
3202
|
api_params = {
|
|
2947
3203
|
enabled: enabled,
|
|
2948
3204
|
}
|
|
2949
|
-
|
|
3205
|
+
|
|
2950
3206
|
api_headers = {
|
|
2951
3207
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2952
3208
|
"content-type": 'application/json',
|
|
@@ -2960,7 +3216,6 @@ module Appwrite
|
|
|
2960
3216
|
params: api_params,
|
|
2961
3217
|
response_type: Models::Project
|
|
2962
3218
|
)
|
|
2963
|
-
|
|
2964
3219
|
end
|
|
2965
3220
|
|
|
2966
3221
|
# Updating this policy allows you to control if team members can see other
|
|
@@ -2975,7 +3230,14 @@ module Appwrite
|
|
|
2975
3230
|
# @param [] user_accessed_at Set to true if you want make user last access time visible to all team members, or false to hide it.
|
|
2976
3231
|
#
|
|
2977
3232
|
# @return [Project]
|
|
2978
|
-
def update_membership_privacy_policy(
|
|
3233
|
+
def update_membership_privacy_policy(
|
|
3234
|
+
user_id: nil,
|
|
3235
|
+
user_email: nil,
|
|
3236
|
+
user_phone: nil,
|
|
3237
|
+
user_name: nil,
|
|
3238
|
+
user_mfa: nil,
|
|
3239
|
+
user_accessed_at: nil
|
|
3240
|
+
)
|
|
2979
3241
|
api_path = '/project/policies/membership-privacy'
|
|
2980
3242
|
|
|
2981
3243
|
api_params = {
|
|
@@ -2986,7 +3248,7 @@ module Appwrite
|
|
|
2986
3248
|
userMFA: user_mfa,
|
|
2987
3249
|
userAccessedAt: user_accessed_at,
|
|
2988
3250
|
}
|
|
2989
|
-
|
|
3251
|
+
|
|
2990
3252
|
api_headers = {
|
|
2991
3253
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
2992
3254
|
"content-type": 'application/json',
|
|
@@ -3000,7 +3262,6 @@ module Appwrite
|
|
|
3000
3262
|
params: api_params,
|
|
3001
3263
|
response_type: Models::Project
|
|
3002
3264
|
)
|
|
3003
|
-
|
|
3004
3265
|
end
|
|
3005
3266
|
|
|
3006
3267
|
# Updating this policy allows you to control which factors users can use to
|
|
@@ -3015,7 +3276,12 @@ module Appwrite
|
|
|
3015
3276
|
# @param [] custom Set to true to allow the custom factor to complete an MFA challenge, or false to disable it.
|
|
3016
3277
|
#
|
|
3017
3278
|
# @return [Project]
|
|
3018
|
-
def update_mfa_factors_policy(
|
|
3279
|
+
def update_mfa_factors_policy(
|
|
3280
|
+
totp: nil,
|
|
3281
|
+
email: nil,
|
|
3282
|
+
phone: nil,
|
|
3283
|
+
custom: nil
|
|
3284
|
+
)
|
|
3019
3285
|
api_path = '/project/policies/mfa-factors'
|
|
3020
3286
|
|
|
3021
3287
|
api_params = {
|
|
@@ -3024,7 +3290,7 @@ module Appwrite
|
|
|
3024
3290
|
phone: phone,
|
|
3025
3291
|
custom: custom,
|
|
3026
3292
|
}
|
|
3027
|
-
|
|
3293
|
+
|
|
3028
3294
|
api_headers = {
|
|
3029
3295
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3030
3296
|
"content-type": 'application/json',
|
|
@@ -3038,7 +3304,6 @@ module Appwrite
|
|
|
3038
3304
|
params: api_params,
|
|
3039
3305
|
response_type: Models::Project
|
|
3040
3306
|
)
|
|
3041
|
-
|
|
3042
3307
|
end
|
|
3043
3308
|
|
|
3044
3309
|
# Updating this policy allows you to control if new passwords are checked
|
|
@@ -3048,17 +3313,19 @@ module Appwrite
|
|
|
3048
3313
|
# @param [] enabled Toggle password dictionary policy. Set to true if you want password change to block passwords in the dictionary, or false to allow them. When changing this policy, existing passwords remain valid.
|
|
3049
3314
|
#
|
|
3050
3315
|
# @return [Project]
|
|
3051
|
-
def update_password_dictionary_policy(
|
|
3316
|
+
def update_password_dictionary_policy(
|
|
3317
|
+
enabled:
|
|
3318
|
+
)
|
|
3052
3319
|
api_path = '/project/policies/password-dictionary'
|
|
3053
3320
|
|
|
3054
3321
|
if enabled.nil?
|
|
3055
|
-
|
|
3322
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3056
3323
|
end
|
|
3057
3324
|
|
|
3058
3325
|
api_params = {
|
|
3059
3326
|
enabled: enabled,
|
|
3060
3327
|
}
|
|
3061
|
-
|
|
3328
|
+
|
|
3062
3329
|
api_headers = {
|
|
3063
3330
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3064
3331
|
"content-type": 'application/json',
|
|
@@ -3072,14 +3339,13 @@ module Appwrite
|
|
|
3072
3339
|
params: api_params,
|
|
3073
3340
|
response_type: Models::Project
|
|
3074
3341
|
)
|
|
3075
|
-
|
|
3076
3342
|
end
|
|
3077
3343
|
|
|
3078
3344
|
# Updates one of password strength policies. Based on total length
|
|
3079
3345
|
# configured, previous password hashes are stored, and users cannot choose a
|
|
3080
3346
|
# new password that is already stored in the passwird history list, when
|
|
3081
3347
|
# updating an user password, or setting new one through password recovery.
|
|
3082
|
-
#
|
|
3348
|
+
#
|
|
3083
3349
|
# Keep in mind, while password history policy is disabled, the history is not
|
|
3084
3350
|
# being stored. Enabling the policy will not have any history on existing
|
|
3085
3351
|
# users, and it will only start to collect and enforce the policy on password
|
|
@@ -3088,17 +3354,19 @@ module Appwrite
|
|
|
3088
3354
|
# @param [Integer] total Set the password history length per user. Value can be between 1 and 20, or null to disable the limit.
|
|
3089
3355
|
#
|
|
3090
3356
|
# @return [Project]
|
|
3091
|
-
def update_password_history_policy(
|
|
3357
|
+
def update_password_history_policy(
|
|
3358
|
+
total:
|
|
3359
|
+
)
|
|
3092
3360
|
api_path = '/project/policies/password-history'
|
|
3093
3361
|
|
|
3094
3362
|
if total.nil?
|
|
3095
|
-
|
|
3363
|
+
raise Appwrite::Exception.new('Missing required parameter: "total"')
|
|
3096
3364
|
end
|
|
3097
3365
|
|
|
3098
3366
|
api_params = {
|
|
3099
3367
|
total: total,
|
|
3100
3368
|
}
|
|
3101
|
-
|
|
3369
|
+
|
|
3102
3370
|
api_headers = {
|
|
3103
3371
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3104
3372
|
"content-type": 'application/json',
|
|
@@ -3112,7 +3380,6 @@ module Appwrite
|
|
|
3112
3380
|
params: api_params,
|
|
3113
3381
|
response_type: Models::Project
|
|
3114
3382
|
)
|
|
3115
|
-
|
|
3116
3383
|
end
|
|
3117
3384
|
|
|
3118
3385
|
# Updating this policy allows you to control if password strength is checked
|
|
@@ -3120,20 +3387,22 @@ module Appwrite
|
|
|
3120
3387
|
# password, the password must not contain user ID, name, email or phone
|
|
3121
3388
|
# number.
|
|
3122
3389
|
#
|
|
3123
|
-
# @param [] enabled Toggle password personal data policy. Set to true if you want to block passwords including user
|
|
3390
|
+
# @param [] enabled Toggle password personal data policy. Set to true if you want to block passwords including user's personal data, or false to allow it. When changing this policy, existing passwords remain valid.
|
|
3124
3391
|
#
|
|
3125
3392
|
# @return [Project]
|
|
3126
|
-
def update_password_personal_data_policy(
|
|
3393
|
+
def update_password_personal_data_policy(
|
|
3394
|
+
enabled:
|
|
3395
|
+
)
|
|
3127
3396
|
api_path = '/project/policies/password-personal-data'
|
|
3128
3397
|
|
|
3129
3398
|
if enabled.nil?
|
|
3130
|
-
|
|
3399
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3131
3400
|
end
|
|
3132
3401
|
|
|
3133
3402
|
api_params = {
|
|
3134
3403
|
enabled: enabled,
|
|
3135
3404
|
}
|
|
3136
|
-
|
|
3405
|
+
|
|
3137
3406
|
api_headers = {
|
|
3138
3407
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3139
3408
|
"content-type": 'application/json',
|
|
@@ -3147,7 +3416,6 @@ module Appwrite
|
|
|
3147
3416
|
params: api_params,
|
|
3148
3417
|
response_type: Models::Project
|
|
3149
3418
|
)
|
|
3150
|
-
|
|
3151
3419
|
end
|
|
3152
3420
|
|
|
3153
3421
|
# Update the password strength requirements for users in the project.
|
|
@@ -3159,7 +3427,13 @@ module Appwrite
|
|
|
3159
3427
|
# @param [] symbols Whether passwords must include at least one symbol.
|
|
3160
3428
|
#
|
|
3161
3429
|
# @return [PolicyPasswordStrength]
|
|
3162
|
-
def update_password_strength_policy(
|
|
3430
|
+
def update_password_strength_policy(
|
|
3431
|
+
min: nil,
|
|
3432
|
+
uppercase: nil,
|
|
3433
|
+
lowercase: nil,
|
|
3434
|
+
number: nil,
|
|
3435
|
+
symbols: nil
|
|
3436
|
+
)
|
|
3163
3437
|
api_path = '/project/policies/password-strength'
|
|
3164
3438
|
|
|
3165
3439
|
api_params = {
|
|
@@ -3169,7 +3443,7 @@ module Appwrite
|
|
|
3169
3443
|
number: number,
|
|
3170
3444
|
symbols: symbols,
|
|
3171
3445
|
}
|
|
3172
|
-
|
|
3446
|
+
|
|
3173
3447
|
api_headers = {
|
|
3174
3448
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3175
3449
|
"content-type": 'application/json',
|
|
@@ -3183,7 +3457,6 @@ module Appwrite
|
|
|
3183
3457
|
params: api_params,
|
|
3184
3458
|
response_type: Models::PolicyPasswordStrength
|
|
3185
3459
|
)
|
|
3186
|
-
|
|
3187
3460
|
end
|
|
3188
3461
|
|
|
3189
3462
|
# Updating this policy allows you to control if email alert is sent upon
|
|
@@ -3195,17 +3468,19 @@ module Appwrite
|
|
|
3195
3468
|
# @param [] enabled Toggle session alert policy. Set to true if you want users to receive email notifications when a sessions are created for their users, or false to not send email alerts.
|
|
3196
3469
|
#
|
|
3197
3470
|
# @return [Project]
|
|
3198
|
-
def update_session_alert_policy(
|
|
3471
|
+
def update_session_alert_policy(
|
|
3472
|
+
enabled:
|
|
3473
|
+
)
|
|
3199
3474
|
api_path = '/project/policies/session-alert'
|
|
3200
3475
|
|
|
3201
3476
|
if enabled.nil?
|
|
3202
|
-
|
|
3477
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3203
3478
|
end
|
|
3204
3479
|
|
|
3205
3480
|
api_params = {
|
|
3206
3481
|
enabled: enabled,
|
|
3207
3482
|
}
|
|
3208
|
-
|
|
3483
|
+
|
|
3209
3484
|
api_headers = {
|
|
3210
3485
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3211
3486
|
"content-type": 'application/json',
|
|
@@ -3219,7 +3494,6 @@ module Appwrite
|
|
|
3219
3494
|
params: api_params,
|
|
3220
3495
|
response_type: Models::Project
|
|
3221
3496
|
)
|
|
3222
|
-
|
|
3223
3497
|
end
|
|
3224
3498
|
|
|
3225
3499
|
# Update maximum duration how long sessions created within a project should
|
|
@@ -3228,17 +3502,19 @@ module Appwrite
|
|
|
3228
3502
|
# @param [Integer] duration Maximum session length in seconds. Minium allowed value is 60 seconds, and maximum is 1 year, which is 31536000 seconds.
|
|
3229
3503
|
#
|
|
3230
3504
|
# @return [Project]
|
|
3231
|
-
def update_session_duration_policy(
|
|
3505
|
+
def update_session_duration_policy(
|
|
3506
|
+
duration:
|
|
3507
|
+
)
|
|
3232
3508
|
api_path = '/project/policies/session-duration'
|
|
3233
3509
|
|
|
3234
3510
|
if duration.nil?
|
|
3235
|
-
|
|
3511
|
+
raise Appwrite::Exception.new('Missing required parameter: "duration"')
|
|
3236
3512
|
end
|
|
3237
3513
|
|
|
3238
3514
|
api_params = {
|
|
3239
3515
|
duration: duration,
|
|
3240
3516
|
}
|
|
3241
|
-
|
|
3517
|
+
|
|
3242
3518
|
api_headers = {
|
|
3243
3519
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3244
3520
|
"content-type": 'application/json',
|
|
@@ -3252,7 +3528,6 @@ module Appwrite
|
|
|
3252
3528
|
params: api_params,
|
|
3253
3529
|
response_type: Models::Project
|
|
3254
3530
|
)
|
|
3255
|
-
|
|
3256
3531
|
end
|
|
3257
3532
|
|
|
3258
3533
|
# Updating this policy allows you to control if existing sessions should be
|
|
@@ -3262,17 +3537,19 @@ module Appwrite
|
|
|
3262
3537
|
# @param [] enabled Toggle session invalidation policy. Set to true if you want password change to invalidate all sessions of an user, or false to keep sessions active.
|
|
3263
3538
|
#
|
|
3264
3539
|
# @return [Project]
|
|
3265
|
-
def update_session_invalidation_policy(
|
|
3540
|
+
def update_session_invalidation_policy(
|
|
3541
|
+
enabled:
|
|
3542
|
+
)
|
|
3266
3543
|
api_path = '/project/policies/session-invalidation'
|
|
3267
3544
|
|
|
3268
3545
|
if enabled.nil?
|
|
3269
|
-
|
|
3546
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3270
3547
|
end
|
|
3271
3548
|
|
|
3272
3549
|
api_params = {
|
|
3273
3550
|
enabled: enabled,
|
|
3274
3551
|
}
|
|
3275
|
-
|
|
3552
|
+
|
|
3276
3553
|
api_headers = {
|
|
3277
3554
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3278
3555
|
"content-type": 'application/json',
|
|
@@ -3286,7 +3563,6 @@ module Appwrite
|
|
|
3286
3563
|
params: api_params,
|
|
3287
3564
|
response_type: Models::Project
|
|
3288
3565
|
)
|
|
3289
|
-
|
|
3290
3566
|
end
|
|
3291
3567
|
|
|
3292
3568
|
# Update the maximum number of sessions allowed per user. When the limit is
|
|
@@ -3295,17 +3571,19 @@ module Appwrite
|
|
|
3295
3571
|
# @param [Integer] total Set the maximum number of sessions allowed per user. Value can be between 1 and 100.
|
|
3296
3572
|
#
|
|
3297
3573
|
# @return [Project]
|
|
3298
|
-
def update_session_limit_policy(
|
|
3574
|
+
def update_session_limit_policy(
|
|
3575
|
+
total:
|
|
3576
|
+
)
|
|
3299
3577
|
api_path = '/project/policies/session-limit'
|
|
3300
3578
|
|
|
3301
3579
|
if total.nil?
|
|
3302
|
-
|
|
3580
|
+
raise Appwrite::Exception.new('Missing required parameter: "total"')
|
|
3303
3581
|
end
|
|
3304
3582
|
|
|
3305
3583
|
api_params = {
|
|
3306
3584
|
total: total,
|
|
3307
3585
|
}
|
|
3308
|
-
|
|
3586
|
+
|
|
3309
3587
|
api_headers = {
|
|
3310
3588
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3311
3589
|
"content-type": 'application/json',
|
|
@@ -3319,7 +3597,6 @@ module Appwrite
|
|
|
3319
3597
|
params: api_params,
|
|
3320
3598
|
response_type: Models::Project
|
|
3321
3599
|
)
|
|
3322
|
-
|
|
3323
3600
|
end
|
|
3324
3601
|
|
|
3325
3602
|
# Update the maximum number of users in the project. When the limit is hit or
|
|
@@ -3329,17 +3606,19 @@ module Appwrite
|
|
|
3329
3606
|
# @param [Integer] total Set the maximum number of users allowed in the project. Value can be between 0 and 10000. Use 0 or null to disable the limit.
|
|
3330
3607
|
#
|
|
3331
3608
|
# @return [Project]
|
|
3332
|
-
def update_user_limit_policy(
|
|
3609
|
+
def update_user_limit_policy(
|
|
3610
|
+
total:
|
|
3611
|
+
)
|
|
3333
3612
|
api_path = '/project/policies/user-limit'
|
|
3334
3613
|
|
|
3335
3614
|
if total.nil?
|
|
3336
|
-
|
|
3615
|
+
raise Appwrite::Exception.new('Missing required parameter: "total"')
|
|
3337
3616
|
end
|
|
3338
3617
|
|
|
3339
3618
|
api_params = {
|
|
3340
3619
|
total: total,
|
|
3341
3620
|
}
|
|
3342
|
-
|
|
3621
|
+
|
|
3343
3622
|
api_headers = {
|
|
3344
3623
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3345
3624
|
"content-type": 'application/json',
|
|
@@ -3353,7 +3632,6 @@ module Appwrite
|
|
|
3353
3632
|
params: api_params,
|
|
3354
3633
|
response_type: Models::Project
|
|
3355
3634
|
)
|
|
3356
|
-
|
|
3357
3635
|
end
|
|
3358
3636
|
|
|
3359
3637
|
# Get a policy by its unique ID. This endpoint returns the current
|
|
@@ -3362,17 +3640,18 @@ module Appwrite
|
|
|
3362
3640
|
# @param [ProjectPolicyId] policy_id Policy ID. Can be one of: password-dictionary, password-history, password-strength, password-personal-data, session-alert, session-duration, session-invalidation, session-limit, user-limit, membership-privacy, mfa-factors, deny-aliased-email, deny-disposable-email, deny-free-email, deny-corporate-email.
|
|
3363
3641
|
#
|
|
3364
3642
|
# @return [PolicyPasswordDictionary, PolicyPasswordHistory, PolicyPasswordStrength, PolicyPasswordPersonalData, PolicySessionAlert, PolicySessionDuration, PolicySessionInvalidation, PolicySessionLimit, PolicyUserLimit, PolicyMembershipPrivacy, PolicyMfaFactors, PolicyDenyAliasedEmail, PolicyDenyDisposableEmail, PolicyDenyFreeEmail, PolicyDenyCorporateEmail]
|
|
3365
|
-
def get_policy(
|
|
3643
|
+
def get_policy(
|
|
3644
|
+
policy_id:
|
|
3645
|
+
)
|
|
3366
3646
|
api_path = '/project/policies/{policyId}'
|
|
3367
3647
|
.gsub('{policyId}', policy_id)
|
|
3368
3648
|
|
|
3369
3649
|
if policy_id.nil?
|
|
3370
|
-
|
|
3650
|
+
raise Appwrite::Exception.new('Missing required parameter: "policyId"')
|
|
3371
3651
|
end
|
|
3372
3652
|
|
|
3373
|
-
api_params = {
|
|
3374
|
-
|
|
3375
|
-
|
|
3653
|
+
api_params = {}
|
|
3654
|
+
|
|
3376
3655
|
api_headers = {
|
|
3377
3656
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3378
3657
|
"accept": 'application/json',
|
|
@@ -3465,32 +3744,34 @@ module Appwrite
|
|
|
3465
3744
|
end
|
|
3466
3745
|
|
|
3467
3746
|
raise Exception, "Unable to match response to any expected response model"
|
|
3468
|
-
|
|
3469
3747
|
end
|
|
3470
3748
|
|
|
3471
3749
|
# Update properties of a specific protocol. Use this endpoint to enable or
|
|
3472
|
-
# disable a protocol in your project.
|
|
3750
|
+
# disable a protocol in your project.
|
|
3473
3751
|
#
|
|
3474
3752
|
# @param [ProjectProtocolId] protocol_id Protocol name. Can be one of: rest, graphql, websocket
|
|
3475
3753
|
# @param [] enabled Protocol status.
|
|
3476
3754
|
#
|
|
3477
3755
|
# @return [Project]
|
|
3478
|
-
def update_protocol(
|
|
3756
|
+
def update_protocol(
|
|
3757
|
+
protocol_id:,
|
|
3758
|
+
enabled:
|
|
3759
|
+
)
|
|
3479
3760
|
api_path = '/project/protocols/{protocolId}'
|
|
3480
3761
|
.gsub('{protocolId}', protocol_id)
|
|
3481
3762
|
|
|
3482
3763
|
if protocol_id.nil?
|
|
3483
|
-
|
|
3764
|
+
raise Appwrite::Exception.new('Missing required parameter: "protocolId"')
|
|
3484
3765
|
end
|
|
3485
3766
|
|
|
3486
3767
|
if enabled.nil?
|
|
3487
|
-
|
|
3768
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3488
3769
|
end
|
|
3489
3770
|
|
|
3490
3771
|
api_params = {
|
|
3491
3772
|
enabled: enabled,
|
|
3492
3773
|
}
|
|
3493
|
-
|
|
3774
|
+
|
|
3494
3775
|
api_headers = {
|
|
3495
3776
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3496
3777
|
"content-type": 'application/json',
|
|
@@ -3504,32 +3785,34 @@ module Appwrite
|
|
|
3504
3785
|
params: api_params,
|
|
3505
3786
|
response_type: Models::Project
|
|
3506
3787
|
)
|
|
3507
|
-
|
|
3508
3788
|
end
|
|
3509
3789
|
|
|
3510
3790
|
# Update properties of a specific service. Use this endpoint to enable or
|
|
3511
|
-
# disable a service in your project.
|
|
3791
|
+
# disable a service in your project.
|
|
3512
3792
|
#
|
|
3513
3793
|
# @param [ProjectServiceId] service_id Service name. Can be one of: account, avatars, databases, tablesdb, locale, health, project, storage, teams, users, vcs, sites, functions, proxy, graphql, migrations, messaging, advisor, oauth2
|
|
3514
3794
|
# @param [] enabled Service status.
|
|
3515
3795
|
#
|
|
3516
3796
|
# @return [Project]
|
|
3517
|
-
def update_service(
|
|
3797
|
+
def update_service(
|
|
3798
|
+
service_id:,
|
|
3799
|
+
enabled:
|
|
3800
|
+
)
|
|
3518
3801
|
api_path = '/project/services/{serviceId}'
|
|
3519
3802
|
.gsub('{serviceId}', service_id)
|
|
3520
3803
|
|
|
3521
3804
|
if service_id.nil?
|
|
3522
|
-
|
|
3805
|
+
raise Appwrite::Exception.new('Missing required parameter: "serviceId"')
|
|
3523
3806
|
end
|
|
3524
3807
|
|
|
3525
3808
|
if enabled.nil?
|
|
3526
|
-
|
|
3809
|
+
raise Appwrite::Exception.new('Missing required parameter: "enabled"')
|
|
3527
3810
|
end
|
|
3528
3811
|
|
|
3529
3812
|
api_params = {
|
|
3530
3813
|
enabled: enabled,
|
|
3531
3814
|
}
|
|
3532
|
-
|
|
3815
|
+
|
|
3533
3816
|
api_headers = {
|
|
3534
3817
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3535
3818
|
"content-type": 'application/json',
|
|
@@ -3543,11 +3826,10 @@ module Appwrite
|
|
|
3543
3826
|
params: api_params,
|
|
3544
3827
|
response_type: Models::Project
|
|
3545
3828
|
)
|
|
3546
|
-
|
|
3547
3829
|
end
|
|
3548
3830
|
|
|
3549
3831
|
# Update the SMTP configuration for your project. Use this endpoint to
|
|
3550
|
-
# configure your project
|
|
3832
|
+
# configure your project's SMTP provider with your custom settings for
|
|
3551
3833
|
# sending transactional emails.
|
|
3552
3834
|
#
|
|
3553
3835
|
# @param [String] host SMTP server hostname (domain)
|
|
@@ -3562,7 +3844,18 @@ module Appwrite
|
|
|
3562
3844
|
# @param [] enabled Enable or disable custom SMTP. Custom SMTP is useful for branding purposes, but also allows use of custom email templates.
|
|
3563
3845
|
#
|
|
3564
3846
|
# @return [Project]
|
|
3565
|
-
def update_smtp(
|
|
3847
|
+
def update_smtp(
|
|
3848
|
+
host: nil,
|
|
3849
|
+
port: nil,
|
|
3850
|
+
username: nil,
|
|
3851
|
+
password: nil,
|
|
3852
|
+
sender_email: nil,
|
|
3853
|
+
sender_name: nil,
|
|
3854
|
+
reply_to_email: nil,
|
|
3855
|
+
reply_to_name: nil,
|
|
3856
|
+
secure: nil,
|
|
3857
|
+
enabled: nil
|
|
3858
|
+
)
|
|
3566
3859
|
api_path = '/project/smtp'
|
|
3567
3860
|
|
|
3568
3861
|
api_params = {
|
|
@@ -3577,7 +3870,7 @@ module Appwrite
|
|
|
3577
3870
|
secure: secure,
|
|
3578
3871
|
enabled: enabled,
|
|
3579
3872
|
}
|
|
3580
|
-
|
|
3873
|
+
|
|
3581
3874
|
api_headers = {
|
|
3582
3875
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3583
3876
|
"content-type": 'application/json',
|
|
@@ -3591,25 +3884,26 @@ module Appwrite
|
|
|
3591
3884
|
params: api_params,
|
|
3592
3885
|
response_type: Models::Project
|
|
3593
3886
|
)
|
|
3594
|
-
|
|
3595
3887
|
end
|
|
3596
3888
|
|
|
3597
|
-
# Send a test email to verify SMTP configuration.
|
|
3889
|
+
# Send a test email to verify SMTP configuration.
|
|
3598
3890
|
#
|
|
3599
3891
|
# @param [Array] emails Array of emails to send test email to. Maximum of 10 emails are allowed.
|
|
3600
3892
|
#
|
|
3601
3893
|
# @return []
|
|
3602
|
-
def create_smtp_test(
|
|
3894
|
+
def create_smtp_test(
|
|
3895
|
+
emails:
|
|
3896
|
+
)
|
|
3603
3897
|
api_path = '/project/smtp/tests'
|
|
3604
3898
|
|
|
3605
3899
|
if emails.nil?
|
|
3606
|
-
|
|
3900
|
+
raise Appwrite::Exception.new('Missing required parameter: "emails"')
|
|
3607
3901
|
end
|
|
3608
3902
|
|
|
3609
3903
|
api_params = {
|
|
3610
3904
|
emails: emails,
|
|
3611
3905
|
}
|
|
3612
|
-
|
|
3906
|
+
|
|
3613
3907
|
api_headers = {
|
|
3614
3908
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3615
3909
|
"content-type": 'application/json',
|
|
@@ -3621,7 +3915,6 @@ module Appwrite
|
|
|
3621
3915
|
headers: api_headers,
|
|
3622
3916
|
params: api_params,
|
|
3623
3917
|
)
|
|
3624
|
-
|
|
3625
3918
|
end
|
|
3626
3919
|
|
|
3627
3920
|
# Get a list of all custom email templates configured for the project. This
|
|
@@ -3632,14 +3925,17 @@ module Appwrite
|
|
|
3632
3925
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
3633
3926
|
#
|
|
3634
3927
|
# @return [EmailTemplateList]
|
|
3635
|
-
def list_email_templates(
|
|
3928
|
+
def list_email_templates(
|
|
3929
|
+
queries: nil,
|
|
3930
|
+
total: nil
|
|
3931
|
+
)
|
|
3636
3932
|
api_path = '/project/templates/email'
|
|
3637
3933
|
|
|
3638
3934
|
api_params = {
|
|
3639
3935
|
queries: queries,
|
|
3640
3936
|
total: total,
|
|
3641
3937
|
}
|
|
3642
|
-
|
|
3938
|
+
|
|
3643
3939
|
api_headers = {
|
|
3644
3940
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3645
3941
|
"accept": 'application/json',
|
|
@@ -3652,7 +3948,6 @@ module Appwrite
|
|
|
3652
3948
|
params: api_params,
|
|
3653
3949
|
response_type: Models::EmailTemplateList
|
|
3654
3950
|
)
|
|
3655
|
-
|
|
3656
3951
|
end
|
|
3657
3952
|
|
|
3658
3953
|
# Update a custom email template for the specified locale and type. Use this
|
|
@@ -3668,11 +3963,20 @@ module Appwrite
|
|
|
3668
3963
|
# @param [String] reply_to_name Reply to name.
|
|
3669
3964
|
#
|
|
3670
3965
|
# @return [EmailTemplate]
|
|
3671
|
-
def update_email_template(
|
|
3966
|
+
def update_email_template(
|
|
3967
|
+
template_id:,
|
|
3968
|
+
locale: nil,
|
|
3969
|
+
subject: nil,
|
|
3970
|
+
message: nil,
|
|
3971
|
+
sender_name: nil,
|
|
3972
|
+
sender_email: nil,
|
|
3973
|
+
reply_to_email: nil,
|
|
3974
|
+
reply_to_name: nil
|
|
3975
|
+
)
|
|
3672
3976
|
api_path = '/project/templates/email'
|
|
3673
3977
|
|
|
3674
3978
|
if template_id.nil?
|
|
3675
|
-
|
|
3979
|
+
raise Appwrite::Exception.new('Missing required parameter: "templateId"')
|
|
3676
3980
|
end
|
|
3677
3981
|
|
|
3678
3982
|
api_params = {
|
|
@@ -3685,7 +3989,7 @@ module Appwrite
|
|
|
3685
3989
|
replyToEmail: reply_to_email,
|
|
3686
3990
|
replyToName: reply_to_name,
|
|
3687
3991
|
}
|
|
3688
|
-
|
|
3992
|
+
|
|
3689
3993
|
api_headers = {
|
|
3690
3994
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3691
3995
|
"content-type": 'application/json',
|
|
@@ -3699,7 +4003,6 @@ module Appwrite
|
|
|
3699
4003
|
params: api_params,
|
|
3700
4004
|
response_type: Models::EmailTemplate
|
|
3701
4005
|
)
|
|
3702
|
-
|
|
3703
4006
|
end
|
|
3704
4007
|
|
|
3705
4008
|
# Get a custom email template for the specified locale and type. This
|
|
@@ -3710,18 +4013,21 @@ module Appwrite
|
|
|
3710
4013
|
# @param [ProjectEmailTemplateLocale] locale Custom email template locale. If left empty, the fallback locale (en) will be used.
|
|
3711
4014
|
#
|
|
3712
4015
|
# @return [EmailTemplate]
|
|
3713
|
-
def get_email_template(
|
|
4016
|
+
def get_email_template(
|
|
4017
|
+
template_id:,
|
|
4018
|
+
locale: nil
|
|
4019
|
+
)
|
|
3714
4020
|
api_path = '/project/templates/email/{templateId}'
|
|
3715
4021
|
.gsub('{templateId}', template_id)
|
|
3716
4022
|
|
|
3717
4023
|
if template_id.nil?
|
|
3718
|
-
|
|
4024
|
+
raise Appwrite::Exception.new('Missing required parameter: "templateId"')
|
|
3719
4025
|
end
|
|
3720
4026
|
|
|
3721
4027
|
api_params = {
|
|
3722
4028
|
locale: locale,
|
|
3723
4029
|
}
|
|
3724
|
-
|
|
4030
|
+
|
|
3725
4031
|
api_headers = {
|
|
3726
4032
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3727
4033
|
"accept": 'application/json',
|
|
@@ -3734,7 +4040,6 @@ module Appwrite
|
|
|
3734
4040
|
params: api_params,
|
|
3735
4041
|
response_type: Models::EmailTemplate
|
|
3736
4042
|
)
|
|
3737
|
-
|
|
3738
4043
|
end
|
|
3739
4044
|
|
|
3740
4045
|
# Get a list of all project environment variables.
|
|
@@ -3743,14 +4048,17 @@ module Appwrite
|
|
|
3743
4048
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
3744
4049
|
#
|
|
3745
4050
|
# @return [VariableList]
|
|
3746
|
-
def list_variables(
|
|
4051
|
+
def list_variables(
|
|
4052
|
+
queries: nil,
|
|
4053
|
+
total: nil
|
|
4054
|
+
)
|
|
3747
4055
|
api_path = '/project/variables'
|
|
3748
4056
|
|
|
3749
4057
|
api_params = {
|
|
3750
4058
|
queries: queries,
|
|
3751
4059
|
total: total,
|
|
3752
4060
|
}
|
|
3753
|
-
|
|
4061
|
+
|
|
3754
4062
|
api_headers = {
|
|
3755
4063
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3756
4064
|
"accept": 'application/json',
|
|
@@ -3763,31 +4071,35 @@ module Appwrite
|
|
|
3763
4071
|
params: api_params,
|
|
3764
4072
|
response_type: Models::VariableList
|
|
3765
4073
|
)
|
|
3766
|
-
|
|
3767
4074
|
end
|
|
3768
4075
|
|
|
3769
4076
|
# Create a new project environment variable. These variables can be accessed
|
|
3770
4077
|
# by all functions and sites in the project.
|
|
3771
4078
|
#
|
|
3772
|
-
# @param [String] variable_id Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can
|
|
3773
|
-
# @param [String] key Variable key. Max length: 255 chars.
|
|
4079
|
+
# @param [String] variable_id Variable unique ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
4080
|
+
# @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
|
|
3774
4081
|
# @param [String] value Variable value. Max length: 8192 chars.
|
|
3775
4082
|
# @param [] secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
3776
4083
|
#
|
|
3777
4084
|
# @return [Variable]
|
|
3778
|
-
def create_variable(
|
|
4085
|
+
def create_variable(
|
|
4086
|
+
variable_id:,
|
|
4087
|
+
key:,
|
|
4088
|
+
value:,
|
|
4089
|
+
secret: nil
|
|
4090
|
+
)
|
|
3779
4091
|
api_path = '/project/variables'
|
|
3780
4092
|
|
|
3781
4093
|
if variable_id.nil?
|
|
3782
|
-
|
|
4094
|
+
raise Appwrite::Exception.new('Missing required parameter: "variableId"')
|
|
3783
4095
|
end
|
|
3784
4096
|
|
|
3785
4097
|
if key.nil?
|
|
3786
|
-
|
|
4098
|
+
raise Appwrite::Exception.new('Missing required parameter: "key"')
|
|
3787
4099
|
end
|
|
3788
4100
|
|
|
3789
4101
|
if value.nil?
|
|
3790
|
-
|
|
4102
|
+
raise Appwrite::Exception.new('Missing required parameter: "value"')
|
|
3791
4103
|
end
|
|
3792
4104
|
|
|
3793
4105
|
api_params = {
|
|
@@ -3796,7 +4108,7 @@ module Appwrite
|
|
|
3796
4108
|
value: value,
|
|
3797
4109
|
secret: secret,
|
|
3798
4110
|
}
|
|
3799
|
-
|
|
4111
|
+
|
|
3800
4112
|
api_headers = {
|
|
3801
4113
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3802
4114
|
"content-type": 'application/json',
|
|
@@ -3810,25 +4122,25 @@ module Appwrite
|
|
|
3810
4122
|
params: api_params,
|
|
3811
4123
|
response_type: Models::Variable
|
|
3812
4124
|
)
|
|
3813
|
-
|
|
3814
4125
|
end
|
|
3815
4126
|
|
|
3816
|
-
# Get a variable by its unique ID.
|
|
4127
|
+
# Get a variable by its unique ID.
|
|
3817
4128
|
#
|
|
3818
4129
|
# @param [String] variable_id Variable unique ID.
|
|
3819
4130
|
#
|
|
3820
4131
|
# @return [Variable]
|
|
3821
|
-
def get_variable(
|
|
4132
|
+
def get_variable(
|
|
4133
|
+
variable_id:
|
|
4134
|
+
)
|
|
3822
4135
|
api_path = '/project/variables/{variableId}'
|
|
3823
4136
|
.gsub('{variableId}', variable_id)
|
|
3824
4137
|
|
|
3825
4138
|
if variable_id.nil?
|
|
3826
|
-
|
|
4139
|
+
raise Appwrite::Exception.new('Missing required parameter: "variableId"')
|
|
3827
4140
|
end
|
|
3828
4141
|
|
|
3829
|
-
api_params = {
|
|
3830
|
-
|
|
3831
|
-
|
|
4142
|
+
api_params = {}
|
|
4143
|
+
|
|
3832
4144
|
api_headers = {
|
|
3833
4145
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3834
4146
|
"accept": 'application/json',
|
|
@@ -3841,23 +4153,27 @@ module Appwrite
|
|
|
3841
4153
|
params: api_params,
|
|
3842
4154
|
response_type: Models::Variable
|
|
3843
4155
|
)
|
|
3844
|
-
|
|
3845
4156
|
end
|
|
3846
4157
|
|
|
3847
4158
|
# Update variable by its unique ID.
|
|
3848
4159
|
#
|
|
3849
4160
|
# @param [String] variable_id Variable unique ID.
|
|
3850
|
-
# @param [String] key Variable key. Max length: 255 chars.
|
|
4161
|
+
# @param [String] key Variable key. Letters, digits and underscores only, must not start with a digit. Max length: 255 chars.
|
|
3851
4162
|
# @param [String] value Variable value. Max length: 8192 chars.
|
|
3852
4163
|
# @param [] secret Secret variables can be updated or deleted, but only projects can read them during build and runtime.
|
|
3853
4164
|
#
|
|
3854
4165
|
# @return [Variable]
|
|
3855
|
-
def update_variable(
|
|
4166
|
+
def update_variable(
|
|
4167
|
+
variable_id:,
|
|
4168
|
+
key: nil,
|
|
4169
|
+
value: nil,
|
|
4170
|
+
secret: nil
|
|
4171
|
+
)
|
|
3856
4172
|
api_path = '/project/variables/{variableId}'
|
|
3857
4173
|
.gsub('{variableId}', variable_id)
|
|
3858
4174
|
|
|
3859
4175
|
if variable_id.nil?
|
|
3860
|
-
|
|
4176
|
+
raise Appwrite::Exception.new('Missing required parameter: "variableId"')
|
|
3861
4177
|
end
|
|
3862
4178
|
|
|
3863
4179
|
api_params = {
|
|
@@ -3865,7 +4181,7 @@ module Appwrite
|
|
|
3865
4181
|
value: value,
|
|
3866
4182
|
secret: secret,
|
|
3867
4183
|
}
|
|
3868
|
-
|
|
4184
|
+
|
|
3869
4185
|
api_headers = {
|
|
3870
4186
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3871
4187
|
"content-type": 'application/json',
|
|
@@ -3879,25 +4195,25 @@ module Appwrite
|
|
|
3879
4195
|
params: api_params,
|
|
3880
4196
|
response_type: Models::Variable
|
|
3881
4197
|
)
|
|
3882
|
-
|
|
3883
4198
|
end
|
|
3884
4199
|
|
|
3885
|
-
# Delete a variable by its unique ID.
|
|
4200
|
+
# Delete a variable by its unique ID.
|
|
3886
4201
|
#
|
|
3887
4202
|
# @param [String] variable_id Variable unique ID.
|
|
3888
4203
|
#
|
|
3889
4204
|
# @return []
|
|
3890
|
-
def delete_variable(
|
|
4205
|
+
def delete_variable(
|
|
4206
|
+
variable_id:
|
|
4207
|
+
)
|
|
3891
4208
|
api_path = '/project/variables/{variableId}'
|
|
3892
4209
|
.gsub('{variableId}', variable_id)
|
|
3893
4210
|
|
|
3894
4211
|
if variable_id.nil?
|
|
3895
|
-
|
|
4212
|
+
raise Appwrite::Exception.new('Missing required parameter: "variableId"')
|
|
3896
4213
|
end
|
|
3897
4214
|
|
|
3898
|
-
api_params = {
|
|
3899
|
-
|
|
3900
|
-
|
|
4215
|
+
api_params = {}
|
|
4216
|
+
|
|
3901
4217
|
api_headers = {
|
|
3902
4218
|
"X-Appwrite-Project": @client.get_config('project'),
|
|
3903
4219
|
"content-type": 'application/json',
|
|
@@ -3909,8 +4225,6 @@ module Appwrite
|
|
|
3909
4225
|
headers: api_headers,
|
|
3910
4226
|
params: api_params,
|
|
3911
4227
|
)
|
|
3912
|
-
|
|
3913
4228
|
end
|
|
3914
|
-
|
|
3915
|
-
end
|
|
4229
|
+
end
|
|
3916
4230
|
end
|