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,739 @@
|
|
|
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 AuthAdminApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Ban a user
|
|
23
|
+
# Bans a user temporarily or permanently. Banned users cannot sign in and all their active sessions are immediately revoked. - Omit `banned_until` for a permanent ban - Provide `banned_until` ISO timestamp for a temporary ban
|
|
24
|
+
# @param id [String] Project ID
|
|
25
|
+
# @param user_id [String]
|
|
26
|
+
# @param [Hash] opts the optional parameters
|
|
27
|
+
# @option opts [BanAuthUserRequest] :ban_auth_user_request
|
|
28
|
+
# @return [BanUserResponse]
|
|
29
|
+
def ban_auth_user(id, user_id, opts = {})
|
|
30
|
+
data, _status_code, _headers = ban_auth_user_with_http_info(id, user_id, opts)
|
|
31
|
+
data
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
# Ban a user
|
|
35
|
+
# Bans a user temporarily or permanently. Banned users cannot sign in and all their active sessions are immediately revoked. - Omit `banned_until` for a permanent ban - Provide `banned_until` ISO timestamp for a temporary ban
|
|
36
|
+
# @param id [String] Project ID
|
|
37
|
+
# @param user_id [String]
|
|
38
|
+
# @param [Hash] opts the optional parameters
|
|
39
|
+
# @option opts [BanAuthUserRequest] :ban_auth_user_request
|
|
40
|
+
# @return [Array<(BanUserResponse, Integer, Hash)>] BanUserResponse data, response status code and response headers
|
|
41
|
+
def ban_auth_user_with_http_info(id, user_id, opts = {})
|
|
42
|
+
if @api_client.config.debugging
|
|
43
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.ban_auth_user ...'
|
|
44
|
+
end
|
|
45
|
+
# verify the required parameter 'id' is set
|
|
46
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
47
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.ban_auth_user"
|
|
48
|
+
end
|
|
49
|
+
# verify the required parameter 'user_id' is set
|
|
50
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
51
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.ban_auth_user"
|
|
52
|
+
end
|
|
53
|
+
# resource path
|
|
54
|
+
local_var_path = '/projects/{id}/auth/users/{userId}/ban'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
55
|
+
|
|
56
|
+
# query parameters
|
|
57
|
+
query_params = opts[:query_params] || {}
|
|
58
|
+
|
|
59
|
+
# header parameters
|
|
60
|
+
header_params = opts[:header_params] || {}
|
|
61
|
+
# HTTP header 'Accept' (if needed)
|
|
62
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
63
|
+
# HTTP header 'Content-Type'
|
|
64
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
65
|
+
if !content_type.nil?
|
|
66
|
+
header_params['Content-Type'] = content_type
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# form parameters
|
|
70
|
+
form_params = opts[:form_params] || {}
|
|
71
|
+
|
|
72
|
+
# http body (model)
|
|
73
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'ban_auth_user_request'])
|
|
74
|
+
|
|
75
|
+
# return_type
|
|
76
|
+
return_type = opts[:debug_return_type] || 'BanUserResponse'
|
|
77
|
+
|
|
78
|
+
# auth_names
|
|
79
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
80
|
+
|
|
81
|
+
new_options = opts.merge(
|
|
82
|
+
:operation => :"AuthAdminApi.ban_auth_user",
|
|
83
|
+
:header_params => header_params,
|
|
84
|
+
:query_params => query_params,
|
|
85
|
+
:form_params => form_params,
|
|
86
|
+
:body => post_body,
|
|
87
|
+
:auth_names => auth_names,
|
|
88
|
+
:return_type => return_type
|
|
89
|
+
)
|
|
90
|
+
|
|
91
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
92
|
+
if @api_client.config.debugging
|
|
93
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#ban_auth_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
94
|
+
end
|
|
95
|
+
return data, status_code, headers
|
|
96
|
+
end
|
|
97
|
+
|
|
98
|
+
# Delete all user sessions
|
|
99
|
+
# Revokes all sessions for a user, forcing them to re-authenticate on all devices. Use this to log out a user from everywhere.
|
|
100
|
+
# @param id [String] Project ID
|
|
101
|
+
# @param user_id [String]
|
|
102
|
+
# @param [Hash] opts the optional parameters
|
|
103
|
+
# @return [nil]
|
|
104
|
+
def delete_all_user_sessions(id, user_id, opts = {})
|
|
105
|
+
delete_all_user_sessions_with_http_info(id, user_id, opts)
|
|
106
|
+
nil
|
|
107
|
+
end
|
|
108
|
+
|
|
109
|
+
# Delete all user sessions
|
|
110
|
+
# Revokes all sessions for a user, forcing them to re-authenticate on all devices. Use this to log out a user from everywhere.
|
|
111
|
+
# @param id [String] Project ID
|
|
112
|
+
# @param user_id [String]
|
|
113
|
+
# @param [Hash] opts the optional parameters
|
|
114
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
115
|
+
def delete_all_user_sessions_with_http_info(id, user_id, opts = {})
|
|
116
|
+
if @api_client.config.debugging
|
|
117
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.delete_all_user_sessions ...'
|
|
118
|
+
end
|
|
119
|
+
# verify the required parameter 'id' is set
|
|
120
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
121
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.delete_all_user_sessions"
|
|
122
|
+
end
|
|
123
|
+
# verify the required parameter 'user_id' is set
|
|
124
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
125
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.delete_all_user_sessions"
|
|
126
|
+
end
|
|
127
|
+
# resource path
|
|
128
|
+
local_var_path = '/projects/{id}/auth/users/{userId}/sessions'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
129
|
+
|
|
130
|
+
# query parameters
|
|
131
|
+
query_params = opts[:query_params] || {}
|
|
132
|
+
|
|
133
|
+
# header parameters
|
|
134
|
+
header_params = opts[:header_params] || {}
|
|
135
|
+
|
|
136
|
+
# form parameters
|
|
137
|
+
form_params = opts[:form_params] || {}
|
|
138
|
+
|
|
139
|
+
# http body (model)
|
|
140
|
+
post_body = opts[:debug_body]
|
|
141
|
+
|
|
142
|
+
# return_type
|
|
143
|
+
return_type = opts[:debug_return_type]
|
|
144
|
+
|
|
145
|
+
# auth_names
|
|
146
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
147
|
+
|
|
148
|
+
new_options = opts.merge(
|
|
149
|
+
:operation => :"AuthAdminApi.delete_all_user_sessions",
|
|
150
|
+
:header_params => header_params,
|
|
151
|
+
:query_params => query_params,
|
|
152
|
+
:form_params => form_params,
|
|
153
|
+
:body => post_body,
|
|
154
|
+
:auth_names => auth_names,
|
|
155
|
+
:return_type => return_type
|
|
156
|
+
)
|
|
157
|
+
|
|
158
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
159
|
+
if @api_client.config.debugging
|
|
160
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#delete_all_user_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
161
|
+
end
|
|
162
|
+
return data, status_code, headers
|
|
163
|
+
end
|
|
164
|
+
|
|
165
|
+
# Delete auth user (admin)
|
|
166
|
+
# Soft-deletes user and revokes all sessions
|
|
167
|
+
# @param id [String] Project ID
|
|
168
|
+
# @param user_id [String]
|
|
169
|
+
# @param [Hash] opts the optional parameters
|
|
170
|
+
# @return [nil]
|
|
171
|
+
def delete_auth_user(id, user_id, opts = {})
|
|
172
|
+
delete_auth_user_with_http_info(id, user_id, opts)
|
|
173
|
+
nil
|
|
174
|
+
end
|
|
175
|
+
|
|
176
|
+
# Delete auth user (admin)
|
|
177
|
+
# Soft-deletes user and revokes all sessions
|
|
178
|
+
# @param id [String] Project ID
|
|
179
|
+
# @param user_id [String]
|
|
180
|
+
# @param [Hash] opts the optional parameters
|
|
181
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
182
|
+
def delete_auth_user_with_http_info(id, user_id, opts = {})
|
|
183
|
+
if @api_client.config.debugging
|
|
184
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.delete_auth_user ...'
|
|
185
|
+
end
|
|
186
|
+
# verify the required parameter 'id' is set
|
|
187
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
188
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.delete_auth_user"
|
|
189
|
+
end
|
|
190
|
+
# verify the required parameter 'user_id' is set
|
|
191
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
192
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.delete_auth_user"
|
|
193
|
+
end
|
|
194
|
+
# resource path
|
|
195
|
+
local_var_path = '/projects/{id}/auth/users/{userId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
196
|
+
|
|
197
|
+
# query parameters
|
|
198
|
+
query_params = opts[:query_params] || {}
|
|
199
|
+
|
|
200
|
+
# header parameters
|
|
201
|
+
header_params = opts[:header_params] || {}
|
|
202
|
+
|
|
203
|
+
# form parameters
|
|
204
|
+
form_params = opts[:form_params] || {}
|
|
205
|
+
|
|
206
|
+
# http body (model)
|
|
207
|
+
post_body = opts[:debug_body]
|
|
208
|
+
|
|
209
|
+
# return_type
|
|
210
|
+
return_type = opts[:debug_return_type]
|
|
211
|
+
|
|
212
|
+
# auth_names
|
|
213
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
214
|
+
|
|
215
|
+
new_options = opts.merge(
|
|
216
|
+
:operation => :"AuthAdminApi.delete_auth_user",
|
|
217
|
+
:header_params => header_params,
|
|
218
|
+
:query_params => query_params,
|
|
219
|
+
:form_params => form_params,
|
|
220
|
+
:body => post_body,
|
|
221
|
+
:auth_names => auth_names,
|
|
222
|
+
:return_type => return_type
|
|
223
|
+
)
|
|
224
|
+
|
|
225
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
226
|
+
if @api_client.config.debugging
|
|
227
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#delete_auth_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
228
|
+
end
|
|
229
|
+
return data, status_code, headers
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
# Delete specific session
|
|
233
|
+
# Revokes a specific session for a user. Use this to log out a user from a single device.
|
|
234
|
+
# @param id [String] Project ID
|
|
235
|
+
# @param user_id [String]
|
|
236
|
+
# @param session_id [String]
|
|
237
|
+
# @param [Hash] opts the optional parameters
|
|
238
|
+
# @return [nil]
|
|
239
|
+
def delete_user_session(id, user_id, session_id, opts = {})
|
|
240
|
+
delete_user_session_with_http_info(id, user_id, session_id, opts)
|
|
241
|
+
nil
|
|
242
|
+
end
|
|
243
|
+
|
|
244
|
+
# Delete specific session
|
|
245
|
+
# Revokes a specific session for a user. Use this to log out a user from a single device.
|
|
246
|
+
# @param id [String] Project ID
|
|
247
|
+
# @param user_id [String]
|
|
248
|
+
# @param session_id [String]
|
|
249
|
+
# @param [Hash] opts the optional parameters
|
|
250
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
251
|
+
def delete_user_session_with_http_info(id, user_id, session_id, opts = {})
|
|
252
|
+
if @api_client.config.debugging
|
|
253
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.delete_user_session ...'
|
|
254
|
+
end
|
|
255
|
+
# verify the required parameter 'id' is set
|
|
256
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
257
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.delete_user_session"
|
|
258
|
+
end
|
|
259
|
+
# verify the required parameter 'user_id' is set
|
|
260
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
261
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.delete_user_session"
|
|
262
|
+
end
|
|
263
|
+
# verify the required parameter 'session_id' is set
|
|
264
|
+
if @api_client.config.client_side_validation && session_id.nil?
|
|
265
|
+
fail ArgumentError, "Missing the required parameter 'session_id' when calling AuthAdminApi.delete_user_session"
|
|
266
|
+
end
|
|
267
|
+
# resource path
|
|
268
|
+
local_var_path = '/projects/{id}/auth/users/{userId}/sessions/{sessionId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s)).sub('{' + 'sessionId' + '}', CGI.escape(session_id.to_s))
|
|
269
|
+
|
|
270
|
+
# query parameters
|
|
271
|
+
query_params = opts[:query_params] || {}
|
|
272
|
+
|
|
273
|
+
# header parameters
|
|
274
|
+
header_params = opts[:header_params] || {}
|
|
275
|
+
|
|
276
|
+
# form parameters
|
|
277
|
+
form_params = opts[:form_params] || {}
|
|
278
|
+
|
|
279
|
+
# http body (model)
|
|
280
|
+
post_body = opts[:debug_body]
|
|
281
|
+
|
|
282
|
+
# return_type
|
|
283
|
+
return_type = opts[:debug_return_type]
|
|
284
|
+
|
|
285
|
+
# auth_names
|
|
286
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
287
|
+
|
|
288
|
+
new_options = opts.merge(
|
|
289
|
+
:operation => :"AuthAdminApi.delete_user_session",
|
|
290
|
+
:header_params => header_params,
|
|
291
|
+
:query_params => query_params,
|
|
292
|
+
:form_params => form_params,
|
|
293
|
+
:body => post_body,
|
|
294
|
+
:auth_names => auth_names,
|
|
295
|
+
:return_type => return_type
|
|
296
|
+
)
|
|
297
|
+
|
|
298
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
299
|
+
if @api_client.config.debugging
|
|
300
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#delete_user_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
301
|
+
end
|
|
302
|
+
return data, status_code, headers
|
|
303
|
+
end
|
|
304
|
+
|
|
305
|
+
# Get auth user insights
|
|
306
|
+
# Returns current auth-user totals, rolling 30-day active users, and zero-filled signup and successful sign-in counts for an inclusive UTC date range. Weeks start on Monday. Sign-in counts and active-user activity begin when collection is deployed. Historical signup counts are backfilled from users present at deployment. Token refreshes affect active users but not the sign-in series.
|
|
307
|
+
# @param id [String] Project ID
|
|
308
|
+
# @param [Hash] opts the optional parameters
|
|
309
|
+
# @option opts [Date] :from Inclusive UTC start date. Defaults to 29 days before `to`.
|
|
310
|
+
# @option opts [Date] :to Inclusive UTC end date. Defaults to today.
|
|
311
|
+
# @option opts [AuthInsightsInterval] :interval Chart bucket size. Defaults to `day`.
|
|
312
|
+
# @return [AuthInsightsResponse]
|
|
313
|
+
def get_auth_insights(id, opts = {})
|
|
314
|
+
data, _status_code, _headers = get_auth_insights_with_http_info(id, opts)
|
|
315
|
+
data
|
|
316
|
+
end
|
|
317
|
+
|
|
318
|
+
# Get auth user insights
|
|
319
|
+
# Returns current auth-user totals, rolling 30-day active users, and zero-filled signup and successful sign-in counts for an inclusive UTC date range. Weeks start on Monday. Sign-in counts and active-user activity begin when collection is deployed. Historical signup counts are backfilled from users present at deployment. Token refreshes affect active users but not the sign-in series.
|
|
320
|
+
# @param id [String] Project ID
|
|
321
|
+
# @param [Hash] opts the optional parameters
|
|
322
|
+
# @option opts [Date] :from Inclusive UTC start date. Defaults to 29 days before `to`.
|
|
323
|
+
# @option opts [Date] :to Inclusive UTC end date. Defaults to today.
|
|
324
|
+
# @option opts [AuthInsightsInterval] :interval Chart bucket size. Defaults to `day`.
|
|
325
|
+
# @return [Array<(AuthInsightsResponse, Integer, Hash)>] AuthInsightsResponse data, response status code and response headers
|
|
326
|
+
def get_auth_insights_with_http_info(id, opts = {})
|
|
327
|
+
if @api_client.config.debugging
|
|
328
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.get_auth_insights ...'
|
|
329
|
+
end
|
|
330
|
+
# verify the required parameter 'id' is set
|
|
331
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
332
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.get_auth_insights"
|
|
333
|
+
end
|
|
334
|
+
# resource path
|
|
335
|
+
local_var_path = '/projects/{id}/auth/insights'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
336
|
+
|
|
337
|
+
# query parameters
|
|
338
|
+
query_params = opts[:query_params] || {}
|
|
339
|
+
query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
|
|
340
|
+
query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?
|
|
341
|
+
query_params[:'interval'] = opts[:'interval'] if !opts[:'interval'].nil?
|
|
342
|
+
|
|
343
|
+
# header parameters
|
|
344
|
+
header_params = opts[:header_params] || {}
|
|
345
|
+
# HTTP header 'Accept' (if needed)
|
|
346
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
347
|
+
|
|
348
|
+
# form parameters
|
|
349
|
+
form_params = opts[:form_params] || {}
|
|
350
|
+
|
|
351
|
+
# http body (model)
|
|
352
|
+
post_body = opts[:debug_body]
|
|
353
|
+
|
|
354
|
+
# return_type
|
|
355
|
+
return_type = opts[:debug_return_type] || 'AuthInsightsResponse'
|
|
356
|
+
|
|
357
|
+
# auth_names
|
|
358
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
359
|
+
|
|
360
|
+
new_options = opts.merge(
|
|
361
|
+
:operation => :"AuthAdminApi.get_auth_insights",
|
|
362
|
+
:header_params => header_params,
|
|
363
|
+
:query_params => query_params,
|
|
364
|
+
:form_params => form_params,
|
|
365
|
+
:body => post_body,
|
|
366
|
+
:auth_names => auth_names,
|
|
367
|
+
:return_type => return_type
|
|
368
|
+
)
|
|
369
|
+
|
|
370
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
371
|
+
if @api_client.config.debugging
|
|
372
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#get_auth_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
373
|
+
end
|
|
374
|
+
return data, status_code, headers
|
|
375
|
+
end
|
|
376
|
+
|
|
377
|
+
# Get specific auth user (admin)
|
|
378
|
+
# @param id [String] Project ID
|
|
379
|
+
# @param user_id [String]
|
|
380
|
+
# @param [Hash] opts the optional parameters
|
|
381
|
+
# @return [AuthUser]
|
|
382
|
+
def get_auth_user(id, user_id, opts = {})
|
|
383
|
+
data, _status_code, _headers = get_auth_user_with_http_info(id, user_id, opts)
|
|
384
|
+
data
|
|
385
|
+
end
|
|
386
|
+
|
|
387
|
+
# Get specific auth user (admin)
|
|
388
|
+
# @param id [String] Project ID
|
|
389
|
+
# @param user_id [String]
|
|
390
|
+
# @param [Hash] opts the optional parameters
|
|
391
|
+
# @return [Array<(AuthUser, Integer, Hash)>] AuthUser data, response status code and response headers
|
|
392
|
+
def get_auth_user_with_http_info(id, user_id, opts = {})
|
|
393
|
+
if @api_client.config.debugging
|
|
394
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.get_auth_user ...'
|
|
395
|
+
end
|
|
396
|
+
# verify the required parameter 'id' is set
|
|
397
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
398
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.get_auth_user"
|
|
399
|
+
end
|
|
400
|
+
# verify the required parameter 'user_id' is set
|
|
401
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
402
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.get_auth_user"
|
|
403
|
+
end
|
|
404
|
+
# resource path
|
|
405
|
+
local_var_path = '/projects/{id}/auth/users/{userId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
406
|
+
|
|
407
|
+
# query parameters
|
|
408
|
+
query_params = opts[:query_params] || {}
|
|
409
|
+
|
|
410
|
+
# header parameters
|
|
411
|
+
header_params = opts[:header_params] || {}
|
|
412
|
+
# HTTP header 'Accept' (if needed)
|
|
413
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
414
|
+
|
|
415
|
+
# form parameters
|
|
416
|
+
form_params = opts[:form_params] || {}
|
|
417
|
+
|
|
418
|
+
# http body (model)
|
|
419
|
+
post_body = opts[:debug_body]
|
|
420
|
+
|
|
421
|
+
# return_type
|
|
422
|
+
return_type = opts[:debug_return_type] || 'AuthUser'
|
|
423
|
+
|
|
424
|
+
# auth_names
|
|
425
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
426
|
+
|
|
427
|
+
new_options = opts.merge(
|
|
428
|
+
:operation => :"AuthAdminApi.get_auth_user",
|
|
429
|
+
:header_params => header_params,
|
|
430
|
+
:query_params => query_params,
|
|
431
|
+
:form_params => form_params,
|
|
432
|
+
:body => post_body,
|
|
433
|
+
:auth_names => auth_names,
|
|
434
|
+
:return_type => return_type
|
|
435
|
+
)
|
|
436
|
+
|
|
437
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
438
|
+
if @api_client.config.debugging
|
|
439
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#get_auth_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
440
|
+
end
|
|
441
|
+
return data, status_code, headers
|
|
442
|
+
end
|
|
443
|
+
|
|
444
|
+
# List all auth users (admin)
|
|
445
|
+
# List auth users in project. Requires platform token.
|
|
446
|
+
# @param id [String] Project ID
|
|
447
|
+
# @param [Hash] opts the optional parameters
|
|
448
|
+
# @option opts [Integer] :page Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit `page` see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying `page` selects offset pagination.
|
|
449
|
+
# @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
|
|
450
|
+
# @option opts [String] :cursor Opaque keyset pagination cursor from a previous response's `next_cursor` — pages forward. Mutually exclusive with `page` and `ending_before`; combining them returns 400. When supplied, the request's `search` and `limit` must match the values bound to the cursor or the request returns 400.
|
|
451
|
+
# @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response's `prev_cursor` — pages backward (the page immediately preceding this cursor). Mutually exclusive with `page` and `cursor`; combining them returns 400. `search` and `limit` must match the values bound to the cursor or the request returns 400.
|
|
452
|
+
# @option opts [Integer] :offset Bounded row offset past the keyset anchor named by `cursor` (forward) or `ending_before` (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise. (default to 0)
|
|
453
|
+
# @option opts [String] :search Case-insensitive substring match on the resource `name`. See the endpoint description for supported pagination modes.
|
|
454
|
+
# @option opts [String] :status Filter by effective status. `banned` returns only currently-banned users; an expired temporary ban lists as `active`.
|
|
455
|
+
# @return [PaginatedAuthUsers]
|
|
456
|
+
def list_auth_users(id, opts = {})
|
|
457
|
+
data, _status_code, _headers = list_auth_users_with_http_info(id, opts)
|
|
458
|
+
data
|
|
459
|
+
end
|
|
460
|
+
|
|
461
|
+
# List all auth users (admin)
|
|
462
|
+
# List auth users in project. Requires platform token.
|
|
463
|
+
# @param id [String] Project ID
|
|
464
|
+
# @param [Hash] opts the optional parameters
|
|
465
|
+
# @option opts [Integer] :page Page number (1-indexed) for offset pagination. Declares no schema default so the request validator does not inject one: handlers that omit `page` see it unset (nil) and default to 1 in code, while cursor-first endpoints (e.g. the project deployments feed) can detect its absence to stay in keyset/search mode. Supplying `page` selects offset pagination.
|
|
466
|
+
# @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
|
|
467
|
+
# @option opts [String] :cursor Opaque keyset pagination cursor from a previous response's `next_cursor` — pages forward. Mutually exclusive with `page` and `ending_before`; combining them returns 400. When supplied, the request's `search` and `limit` must match the values bound to the cursor or the request returns 400.
|
|
468
|
+
# @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response's `prev_cursor` — pages backward (the page immediately preceding this cursor). Mutually exclusive with `page` and `cursor`; combining them returns 400. `search` and `limit` must match the values bound to the cursor or the request returns 400.
|
|
469
|
+
# @option opts [Integer] :offset Bounded row offset past the keyset anchor named by `cursor` (forward) or `ending_before` (backward) — the hybrid jump. Seek to the anchor, then skip this many rows within. Used for numbered jump-to-page: from the current page, seek to its next/prev cursor and offset the remaining pages. Only honored on the cursor pagination path; ignored otherwise. (default to 0)
|
|
470
|
+
# @option opts [String] :search Case-insensitive substring match on the resource `name`. See the endpoint description for supported pagination modes.
|
|
471
|
+
# @option opts [String] :status Filter by effective status. `banned` returns only currently-banned users; an expired temporary ban lists as `active`.
|
|
472
|
+
# @return [Array<(PaginatedAuthUsers, Integer, Hash)>] PaginatedAuthUsers data, response status code and response headers
|
|
473
|
+
def list_auth_users_with_http_info(id, opts = {})
|
|
474
|
+
if @api_client.config.debugging
|
|
475
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.list_auth_users ...'
|
|
476
|
+
end
|
|
477
|
+
# verify the required parameter 'id' is set
|
|
478
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
479
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.list_auth_users"
|
|
480
|
+
end
|
|
481
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
482
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AuthAdminApi.list_auth_users, must be greater than or equal to 1.'
|
|
483
|
+
end
|
|
484
|
+
|
|
485
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
486
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AuthAdminApi.list_auth_users, must be smaller than or equal to 100.'
|
|
487
|
+
end
|
|
488
|
+
|
|
489
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
490
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AuthAdminApi.list_auth_users, must be greater than or equal to 1.'
|
|
491
|
+
end
|
|
492
|
+
|
|
493
|
+
if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
|
|
494
|
+
fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AuthAdminApi.list_auth_users, must be greater than or equal to 0.'
|
|
495
|
+
end
|
|
496
|
+
|
|
497
|
+
if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 256
|
|
498
|
+
fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AuthAdminApi.list_auth_users, the character length must be smaller than or equal to 256.'
|
|
499
|
+
end
|
|
500
|
+
|
|
501
|
+
allowable_values = ["active", "banned"]
|
|
502
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
503
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
504
|
+
end
|
|
505
|
+
# resource path
|
|
506
|
+
local_var_path = '/projects/{id}/auth/users'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
|
507
|
+
|
|
508
|
+
# query parameters
|
|
509
|
+
query_params = opts[:query_params] || {}
|
|
510
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
511
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
512
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
513
|
+
query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
|
|
514
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
515
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
516
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
517
|
+
|
|
518
|
+
# header parameters
|
|
519
|
+
header_params = opts[:header_params] || {}
|
|
520
|
+
# HTTP header 'Accept' (if needed)
|
|
521
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
522
|
+
|
|
523
|
+
# form parameters
|
|
524
|
+
form_params = opts[:form_params] || {}
|
|
525
|
+
|
|
526
|
+
# http body (model)
|
|
527
|
+
post_body = opts[:debug_body]
|
|
528
|
+
|
|
529
|
+
# return_type
|
|
530
|
+
return_type = opts[:debug_return_type] || 'PaginatedAuthUsers'
|
|
531
|
+
|
|
532
|
+
# auth_names
|
|
533
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
534
|
+
|
|
535
|
+
new_options = opts.merge(
|
|
536
|
+
:operation => :"AuthAdminApi.list_auth_users",
|
|
537
|
+
:header_params => header_params,
|
|
538
|
+
:query_params => query_params,
|
|
539
|
+
:form_params => form_params,
|
|
540
|
+
:body => post_body,
|
|
541
|
+
:auth_names => auth_names,
|
|
542
|
+
:return_type => return_type
|
|
543
|
+
)
|
|
544
|
+
|
|
545
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
546
|
+
if @api_client.config.debugging
|
|
547
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#list_auth_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
548
|
+
end
|
|
549
|
+
return data, status_code, headers
|
|
550
|
+
end
|
|
551
|
+
|
|
552
|
+
# List user sessions
|
|
553
|
+
# List paginated sessions for a specific auth user. Returns session details including device info, IP address, and activity timestamps. Ordering and pagination match `GET /auth/user/sessions`: the default is activity order with `page`/`limit` and the legacy `sessions` body, and `sort=created_at` opts into the standard cursor/offset hybrid with the shared `data` envelope. Cursor pagination is only available for `sort=created_at`, because the activity timestamp changes under paging. The `status=expired` filter is offset-only because sessions can expire above a cursor anchor during a walk.
|
|
554
|
+
# @param id [String] Project ID
|
|
555
|
+
# @param user_id [String]
|
|
556
|
+
# @param [Hash] opts the optional parameters
|
|
557
|
+
# @option opts [Integer] :page Page number (1-indexed) (default to 1)
|
|
558
|
+
# @option opts [Integer] :limit Number of sessions per page (max 100) (default to 20)
|
|
559
|
+
# @option opts [String] :sort Sort key. `last_activity` (default) orders by most recent activity and supports offset pagination only. `created_at` orders by session start and supports both offset and cursor pagination. (default to 'last_activity')
|
|
560
|
+
# @option opts [String] :status Filter by whether the session can still be refreshed. Omit for every stored session, including expired ones. `expired` is not supported with cursor pagination.
|
|
561
|
+
# @option opts [String] :cursor Opaque keyset cursor from a previous response's `next_cursor`. Requires `sort=created_at`; mutually exclusive with `page` and `ending_before`.
|
|
562
|
+
# @option opts [String] :ending_before Opaque keyset cursor from a previous response's `prev_cursor`, paging backward. Requires `sort=created_at`; mutually exclusive with `page` and `cursor`.
|
|
563
|
+
# @option opts [Integer] :offset Bounded number of rows to skip past the cursor anchor (the hybrid jump, maximum 100000). Ignored unless `cursor` or `ending_before` is supplied.
|
|
564
|
+
# @return [AuthGetMySessions200Response]
|
|
565
|
+
def list_user_sessions(id, user_id, opts = {})
|
|
566
|
+
data, _status_code, _headers = list_user_sessions_with_http_info(id, user_id, opts)
|
|
567
|
+
data
|
|
568
|
+
end
|
|
569
|
+
|
|
570
|
+
# List user sessions
|
|
571
|
+
# List paginated sessions for a specific auth user. Returns session details including device info, IP address, and activity timestamps. Ordering and pagination match `GET /auth/user/sessions`: the default is activity order with `page`/`limit` and the legacy `sessions` body, and `sort=created_at` opts into the standard cursor/offset hybrid with the shared `data` envelope. Cursor pagination is only available for `sort=created_at`, because the activity timestamp changes under paging. The `status=expired` filter is offset-only because sessions can expire above a cursor anchor during a walk.
|
|
572
|
+
# @param id [String] Project ID
|
|
573
|
+
# @param user_id [String]
|
|
574
|
+
# @param [Hash] opts the optional parameters
|
|
575
|
+
# @option opts [Integer] :page Page number (1-indexed) (default to 1)
|
|
576
|
+
# @option opts [Integer] :limit Number of sessions per page (max 100) (default to 20)
|
|
577
|
+
# @option opts [String] :sort Sort key. `last_activity` (default) orders by most recent activity and supports offset pagination only. `created_at` orders by session start and supports both offset and cursor pagination. (default to 'last_activity')
|
|
578
|
+
# @option opts [String] :status Filter by whether the session can still be refreshed. Omit for every stored session, including expired ones. `expired` is not supported with cursor pagination.
|
|
579
|
+
# @option opts [String] :cursor Opaque keyset cursor from a previous response's `next_cursor`. Requires `sort=created_at`; mutually exclusive with `page` and `ending_before`.
|
|
580
|
+
# @option opts [String] :ending_before Opaque keyset cursor from a previous response's `prev_cursor`, paging backward. Requires `sort=created_at`; mutually exclusive with `page` and `cursor`.
|
|
581
|
+
# @option opts [Integer] :offset Bounded number of rows to skip past the cursor anchor (the hybrid jump, maximum 100000). Ignored unless `cursor` or `ending_before` is supplied.
|
|
582
|
+
# @return [Array<(AuthGetMySessions200Response, Integer, Hash)>] AuthGetMySessions200Response data, response status code and response headers
|
|
583
|
+
def list_user_sessions_with_http_info(id, user_id, opts = {})
|
|
584
|
+
if @api_client.config.debugging
|
|
585
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.list_user_sessions ...'
|
|
586
|
+
end
|
|
587
|
+
# verify the required parameter 'id' is set
|
|
588
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
589
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.list_user_sessions"
|
|
590
|
+
end
|
|
591
|
+
# verify the required parameter 'user_id' is set
|
|
592
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
593
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.list_user_sessions"
|
|
594
|
+
end
|
|
595
|
+
if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
|
|
596
|
+
fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AuthAdminApi.list_user_sessions, must be greater than or equal to 1.'
|
|
597
|
+
end
|
|
598
|
+
|
|
599
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
|
|
600
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AuthAdminApi.list_user_sessions, must be smaller than or equal to 100.'
|
|
601
|
+
end
|
|
602
|
+
|
|
603
|
+
if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
|
|
604
|
+
fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AuthAdminApi.list_user_sessions, must be greater than or equal to 1.'
|
|
605
|
+
end
|
|
606
|
+
|
|
607
|
+
allowable_values = ["last_activity", "created_at"]
|
|
608
|
+
if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
|
|
609
|
+
fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
|
|
610
|
+
end
|
|
611
|
+
allowable_values = ["active", "expired"]
|
|
612
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
613
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
614
|
+
end
|
|
615
|
+
if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 100000
|
|
616
|
+
fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AuthAdminApi.list_user_sessions, must be smaller than or equal to 100000.'
|
|
617
|
+
end
|
|
618
|
+
|
|
619
|
+
if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
|
|
620
|
+
fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AuthAdminApi.list_user_sessions, must be greater than or equal to 0.'
|
|
621
|
+
end
|
|
622
|
+
|
|
623
|
+
# resource path
|
|
624
|
+
local_var_path = '/projects/{id}/auth/users/{userId}/sessions'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
625
|
+
|
|
626
|
+
# query parameters
|
|
627
|
+
query_params = opts[:query_params] || {}
|
|
628
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
629
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
630
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
631
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
632
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
|
633
|
+
query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
|
|
634
|
+
query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
|
|
635
|
+
|
|
636
|
+
# header parameters
|
|
637
|
+
header_params = opts[:header_params] || {}
|
|
638
|
+
# HTTP header 'Accept' (if needed)
|
|
639
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
640
|
+
|
|
641
|
+
# form parameters
|
|
642
|
+
form_params = opts[:form_params] || {}
|
|
643
|
+
|
|
644
|
+
# http body (model)
|
|
645
|
+
post_body = opts[:debug_body]
|
|
646
|
+
|
|
647
|
+
# return_type
|
|
648
|
+
return_type = opts[:debug_return_type] || 'AuthGetMySessions200Response'
|
|
649
|
+
|
|
650
|
+
# auth_names
|
|
651
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
652
|
+
|
|
653
|
+
new_options = opts.merge(
|
|
654
|
+
:operation => :"AuthAdminApi.list_user_sessions",
|
|
655
|
+
:header_params => header_params,
|
|
656
|
+
:query_params => query_params,
|
|
657
|
+
:form_params => form_params,
|
|
658
|
+
:body => post_body,
|
|
659
|
+
:auth_names => auth_names,
|
|
660
|
+
:return_type => return_type
|
|
661
|
+
)
|
|
662
|
+
|
|
663
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
664
|
+
if @api_client.config.debugging
|
|
665
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#list_user_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
666
|
+
end
|
|
667
|
+
return data, status_code, headers
|
|
668
|
+
end
|
|
669
|
+
|
|
670
|
+
# Unban a user
|
|
671
|
+
# Removes a ban from a user, restoring their ability to sign in. The user's status is set back to 'active'.
|
|
672
|
+
# @param id [String] Project ID
|
|
673
|
+
# @param user_id [String]
|
|
674
|
+
# @param [Hash] opts the optional parameters
|
|
675
|
+
# @return [UnbanUserResponse]
|
|
676
|
+
def unban_auth_user(id, user_id, opts = {})
|
|
677
|
+
data, _status_code, _headers = unban_auth_user_with_http_info(id, user_id, opts)
|
|
678
|
+
data
|
|
679
|
+
end
|
|
680
|
+
|
|
681
|
+
# Unban a user
|
|
682
|
+
# Removes a ban from a user, restoring their ability to sign in. The user's status is set back to 'active'.
|
|
683
|
+
# @param id [String] Project ID
|
|
684
|
+
# @param user_id [String]
|
|
685
|
+
# @param [Hash] opts the optional parameters
|
|
686
|
+
# @return [Array<(UnbanUserResponse, Integer, Hash)>] UnbanUserResponse data, response status code and response headers
|
|
687
|
+
def unban_auth_user_with_http_info(id, user_id, opts = {})
|
|
688
|
+
if @api_client.config.debugging
|
|
689
|
+
@api_client.config.logger.debug 'Calling API: AuthAdminApi.unban_auth_user ...'
|
|
690
|
+
end
|
|
691
|
+
# verify the required parameter 'id' is set
|
|
692
|
+
if @api_client.config.client_side_validation && id.nil?
|
|
693
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthAdminApi.unban_auth_user"
|
|
694
|
+
end
|
|
695
|
+
# verify the required parameter 'user_id' is set
|
|
696
|
+
if @api_client.config.client_side_validation && user_id.nil?
|
|
697
|
+
fail ArgumentError, "Missing the required parameter 'user_id' when calling AuthAdminApi.unban_auth_user"
|
|
698
|
+
end
|
|
699
|
+
# resource path
|
|
700
|
+
local_var_path = '/projects/{id}/auth/users/{userId}/unban'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'userId' + '}', CGI.escape(user_id.to_s))
|
|
701
|
+
|
|
702
|
+
# query parameters
|
|
703
|
+
query_params = opts[:query_params] || {}
|
|
704
|
+
|
|
705
|
+
# header parameters
|
|
706
|
+
header_params = opts[:header_params] || {}
|
|
707
|
+
# HTTP header 'Accept' (if needed)
|
|
708
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
|
|
709
|
+
|
|
710
|
+
# form parameters
|
|
711
|
+
form_params = opts[:form_params] || {}
|
|
712
|
+
|
|
713
|
+
# http body (model)
|
|
714
|
+
post_body = opts[:debug_body]
|
|
715
|
+
|
|
716
|
+
# return_type
|
|
717
|
+
return_type = opts[:debug_return_type] || 'UnbanUserResponse'
|
|
718
|
+
|
|
719
|
+
# auth_names
|
|
720
|
+
auth_names = opts[:debug_auth_names] || ['UserToken']
|
|
721
|
+
|
|
722
|
+
new_options = opts.merge(
|
|
723
|
+
:operation => :"AuthAdminApi.unban_auth_user",
|
|
724
|
+
:header_params => header_params,
|
|
725
|
+
:query_params => query_params,
|
|
726
|
+
:form_params => form_params,
|
|
727
|
+
:body => post_body,
|
|
728
|
+
:auth_names => auth_names,
|
|
729
|
+
:return_type => return_type
|
|
730
|
+
)
|
|
731
|
+
|
|
732
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
733
|
+
if @api_client.config.debugging
|
|
734
|
+
@api_client.config.logger.debug "API called: AuthAdminApi#unban_auth_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
735
|
+
end
|
|
736
|
+
return data, status_code, headers
|
|
737
|
+
end
|
|
738
|
+
end
|
|
739
|
+
end
|