volcano-sdk 0.5.2
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 +7 -0
- data/LICENSE +203 -0
- data/README.md +758 -0
- data/lib/volcano/auth.rb +113 -0
- data/lib/volcano/auth_anonymous.rb +51 -0
- data/lib/volcano/auth_confirm_email.rb +19 -0
- data/lib/volcano/auth_email_change.rb +75 -0
- data/lib/volcano/auth_get_user.rb +110 -0
- data/lib/volcano/auth_hosted.rb +43 -0
- data/lib/volcano/auth_oauth.rb +102 -0
- data/lib/volcano/auth_oauth_api.rb +51 -0
- data/lib/volcano/auth_oauth_sign_in.rb +61 -0
- data/lib/volcano/auth_oauth_token.rb +51 -0
- data/lib/volcano/auth_refresh.rb +117 -0
- data/lib/volcano/auth_resend_confirmation.rb +19 -0
- data/lib/volcano/auth_reset_password.rb +23 -0
- data/lib/volcano/auth_reset_password_for_email.rb +19 -0
- data/lib/volcano/auth_sessions.rb +139 -0
- data/lib/volcano/auth_sign_up.rb +40 -0
- data/lib/volcano/auth_state.rb +148 -0
- data/lib/volcano/auth_update_user.rb +32 -0
- data/lib/volcano/client.rb +121 -0
- data/lib/volcano/connection_string.rb +85 -0
- data/lib/volcano/database.rb +243 -0
- data/lib/volcano/errors.rb +38 -0
- data/lib/volcano/function_resolution.rb +120 -0
- data/lib/volcano/function_response.rb +26 -0
- data/lib/volcano/functions.rb +136 -0
- data/lib/volcano/generated/lib/volcano-generated/api/anon_keys_api.rb +471 -0
- data/lib/volcano/generated/lib/volcano-generated/api/auth_admin_api.rb +739 -0
- data/lib/volcano/generated/lib/volcano-generated/api/auth_configuration_api.rb +1798 -0
- data/lib/volcano/generated/lib/volcano-generated/api/authentication_api.rb +1523 -0
- data/lib/volcano/generated/lib/volcano-generated/api/database_backups_api.rb +791 -0
- data/lib/volcano/generated/lib/volcano-generated/api/database_branches_api.rb +665 -0
- data/lib/volcano/generated/lib/volcano-generated/api/database_queries_api.rb +905 -0
- data/lib/volcano/generated/lib/volcano-generated/api/databases_api.rb +819 -0
- data/lib/volcano/generated/lib/volcano-generated/api/frontends_api.rb +913 -0
- data/lib/volcano/generated/lib/volcano-generated/api/functions_api.rb +1355 -0
- data/lib/volcano/generated/lib/volcano-generated/api/git_connections_api.rb +1012 -0
- data/lib/volcano/generated/lib/volcano-generated/api/locks_api.rb +480 -0
- data/lib/volcano/generated/lib/volcano-generated/api/logs_api.rb +250 -0
- data/lib/volcano/generated/lib/volcano-generated/api/o_auth_authentication_api.rb +962 -0
- data/lib/volcano/generated/lib/volcano-generated/api/o_auth_configuration_api.rb +452 -0
- data/lib/volcano/generated/lib/volcano-generated/api/project_imports_api.rb +599 -0
- data/lib/volcano/generated/lib/volcano-generated/api/projects_api.rb +1862 -0
- data/lib/volcano/generated/lib/volcano-generated/api/realtime_api.rb +222 -0
- data/lib/volcano/generated/lib/volcano-generated/api/service_keys_api.rb +402 -0
- data/lib/volcano/generated/lib/volcano-generated/api/storage_admin_api.rb +189 -0
- data/lib/volcano/generated/lib/volcano-generated/api/storage_buckets_api.rb +437 -0
- data/lib/volcano/generated/lib/volcano-generated/api/storage_objects_api.rb +857 -0
- data/lib/volcano/generated/lib/volcano-generated/api/storage_policies_api.rb +277 -0
- data/lib/volcano/generated/lib/volcano-generated/api/system_api.rb +79 -0
- data/lib/volcano/generated/lib/volcano-generated/api/variables_api.rb +454 -0
- data/lib/volcano/generated/lib/volcano-generated/api_client.rb +393 -0
- data/lib/volcano/generated/lib/volcano-generated/api_error.rb +58 -0
- data/lib/volcano/generated/lib/volcano-generated/api_model_base.rb +88 -0
- data/lib/volcano/generated/lib/volcano-generated/configuration.rb +337 -0
- data/lib/volcano/generated/lib/volcano-generated/models/anon_key.rb +257 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_config.rb +728 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_confirm_email200_response.rb +181 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_confirm_email_change200_response.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_confirm_email_change_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_confirm_email_request.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_convert_anonymous200_response.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_device_authorize_request.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_device_token_request.rb +240 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_device_verify200_response.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_device_verify_request.rb +209 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_forgot_password200_response.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_forgot_password_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_get_my_sessions200_response.rb +231 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_hosted_page.rb +225 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_hosted_page_defaults.rb +193 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_hosted_page_response.rb +203 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_hosted_page_runtime.rb +220 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_identities_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_identity.rb +273 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_insights_interval.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_insights_response.rb +270 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_insights_series_point.rb +263 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_insights_summary.rb +210 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_insights_window.rb +238 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_link_o_auth_provider200_response.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_list_o_auth_providers200_response.rb +149 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_list_o_auth_providers200_response_providers_inner.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_method_summary.rb +370 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_methods_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_o_auth_exchange_request.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_appearance_defaults.rb +212 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_appearance_options.rb +306 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_appearance_response.rb +299 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_density.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_font.rb +43 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_layout.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_radius.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_scale.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_theme.rb +318 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_page_theme_colors.rb +323 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_password_policy.rb +409 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_platform_exchange_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_refresh_request.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_request_email_change200_response.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_request_email_change_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_reset_password200_response.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_reset_password_request.rb +192 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_session.rb +393 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_signin_request.rb +233 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_signup_anonymous_request.rb +150 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_signup_request.rb +202 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_signup_response.rb +193 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_token_response.rb +254 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_update_user_request.rb +160 -0
- data/lib/volcano/generated/lib/volcano-generated/models/auth_user.rb +330 -0
- data/lib/volcano/generated/lib/volcano-generated/models/ban_auth_user_request.rb +148 -0
- data/lib/volcano/generated/lib/volcano-generated/models/ban_user_response.rb +278 -0
- data/lib/volcano/generated/lib/volcano-generated/models/batch_function_deploy_failure.rb +242 -0
- data/lib/volcano/generated/lib/volcano-generated/models/batch_function_deploy_response.rb +205 -0
- data/lib/volcano/generated/lib/volcano-generated/models/call_o_auth_provider_api200_response.rb +272 -0
- data/lib/volcano/generated/lib/volcano-generated/models/call_o_auth_provider_api_request.rb +223 -0
- data/lib/volcano/generated/lib/volcano-generated/models/complete_upload_session_response.rb +148 -0
- data/lib/volcano/generated/lib/volcano-generated/models/configure_auth_methods_request.rb +167 -0
- data/lib/volcano/generated/lib/volcano-generated/models/configure_auth_methods_request_oauth_providers_inner.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/connect_project_git_request.rb +250 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_anon_key_request.rb +228 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_database_backup_request.rb +185 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_database_branch_request.rb +223 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_database_request.rb +290 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_database_restore_request.rb +187 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_email_template_request.rb +270 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_frontend_custom_domain_request.rb +191 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_function_scheduler_request.rb +252 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_o_auth_config_request.rb +230 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_project_request.rb +219 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_service_key_request.rb +206 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_storage_bucket_request.rb +216 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_storage_policy_request.rb +243 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_upload_session_request.rb +276 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_upload_session_response.rb +179 -0
- data/lib/volcano/generated/lib/volcano-generated/models/create_variable_request.rb +219 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database.rb +442 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_backup.rb +283 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_backup_list.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_backup_schedule.rb +167 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_backup_schedule_entry.rb +301 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_branch.rb +480 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_branch_list.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_branch_storage.rb +228 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_delete_request.rb +203 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_insert_request.rb +194 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_filter.rb +242 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_filter_value.rb +106 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_filter_value_one_of_inner.rb +105 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_order.rb +187 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_performance_database.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_performance_item.rb +411 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_performance_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_query_result.rb +161 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_restore.rb +388 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_restore_list.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_restore_window.rb +159 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_select_request.rb +268 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_stats.rb +447 -0
- data/lib/volcano/generated/lib/volcano-generated/models/database_update_request.rb +232 -0
- data/lib/volcano/generated/lib/volcano-generated/models/delete_database202_response.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/delete_database_backup200_response.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/delete_database_branch202_response.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/deployment_phase.rb +263 -0
- data/lib/volcano/generated/lib/volcano-generated/models/deployment_progress.rb +324 -0
- data/lib/volcano/generated/lib/volcano-generated/models/deployment_reference.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/device_authorization_response.rb +296 -0
- data/lib/volcano/generated/lib/volcano-generated/models/email_template.rb +305 -0
- data/lib/volcano/generated/lib/volcano-generated/models/error.rb +174 -0
- data/lib/volcano/generated/lib/volcano-generated/models/export_project_source_request.rb +174 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend.rb +504 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_custom_domain_response.rb +370 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_custom_domain_tls_config.rb +253 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_deployment.rb +487 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_domain_routing_record.rb +240 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_domain_verification_record.rb +216 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_usage_daily_entry.rb +247 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_usage_data.rb +204 -0
- data/lib/volcano/generated/lib/volcano-generated/models/frontend_usage_history_response.rb +298 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function.rb +565 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_deployment.rb +477 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_http_auth_mode.rb +40 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_invocation_mode.rb +40 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_invocation_request.rb +150 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_region.rb +219 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_runtime_deployment.rb +250 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_runtime_option.rb +245 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_runtimes_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_scheduler.rb +330 -0
- data/lib/volcano/generated/lib/volcano-generated/models/function_scheduler_list_response.rb +290 -0
- data/lib/volcano/generated/lib/volcano-generated/models/get_auth_methods200_response.rb +178 -0
- data/lib/volcano/generated/lib/volcano-generated/models/get_auth_methods200_response_email_password.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/get_auth_methods200_response_oauth_providers_inner.rb +194 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_connect_start_response.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_connection.rb +346 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_connections_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_installation.rb +242 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_installations_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_repositories_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/git_repository.rb +270 -0
- data/lib/volcano/generated/lib/volcano-generated/models/hosted_auth_page_type.rb +44 -0
- data/lib/volcano/generated/lib/volcano-generated/models/hosted_login_email_check_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/hosted_login_email_check_response.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/hosted_login_options_response.rb +185 -0
- data/lib/volcano/generated/lib/volcano-generated/models/hosted_renderable_page_type.rb +43 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_connect_start_response.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_connection.rb +432 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_connections_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_provider.rb +39 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_source.rb +242 -0
- data/lib/volcano/generated/lib/volcano-generated/models/import_sources_response.rb +166 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_anon_keys200_response.rb +189 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_available_o_auth_providers200_response.rb +149 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_available_o_auth_providers200_response_providers_inner.rb +167 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_database_regions200_response_inner.rb +158 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_email_templates200_response.rb +149 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_o_auth_configs200_response.rb +149 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_postgres_versions200_response_inner.rb +178 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_storage_buckets200_response.rb +104 -0
- data/lib/volcano/generated/lib/volcano-generated/models/list_storage_objects_admin200_response.rb +205 -0
- data/lib/volcano/generated/lib/volcano-generated/models/live_log_level.rb +44 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_activity_bucket.rb +246 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_activity_bucket_counts.rb +226 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_activity_request.rb +252 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_activity_response.rb +194 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_database_request_resource.rb +221 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_deployment.rb +210 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_deployment_request_selector.rb +170 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_event.rb +257 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_event_body.rb +108 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_frontend_request_resource.rb +230 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_function_request_resource.rb +230 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_request_resource.rb +58 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_resource.rb +227 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_search_event.rb +297 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_search_request.rb +264 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_search_response.rb +232 -0
- data/lib/volcano/generated/lib/volcano-generated/models/log_stream_request.rb +244 -0
- data/lib/volcano/generated/lib/volcano-generated/models/metric_usage_data.rb +278 -0
- data/lib/volcano/generated/lib/volcano-generated/models/o_auth_config.rb +256 -0
- data/lib/volcano/generated/lib/volcano-generated/models/o_auth_error_response.rb +173 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_auth_users.rb +284 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_databases.rb +304 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_frontend_deployments.rb +284 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_frontends.rb +304 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_function_deployments.rb +284 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_functions.rb +304 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_project_custom_domains.rb +284 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_project_deployments.rb +306 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_projects.rb +368 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_service_keys.rb +304 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_storage_buckets.rb +251 -0
- data/lib/volcano/generated/lib/volcano-generated/models/paginated_variables.rb +304 -0
- data/lib/volcano/generated/lib/volcano-generated/models/platform_exchange_response.rb +242 -0
- data/lib/volcano/generated/lib/volcano-generated/models/preview_auth_page_request.rb +221 -0
- data/lib/volcano/generated/lib/volcano-generated/models/preview_auth_page_response.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project.rb +419 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config.rb +273 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_apply_result.rb +261 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_apply_result_entry.rb +245 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_apply_summary.rb +320 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth.rb +238 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_cors.rb +176 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_email.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_email_from.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_email_password_provider.rb +147 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_email_smtp.rb +184 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_email_verification.rb +158 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_managed_pages.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_page_appearance.rb +156 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_page_layouts.rb +214 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_password.rb +211 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_password_reset.rb +167 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_providers.rb +159 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_rate_limits.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_redirects.rb +180 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_sessions.rb +158 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_signup.rb +232 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_auth_tokens.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_bucket.rb +226 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_bucket_policy.rb +250 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_custom_domain.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_database.rb +274 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_email_template.rb +205 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_email_templates.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_frontend.rb +183 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_function.rb +248 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_hosted_page.rb +203 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_hosted_pages.rb +193 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_missing_resource.rb +214 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_o_auth_provider.rb +238 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_project.rb +209 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_realtime.rb +174 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_scheduler.rb +229 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_skipped_resource.rb +240 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_validation_error.rb +201 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_validation_error_response.rb +193 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_config_variable.rb +199 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_deployment.rb +412 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_deployment_resource.rb +241 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_deployment_summary.rb +312 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_frontend_custom_domain.rb +403 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_frontend_custom_domain_all_of_frontend.rb +191 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_git_connection.rb +296 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_git_connection_summary.rb +294 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_git_deploy_settings.rb +239 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_category.rb +40 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_check.rb +316 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_data_status.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_evidence.rb +251 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_resource.rb +240 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_response.rb +356 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_scope.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_status.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_health_summary.rb +186 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_action.rb +238 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_action_code.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_destination.rb +238 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_destination_mode.rb +39 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_disposition.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_finding.rb +327 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_impact.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_preflight_request.rb +305 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_readiness.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_report.rb +476 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_resource.rb +270 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_resource_kind.rb +43 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_run.rb +412 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_run_status.rb +43 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_start_request.rb +365 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_summary.rb +348 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_import_target.rb +39 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_lock_lease.rb +192 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_lock_lease_request.rb +183 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_lock_state.rb +185 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_data_status.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_dimensions.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_group_by.rb +40 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_metric.rb +42 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_query.rb +250 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_query_request.rb +210 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_query_response.rb +227 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_query_time_range.rb +188 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_result.rb +292 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_unit.rb +41 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_value.rb +199 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_metrics_window.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_source_export.rb +302 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_source_export_omission.rb +218 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_source_export_skip.rb +217 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_source_export_state.rb +228 -0
- data/lib/volcano/generated/lib/volcano-generated/models/project_usage_response.rb +234 -0
- data/lib/volcano/generated/lib/volcano-generated/models/realtime_config.rb +217 -0
- data/lib/volcano/generated/lib/volcano-generated/models/realtime_plan_limits.rb +189 -0
- data/lib/volcano/generated/lib/volcano-generated/models/realtime_stats.rb +178 -0
- data/lib/volcano/generated/lib/volcano-generated/models/refresh_o_auth_provider_token200_response.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/reset_database_password200_response.rb +177 -0
- data/lib/volcano/generated/lib/volcano-generated/models/resolve_function_response.rb +248 -0
- data/lib/volcano/generated/lib/volcano-generated/models/resource_reference.rb +241 -0
- data/lib/volcano/generated/lib/volcano-generated/models/schedule_request.rb +210 -0
- data/lib/volcano/generated/lib/volcano-generated/models/service_key.rb +294 -0
- data/lib/volcano/generated/lib/volcano-generated/models/set_project_git_production_branch_request.rb +183 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_bucket.rb +282 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_copy_request.rb +192 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_list_response.rb +159 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_move_request.rb +192 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_object.rb +359 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_object_with_bucket.rb +383 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_policy.rb +313 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_stats.rb +220 -0
- data/lib/volcano/generated/lib/volcano-generated/models/storage_visibility_request.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/test_email_request.rb +234 -0
- data/lib/volcano/generated/lib/volcano-generated/models/test_email_response.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/unban_user_response.rb +267 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_auth_config_request.rb +626 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_auth_hosted_page_request.rb +175 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_auth_page_layout_request.rb +186 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_auth_page_theme_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_database_branch_request.rb +184 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_database_type_request.rb +190 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_email_template_request.rb +165 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_function_request.rb +201 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_function_scheduler_request.rb +225 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_o_auth_config_request.rb +187 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_project_git_deploy_settings_request.rb +211 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_project_request.rb +198 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_realtime_config_request.rb +179 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_storage_bucket_request.rb +158 -0
- data/lib/volcano/generated/lib/volcano-generated/models/update_variable_request.rb +164 -0
- data/lib/volcano/generated/lib/volcano-generated/models/upload_session_part.rb +169 -0
- data/lib/volcano/generated/lib/volcano-generated/models/upload_session_status_response.rb +295 -0
- data/lib/volcano/generated/lib/volcano-generated/models/upload_storage_object201_response.rb +104 -0
- data/lib/volcano/generated/lib/volcano-generated/models/usage_data_point.rb +193 -0
- data/lib/volcano/generated/lib/volcano-generated/models/variable.rb +389 -0
- data/lib/volcano/generated/lib/volcano-generated/version.rb +15 -0
- data/lib/volcano/generated/lib/volcano-generated.rb +405 -0
- data/lib/volcano/generated_transport.rb +131 -0
- data/lib/volcano/generated_transport_anonymous.rb +34 -0
- data/lib/volcano/generated_transport_auth.rb +108 -0
- data/lib/volcano/generated_transport_confirmation.rb +30 -0
- data/lib/volcano/generated_transport_database.rb +54 -0
- data/lib/volcano/generated_transport_email_change.rb +44 -0
- data/lib/volcano/generated_transport_functions.rb +108 -0
- data/lib/volcano/generated_transport_logs.rb +31 -0
- data/lib/volcano/generated_transport_oauth.rb +64 -0
- data/lib/volcano/generated_transport_sessions.rb +27 -0
- data/lib/volcano/generated_transport_storage.rb +86 -0
- data/lib/volcano/generated_transport_support.rb +221 -0
- data/lib/volcano/generated_transport_upload_session_api.rb +69 -0
- data/lib/volcano/generated_transport_upload_sessions.rb +67 -0
- data/lib/volcano/lock_auto_renewal.rb +51 -0
- data/lib/volcano/lock_guard.rb +135 -0
- data/lib/volcano/lock_lease_clock.rb +39 -0
- data/lib/volcano/lock_renewer.rb +73 -0
- data/lib/volcano/lock_session.rb +70 -0
- data/lib/volcano/locks.rb +109 -0
- data/lib/volcano/log_responses.rb +39 -0
- data/lib/volcano/logs.rb +82 -0
- data/lib/volcano/models.rb +115 -0
- data/lib/volcano/realtime/blocking_call.rb +32 -0
- data/lib/volcano/realtime/broadcast_delivery.rb +63 -0
- data/lib/volcano/realtime/channel_callbacks.rb +127 -0
- data/lib/volcano/realtime/channel_lifecycle.rb +133 -0
- data/lib/volcano/realtime/connection.rb +114 -0
- data/lib/volcano/realtime/connection_callbacks.rb +126 -0
- data/lib/volcano/realtime/lifecycle.rb +46 -0
- data/lib/volcano/realtime/postgres_batch.rb +89 -0
- data/lib/volcano/realtime/postgres_changes.rb +107 -0
- data/lib/volcano/realtime/postgres_database.rb +63 -0
- data/lib/volcano/realtime/postgres_delivery.rb +113 -0
- data/lib/volcano/realtime/postgres_expansion.rb +66 -0
- data/lib/volcano/realtime/presence.rb +122 -0
- data/lib/volcano/realtime/presence_state.rb +61 -0
- data/lib/volcano/realtime/protocol.rb +150 -0
- data/lib/volcano/realtime/protocol_dispatch.rb +114 -0
- data/lib/volcano/realtime/protocol_io.rb +96 -0
- data/lib/volcano/realtime/protocol_lifecycle.rb +122 -0
- data/lib/volcano/realtime/protocol_publication_dispatch.rb +121 -0
- data/lib/volcano/realtime/protocol_recovery.rb +117 -0
- data/lib/volcano/realtime/protocol_recovery_dispatch.rb +106 -0
- data/lib/volcano/realtime/protocol_recovery_position.rb +95 -0
- data/lib/volcano/realtime/reconnect.rb +88 -0
- data/lib/volcano/realtime.rb +260 -0
- data/lib/volcano/redaction.rb +60 -0
- data/lib/volcano/sign_up_result.rb +9 -0
- data/lib/volcano/storage.rb +120 -0
- data/lib/volcano/storage_models.rb +121 -0
- data/lib/volcano/storage_mutations.rb +81 -0
- data/lib/volcano/storage_public_url.rb +64 -0
- data/lib/volcano/storage_resumable_upload.rb +90 -0
- data/lib/volcano/storage_upload_sessions.rb +116 -0
- data/lib/volcano/transport.rb +60 -0
- data/lib/volcano/version.rb +5 -0
- data/lib/volcano.rb +58 -0
- metadata +580 -0
|
@@ -0,0 +1,1798 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#Volcano Hosting API
|
|
3
|
+
|
|
4
|
+
#Public API for Volcano Hosting clients, SDKs, and CLI tooling (Port 8000). This specification intentionally excludes first-party/internal APIs. See api/openapi-internal.yaml for non-public internal and Builder operations.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 3.0.0
|
|
7
|
+
Contact: support@volcano.dev
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.17.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module Volcano::Generated
|
|
16
|
+
class AuthConfigurationApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Configure authentication methods (unified)
|
|
23
|
+
# Configure all authentication methods in a single request. At least one method must remain enabled.
|
|
24
|
+
# @param id [String] Project ID
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @option opts [ConfigureAuthMethodsRequest] :configure_auth_methods_request
|
|
27
|
+
# @return [nil]
|
|
28
|
+
def configure_auth_methods(id, opts = {})
|
|
29
|
+
configure_auth_methods_with_http_info(id, opts)
|
|
30
|
+
nil
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Configure authentication methods (unified)
|
|
34
|
+
# Configure all authentication methods in a single request. At least one method must remain enabled.
|
|
35
|
+
# @param id [String] Project ID
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @option opts [ConfigureAuthMethodsRequest] :configure_auth_methods_request
|
|
38
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
39
|
+
def configure_auth_methods_with_http_info(id, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.configure_auth_methods ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'id' is set
|
|
44
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.configure_auth_methods"
|
|
46
|
+
end
|
|
47
|
+
# resource path
|
|
48
|
+
local_var_path = '/projects/{id}/auth/methods'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
49
|
+
|
|
50
|
+
# query parameters
|
|
51
|
+
query_params = opts[:query_params] || {}
|
|
52
|
+
|
|
53
|
+
# header parameters
|
|
54
|
+
header_params = opts[:header_params] || {}
|
|
55
|
+
# HTTP header 'Content-Type'
|
|
56
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
57
|
+
if !content_type.nil?
|
|
58
|
+
header_params['Content-Type'] = content_type
|
|
59
|
+
end
|
|
60
|
+
|
|
61
|
+
# form parameters
|
|
62
|
+
form_params = opts[:form_params] || {}
|
|
63
|
+
|
|
64
|
+
# http body (model)
|
|
65
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'configure_auth_methods_request'])
|
|
66
|
+
|
|
67
|
+
# return_type
|
|
68
|
+
return_type = opts[:debug_return_type]
|
|
69
|
+
|
|
70
|
+
# auth_names
|
|
71
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
72
|
+
|
|
73
|
+
new_options = opts.merge(
|
|
74
|
+
:operation => :"AuthConfigurationApi.configure_auth_methods",
|
|
75
|
+
:header_params => header_params,
|
|
76
|
+
:query_params => query_params,
|
|
77
|
+
:form_params => form_params,
|
|
78
|
+
:body => post_body,
|
|
79
|
+
:auth_names => auth_names,
|
|
80
|
+
:return_type => return_type
|
|
81
|
+
)
|
|
82
|
+
|
|
83
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
84
|
+
if @api_client.config.debugging
|
|
85
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#configure_auth_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
86
|
+
end
|
|
87
|
+
return data, status_code, headers
|
|
88
|
+
end
|
|
89
|
+
|
|
90
|
+
# Create email template
|
|
91
|
+
# Creates a custom email template for the project. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403, and FREE projects always send the built-in default templates regardless of any previously saved custom rows. Every project is created with one template per type, so customizing one is usually a PUT; creating a type the project already has returns 409. Valid template types: welcome, confirmation, password_reset, password_changed
|
|
92
|
+
# @param id [String] Project ID
|
|
93
|
+
# @param create_email_template_request [CreateEmailTemplateRequest]
|
|
94
|
+
# @param [Hash] opts the optional parameters
|
|
95
|
+
# @return [EmailTemplate]
|
|
96
|
+
def create_email_template(id, create_email_template_request, opts = {})
|
|
97
|
+
data, _status_code, _headers = create_email_template_with_http_info(id, create_email_template_request, opts)
|
|
98
|
+
data
|
|
99
|
+
end
|
|
100
|
+
|
|
101
|
+
# Create email template
|
|
102
|
+
# Creates a custom email template for the project. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403, and FREE projects always send the built-in default templates regardless of any previously saved custom rows. Every project is created with one template per type, so customizing one is usually a PUT; creating a type the project already has returns 409. Valid template types: welcome, confirmation, password_reset, password_changed
|
|
103
|
+
# @param id [String] Project ID
|
|
104
|
+
# @param create_email_template_request [CreateEmailTemplateRequest]
|
|
105
|
+
# @param [Hash] opts the optional parameters
|
|
106
|
+
# @return [Array<(EmailTemplate, Integer, Hash)>] EmailTemplate data, response status code and response headers
|
|
107
|
+
def create_email_template_with_http_info(id, create_email_template_request, opts = {})
|
|
108
|
+
if @api_client.config.debugging
|
|
109
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.create_email_template ...'
|
|
110
|
+
end
|
|
111
|
+
# verify the required parameter 'id' is set
|
|
112
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
113
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.create_email_template"
|
|
114
|
+
end
|
|
115
|
+
# verify the required parameter 'create_email_template_request' is set
|
|
116
|
+
if @api_client.config.client_side_validation && create_email_template_request.nil?
|
|
117
|
+
fail ArgumentError, "Missing the required parameter 'create_email_template_request' when calling AuthConfigurationApi.create_email_template"
|
|
118
|
+
end
|
|
119
|
+
# resource path
|
|
120
|
+
local_var_path = '/projects/{id}/email-templates'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
121
|
+
|
|
122
|
+
# query parameters
|
|
123
|
+
query_params = opts[:query_params] || {}
|
|
124
|
+
|
|
125
|
+
# header parameters
|
|
126
|
+
header_params = opts[:header_params] || {}
|
|
127
|
+
# HTTP header 'Accept' (if needed)
|
|
128
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
129
|
+
# HTTP header 'Content-Type'
|
|
130
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
131
|
+
if !content_type.nil?
|
|
132
|
+
header_params['Content-Type'] = content_type
|
|
133
|
+
end
|
|
134
|
+
|
|
135
|
+
# form parameters
|
|
136
|
+
form_params = opts[:form_params] || {}
|
|
137
|
+
|
|
138
|
+
# http body (model)
|
|
139
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(create_email_template_request)
|
|
140
|
+
|
|
141
|
+
# return_type
|
|
142
|
+
return_type = opts[:debug_return_type] || 'EmailTemplate'
|
|
143
|
+
|
|
144
|
+
# auth_names
|
|
145
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
146
|
+
|
|
147
|
+
new_options = opts.merge(
|
|
148
|
+
:operation => :"AuthConfigurationApi.create_email_template",
|
|
149
|
+
:header_params => header_params,
|
|
150
|
+
:query_params => query_params,
|
|
151
|
+
:form_params => form_params,
|
|
152
|
+
:body => post_body,
|
|
153
|
+
:auth_names => auth_names,
|
|
154
|
+
:return_type => return_type
|
|
155
|
+
)
|
|
156
|
+
|
|
157
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
158
|
+
if @api_client.config.debugging
|
|
159
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#create_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
160
|
+
end
|
|
161
|
+
return data, status_code, headers
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Clear one managed auth page layout
|
|
165
|
+
# @param id [String] Project ID
|
|
166
|
+
# @param page_type [HostedAuthPageType]
|
|
167
|
+
# @param [Hash] opts the optional parameters
|
|
168
|
+
# @return [nil]
|
|
169
|
+
def delete_auth_page_layout(id, page_type, opts = {})
|
|
170
|
+
delete_auth_page_layout_with_http_info(id, page_type, opts)
|
|
171
|
+
nil
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# Clear one managed auth page layout
|
|
175
|
+
# @param id [String] Project ID
|
|
176
|
+
# @param page_type [HostedAuthPageType]
|
|
177
|
+
# @param [Hash] opts the optional parameters
|
|
178
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
179
|
+
def delete_auth_page_layout_with_http_info(id, page_type, opts = {})
|
|
180
|
+
if @api_client.config.debugging
|
|
181
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.delete_auth_page_layout ...'
|
|
182
|
+
end
|
|
183
|
+
# verify the required parameter 'id' is set
|
|
184
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
185
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.delete_auth_page_layout"
|
|
186
|
+
end
|
|
187
|
+
# verify the required parameter 'page_type' is set
|
|
188
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
189
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.delete_auth_page_layout"
|
|
190
|
+
end
|
|
191
|
+
# resource path
|
|
192
|
+
local_var_path = '/projects/{id}/auth/pages/{pageType}/layout'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
193
|
+
|
|
194
|
+
# query parameters
|
|
195
|
+
query_params = opts[:query_params] || {}
|
|
196
|
+
|
|
197
|
+
# header parameters
|
|
198
|
+
header_params = opts[:header_params] || {}
|
|
199
|
+
# HTTP header 'Accept' (if needed)
|
|
200
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
201
|
+
|
|
202
|
+
# form parameters
|
|
203
|
+
form_params = opts[:form_params] || {}
|
|
204
|
+
|
|
205
|
+
# http body (model)
|
|
206
|
+
post_body = opts[:debug_body]
|
|
207
|
+
|
|
208
|
+
# return_type
|
|
209
|
+
return_type = opts[:debug_return_type]
|
|
210
|
+
|
|
211
|
+
# auth_names
|
|
212
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
213
|
+
|
|
214
|
+
new_options = opts.merge(
|
|
215
|
+
:operation => :"AuthConfigurationApi.delete_auth_page_layout",
|
|
216
|
+
:header_params => header_params,
|
|
217
|
+
:query_params => query_params,
|
|
218
|
+
:form_params => form_params,
|
|
219
|
+
:body => post_body,
|
|
220
|
+
:auth_names => auth_names,
|
|
221
|
+
:return_type => return_type
|
|
222
|
+
)
|
|
223
|
+
|
|
224
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
225
|
+
if @api_client.config.debugging
|
|
226
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#delete_auth_page_layout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
227
|
+
end
|
|
228
|
+
return data, status_code, headers
|
|
229
|
+
end
|
|
230
|
+
|
|
231
|
+
# Clear the managed auth page theme
|
|
232
|
+
# @param id [String] Project ID
|
|
233
|
+
# @param [Hash] opts the optional parameters
|
|
234
|
+
# @return [nil]
|
|
235
|
+
def delete_auth_page_theme(id, opts = {})
|
|
236
|
+
delete_auth_page_theme_with_http_info(id, opts)
|
|
237
|
+
nil
|
|
238
|
+
end
|
|
239
|
+
|
|
240
|
+
# Clear the managed auth page theme
|
|
241
|
+
# @param id [String] Project ID
|
|
242
|
+
# @param [Hash] opts the optional parameters
|
|
243
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
244
|
+
def delete_auth_page_theme_with_http_info(id, opts = {})
|
|
245
|
+
if @api_client.config.debugging
|
|
246
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.delete_auth_page_theme ...'
|
|
247
|
+
end
|
|
248
|
+
# verify the required parameter 'id' is set
|
|
249
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
250
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.delete_auth_page_theme"
|
|
251
|
+
end
|
|
252
|
+
# resource path
|
|
253
|
+
local_var_path = '/projects/{id}/auth/pages/theme'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
254
|
+
|
|
255
|
+
# query parameters
|
|
256
|
+
query_params = opts[:query_params] || {}
|
|
257
|
+
|
|
258
|
+
# header parameters
|
|
259
|
+
header_params = opts[:header_params] || {}
|
|
260
|
+
# HTTP header 'Accept' (if needed)
|
|
261
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
262
|
+
|
|
263
|
+
# form parameters
|
|
264
|
+
form_params = opts[:form_params] || {}
|
|
265
|
+
|
|
266
|
+
# http body (model)
|
|
267
|
+
post_body = opts[:debug_body]
|
|
268
|
+
|
|
269
|
+
# return_type
|
|
270
|
+
return_type = opts[:debug_return_type]
|
|
271
|
+
|
|
272
|
+
# auth_names
|
|
273
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
274
|
+
|
|
275
|
+
new_options = opts.merge(
|
|
276
|
+
:operation => :"AuthConfigurationApi.delete_auth_page_theme",
|
|
277
|
+
:header_params => header_params,
|
|
278
|
+
:query_params => query_params,
|
|
279
|
+
:form_params => form_params,
|
|
280
|
+
:body => post_body,
|
|
281
|
+
:auth_names => auth_names,
|
|
282
|
+
:return_type => return_type
|
|
283
|
+
)
|
|
284
|
+
|
|
285
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
286
|
+
if @api_client.config.debugging
|
|
287
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#delete_auth_page_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
288
|
+
end
|
|
289
|
+
return data, status_code, headers
|
|
290
|
+
end
|
|
291
|
+
|
|
292
|
+
# Delete email template
|
|
293
|
+
# Deletes a custom template, reverting to the default. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403.
|
|
294
|
+
# @param id [String] Project ID
|
|
295
|
+
# @param type [String]
|
|
296
|
+
# @param [Hash] opts the optional parameters
|
|
297
|
+
# @return [nil]
|
|
298
|
+
def delete_email_template(id, type, opts = {})
|
|
299
|
+
delete_email_template_with_http_info(id, type, opts)
|
|
300
|
+
nil
|
|
301
|
+
end
|
|
302
|
+
|
|
303
|
+
# Delete email template
|
|
304
|
+
# Deletes a custom template, reverting to the default. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403.
|
|
305
|
+
# @param id [String] Project ID
|
|
306
|
+
# @param type [String]
|
|
307
|
+
# @param [Hash] opts the optional parameters
|
|
308
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
309
|
+
def delete_email_template_with_http_info(id, type, opts = {})
|
|
310
|
+
if @api_client.config.debugging
|
|
311
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.delete_email_template ...'
|
|
312
|
+
end
|
|
313
|
+
# verify the required parameter 'id' is set
|
|
314
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
315
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.delete_email_template"
|
|
316
|
+
end
|
|
317
|
+
# verify the required parameter 'type' is set
|
|
318
|
+
if @api_client.config.client_side_validation && type.nil?
|
|
319
|
+
fail ArgumentError, "Missing the required parameter 'type' when calling AuthConfigurationApi.delete_email_template"
|
|
320
|
+
end
|
|
321
|
+
# verify enum value
|
|
322
|
+
allowable_values = ["welcome", "confirmation", "password_reset", "password_changed"]
|
|
323
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(type)
|
|
324
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
325
|
+
end
|
|
326
|
+
# resource path
|
|
327
|
+
local_var_path = '/projects/{id}/email-templates/{type}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'type' + '}', CGI.escape(type.to_s))
|
|
328
|
+
|
|
329
|
+
# query parameters
|
|
330
|
+
query_params = opts[:query_params] || {}
|
|
331
|
+
|
|
332
|
+
# header parameters
|
|
333
|
+
header_params = opts[:header_params] || {}
|
|
334
|
+
# HTTP header 'Accept' (if needed)
|
|
335
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
336
|
+
|
|
337
|
+
# form parameters
|
|
338
|
+
form_params = opts[:form_params] || {}
|
|
339
|
+
|
|
340
|
+
# http body (model)
|
|
341
|
+
post_body = opts[:debug_body]
|
|
342
|
+
|
|
343
|
+
# return_type
|
|
344
|
+
return_type = opts[:debug_return_type]
|
|
345
|
+
|
|
346
|
+
# auth_names
|
|
347
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
348
|
+
|
|
349
|
+
new_options = opts.merge(
|
|
350
|
+
:operation => :"AuthConfigurationApi.delete_email_template",
|
|
351
|
+
:header_params => header_params,
|
|
352
|
+
:query_params => query_params,
|
|
353
|
+
:form_params => form_params,
|
|
354
|
+
:body => post_body,
|
|
355
|
+
:auth_names => auth_names,
|
|
356
|
+
:return_type => return_type
|
|
357
|
+
)
|
|
358
|
+
|
|
359
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
360
|
+
if @api_client.config.debugging
|
|
361
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#delete_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
362
|
+
end
|
|
363
|
+
return data, status_code, headers
|
|
364
|
+
end
|
|
365
|
+
|
|
366
|
+
# Get auth configuration
|
|
367
|
+
# @param id [String] Project ID
|
|
368
|
+
# @param [Hash] opts the optional parameters
|
|
369
|
+
# @return [AuthConfig]
|
|
370
|
+
def get_auth_config(id, opts = {})
|
|
371
|
+
data, _status_code, _headers = get_auth_config_with_http_info(id, opts)
|
|
372
|
+
data
|
|
373
|
+
end
|
|
374
|
+
|
|
375
|
+
# Get auth configuration
|
|
376
|
+
# @param id [String] Project ID
|
|
377
|
+
# @param [Hash] opts the optional parameters
|
|
378
|
+
# @return [Array<(AuthConfig, Integer, Hash)>] AuthConfig data, response status code and response headers
|
|
379
|
+
def get_auth_config_with_http_info(id, opts = {})
|
|
380
|
+
if @api_client.config.debugging
|
|
381
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_auth_config ...'
|
|
382
|
+
end
|
|
383
|
+
# verify the required parameter 'id' is set
|
|
384
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
385
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_auth_config"
|
|
386
|
+
end
|
|
387
|
+
# resource path
|
|
388
|
+
local_var_path = '/projects/{id}/auth/config'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
389
|
+
|
|
390
|
+
# query parameters
|
|
391
|
+
query_params = opts[:query_params] || {}
|
|
392
|
+
|
|
393
|
+
# header parameters
|
|
394
|
+
header_params = opts[:header_params] || {}
|
|
395
|
+
# HTTP header 'Accept' (if needed)
|
|
396
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
397
|
+
|
|
398
|
+
# form parameters
|
|
399
|
+
form_params = opts[:form_params] || {}
|
|
400
|
+
|
|
401
|
+
# http body (model)
|
|
402
|
+
post_body = opts[:debug_body]
|
|
403
|
+
|
|
404
|
+
# return_type
|
|
405
|
+
return_type = opts[:debug_return_type] || 'AuthConfig'
|
|
406
|
+
|
|
407
|
+
# auth_names
|
|
408
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
409
|
+
|
|
410
|
+
new_options = opts.merge(
|
|
411
|
+
:operation => :"AuthConfigurationApi.get_auth_config",
|
|
412
|
+
:header_params => header_params,
|
|
413
|
+
:query_params => query_params,
|
|
414
|
+
:form_params => form_params,
|
|
415
|
+
:body => post_body,
|
|
416
|
+
:auth_names => auth_names,
|
|
417
|
+
:return_type => return_type
|
|
418
|
+
)
|
|
419
|
+
|
|
420
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
421
|
+
if @api_client.config.debugging
|
|
422
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
423
|
+
end
|
|
424
|
+
return data, status_code, headers
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
# Get hosted auth page
|
|
428
|
+
# Returns the saved HTML/CSS for the page type, or `page: null` when the project has not customized it yet. Always returns `defaults` (the theme shell to seed an editor with, which is valid input to the update endpoint) and `runtime` (the script the rendered page runs, plus a preview harness).
|
|
429
|
+
# @param id [String] Project ID
|
|
430
|
+
# @param page_type [HostedAuthPageType]
|
|
431
|
+
# @param [Hash] opts the optional parameters
|
|
432
|
+
# @return [AuthHostedPageResponse]
|
|
433
|
+
def get_auth_hosted_page(id, page_type, opts = {})
|
|
434
|
+
data, _status_code, _headers = get_auth_hosted_page_with_http_info(id, page_type, opts)
|
|
435
|
+
data
|
|
436
|
+
end
|
|
437
|
+
|
|
438
|
+
# Get hosted auth page
|
|
439
|
+
# Returns the saved HTML/CSS for the page type, or `page: null` when the project has not customized it yet. Always returns `defaults` (the theme shell to seed an editor with, which is valid input to the update endpoint) and `runtime` (the script the rendered page runs, plus a preview harness).
|
|
440
|
+
# @param id [String] Project ID
|
|
441
|
+
# @param page_type [HostedAuthPageType]
|
|
442
|
+
# @param [Hash] opts the optional parameters
|
|
443
|
+
# @return [Array<(AuthHostedPageResponse, Integer, Hash)>] AuthHostedPageResponse data, response status code and response headers
|
|
444
|
+
def get_auth_hosted_page_with_http_info(id, page_type, opts = {})
|
|
445
|
+
if @api_client.config.debugging
|
|
446
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_auth_hosted_page ...'
|
|
447
|
+
end
|
|
448
|
+
# verify the required parameter 'id' is set
|
|
449
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
450
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_auth_hosted_page"
|
|
451
|
+
end
|
|
452
|
+
# verify the required parameter 'page_type' is set
|
|
453
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
454
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.get_auth_hosted_page"
|
|
455
|
+
end
|
|
456
|
+
# resource path
|
|
457
|
+
local_var_path = '/projects/{id}/auth/hosted-pages/{pageType}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
458
|
+
|
|
459
|
+
# query parameters
|
|
460
|
+
query_params = opts[:query_params] || {}
|
|
461
|
+
|
|
462
|
+
# header parameters
|
|
463
|
+
header_params = opts[:header_params] || {}
|
|
464
|
+
# HTTP header 'Accept' (if needed)
|
|
465
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
466
|
+
|
|
467
|
+
# form parameters
|
|
468
|
+
form_params = opts[:form_params] || {}
|
|
469
|
+
|
|
470
|
+
# http body (model)
|
|
471
|
+
post_body = opts[:debug_body]
|
|
472
|
+
|
|
473
|
+
# return_type
|
|
474
|
+
return_type = opts[:debug_return_type] || 'AuthHostedPageResponse'
|
|
475
|
+
|
|
476
|
+
# auth_names
|
|
477
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
478
|
+
|
|
479
|
+
new_options = opts.merge(
|
|
480
|
+
:operation => :"AuthConfigurationApi.get_auth_hosted_page",
|
|
481
|
+
:header_params => header_params,
|
|
482
|
+
:query_params => query_params,
|
|
483
|
+
:form_params => form_params,
|
|
484
|
+
:body => post_body,
|
|
485
|
+
:auth_names => auth_names,
|
|
486
|
+
:return_type => return_type
|
|
487
|
+
)
|
|
488
|
+
|
|
489
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
490
|
+
if @api_client.config.debugging
|
|
491
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_auth_hosted_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
492
|
+
end
|
|
493
|
+
return data, status_code, headers
|
|
494
|
+
end
|
|
495
|
+
|
|
496
|
+
# Get all authentication methods
|
|
497
|
+
# Returns all configured authentication methods for this project, including email/password, anonymous, device authorization, and OAuth providers.
|
|
498
|
+
# @param id [String] Project ID
|
|
499
|
+
# @param [Hash] opts the optional parameters
|
|
500
|
+
# @return [GetAuthMethods200Response]
|
|
501
|
+
def get_auth_methods(id, opts = {})
|
|
502
|
+
data, _status_code, _headers = get_auth_methods_with_http_info(id, opts)
|
|
503
|
+
data
|
|
504
|
+
end
|
|
505
|
+
|
|
506
|
+
# Get all authentication methods
|
|
507
|
+
# Returns all configured authentication methods for this project, including email/password, anonymous, device authorization, and OAuth providers.
|
|
508
|
+
# @param id [String] Project ID
|
|
509
|
+
# @param [Hash] opts the optional parameters
|
|
510
|
+
# @return [Array<(GetAuthMethods200Response, Integer, Hash)>] GetAuthMethods200Response data, response status code and response headers
|
|
511
|
+
def get_auth_methods_with_http_info(id, opts = {})
|
|
512
|
+
if @api_client.config.debugging
|
|
513
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_auth_methods ...'
|
|
514
|
+
end
|
|
515
|
+
# verify the required parameter 'id' is set
|
|
516
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
517
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_auth_methods"
|
|
518
|
+
end
|
|
519
|
+
# resource path
|
|
520
|
+
local_var_path = '/projects/{id}/auth/methods'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
521
|
+
|
|
522
|
+
# query parameters
|
|
523
|
+
query_params = opts[:query_params] || {}
|
|
524
|
+
|
|
525
|
+
# header parameters
|
|
526
|
+
header_params = opts[:header_params] || {}
|
|
527
|
+
# HTTP header 'Accept' (if needed)
|
|
528
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
529
|
+
|
|
530
|
+
# form parameters
|
|
531
|
+
form_params = opts[:form_params] || {}
|
|
532
|
+
|
|
533
|
+
# http body (model)
|
|
534
|
+
post_body = opts[:debug_body]
|
|
535
|
+
|
|
536
|
+
# return_type
|
|
537
|
+
return_type = opts[:debug_return_type] || 'GetAuthMethods200Response'
|
|
538
|
+
|
|
539
|
+
# auth_names
|
|
540
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
541
|
+
|
|
542
|
+
new_options = opts.merge(
|
|
543
|
+
:operation => :"AuthConfigurationApi.get_auth_methods",
|
|
544
|
+
:header_params => header_params,
|
|
545
|
+
:query_params => query_params,
|
|
546
|
+
:form_params => form_params,
|
|
547
|
+
:body => post_body,
|
|
548
|
+
:auth_names => auth_names,
|
|
549
|
+
:return_type => return_type
|
|
550
|
+
)
|
|
551
|
+
|
|
552
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
553
|
+
if @api_client.config.debugging
|
|
554
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_auth_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
555
|
+
end
|
|
556
|
+
return data, status_code, headers
|
|
557
|
+
end
|
|
558
|
+
|
|
559
|
+
# Get managed auth page appearance
|
|
560
|
+
# @param id [String] Project ID
|
|
561
|
+
# @param [Hash] opts the optional parameters
|
|
562
|
+
# @return [AuthPageAppearanceResponse]
|
|
563
|
+
def get_auth_page_appearance(id, opts = {})
|
|
564
|
+
data, _status_code, _headers = get_auth_page_appearance_with_http_info(id, opts)
|
|
565
|
+
data
|
|
566
|
+
end
|
|
567
|
+
|
|
568
|
+
# Get managed auth page appearance
|
|
569
|
+
# @param id [String] Project ID
|
|
570
|
+
# @param [Hash] opts the optional parameters
|
|
571
|
+
# @return [Array<(AuthPageAppearanceResponse, Integer, Hash)>] AuthPageAppearanceResponse data, response status code and response headers
|
|
572
|
+
def get_auth_page_appearance_with_http_info(id, opts = {})
|
|
573
|
+
if @api_client.config.debugging
|
|
574
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_auth_page_appearance ...'
|
|
575
|
+
end
|
|
576
|
+
# verify the required parameter 'id' is set
|
|
577
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
578
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_auth_page_appearance"
|
|
579
|
+
end
|
|
580
|
+
# resource path
|
|
581
|
+
local_var_path = '/projects/{id}/auth/pages/appearance'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
582
|
+
|
|
583
|
+
# query parameters
|
|
584
|
+
query_params = opts[:query_params] || {}
|
|
585
|
+
|
|
586
|
+
# header parameters
|
|
587
|
+
header_params = opts[:header_params] || {}
|
|
588
|
+
# HTTP header 'Accept' (if needed)
|
|
589
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
590
|
+
|
|
591
|
+
# form parameters
|
|
592
|
+
form_params = opts[:form_params] || {}
|
|
593
|
+
|
|
594
|
+
# http body (model)
|
|
595
|
+
post_body = opts[:debug_body]
|
|
596
|
+
|
|
597
|
+
# return_type
|
|
598
|
+
return_type = opts[:debug_return_type] || 'AuthPageAppearanceResponse'
|
|
599
|
+
|
|
600
|
+
# auth_names
|
|
601
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
602
|
+
|
|
603
|
+
new_options = opts.merge(
|
|
604
|
+
:operation => :"AuthConfigurationApi.get_auth_page_appearance",
|
|
605
|
+
:header_params => header_params,
|
|
606
|
+
:query_params => query_params,
|
|
607
|
+
:form_params => form_params,
|
|
608
|
+
:body => post_body,
|
|
609
|
+
:auth_names => auth_names,
|
|
610
|
+
:return_type => return_type
|
|
611
|
+
)
|
|
612
|
+
|
|
613
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
614
|
+
if @api_client.config.debugging
|
|
615
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_auth_page_appearance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
616
|
+
end
|
|
617
|
+
return data, status_code, headers
|
|
618
|
+
end
|
|
619
|
+
|
|
620
|
+
# Get default email template by type
|
|
621
|
+
# @param type [String]
|
|
622
|
+
# @param [Hash] opts the optional parameters
|
|
623
|
+
# @return [EmailTemplate]
|
|
624
|
+
def get_default_email_template(type, opts = {})
|
|
625
|
+
data, _status_code, _headers = get_default_email_template_with_http_info(type, opts)
|
|
626
|
+
data
|
|
627
|
+
end
|
|
628
|
+
|
|
629
|
+
# Get default email template by type
|
|
630
|
+
# @param type [String]
|
|
631
|
+
# @param [Hash] opts the optional parameters
|
|
632
|
+
# @return [Array<(EmailTemplate, Integer, Hash)>] EmailTemplate data, response status code and response headers
|
|
633
|
+
def get_default_email_template_with_http_info(type, opts = {})
|
|
634
|
+
if @api_client.config.debugging
|
|
635
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_default_email_template ...'
|
|
636
|
+
end
|
|
637
|
+
# verify the required parameter 'type' is set
|
|
638
|
+
if @api_client.config.client_side_validation && type.nil?
|
|
639
|
+
fail ArgumentError, "Missing the required parameter 'type' when calling AuthConfigurationApi.get_default_email_template"
|
|
640
|
+
end
|
|
641
|
+
# verify enum value
|
|
642
|
+
allowable_values = ["welcome", "confirmation", "password_reset", "password_changed"]
|
|
643
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(type)
|
|
644
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
645
|
+
end
|
|
646
|
+
# resource path
|
|
647
|
+
local_var_path = '/email-templates/defaults/{type}'.sub('{' + 'type' + '}', CGI.escape(type.to_s))
|
|
648
|
+
|
|
649
|
+
# query parameters
|
|
650
|
+
query_params = opts[:query_params] || {}
|
|
651
|
+
|
|
652
|
+
# header parameters
|
|
653
|
+
header_params = opts[:header_params] || {}
|
|
654
|
+
# HTTP header 'Accept' (if needed)
|
|
655
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
656
|
+
|
|
657
|
+
# form parameters
|
|
658
|
+
form_params = opts[:form_params] || {}
|
|
659
|
+
|
|
660
|
+
# http body (model)
|
|
661
|
+
post_body = opts[:debug_body]
|
|
662
|
+
|
|
663
|
+
# return_type
|
|
664
|
+
return_type = opts[:debug_return_type] || 'EmailTemplate'
|
|
665
|
+
|
|
666
|
+
# auth_names
|
|
667
|
+
auth_names = opts[:debug_auth_names] || []
|
|
668
|
+
|
|
669
|
+
new_options = opts.merge(
|
|
670
|
+
:operation => :"AuthConfigurationApi.get_default_email_template",
|
|
671
|
+
:header_params => header_params,
|
|
672
|
+
:query_params => query_params,
|
|
673
|
+
:form_params => form_params,
|
|
674
|
+
:body => post_body,
|
|
675
|
+
:auth_names => auth_names,
|
|
676
|
+
:return_type => return_type
|
|
677
|
+
)
|
|
678
|
+
|
|
679
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
680
|
+
if @api_client.config.debugging
|
|
681
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_default_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
682
|
+
end
|
|
683
|
+
return data, status_code, headers
|
|
684
|
+
end
|
|
685
|
+
|
|
686
|
+
# Get default email templates
|
|
687
|
+
# Returns the default email templates used when no custom template is configured.
|
|
688
|
+
# @param [Hash] opts the optional parameters
|
|
689
|
+
# @return [ListEmailTemplates200Response]
|
|
690
|
+
def get_default_email_templates(opts = {})
|
|
691
|
+
data, _status_code, _headers = get_default_email_templates_with_http_info(opts)
|
|
692
|
+
data
|
|
693
|
+
end
|
|
694
|
+
|
|
695
|
+
# Get default email templates
|
|
696
|
+
# Returns the default email templates used when no custom template is configured.
|
|
697
|
+
# @param [Hash] opts the optional parameters
|
|
698
|
+
# @return [Array<(ListEmailTemplates200Response, Integer, Hash)>] ListEmailTemplates200Response data, response status code and response headers
|
|
699
|
+
def get_default_email_templates_with_http_info(opts = {})
|
|
700
|
+
if @api_client.config.debugging
|
|
701
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_default_email_templates ...'
|
|
702
|
+
end
|
|
703
|
+
# resource path
|
|
704
|
+
local_var_path = '/email-templates/defaults'
|
|
705
|
+
|
|
706
|
+
# query parameters
|
|
707
|
+
query_params = opts[:query_params] || {}
|
|
708
|
+
|
|
709
|
+
# header parameters
|
|
710
|
+
header_params = opts[:header_params] || {}
|
|
711
|
+
# HTTP header 'Accept' (if needed)
|
|
712
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
713
|
+
|
|
714
|
+
# form parameters
|
|
715
|
+
form_params = opts[:form_params] || {}
|
|
716
|
+
|
|
717
|
+
# http body (model)
|
|
718
|
+
post_body = opts[:debug_body]
|
|
719
|
+
|
|
720
|
+
# return_type
|
|
721
|
+
return_type = opts[:debug_return_type] || 'ListEmailTemplates200Response'
|
|
722
|
+
|
|
723
|
+
# auth_names
|
|
724
|
+
auth_names = opts[:debug_auth_names] || []
|
|
725
|
+
|
|
726
|
+
new_options = opts.merge(
|
|
727
|
+
:operation => :"AuthConfigurationApi.get_default_email_templates",
|
|
728
|
+
:header_params => header_params,
|
|
729
|
+
:query_params => query_params,
|
|
730
|
+
:form_params => form_params,
|
|
731
|
+
:body => post_body,
|
|
732
|
+
:auth_names => auth_names,
|
|
733
|
+
:return_type => return_type
|
|
734
|
+
)
|
|
735
|
+
|
|
736
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
737
|
+
if @api_client.config.debugging
|
|
738
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_default_email_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
739
|
+
end
|
|
740
|
+
return data, status_code, headers
|
|
741
|
+
end
|
|
742
|
+
|
|
743
|
+
# Get email template
|
|
744
|
+
# @param id [String] Project ID
|
|
745
|
+
# @param type [String]
|
|
746
|
+
# @param [Hash] opts the optional parameters
|
|
747
|
+
# @return [EmailTemplate]
|
|
748
|
+
def get_email_template(id, type, opts = {})
|
|
749
|
+
data, _status_code, _headers = get_email_template_with_http_info(id, type, opts)
|
|
750
|
+
data
|
|
751
|
+
end
|
|
752
|
+
|
|
753
|
+
# Get email template
|
|
754
|
+
# @param id [String] Project ID
|
|
755
|
+
# @param type [String]
|
|
756
|
+
# @param [Hash] opts the optional parameters
|
|
757
|
+
# @return [Array<(EmailTemplate, Integer, Hash)>] EmailTemplate data, response status code and response headers
|
|
758
|
+
def get_email_template_with_http_info(id, type, opts = {})
|
|
759
|
+
if @api_client.config.debugging
|
|
760
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_email_template ...'
|
|
761
|
+
end
|
|
762
|
+
# verify the required parameter 'id' is set
|
|
763
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
764
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_email_template"
|
|
765
|
+
end
|
|
766
|
+
# verify the required parameter 'type' is set
|
|
767
|
+
if @api_client.config.client_side_validation && type.nil?
|
|
768
|
+
fail ArgumentError, "Missing the required parameter 'type' when calling AuthConfigurationApi.get_email_template"
|
|
769
|
+
end
|
|
770
|
+
# verify enum value
|
|
771
|
+
allowable_values = ["welcome", "confirmation", "password_reset", "password_changed"]
|
|
772
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(type)
|
|
773
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
774
|
+
end
|
|
775
|
+
# resource path
|
|
776
|
+
local_var_path = '/projects/{id}/email-templates/{type}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'type' + '}', CGI.escape(type.to_s))
|
|
777
|
+
|
|
778
|
+
# query parameters
|
|
779
|
+
query_params = opts[:query_params] || {}
|
|
780
|
+
|
|
781
|
+
# header parameters
|
|
782
|
+
header_params = opts[:header_params] || {}
|
|
783
|
+
# HTTP header 'Accept' (if needed)
|
|
784
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
785
|
+
|
|
786
|
+
# form parameters
|
|
787
|
+
form_params = opts[:form_params] || {}
|
|
788
|
+
|
|
789
|
+
# http body (model)
|
|
790
|
+
post_body = opts[:debug_body]
|
|
791
|
+
|
|
792
|
+
# return_type
|
|
793
|
+
return_type = opts[:debug_return_type] || 'EmailTemplate'
|
|
794
|
+
|
|
795
|
+
# auth_names
|
|
796
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
797
|
+
|
|
798
|
+
new_options = opts.merge(
|
|
799
|
+
:operation => :"AuthConfigurationApi.get_email_template",
|
|
800
|
+
:header_params => header_params,
|
|
801
|
+
:query_params => query_params,
|
|
802
|
+
:form_params => form_params,
|
|
803
|
+
:body => post_body,
|
|
804
|
+
:auth_names => auth_names,
|
|
805
|
+
:return_type => return_type
|
|
806
|
+
)
|
|
807
|
+
|
|
808
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
809
|
+
if @api_client.config.debugging
|
|
810
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
811
|
+
end
|
|
812
|
+
return data, status_code, headers
|
|
813
|
+
end
|
|
814
|
+
|
|
815
|
+
# Get hosted login runtime options
|
|
816
|
+
# Returns runtime options for the built-in managed login flow. Requires `anon_key` query parameter. Rate limited per project and client IP. Excess requests return `429` and `Retry-After`.
|
|
817
|
+
# @param id [String] Project ID
|
|
818
|
+
# @param anon_key [String]
|
|
819
|
+
# @param [Hash] opts the optional parameters
|
|
820
|
+
# @return [HostedLoginOptionsResponse]
|
|
821
|
+
def get_hosted_login_options(id, anon_key, opts = {})
|
|
822
|
+
data, _status_code, _headers = get_hosted_login_options_with_http_info(id, anon_key, opts)
|
|
823
|
+
data
|
|
824
|
+
end
|
|
825
|
+
|
|
826
|
+
# Get hosted login runtime options
|
|
827
|
+
# Returns runtime options for the built-in managed login flow. Requires `anon_key` query parameter. Rate limited per project and client IP. Excess requests return `429` and `Retry-After`.
|
|
828
|
+
# @param id [String] Project ID
|
|
829
|
+
# @param anon_key [String]
|
|
830
|
+
# @param [Hash] opts the optional parameters
|
|
831
|
+
# @return [Array<(HostedLoginOptionsResponse, Integer, Hash)>] HostedLoginOptionsResponse data, response status code and response headers
|
|
832
|
+
def get_hosted_login_options_with_http_info(id, anon_key, opts = {})
|
|
833
|
+
if @api_client.config.debugging
|
|
834
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.get_hosted_login_options ...'
|
|
835
|
+
end
|
|
836
|
+
# verify the required parameter 'id' is set
|
|
837
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
838
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.get_hosted_login_options"
|
|
839
|
+
end
|
|
840
|
+
# verify the required parameter 'anon_key' is set
|
|
841
|
+
if @api_client.config.client_side_validation && anon_key.nil?
|
|
842
|
+
fail ArgumentError, "Missing the required parameter 'anon_key' when calling AuthConfigurationApi.get_hosted_login_options"
|
|
843
|
+
end
|
|
844
|
+
# resource path
|
|
845
|
+
local_var_path = '/projects/{id}/auth/hosted/login/options'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
846
|
+
|
|
847
|
+
# query parameters
|
|
848
|
+
query_params = opts[:query_params] || {}
|
|
849
|
+
query_params[:'anon_key'] = anon_key
|
|
850
|
+
|
|
851
|
+
# header parameters
|
|
852
|
+
header_params = opts[:header_params] || {}
|
|
853
|
+
# HTTP header 'Accept' (if needed)
|
|
854
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
855
|
+
|
|
856
|
+
# form parameters
|
|
857
|
+
form_params = opts[:form_params] || {}
|
|
858
|
+
|
|
859
|
+
# http body (model)
|
|
860
|
+
post_body = opts[:debug_body]
|
|
861
|
+
|
|
862
|
+
# return_type
|
|
863
|
+
return_type = opts[:debug_return_type] || 'HostedLoginOptionsResponse'
|
|
864
|
+
|
|
865
|
+
# auth_names
|
|
866
|
+
auth_names = opts[:debug_auth_names] || []
|
|
867
|
+
|
|
868
|
+
new_options = opts.merge(
|
|
869
|
+
:operation => :"AuthConfigurationApi.get_hosted_login_options",
|
|
870
|
+
:header_params => header_params,
|
|
871
|
+
:query_params => query_params,
|
|
872
|
+
:form_params => form_params,
|
|
873
|
+
:body => post_body,
|
|
874
|
+
:auth_names => auth_names,
|
|
875
|
+
:return_type => return_type
|
|
876
|
+
)
|
|
877
|
+
|
|
878
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
879
|
+
if @api_client.config.debugging
|
|
880
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#get_hosted_login_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
881
|
+
end
|
|
882
|
+
return data, status_code, headers
|
|
883
|
+
end
|
|
884
|
+
|
|
885
|
+
# Check whether email exists for hosted login flow
|
|
886
|
+
# Used by the built-in managed login page to branch UI between signin and signup. Requires anon key in Authorization header. Rate limited per project and client IP. Excess requests return `429` and `Retry-After`.
|
|
887
|
+
# @param id [String] Project ID
|
|
888
|
+
# @param authorization [String] Bearer anon key (`Bearer <anon_key>`)
|
|
889
|
+
# @param hosted_login_email_check_request [HostedLoginEmailCheckRequest]
|
|
890
|
+
# @param [Hash] opts the optional parameters
|
|
891
|
+
# @return [HostedLoginEmailCheckResponse]
|
|
892
|
+
def hosted_login_check_email(id, authorization, hosted_login_email_check_request, opts = {})
|
|
893
|
+
data, _status_code, _headers = hosted_login_check_email_with_http_info(id, authorization, hosted_login_email_check_request, opts)
|
|
894
|
+
data
|
|
895
|
+
end
|
|
896
|
+
|
|
897
|
+
# Check whether email exists for hosted login flow
|
|
898
|
+
# Used by the built-in managed login page to branch UI between signin and signup. Requires anon key in Authorization header. Rate limited per project and client IP. Excess requests return `429` and `Retry-After`.
|
|
899
|
+
# @param id [String] Project ID
|
|
900
|
+
# @param authorization [String] Bearer anon key (`Bearer <anon_key>`)
|
|
901
|
+
# @param hosted_login_email_check_request [HostedLoginEmailCheckRequest]
|
|
902
|
+
# @param [Hash] opts the optional parameters
|
|
903
|
+
# @return [Array<(HostedLoginEmailCheckResponse, Integer, Hash)>] HostedLoginEmailCheckResponse data, response status code and response headers
|
|
904
|
+
def hosted_login_check_email_with_http_info(id, authorization, hosted_login_email_check_request, opts = {})
|
|
905
|
+
if @api_client.config.debugging
|
|
906
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.hosted_login_check_email ...'
|
|
907
|
+
end
|
|
908
|
+
# verify the required parameter 'id' is set
|
|
909
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
910
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.hosted_login_check_email"
|
|
911
|
+
end
|
|
912
|
+
# verify the required parameter 'authorization' is set
|
|
913
|
+
if @api_client.config.client_side_validation && authorization.nil?
|
|
914
|
+
fail ArgumentError, "Missing the required parameter 'authorization' when calling AuthConfigurationApi.hosted_login_check_email"
|
|
915
|
+
end
|
|
916
|
+
# verify the required parameter 'hosted_login_email_check_request' is set
|
|
917
|
+
if @api_client.config.client_side_validation && hosted_login_email_check_request.nil?
|
|
918
|
+
fail ArgumentError, "Missing the required parameter 'hosted_login_email_check_request' when calling AuthConfigurationApi.hosted_login_check_email"
|
|
919
|
+
end
|
|
920
|
+
# resource path
|
|
921
|
+
local_var_path = '/projects/{id}/auth/hosted/login/check-email'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
922
|
+
|
|
923
|
+
# query parameters
|
|
924
|
+
query_params = opts[:query_params] || {}
|
|
925
|
+
|
|
926
|
+
# header parameters
|
|
927
|
+
header_params = opts[:header_params] || {}
|
|
928
|
+
# HTTP header 'Accept' (if needed)
|
|
929
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
930
|
+
# HTTP header 'Content-Type'
|
|
931
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
932
|
+
if !content_type.nil?
|
|
933
|
+
header_params['Content-Type'] = content_type
|
|
934
|
+
end
|
|
935
|
+
header_params[:'Authorization'] = authorization
|
|
936
|
+
|
|
937
|
+
# form parameters
|
|
938
|
+
form_params = opts[:form_params] || {}
|
|
939
|
+
|
|
940
|
+
# http body (model)
|
|
941
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(hosted_login_email_check_request)
|
|
942
|
+
|
|
943
|
+
# return_type
|
|
944
|
+
return_type = opts[:debug_return_type] || 'HostedLoginEmailCheckResponse'
|
|
945
|
+
|
|
946
|
+
# auth_names
|
|
947
|
+
auth_names = opts[:debug_auth_names] || []
|
|
948
|
+
|
|
949
|
+
new_options = opts.merge(
|
|
950
|
+
:operation => :"AuthConfigurationApi.hosted_login_check_email",
|
|
951
|
+
:header_params => header_params,
|
|
952
|
+
:query_params => query_params,
|
|
953
|
+
:form_params => form_params,
|
|
954
|
+
:body => post_body,
|
|
955
|
+
:auth_names => auth_names,
|
|
956
|
+
:return_type => return_type
|
|
957
|
+
)
|
|
958
|
+
|
|
959
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
960
|
+
if @api_client.config.debugging
|
|
961
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#hosted_login_check_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
962
|
+
end
|
|
963
|
+
return data, status_code, headers
|
|
964
|
+
end
|
|
965
|
+
|
|
966
|
+
# List email templates
|
|
967
|
+
# Returns all custom email templates for this project.
|
|
968
|
+
# @param id [String] Project ID
|
|
969
|
+
# @param [Hash] opts the optional parameters
|
|
970
|
+
# @return [ListEmailTemplates200Response]
|
|
971
|
+
def list_email_templates(id, opts = {})
|
|
972
|
+
data, _status_code, _headers = list_email_templates_with_http_info(id, opts)
|
|
973
|
+
data
|
|
974
|
+
end
|
|
975
|
+
|
|
976
|
+
# List email templates
|
|
977
|
+
# Returns all custom email templates for this project.
|
|
978
|
+
# @param id [String] Project ID
|
|
979
|
+
# @param [Hash] opts the optional parameters
|
|
980
|
+
# @return [Array<(ListEmailTemplates200Response, Integer, Hash)>] ListEmailTemplates200Response data, response status code and response headers
|
|
981
|
+
def list_email_templates_with_http_info(id, opts = {})
|
|
982
|
+
if @api_client.config.debugging
|
|
983
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.list_email_templates ...'
|
|
984
|
+
end
|
|
985
|
+
# verify the required parameter 'id' is set
|
|
986
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
987
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.list_email_templates"
|
|
988
|
+
end
|
|
989
|
+
# resource path
|
|
990
|
+
local_var_path = '/projects/{id}/email-templates'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
991
|
+
|
|
992
|
+
# query parameters
|
|
993
|
+
query_params = opts[:query_params] || {}
|
|
994
|
+
|
|
995
|
+
# header parameters
|
|
996
|
+
header_params = opts[:header_params] || {}
|
|
997
|
+
# HTTP header 'Accept' (if needed)
|
|
998
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
999
|
+
|
|
1000
|
+
# form parameters
|
|
1001
|
+
form_params = opts[:form_params] || {}
|
|
1002
|
+
|
|
1003
|
+
# http body (model)
|
|
1004
|
+
post_body = opts[:debug_body]
|
|
1005
|
+
|
|
1006
|
+
# return_type
|
|
1007
|
+
return_type = opts[:debug_return_type] || 'ListEmailTemplates200Response'
|
|
1008
|
+
|
|
1009
|
+
# auth_names
|
|
1010
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1011
|
+
|
|
1012
|
+
new_options = opts.merge(
|
|
1013
|
+
:operation => :"AuthConfigurationApi.list_email_templates",
|
|
1014
|
+
:header_params => header_params,
|
|
1015
|
+
:query_params => query_params,
|
|
1016
|
+
:form_params => form_params,
|
|
1017
|
+
:body => post_body,
|
|
1018
|
+
:auth_names => auth_names,
|
|
1019
|
+
:return_type => return_type
|
|
1020
|
+
)
|
|
1021
|
+
|
|
1022
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1023
|
+
if @api_client.config.debugging
|
|
1024
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#list_email_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1025
|
+
end
|
|
1026
|
+
return data, status_code, headers
|
|
1027
|
+
end
|
|
1028
|
+
|
|
1029
|
+
# Preview an unsaved managed auth page appearance
|
|
1030
|
+
# @param id [String] Project ID
|
|
1031
|
+
# @param page_type [HostedAuthPageType]
|
|
1032
|
+
# @param preview_auth_page_request [PreviewAuthPageRequest]
|
|
1033
|
+
# @param [Hash] opts the optional parameters
|
|
1034
|
+
# @return [PreviewAuthPageResponse]
|
|
1035
|
+
def preview_auth_page(id, page_type, preview_auth_page_request, opts = {})
|
|
1036
|
+
data, _status_code, _headers = preview_auth_page_with_http_info(id, page_type, preview_auth_page_request, opts)
|
|
1037
|
+
data
|
|
1038
|
+
end
|
|
1039
|
+
|
|
1040
|
+
# Preview an unsaved managed auth page appearance
|
|
1041
|
+
# @param id [String] Project ID
|
|
1042
|
+
# @param page_type [HostedAuthPageType]
|
|
1043
|
+
# @param preview_auth_page_request [PreviewAuthPageRequest]
|
|
1044
|
+
# @param [Hash] opts the optional parameters
|
|
1045
|
+
# @return [Array<(PreviewAuthPageResponse, Integer, Hash)>] PreviewAuthPageResponse data, response status code and response headers
|
|
1046
|
+
def preview_auth_page_with_http_info(id, page_type, preview_auth_page_request, opts = {})
|
|
1047
|
+
if @api_client.config.debugging
|
|
1048
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.preview_auth_page ...'
|
|
1049
|
+
end
|
|
1050
|
+
# verify the required parameter 'id' is set
|
|
1051
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1052
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.preview_auth_page"
|
|
1053
|
+
end
|
|
1054
|
+
# verify the required parameter 'page_type' is set
|
|
1055
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
1056
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.preview_auth_page"
|
|
1057
|
+
end
|
|
1058
|
+
# verify the required parameter 'preview_auth_page_request' is set
|
|
1059
|
+
if @api_client.config.client_side_validation && preview_auth_page_request.nil?
|
|
1060
|
+
fail ArgumentError, "Missing the required parameter 'preview_auth_page_request' when calling AuthConfigurationApi.preview_auth_page"
|
|
1061
|
+
end
|
|
1062
|
+
# resource path
|
|
1063
|
+
local_var_path = '/projects/{id}/auth/pages/{pageType}/preview'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
1064
|
+
|
|
1065
|
+
# query parameters
|
|
1066
|
+
query_params = opts[:query_params] || {}
|
|
1067
|
+
|
|
1068
|
+
# header parameters
|
|
1069
|
+
header_params = opts[:header_params] || {}
|
|
1070
|
+
# HTTP header 'Accept' (if needed)
|
|
1071
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1072
|
+
# HTTP header 'Content-Type'
|
|
1073
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1074
|
+
if !content_type.nil?
|
|
1075
|
+
header_params['Content-Type'] = content_type
|
|
1076
|
+
end
|
|
1077
|
+
|
|
1078
|
+
# form parameters
|
|
1079
|
+
form_params = opts[:form_params] || {}
|
|
1080
|
+
|
|
1081
|
+
# http body (model)
|
|
1082
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(preview_auth_page_request)
|
|
1083
|
+
|
|
1084
|
+
# return_type
|
|
1085
|
+
return_type = opts[:debug_return_type] || 'PreviewAuthPageResponse'
|
|
1086
|
+
|
|
1087
|
+
# auth_names
|
|
1088
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1089
|
+
|
|
1090
|
+
new_options = opts.merge(
|
|
1091
|
+
:operation => :"AuthConfigurationApi.preview_auth_page",
|
|
1092
|
+
:header_params => header_params,
|
|
1093
|
+
:query_params => query_params,
|
|
1094
|
+
:form_params => form_params,
|
|
1095
|
+
:body => post_body,
|
|
1096
|
+
:auth_names => auth_names,
|
|
1097
|
+
:return_type => return_type
|
|
1098
|
+
)
|
|
1099
|
+
|
|
1100
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1101
|
+
if @api_client.config.debugging
|
|
1102
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#preview_auth_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1103
|
+
end
|
|
1104
|
+
return data, status_code, headers
|
|
1105
|
+
end
|
|
1106
|
+
|
|
1107
|
+
# Render a short-lived managed auth page preview
|
|
1108
|
+
# Public HTML endpoint for a preview URL returned by the POST operation. The signed ticket contains the unsaved appearance, expires shortly, and runs the production page runtime against mocked authentication responses.
|
|
1109
|
+
# @param id [String] Project ID
|
|
1110
|
+
# @param page_type [HostedAuthPageType]
|
|
1111
|
+
# @param ticket [String] Short-lived signed preview ticket returned by the POST operation.
|
|
1112
|
+
# @param [Hash] opts the optional parameters
|
|
1113
|
+
# @return [String]
|
|
1114
|
+
def render_auth_page_preview(id, page_type, ticket, opts = {})
|
|
1115
|
+
data, _status_code, _headers = render_auth_page_preview_with_http_info(id, page_type, ticket, opts)
|
|
1116
|
+
data
|
|
1117
|
+
end
|
|
1118
|
+
|
|
1119
|
+
# Render a short-lived managed auth page preview
|
|
1120
|
+
# Public HTML endpoint for a preview URL returned by the POST operation. The signed ticket contains the unsaved appearance, expires shortly, and runs the production page runtime against mocked authentication responses.
|
|
1121
|
+
# @param id [String] Project ID
|
|
1122
|
+
# @param page_type [HostedAuthPageType]
|
|
1123
|
+
# @param ticket [String] Short-lived signed preview ticket returned by the POST operation.
|
|
1124
|
+
# @param [Hash] opts the optional parameters
|
|
1125
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1126
|
+
def render_auth_page_preview_with_http_info(id, page_type, ticket, opts = {})
|
|
1127
|
+
if @api_client.config.debugging
|
|
1128
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.render_auth_page_preview ...'
|
|
1129
|
+
end
|
|
1130
|
+
# verify the required parameter 'id' is set
|
|
1131
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1132
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.render_auth_page_preview"
|
|
1133
|
+
end
|
|
1134
|
+
# verify the required parameter 'page_type' is set
|
|
1135
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
1136
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.render_auth_page_preview"
|
|
1137
|
+
end
|
|
1138
|
+
# verify the required parameter 'ticket' is set
|
|
1139
|
+
if @api_client.config.client_side_validation && ticket.nil?
|
|
1140
|
+
fail ArgumentError, "Missing the required parameter 'ticket' when calling AuthConfigurationApi.render_auth_page_preview"
|
|
1141
|
+
end
|
|
1142
|
+
if @api_client.config.client_side_validation && ticket.to_s.length > 4096
|
|
1143
|
+
fail ArgumentError, 'invalid value for "ticket" when calling AuthConfigurationApi.render_auth_page_preview, the character length must be smaller than or equal to 4096.'
|
|
1144
|
+
end
|
|
1145
|
+
|
|
1146
|
+
if @api_client.config.client_side_validation && ticket.to_s.length < 1
|
|
1147
|
+
fail ArgumentError, 'invalid value for "ticket" when calling AuthConfigurationApi.render_auth_page_preview, the character length must be greater than or equal to 1.'
|
|
1148
|
+
end
|
|
1149
|
+
|
|
1150
|
+
# resource path
|
|
1151
|
+
local_var_path = '/projects/{id}/auth/pages/{pageType}/preview'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
1152
|
+
|
|
1153
|
+
# query parameters
|
|
1154
|
+
query_params = opts[:query_params] || {}
|
|
1155
|
+
query_params[:'ticket'] = ticket
|
|
1156
|
+
|
|
1157
|
+
# header parameters
|
|
1158
|
+
header_params = opts[:header_params] || {}
|
|
1159
|
+
# HTTP header 'Accept' (if needed)
|
|
1160
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/html', 'text/plain']) unless header_params['Accept']
|
|
1161
|
+
|
|
1162
|
+
# form parameters
|
|
1163
|
+
form_params = opts[:form_params] || {}
|
|
1164
|
+
|
|
1165
|
+
# http body (model)
|
|
1166
|
+
post_body = opts[:debug_body]
|
|
1167
|
+
|
|
1168
|
+
# return_type
|
|
1169
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1170
|
+
|
|
1171
|
+
# auth_names
|
|
1172
|
+
auth_names = opts[:debug_auth_names] || []
|
|
1173
|
+
|
|
1174
|
+
new_options = opts.merge(
|
|
1175
|
+
:operation => :"AuthConfigurationApi.render_auth_page_preview",
|
|
1176
|
+
:header_params => header_params,
|
|
1177
|
+
:query_params => query_params,
|
|
1178
|
+
:form_params => form_params,
|
|
1179
|
+
:body => post_body,
|
|
1180
|
+
:auth_names => auth_names,
|
|
1181
|
+
:return_type => return_type
|
|
1182
|
+
)
|
|
1183
|
+
|
|
1184
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1185
|
+
if @api_client.config.debugging
|
|
1186
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#render_auth_page_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1187
|
+
end
|
|
1188
|
+
return data, status_code, headers
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
# Render default managed auth page
|
|
1192
|
+
# Public HTML endpoint for the managed login page. Requires `Accept: text/html`.
|
|
1193
|
+
# @param id [String] Project ID
|
|
1194
|
+
# @param [Hash] opts the optional parameters
|
|
1195
|
+
# @option opts [String] :action Optional deep-link action for the unified hosted page. Ignored when a custom login page is configured. `action=device` renders the device authorization approval UI inline (no redirect to any external app); it signs the user in and calls `POST /auth/device/verify`.
|
|
1196
|
+
# @option opts [String] :user_code Device user code (from `POST /auth/device/authorize`) used with `action=device`.
|
|
1197
|
+
# @option opts [String] :anon_key Project anon key used by built-in managed auth flows (required for login/signup/device actions).
|
|
1198
|
+
# @option opts [String] :state Opaque one-time nonce generated by the client SDK before redirecting here. On successful login/signup it is echoed back in the post-auth redirect fragment as `state`, so the SDK can bind the returned session to the flow it initiated (login-CSRF / session-fixation defense). The SDK rejects a returned session whose `state` does not match.
|
|
1199
|
+
# @return [String]
|
|
1200
|
+
def render_default_managed_auth_page(id, opts = {})
|
|
1201
|
+
data, _status_code, _headers = render_default_managed_auth_page_with_http_info(id, opts)
|
|
1202
|
+
data
|
|
1203
|
+
end
|
|
1204
|
+
|
|
1205
|
+
# Render default managed auth page
|
|
1206
|
+
# Public HTML endpoint for the managed login page. Requires `Accept: text/html`.
|
|
1207
|
+
# @param id [String] Project ID
|
|
1208
|
+
# @param [Hash] opts the optional parameters
|
|
1209
|
+
# @option opts [String] :action Optional deep-link action for the unified hosted page. Ignored when a custom login page is configured. `action=device` renders the device authorization approval UI inline (no redirect to any external app); it signs the user in and calls `POST /auth/device/verify`.
|
|
1210
|
+
# @option opts [String] :user_code Device user code (from `POST /auth/device/authorize`) used with `action=device`.
|
|
1211
|
+
# @option opts [String] :anon_key Project anon key used by built-in managed auth flows (required for login/signup/device actions).
|
|
1212
|
+
# @option opts [String] :state Opaque one-time nonce generated by the client SDK before redirecting here. On successful login/signup it is echoed back in the post-auth redirect fragment as `state`, so the SDK can bind the returned session to the flow it initiated (login-CSRF / session-fixation defense). The SDK rejects a returned session whose `state` does not match.
|
|
1213
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1214
|
+
def render_default_managed_auth_page_with_http_info(id, opts = {})
|
|
1215
|
+
if @api_client.config.debugging
|
|
1216
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.render_default_managed_auth_page ...'
|
|
1217
|
+
end
|
|
1218
|
+
# verify the required parameter 'id' is set
|
|
1219
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1220
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.render_default_managed_auth_page"
|
|
1221
|
+
end
|
|
1222
|
+
allowable_values = ["login", "signup", "forgot-password", "device"]
|
|
1223
|
+
if @api_client.config.client_side_validation && opts[:'action'] && !allowable_values.include?(opts[:'action'])
|
|
1224
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{allowable_values}"
|
|
1225
|
+
end
|
|
1226
|
+
# resource path
|
|
1227
|
+
local_var_path = '/projects/{id}/auth/hosted'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1228
|
+
|
|
1229
|
+
# query parameters
|
|
1230
|
+
query_params = opts[:query_params] || {}
|
|
1231
|
+
query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
|
|
1232
|
+
query_params[:'user_code'] = opts[:'user_code'] if !opts[:'user_code'].nil?
|
|
1233
|
+
query_params[:'anon_key'] = opts[:'anon_key'] if !opts[:'anon_key'].nil?
|
|
1234
|
+
query_params[:'state'] = opts[:'state'] if !opts[:'state'].nil?
|
|
1235
|
+
|
|
1236
|
+
# header parameters
|
|
1237
|
+
header_params = opts[:header_params] || {}
|
|
1238
|
+
# HTTP header 'Accept' (if needed)
|
|
1239
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/html']) unless header_params['Accept']
|
|
1240
|
+
|
|
1241
|
+
# form parameters
|
|
1242
|
+
form_params = opts[:form_params] || {}
|
|
1243
|
+
|
|
1244
|
+
# http body (model)
|
|
1245
|
+
post_body = opts[:debug_body]
|
|
1246
|
+
|
|
1247
|
+
# return_type
|
|
1248
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1249
|
+
|
|
1250
|
+
# auth_names
|
|
1251
|
+
auth_names = opts[:debug_auth_names] || []
|
|
1252
|
+
|
|
1253
|
+
new_options = opts.merge(
|
|
1254
|
+
:operation => :"AuthConfigurationApi.render_default_managed_auth_page",
|
|
1255
|
+
:header_params => header_params,
|
|
1256
|
+
:query_params => query_params,
|
|
1257
|
+
:form_params => form_params,
|
|
1258
|
+
:body => post_body,
|
|
1259
|
+
:auth_names => auth_names,
|
|
1260
|
+
:return_type => return_type
|
|
1261
|
+
)
|
|
1262
|
+
|
|
1263
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1264
|
+
if @api_client.config.debugging
|
|
1265
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#render_default_managed_auth_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1266
|
+
end
|
|
1267
|
+
return data, status_code, headers
|
|
1268
|
+
end
|
|
1269
|
+
|
|
1270
|
+
# Render a managed auth page
|
|
1271
|
+
# Public HTML endpoint for signup, forgot-password, device approval, verify-email, and reset-password pages. Login uses the path without a page type. Requires `Accept: text/html`. Returns 404 when managed hosted pages are disabled for the project.
|
|
1272
|
+
# @param id [String] Project ID
|
|
1273
|
+
# @param page_type [HostedRenderablePageType]
|
|
1274
|
+
# @param [Hash] opts the optional parameters
|
|
1275
|
+
# @return [String]
|
|
1276
|
+
def render_managed_auth_page(id, page_type, opts = {})
|
|
1277
|
+
data, _status_code, _headers = render_managed_auth_page_with_http_info(id, page_type, opts)
|
|
1278
|
+
data
|
|
1279
|
+
end
|
|
1280
|
+
|
|
1281
|
+
# Render a managed auth page
|
|
1282
|
+
# Public HTML endpoint for signup, forgot-password, device approval, verify-email, and reset-password pages. Login uses the path without a page type. Requires `Accept: text/html`. Returns 404 when managed hosted pages are disabled for the project.
|
|
1283
|
+
# @param id [String] Project ID
|
|
1284
|
+
# @param page_type [HostedRenderablePageType]
|
|
1285
|
+
# @param [Hash] opts the optional parameters
|
|
1286
|
+
# @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
|
|
1287
|
+
def render_managed_auth_page_with_http_info(id, page_type, opts = {})
|
|
1288
|
+
if @api_client.config.debugging
|
|
1289
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.render_managed_auth_page ...'
|
|
1290
|
+
end
|
|
1291
|
+
# verify the required parameter 'id' is set
|
|
1292
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1293
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.render_managed_auth_page"
|
|
1294
|
+
end
|
|
1295
|
+
# verify the required parameter 'page_type' is set
|
|
1296
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
1297
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.render_managed_auth_page"
|
|
1298
|
+
end
|
|
1299
|
+
# resource path
|
|
1300
|
+
local_var_path = '/projects/{id}/auth/hosted/{pageType}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
1301
|
+
|
|
1302
|
+
# query parameters
|
|
1303
|
+
query_params = opts[:query_params] || {}
|
|
1304
|
+
|
|
1305
|
+
# header parameters
|
|
1306
|
+
header_params = opts[:header_params] || {}
|
|
1307
|
+
# HTTP header 'Accept' (if needed)
|
|
1308
|
+
header_params['Accept'] = @api_client.select_header_accept(['text/html']) unless header_params['Accept']
|
|
1309
|
+
|
|
1310
|
+
# form parameters
|
|
1311
|
+
form_params = opts[:form_params] || {}
|
|
1312
|
+
|
|
1313
|
+
# http body (model)
|
|
1314
|
+
post_body = opts[:debug_body]
|
|
1315
|
+
|
|
1316
|
+
# return_type
|
|
1317
|
+
return_type = opts[:debug_return_type] || 'String'
|
|
1318
|
+
|
|
1319
|
+
# auth_names
|
|
1320
|
+
auth_names = opts[:debug_auth_names] || []
|
|
1321
|
+
|
|
1322
|
+
new_options = opts.merge(
|
|
1323
|
+
:operation => :"AuthConfigurationApi.render_managed_auth_page",
|
|
1324
|
+
:header_params => header_params,
|
|
1325
|
+
:query_params => query_params,
|
|
1326
|
+
:form_params => form_params,
|
|
1327
|
+
:body => post_body,
|
|
1328
|
+
:auth_names => auth_names,
|
|
1329
|
+
:return_type => return_type
|
|
1330
|
+
)
|
|
1331
|
+
|
|
1332
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
1333
|
+
if @api_client.config.debugging
|
|
1334
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#render_managed_auth_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1335
|
+
end
|
|
1336
|
+
return data, status_code, headers
|
|
1337
|
+
end
|
|
1338
|
+
|
|
1339
|
+
# Send a test email using the project's saved SMTP config
|
|
1340
|
+
# Sends a diagnostic email to `to_email` using the project's persisted `auth_config` SMTP credentials. If `html_body` or `text_body` is supplied, the override path is taken: those values (plus optional `subject`) are rendered through html/text templates against the project's `Data` and used as the body — used by the template editor's \"Send Test\" affordance to preview an unsaved template. With both bodies omitted, a hardcoded diagnostic message is sent and any `subject` field is ignored. Sending `subject` alone (no bodies) is rejected with 400 to avoid a silently-dropped subject or a blank message. Also rejects with 400 if `email_enabled=false` or `smtp_host` is empty.
|
|
1341
|
+
# @param id [String] Project ID
|
|
1342
|
+
# @param test_email_request [TestEmailRequest]
|
|
1343
|
+
# @param [Hash] opts the optional parameters
|
|
1344
|
+
# @return [TestEmailResponse]
|
|
1345
|
+
def test_email_config(id, test_email_request, opts = {})
|
|
1346
|
+
data, _status_code, _headers = test_email_config_with_http_info(id, test_email_request, opts)
|
|
1347
|
+
data
|
|
1348
|
+
end
|
|
1349
|
+
|
|
1350
|
+
# Send a test email using the project's saved SMTP config
|
|
1351
|
+
# Sends a diagnostic email to `to_email` using the project's persisted `auth_config` SMTP credentials. If `html_body` or `text_body` is supplied, the override path is taken: those values (plus optional `subject`) are rendered through html/text templates against the project's `Data` and used as the body — used by the template editor's \"Send Test\" affordance to preview an unsaved template. With both bodies omitted, a hardcoded diagnostic message is sent and any `subject` field is ignored. Sending `subject` alone (no bodies) is rejected with 400 to avoid a silently-dropped subject or a blank message. Also rejects with 400 if `email_enabled=false` or `smtp_host` is empty.
|
|
1352
|
+
# @param id [String] Project ID
|
|
1353
|
+
# @param test_email_request [TestEmailRequest]
|
|
1354
|
+
# @param [Hash] opts the optional parameters
|
|
1355
|
+
# @return [Array<(TestEmailResponse, Integer, Hash)>] TestEmailResponse data, response status code and response headers
|
|
1356
|
+
def test_email_config_with_http_info(id, test_email_request, opts = {})
|
|
1357
|
+
if @api_client.config.debugging
|
|
1358
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.test_email_config ...'
|
|
1359
|
+
end
|
|
1360
|
+
# verify the required parameter 'id' is set
|
|
1361
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1362
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.test_email_config"
|
|
1363
|
+
end
|
|
1364
|
+
# verify the required parameter 'test_email_request' is set
|
|
1365
|
+
if @api_client.config.client_side_validation && test_email_request.nil?
|
|
1366
|
+
fail ArgumentError, "Missing the required parameter 'test_email_request' when calling AuthConfigurationApi.test_email_config"
|
|
1367
|
+
end
|
|
1368
|
+
# resource path
|
|
1369
|
+
local_var_path = '/projects/{id}/auth/config/test-email'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1370
|
+
|
|
1371
|
+
# query parameters
|
|
1372
|
+
query_params = opts[:query_params] || {}
|
|
1373
|
+
|
|
1374
|
+
# header parameters
|
|
1375
|
+
header_params = opts[:header_params] || {}
|
|
1376
|
+
# HTTP header 'Accept' (if needed)
|
|
1377
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1378
|
+
# HTTP header 'Content-Type'
|
|
1379
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1380
|
+
if !content_type.nil?
|
|
1381
|
+
header_params['Content-Type'] = content_type
|
|
1382
|
+
end
|
|
1383
|
+
|
|
1384
|
+
# form parameters
|
|
1385
|
+
form_params = opts[:form_params] || {}
|
|
1386
|
+
|
|
1387
|
+
# http body (model)
|
|
1388
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(test_email_request)
|
|
1389
|
+
|
|
1390
|
+
# return_type
|
|
1391
|
+
return_type = opts[:debug_return_type] || 'TestEmailResponse'
|
|
1392
|
+
|
|
1393
|
+
# auth_names
|
|
1394
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1395
|
+
|
|
1396
|
+
new_options = opts.merge(
|
|
1397
|
+
:operation => :"AuthConfigurationApi.test_email_config",
|
|
1398
|
+
:header_params => header_params,
|
|
1399
|
+
:query_params => query_params,
|
|
1400
|
+
:form_params => form_params,
|
|
1401
|
+
:body => post_body,
|
|
1402
|
+
:auth_names => auth_names,
|
|
1403
|
+
:return_type => return_type
|
|
1404
|
+
)
|
|
1405
|
+
|
|
1406
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1407
|
+
if @api_client.config.debugging
|
|
1408
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#test_email_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1409
|
+
end
|
|
1410
|
+
return data, status_code, headers
|
|
1411
|
+
end
|
|
1412
|
+
|
|
1413
|
+
# Update auth configuration
|
|
1414
|
+
# Updates the project's auth configuration. Only the fields present in the body are changed.
|
|
1415
|
+
# @param id [String] Project ID
|
|
1416
|
+
# @param [Hash] opts the optional parameters
|
|
1417
|
+
# @option opts [UpdateAuthConfigRequest] :update_auth_config_request
|
|
1418
|
+
# @return [AuthConfig]
|
|
1419
|
+
def update_auth_config(id, opts = {})
|
|
1420
|
+
data, _status_code, _headers = update_auth_config_with_http_info(id, opts)
|
|
1421
|
+
data
|
|
1422
|
+
end
|
|
1423
|
+
|
|
1424
|
+
# Update auth configuration
|
|
1425
|
+
# Updates the project's auth configuration. Only the fields present in the body are changed.
|
|
1426
|
+
# @param id [String] Project ID
|
|
1427
|
+
# @param [Hash] opts the optional parameters
|
|
1428
|
+
# @option opts [UpdateAuthConfigRequest] :update_auth_config_request
|
|
1429
|
+
# @return [Array<(AuthConfig, Integer, Hash)>] AuthConfig data, response status code and response headers
|
|
1430
|
+
def update_auth_config_with_http_info(id, opts = {})
|
|
1431
|
+
if @api_client.config.debugging
|
|
1432
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.update_auth_config ...'
|
|
1433
|
+
end
|
|
1434
|
+
# verify the required parameter 'id' is set
|
|
1435
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1436
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.update_auth_config"
|
|
1437
|
+
end
|
|
1438
|
+
# resource path
|
|
1439
|
+
local_var_path = '/projects/{id}/auth/config'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1440
|
+
|
|
1441
|
+
# query parameters
|
|
1442
|
+
query_params = opts[:query_params] || {}
|
|
1443
|
+
|
|
1444
|
+
# header parameters
|
|
1445
|
+
header_params = opts[:header_params] || {}
|
|
1446
|
+
# HTTP header 'Accept' (if needed)
|
|
1447
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1448
|
+
# HTTP header 'Content-Type'
|
|
1449
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1450
|
+
if !content_type.nil?
|
|
1451
|
+
header_params['Content-Type'] = content_type
|
|
1452
|
+
end
|
|
1453
|
+
|
|
1454
|
+
# form parameters
|
|
1455
|
+
form_params = opts[:form_params] || {}
|
|
1456
|
+
|
|
1457
|
+
# http body (model)
|
|
1458
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'update_auth_config_request'])
|
|
1459
|
+
|
|
1460
|
+
# return_type
|
|
1461
|
+
return_type = opts[:debug_return_type] || 'AuthConfig'
|
|
1462
|
+
|
|
1463
|
+
# auth_names
|
|
1464
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1465
|
+
|
|
1466
|
+
new_options = opts.merge(
|
|
1467
|
+
:operation => :"AuthConfigurationApi.update_auth_config",
|
|
1468
|
+
:header_params => header_params,
|
|
1469
|
+
:query_params => query_params,
|
|
1470
|
+
:form_params => form_params,
|
|
1471
|
+
:body => post_body,
|
|
1472
|
+
:auth_names => auth_names,
|
|
1473
|
+
:return_type => return_type
|
|
1474
|
+
)
|
|
1475
|
+
|
|
1476
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1477
|
+
if @api_client.config.debugging
|
|
1478
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#update_auth_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1479
|
+
end
|
|
1480
|
+
return data, status_code, headers
|
|
1481
|
+
end
|
|
1482
|
+
|
|
1483
|
+
# Update hosted auth page
|
|
1484
|
+
# Saves the current HTML/CSS for this page type. Security validation rejects script tags, javascript: URLs, inline event handlers, iframe/object/embed/meta/link tags in HTML, and closing style/head tags in CSS.
|
|
1485
|
+
# @param id [String] Project ID
|
|
1486
|
+
# @param page_type [HostedAuthPageType]
|
|
1487
|
+
# @param update_auth_hosted_page_request [UpdateAuthHostedPageRequest]
|
|
1488
|
+
# @param [Hash] opts the optional parameters
|
|
1489
|
+
# @return [AuthHostedPageResponse]
|
|
1490
|
+
def update_auth_hosted_page(id, page_type, update_auth_hosted_page_request, opts = {})
|
|
1491
|
+
data, _status_code, _headers = update_auth_hosted_page_with_http_info(id, page_type, update_auth_hosted_page_request, opts)
|
|
1492
|
+
data
|
|
1493
|
+
end
|
|
1494
|
+
|
|
1495
|
+
# Update hosted auth page
|
|
1496
|
+
# Saves the current HTML/CSS for this page type. Security validation rejects script tags, javascript: URLs, inline event handlers, iframe/object/embed/meta/link tags in HTML, and closing style/head tags in CSS.
|
|
1497
|
+
# @param id [String] Project ID
|
|
1498
|
+
# @param page_type [HostedAuthPageType]
|
|
1499
|
+
# @param update_auth_hosted_page_request [UpdateAuthHostedPageRequest]
|
|
1500
|
+
# @param [Hash] opts the optional parameters
|
|
1501
|
+
# @return [Array<(AuthHostedPageResponse, Integer, Hash)>] AuthHostedPageResponse data, response status code and response headers
|
|
1502
|
+
def update_auth_hosted_page_with_http_info(id, page_type, update_auth_hosted_page_request, opts = {})
|
|
1503
|
+
if @api_client.config.debugging
|
|
1504
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.update_auth_hosted_page ...'
|
|
1505
|
+
end
|
|
1506
|
+
# verify the required parameter 'id' is set
|
|
1507
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1508
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.update_auth_hosted_page"
|
|
1509
|
+
end
|
|
1510
|
+
# verify the required parameter 'page_type' is set
|
|
1511
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
1512
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.update_auth_hosted_page"
|
|
1513
|
+
end
|
|
1514
|
+
# verify the required parameter 'update_auth_hosted_page_request' is set
|
|
1515
|
+
if @api_client.config.client_side_validation && update_auth_hosted_page_request.nil?
|
|
1516
|
+
fail ArgumentError, "Missing the required parameter 'update_auth_hosted_page_request' when calling AuthConfigurationApi.update_auth_hosted_page"
|
|
1517
|
+
end
|
|
1518
|
+
# resource path
|
|
1519
|
+
local_var_path = '/projects/{id}/auth/hosted-pages/{pageType}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
1520
|
+
|
|
1521
|
+
# query parameters
|
|
1522
|
+
query_params = opts[:query_params] || {}
|
|
1523
|
+
|
|
1524
|
+
# header parameters
|
|
1525
|
+
header_params = opts[:header_params] || {}
|
|
1526
|
+
# HTTP header 'Accept' (if needed)
|
|
1527
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1528
|
+
# HTTP header 'Content-Type'
|
|
1529
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1530
|
+
if !content_type.nil?
|
|
1531
|
+
header_params['Content-Type'] = content_type
|
|
1532
|
+
end
|
|
1533
|
+
|
|
1534
|
+
# form parameters
|
|
1535
|
+
form_params = opts[:form_params] || {}
|
|
1536
|
+
|
|
1537
|
+
# http body (model)
|
|
1538
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_auth_hosted_page_request)
|
|
1539
|
+
|
|
1540
|
+
# return_type
|
|
1541
|
+
return_type = opts[:debug_return_type] || 'AuthHostedPageResponse'
|
|
1542
|
+
|
|
1543
|
+
# auth_names
|
|
1544
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1545
|
+
|
|
1546
|
+
new_options = opts.merge(
|
|
1547
|
+
:operation => :"AuthConfigurationApi.update_auth_hosted_page",
|
|
1548
|
+
:header_params => header_params,
|
|
1549
|
+
:query_params => query_params,
|
|
1550
|
+
:form_params => form_params,
|
|
1551
|
+
:body => post_body,
|
|
1552
|
+
:auth_names => auth_names,
|
|
1553
|
+
:return_type => return_type
|
|
1554
|
+
)
|
|
1555
|
+
|
|
1556
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1557
|
+
if @api_client.config.debugging
|
|
1558
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#update_auth_hosted_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1559
|
+
end
|
|
1560
|
+
return data, status_code, headers
|
|
1561
|
+
end
|
|
1562
|
+
|
|
1563
|
+
# Save one managed auth page layout
|
|
1564
|
+
# @param id [String] Project ID
|
|
1565
|
+
# @param page_type [HostedAuthPageType]
|
|
1566
|
+
# @param update_auth_page_layout_request [UpdateAuthPageLayoutRequest]
|
|
1567
|
+
# @param [Hash] opts the optional parameters
|
|
1568
|
+
# @return [UpdateAuthPageLayoutRequest]
|
|
1569
|
+
def update_auth_page_layout(id, page_type, update_auth_page_layout_request, opts = {})
|
|
1570
|
+
data, _status_code, _headers = update_auth_page_layout_with_http_info(id, page_type, update_auth_page_layout_request, opts)
|
|
1571
|
+
data
|
|
1572
|
+
end
|
|
1573
|
+
|
|
1574
|
+
# Save one managed auth page layout
|
|
1575
|
+
# @param id [String] Project ID
|
|
1576
|
+
# @param page_type [HostedAuthPageType]
|
|
1577
|
+
# @param update_auth_page_layout_request [UpdateAuthPageLayoutRequest]
|
|
1578
|
+
# @param [Hash] opts the optional parameters
|
|
1579
|
+
# @return [Array<(UpdateAuthPageLayoutRequest, Integer, Hash)>] UpdateAuthPageLayoutRequest data, response status code and response headers
|
|
1580
|
+
def update_auth_page_layout_with_http_info(id, page_type, update_auth_page_layout_request, opts = {})
|
|
1581
|
+
if @api_client.config.debugging
|
|
1582
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.update_auth_page_layout ...'
|
|
1583
|
+
end
|
|
1584
|
+
# verify the required parameter 'id' is set
|
|
1585
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1586
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.update_auth_page_layout"
|
|
1587
|
+
end
|
|
1588
|
+
# verify the required parameter 'page_type' is set
|
|
1589
|
+
if @api_client.config.client_side_validation && page_type.nil?
|
|
1590
|
+
fail ArgumentError, "Missing the required parameter 'page_type' when calling AuthConfigurationApi.update_auth_page_layout"
|
|
1591
|
+
end
|
|
1592
|
+
# verify the required parameter 'update_auth_page_layout_request' is set
|
|
1593
|
+
if @api_client.config.client_side_validation && update_auth_page_layout_request.nil?
|
|
1594
|
+
fail ArgumentError, "Missing the required parameter 'update_auth_page_layout_request' when calling AuthConfigurationApi.update_auth_page_layout"
|
|
1595
|
+
end
|
|
1596
|
+
# resource path
|
|
1597
|
+
local_var_path = '/projects/{id}/auth/pages/{pageType}/layout'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'pageType' + '}', CGI.escape(page_type.to_s))
|
|
1598
|
+
|
|
1599
|
+
# query parameters
|
|
1600
|
+
query_params = opts[:query_params] || {}
|
|
1601
|
+
|
|
1602
|
+
# header parameters
|
|
1603
|
+
header_params = opts[:header_params] || {}
|
|
1604
|
+
# HTTP header 'Accept' (if needed)
|
|
1605
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1606
|
+
# HTTP header 'Content-Type'
|
|
1607
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1608
|
+
if !content_type.nil?
|
|
1609
|
+
header_params['Content-Type'] = content_type
|
|
1610
|
+
end
|
|
1611
|
+
|
|
1612
|
+
# form parameters
|
|
1613
|
+
form_params = opts[:form_params] || {}
|
|
1614
|
+
|
|
1615
|
+
# http body (model)
|
|
1616
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_auth_page_layout_request)
|
|
1617
|
+
|
|
1618
|
+
# return_type
|
|
1619
|
+
return_type = opts[:debug_return_type] || 'UpdateAuthPageLayoutRequest'
|
|
1620
|
+
|
|
1621
|
+
# auth_names
|
|
1622
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1623
|
+
|
|
1624
|
+
new_options = opts.merge(
|
|
1625
|
+
:operation => :"AuthConfigurationApi.update_auth_page_layout",
|
|
1626
|
+
:header_params => header_params,
|
|
1627
|
+
:query_params => query_params,
|
|
1628
|
+
:form_params => form_params,
|
|
1629
|
+
:body => post_body,
|
|
1630
|
+
:auth_names => auth_names,
|
|
1631
|
+
:return_type => return_type
|
|
1632
|
+
)
|
|
1633
|
+
|
|
1634
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1635
|
+
if @api_client.config.debugging
|
|
1636
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#update_auth_page_layout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1637
|
+
end
|
|
1638
|
+
return data, status_code, headers
|
|
1639
|
+
end
|
|
1640
|
+
|
|
1641
|
+
# Save the managed auth page theme
|
|
1642
|
+
# @param id [String] Project ID
|
|
1643
|
+
# @param update_auth_page_theme_request [UpdateAuthPageThemeRequest]
|
|
1644
|
+
# @param [Hash] opts the optional parameters
|
|
1645
|
+
# @return [UpdateAuthPageThemeRequest]
|
|
1646
|
+
def update_auth_page_theme(id, update_auth_page_theme_request, opts = {})
|
|
1647
|
+
data, _status_code, _headers = update_auth_page_theme_with_http_info(id, update_auth_page_theme_request, opts)
|
|
1648
|
+
data
|
|
1649
|
+
end
|
|
1650
|
+
|
|
1651
|
+
# Save the managed auth page theme
|
|
1652
|
+
# @param id [String] Project ID
|
|
1653
|
+
# @param update_auth_page_theme_request [UpdateAuthPageThemeRequest]
|
|
1654
|
+
# @param [Hash] opts the optional parameters
|
|
1655
|
+
# @return [Array<(UpdateAuthPageThemeRequest, Integer, Hash)>] UpdateAuthPageThemeRequest data, response status code and response headers
|
|
1656
|
+
def update_auth_page_theme_with_http_info(id, update_auth_page_theme_request, opts = {})
|
|
1657
|
+
if @api_client.config.debugging
|
|
1658
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.update_auth_page_theme ...'
|
|
1659
|
+
end
|
|
1660
|
+
# verify the required parameter 'id' is set
|
|
1661
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1662
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.update_auth_page_theme"
|
|
1663
|
+
end
|
|
1664
|
+
# verify the required parameter 'update_auth_page_theme_request' is set
|
|
1665
|
+
if @api_client.config.client_side_validation && update_auth_page_theme_request.nil?
|
|
1666
|
+
fail ArgumentError, "Missing the required parameter 'update_auth_page_theme_request' when calling AuthConfigurationApi.update_auth_page_theme"
|
|
1667
|
+
end
|
|
1668
|
+
# resource path
|
|
1669
|
+
local_var_path = '/projects/{id}/auth/pages/theme'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
1670
|
+
|
|
1671
|
+
# query parameters
|
|
1672
|
+
query_params = opts[:query_params] || {}
|
|
1673
|
+
|
|
1674
|
+
# header parameters
|
|
1675
|
+
header_params = opts[:header_params] || {}
|
|
1676
|
+
# HTTP header 'Accept' (if needed)
|
|
1677
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1678
|
+
# HTTP header 'Content-Type'
|
|
1679
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1680
|
+
if !content_type.nil?
|
|
1681
|
+
header_params['Content-Type'] = content_type
|
|
1682
|
+
end
|
|
1683
|
+
|
|
1684
|
+
# form parameters
|
|
1685
|
+
form_params = opts[:form_params] || {}
|
|
1686
|
+
|
|
1687
|
+
# http body (model)
|
|
1688
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_auth_page_theme_request)
|
|
1689
|
+
|
|
1690
|
+
# return_type
|
|
1691
|
+
return_type = opts[:debug_return_type] || 'UpdateAuthPageThemeRequest'
|
|
1692
|
+
|
|
1693
|
+
# auth_names
|
|
1694
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1695
|
+
|
|
1696
|
+
new_options = opts.merge(
|
|
1697
|
+
:operation => :"AuthConfigurationApi.update_auth_page_theme",
|
|
1698
|
+
:header_params => header_params,
|
|
1699
|
+
:query_params => query_params,
|
|
1700
|
+
:form_params => form_params,
|
|
1701
|
+
:body => post_body,
|
|
1702
|
+
:auth_names => auth_names,
|
|
1703
|
+
:return_type => return_type
|
|
1704
|
+
)
|
|
1705
|
+
|
|
1706
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1707
|
+
if @api_client.config.debugging
|
|
1708
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#update_auth_page_theme\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1709
|
+
end
|
|
1710
|
+
return data, status_code, headers
|
|
1711
|
+
end
|
|
1712
|
+
|
|
1713
|
+
# Update email template
|
|
1714
|
+
# Updates a custom email template. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403 (including after a PRO→FREE downgrade), so a FREE project cannot modify templates and always sends the built-in defaults.
|
|
1715
|
+
# @param id [String] Project ID
|
|
1716
|
+
# @param type [String]
|
|
1717
|
+
# @param update_email_template_request [UpdateEmailTemplateRequest]
|
|
1718
|
+
# @param [Hash] opts the optional parameters
|
|
1719
|
+
# @return [EmailTemplate]
|
|
1720
|
+
def update_email_template(id, type, update_email_template_request, opts = {})
|
|
1721
|
+
data, _status_code, _headers = update_email_template_with_http_info(id, type, update_email_template_request, opts)
|
|
1722
|
+
data
|
|
1723
|
+
end
|
|
1724
|
+
|
|
1725
|
+
# Update email template
|
|
1726
|
+
# Updates a custom email template. Custom email templates are a PRO-plan feature: requests from a FREE-plan project owner are rejected with 403 (including after a PRO→FREE downgrade), so a FREE project cannot modify templates and always sends the built-in defaults.
|
|
1727
|
+
# @param id [String] Project ID
|
|
1728
|
+
# @param type [String]
|
|
1729
|
+
# @param update_email_template_request [UpdateEmailTemplateRequest]
|
|
1730
|
+
# @param [Hash] opts the optional parameters
|
|
1731
|
+
# @return [Array<(EmailTemplate, Integer, Hash)>] EmailTemplate data, response status code and response headers
|
|
1732
|
+
def update_email_template_with_http_info(id, type, update_email_template_request, opts = {})
|
|
1733
|
+
if @api_client.config.debugging
|
|
1734
|
+
@api_client.config.logger.debug 'Calling API: AuthConfigurationApi.update_email_template ...'
|
|
1735
|
+
end
|
|
1736
|
+
# verify the required parameter 'id' is set
|
|
1737
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
1738
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthConfigurationApi.update_email_template"
|
|
1739
|
+
end
|
|
1740
|
+
# verify the required parameter 'type' is set
|
|
1741
|
+
if @api_client.config.client_side_validation && type.nil?
|
|
1742
|
+
fail ArgumentError, "Missing the required parameter 'type' when calling AuthConfigurationApi.update_email_template"
|
|
1743
|
+
end
|
|
1744
|
+
# verify enum value
|
|
1745
|
+
allowable_values = ["welcome", "confirmation", "password_reset", "password_changed"]
|
|
1746
|
+
if @api_client.config.client_side_validation && !allowable_values.include?(type)
|
|
1747
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
1748
|
+
end
|
|
1749
|
+
# verify the required parameter 'update_email_template_request' is set
|
|
1750
|
+
if @api_client.config.client_side_validation && update_email_template_request.nil?
|
|
1751
|
+
fail ArgumentError, "Missing the required parameter 'update_email_template_request' when calling AuthConfigurationApi.update_email_template"
|
|
1752
|
+
end
|
|
1753
|
+
# resource path
|
|
1754
|
+
local_var_path = '/projects/{id}/email-templates/{type}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'type' + '}', CGI.escape(type.to_s))
|
|
1755
|
+
|
|
1756
|
+
# query parameters
|
|
1757
|
+
query_params = opts[:query_params] || {}
|
|
1758
|
+
|
|
1759
|
+
# header parameters
|
|
1760
|
+
header_params = opts[:header_params] || {}
|
|
1761
|
+
# HTTP header 'Accept' (if needed)
|
|
1762
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
1763
|
+
# HTTP header 'Content-Type'
|
|
1764
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
1765
|
+
if !content_type.nil?
|
|
1766
|
+
header_params['Content-Type'] = content_type
|
|
1767
|
+
end
|
|
1768
|
+
|
|
1769
|
+
# form parameters
|
|
1770
|
+
form_params = opts[:form_params] || {}
|
|
1771
|
+
|
|
1772
|
+
# http body (model)
|
|
1773
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(update_email_template_request)
|
|
1774
|
+
|
|
1775
|
+
# return_type
|
|
1776
|
+
return_type = opts[:debug_return_type] || 'EmailTemplate'
|
|
1777
|
+
|
|
1778
|
+
# auth_names
|
|
1779
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
1780
|
+
|
|
1781
|
+
new_options = opts.merge(
|
|
1782
|
+
:operation => :"AuthConfigurationApi.update_email_template",
|
|
1783
|
+
:header_params => header_params,
|
|
1784
|
+
:query_params => query_params,
|
|
1785
|
+
:form_params => form_params,
|
|
1786
|
+
:body => post_body,
|
|
1787
|
+
:auth_names => auth_names,
|
|
1788
|
+
:return_type => return_type
|
|
1789
|
+
)
|
|
1790
|
+
|
|
1791
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
|
|
1792
|
+
if @api_client.config.debugging
|
|
1793
|
+
@api_client.config.logger.debug "API called: AuthConfigurationApi#update_email_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1794
|
+
end
|
|
1795
|
+
return data, status_code, headers
|
|
1796
|
+
end
|
|
1797
|
+
end
|
|
1798
|
+
end
|