hyperstack 1.25.0a0__py3-none-any.whl
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.
- hyperstack/__init__.py +420 -0
- hyperstack/api/__init__.py +48 -0
- hyperstack/api/alive_api.py +270 -0
- hyperstack/api/api_key_api.py +1161 -0
- hyperstack/api/assigning_member_role_api.py +615 -0
- hyperstack/api/auth_api.py +292 -0
- hyperstack/api/billing_api.py +5946 -0
- hyperstack/api/calculate_api.py +326 -0
- hyperstack/api/callbacks_api.py +1795 -0
- hyperstack/api/cluster_events_api.py +308 -0
- hyperstack/api/clusters_api.py +1651 -0
- hyperstack/api/compliance_api.py +1169 -0
- hyperstack/api/credit_api.py +295 -0
- hyperstack/api/customer_contract_api.py +922 -0
- hyperstack/api/dashboard_api.py +292 -0
- hyperstack/api/deployment_api.py +1122 -0
- hyperstack/api/environment_api.py +1490 -0
- hyperstack/api/firewall_attachment_api.py +343 -0
- hyperstack/api/firewalls_api.py +1819 -0
- hyperstack/api/flavor_api.py +315 -0
- hyperstack/api/floating_ip_api.py +585 -0
- hyperstack/api/gpu_api.py +292 -0
- hyperstack/api/image_api.py +1228 -0
- hyperstack/api/invite_api.py +857 -0
- hyperstack/api/keypair_api.py +1217 -0
- hyperstack/api/organization_api.py +864 -0
- hyperstack/api/payment_api.py +584 -0
- hyperstack/api/permission_api.py +292 -0
- hyperstack/api/policy_api.py +292 -0
- hyperstack/api/pricebook_api.py +293 -0
- hyperstack/api/profile_api.py +1131 -0
- hyperstack/api/rbac_role_api.py +1434 -0
- hyperstack/api/region_api.py +292 -0
- hyperstack/api/security_rules_api.py +292 -0
- hyperstack/api/snapshot_events_api.py +291 -0
- hyperstack/api/snapshots_api.py +1779 -0
- hyperstack/api/stock_api.py +292 -0
- hyperstack/api/template_api.py +1497 -0
- hyperstack/api/user_api.py +871 -0
- hyperstack/api/user_detail_choice_api.py +295 -0
- hyperstack/api/user_permission_api.py +567 -0
- hyperstack/api/virtual_machine_api.py +5289 -0
- hyperstack/api/virtual_machine_events_api.py +311 -0
- hyperstack/api/vnc_url_api.py +595 -0
- hyperstack/api/volume_api.py +1742 -0
- hyperstack/api/volume_attachment_api.py +650 -0
- hyperstack/api_client.py +797 -0
- hyperstack/api_response.py +21 -0
- hyperstack/configuration.py +605 -0
- hyperstack/exceptions.py +199 -0
- hyperstack/models/__init__.py +360 -0
- hyperstack/models/add_update_flavor_organization_payload.py +111 -0
- hyperstack/models/add_user_info_success_response_model.py +95 -0
- hyperstack/models/allocated_gpu_count_graph.py +89 -0
- hyperstack/models/api_key_fields.py +96 -0
- hyperstack/models/api_key_verify_fields.py +93 -0
- hyperstack/models/assign_rbac_role_payload.py +87 -0
- hyperstack/models/attach_callback_payload.py +87 -0
- hyperstack/models/attach_callback_response.py +91 -0
- hyperstack/models/attach_firewall_with_vm.py +87 -0
- hyperstack/models/attach_firewalls_to_vm_payload.py +87 -0
- hyperstack/models/attach_volume_fields.py +96 -0
- hyperstack/models/attach_volumes.py +99 -0
- hyperstack/models/attach_volumes_payload.py +87 -0
- hyperstack/models/auth_get_token_response_model.py +97 -0
- hyperstack/models/auth_request_login_fields.py +89 -0
- hyperstack/models/auth_request_login_response_model.py +95 -0
- hyperstack/models/auth_user_fields.py +94 -0
- hyperstack/models/auth_user_info_response_model.py +95 -0
- hyperstack/models/billing_immune_resources_response.py +95 -0
- hyperstack/models/billing_response.py +100 -0
- hyperstack/models/billingmetricesfields.py +108 -0
- hyperstack/models/billingmetricesresponse.py +99 -0
- hyperstack/models/cluster_events.py +99 -0
- hyperstack/models/cluster_events_fields.py +104 -0
- hyperstack/models/cluster_fields.py +114 -0
- hyperstack/models/cluster_list_response.py +99 -0
- hyperstack/models/cluster_response.py +95 -0
- hyperstack/models/cluster_versions.py +91 -0
- hyperstack/models/common_response_model.py +89 -0
- hyperstack/models/compliance_fields.py +93 -0
- hyperstack/models/compliance_model_fields.py +99 -0
- hyperstack/models/compliance_payload.py +97 -0
- hyperstack/models/compliance_response.py +95 -0
- hyperstack/models/container_overview_fields.py +95 -0
- hyperstack/models/contract.py +105 -0
- hyperstack/models/contract_billing_history.py +97 -0
- hyperstack/models/contract_billing_history_response_attributes.py +99 -0
- hyperstack/models/contract_billing_history_response_model.py +95 -0
- hyperstack/models/contract_change_payload.py +101 -0
- hyperstack/models/contract_discount_plan_fields.py +103 -0
- hyperstack/models/contract_eligible_instance_fields.py +99 -0
- hyperstack/models/contract_eligible_instances_response.py +101 -0
- hyperstack/models/contract_event_create_model.py +91 -0
- hyperstack/models/contract_gpu_allocation_graph_response.py +95 -0
- hyperstack/models/contract_instance_fields.py +102 -0
- hyperstack/models/contract_instances_response.py +99 -0
- hyperstack/models/contract_resource_payload.py +95 -0
- hyperstack/models/contractl_billing_history_response_metrics.py +87 -0
- hyperstack/models/create_cluster_payload.py +101 -0
- hyperstack/models/create_contract_fields.py +110 -0
- hyperstack/models/create_contract_payload.py +106 -0
- hyperstack/models/create_discount_response.py +95 -0
- hyperstack/models/create_discounts_payload.py +112 -0
- hyperstack/models/create_environment.py +90 -0
- hyperstack/models/create_firewall_payload.py +91 -0
- hyperstack/models/create_firewall_rule_payload.py +104 -0
- hyperstack/models/create_gpu.py +91 -0
- hyperstack/models/create_image.py +91 -0
- hyperstack/models/create_image_payload.py +89 -0
- hyperstack/models/create_instances_payload.py +134 -0
- hyperstack/models/create_instances_response.py +99 -0
- hyperstack/models/create_profile_payload.py +92 -0
- hyperstack/models/create_profile_response.py +95 -0
- hyperstack/models/create_security_rule_payload.py +104 -0
- hyperstack/models/create_snapshot_payload.py +93 -0
- hyperstack/models/create_snapshot_response.py +95 -0
- hyperstack/models/create_update_compliance_response.py +95 -0
- hyperstack/models/create_update_permission_payload.py +93 -0
- hyperstack/models/create_update_permission_response_model.py +95 -0
- hyperstack/models/create_update_policy_payload.py +93 -0
- hyperstack/models/create_update_policy_response_model.py +95 -0
- hyperstack/models/create_update_rbac_role_payload.py +94 -0
- hyperstack/models/create_volume_payload.py +100 -0
- hyperstack/models/creditrechargelimitfield.py +93 -0
- hyperstack/models/creditrechargelimitresponse.py +99 -0
- hyperstack/models/creditrequestresponse.py +99 -0
- hyperstack/models/creditrequests.py +96 -0
- hyperstack/models/customer_contract_detail_response_model.py +95 -0
- hyperstack/models/customer_contract_fields.py +112 -0
- hyperstack/models/customer_fields.py +89 -0
- hyperstack/models/customer_payload.py +89 -0
- hyperstack/models/dashboard_info_response.py +95 -0
- hyperstack/models/data.py +91 -0
- hyperstack/models/deployment_fields.py +98 -0
- hyperstack/models/deployment_fieldsforstartdeployments.py +100 -0
- hyperstack/models/deployments.py +99 -0
- hyperstack/models/detach_volumes.py +99 -0
- hyperstack/models/detach_volumes_payload.py +87 -0
- hyperstack/models/discount_entity_model.py +97 -0
- hyperstack/models/discount_fields.py +100 -0
- hyperstack/models/discount_plan_fields.py +108 -0
- hyperstack/models/discount_resource_fields.py +93 -0
- hyperstack/models/discount_resource_payload.py +93 -0
- hyperstack/models/editlabelofanexisting_vm_payload.py +87 -0
- hyperstack/models/environment.py +95 -0
- hyperstack/models/environment_features.py +87 -0
- hyperstack/models/environment_fields.py +100 -0
- hyperstack/models/environment_fieldsfor_volume.py +87 -0
- hyperstack/models/environments.py +105 -0
- hyperstack/models/error_response_model.py +91 -0
- hyperstack/models/exclude_billing_post_payload.py +91 -0
- hyperstack/models/exclude_billing_post_response.py +91 -0
- hyperstack/models/export_billing_data_request.py +105 -0
- hyperstack/models/export_billing_data_response.py +89 -0
- hyperstack/models/field_change.py +91 -0
- hyperstack/models/firewall_attachment_model.py +98 -0
- hyperstack/models/firewall_attachment_vm_model.py +98 -0
- hyperstack/models/firewall_detail_fields.py +122 -0
- hyperstack/models/firewall_detail_response.py +95 -0
- hyperstack/models/firewall_environment_fields.py +91 -0
- hyperstack/models/firewall_fields.py +102 -0
- hyperstack/models/firewall_response.py +95 -0
- hyperstack/models/firewall_rule.py +95 -0
- hyperstack/models/firewalls_list_response.py +105 -0
- hyperstack/models/flavor_fields.py +120 -0
- hyperstack/models/flavor_item_get_response.py +99 -0
- hyperstack/models/flavor_list_response.py +99 -0
- hyperstack/models/flavor_object_fields.py +95 -0
- hyperstack/models/flavor_payload.py +101 -0
- hyperstack/models/flavor_response.py +95 -0
- hyperstack/models/flavor_vm_fields.py +100 -0
- hyperstack/models/flavor_vms_response.py +99 -0
- hyperstack/models/future_node_model.py +106 -0
- hyperstack/models/future_node_response_model.py +97 -0
- hyperstack/models/future_node_stock_model.py +93 -0
- hyperstack/models/future_node_update_model.py +98 -0
- hyperstack/models/future_nodes_stock_model.py +95 -0
- hyperstack/models/generate_update_api_key_payload.py +89 -0
- hyperstack/models/generate_update_api_key_response_model.py +95 -0
- hyperstack/models/get_all_contract_fields.py +100 -0
- hyperstack/models/get_all_contracts_response_model.py +99 -0
- hyperstack/models/get_all_discount_for_all_organization_response.py +99 -0
- hyperstack/models/get_all_discounts_fields.py +106 -0
- hyperstack/models/get_api_keys_response_model.py +99 -0
- hyperstack/models/get_customer_contracts_list_response_model.py +101 -0
- hyperstack/models/get_discount_detail_response.py +95 -0
- hyperstack/models/get_discount_response.py +99 -0
- hyperstack/models/get_entity_discount_detail_response.py +108 -0
- hyperstack/models/get_invites_response_model.py +99 -0
- hyperstack/models/get_organization_response_model.py +95 -0
- hyperstack/models/get_permissions_response_model.py +99 -0
- hyperstack/models/get_policies_response_model.py +99 -0
- hyperstack/models/get_rbac_roles_response_model.py +99 -0
- hyperstack/models/get_token_payload.py +89 -0
- hyperstack/models/get_user_permissions_response_model.py +99 -0
- hyperstack/models/get_version_response.py +91 -0
- hyperstack/models/getcreditandthresholdinfo.py +91 -0
- hyperstack/models/getcreditandthresholdinfoinresponse.py +95 -0
- hyperstack/models/gpu.py +95 -0
- hyperstack/models/gpu_fields.py +106 -0
- hyperstack/models/gpu_list.py +99 -0
- hyperstack/models/gpu_region_fields.py +89 -0
- hyperstack/models/graph_datetime_value_model.py +89 -0
- hyperstack/models/historical_instance.py +101 -0
- hyperstack/models/historical_instances_fields.py +110 -0
- hyperstack/models/image.py +91 -0
- hyperstack/models/image_fields.py +113 -0
- hyperstack/models/image_get_response.py +101 -0
- hyperstack/models/image_logos.py +99 -0
- hyperstack/models/images.py +99 -0
- hyperstack/models/import_keypair_payload.py +92 -0
- hyperstack/models/import_keypair_response.py +95 -0
- hyperstack/models/infrahub_resource_object_response.py +119 -0
- hyperstack/models/infrahub_resource_object_response_for_customer.py +109 -0
- hyperstack/models/insert_discount_plan_fields.py +112 -0
- hyperstack/models/instance.py +95 -0
- hyperstack/models/instance_environment_fields.py +99 -0
- hyperstack/models/instance_events.py +99 -0
- hyperstack/models/instance_events_fields.py +102 -0
- hyperstack/models/instance_fields.py +162 -0
- hyperstack/models/instance_flavor_fields.py +101 -0
- hyperstack/models/instance_image_fields.py +87 -0
- hyperstack/models/instance_keypair_fields.py +87 -0
- hyperstack/models/instance_overview_fields.py +95 -0
- hyperstack/models/instance_resize_payload.py +93 -0
- hyperstack/models/instances.py +105 -0
- hyperstack/models/instances_summary_fields.py +120 -0
- hyperstack/models/internal_environment_fields.py +94 -0
- hyperstack/models/internal_instance_fields.py +156 -0
- hyperstack/models/internal_instance_flavor_fields.py +104 -0
- hyperstack/models/internal_instance_image_fields.py +95 -0
- hyperstack/models/internal_instance_keypair_fields.py +98 -0
- hyperstack/models/internal_instances_response.py +99 -0
- hyperstack/models/internal_security_rules_fields_for_instance.py +104 -0
- hyperstack/models/internal_volume_attachment_fields.py +98 -0
- hyperstack/models/internal_volume_fields.py +95 -0
- hyperstack/models/internal_volumes_response.py +99 -0
- hyperstack/models/invite_fields.py +94 -0
- hyperstack/models/invite_user_payload.py +88 -0
- hyperstack/models/invite_user_response_model.py +95 -0
- hyperstack/models/keypair_fields.py +98 -0
- hyperstack/models/keypairs.py +105 -0
- hyperstack/models/lable_resonse.py +89 -0
- hyperstack/models/lastdaycostfields.py +93 -0
- hyperstack/models/lastdaycostresponse.py +95 -0
- hyperstack/models/logo_get_response.py +91 -0
- hyperstack/models/logout_payload.py +87 -0
- hyperstack/models/metric_item_fields.py +91 -0
- hyperstack/models/metrics_fields.py +116 -0
- hyperstack/models/name_available_model.py +91 -0
- hyperstack/models/new_configurations_response.py +95 -0
- hyperstack/models/new_model_response.py +101 -0
- hyperstack/models/new_stock_response.py +99 -0
- hyperstack/models/new_stock_retrive_response.py +95 -0
- hyperstack/models/new_stock_update_response_model.py +89 -0
- hyperstack/models/node_model.py +114 -0
- hyperstack/models/node_payload_model.py +97 -0
- hyperstack/models/node_power_usage_model.py +120 -0
- hyperstack/models/node_response_model.py +97 -0
- hyperstack/models/node_stock_payload_model.py +95 -0
- hyperstack/models/node_stock_response_model.py +95 -0
- hyperstack/models/node_stocks_payload.py +93 -0
- hyperstack/models/organization_fields.py +114 -0
- hyperstack/models/organization_level_billing_history.py +99 -0
- hyperstack/models/organization_level_billing_history_resources.py +97 -0
- hyperstack/models/organization_level_billing_history_response_attributes.py +87 -0
- hyperstack/models/organization_level_billing_history_response_metrics.py +97 -0
- hyperstack/models/organization_level_billing_history_response_model.py +95 -0
- hyperstack/models/organization_object_response.py +97 -0
- hyperstack/models/organization_thresholdfields.py +95 -0
- hyperstack/models/organization_user_response_model.py +112 -0
- hyperstack/models/organizationcreditrechargelimitresponse.py +95 -0
- hyperstack/models/organizationthresholdsresponse.py +99 -0
- hyperstack/models/organizationthresholdupdateresponse.py +95 -0
- hyperstack/models/overview_info.py +103 -0
- hyperstack/models/pagination_data.py +91 -0
- hyperstack/models/payment_details_fields.py +106 -0
- hyperstack/models/payment_details_response.py +95 -0
- hyperstack/models/payment_initiate_fields.py +87 -0
- hyperstack/models/payment_initiate_payload.py +87 -0
- hyperstack/models/payment_initiate_response.py +95 -0
- hyperstack/models/permission_fields.py +98 -0
- hyperstack/models/policy_fields.py +104 -0
- hyperstack/models/policy_permission_fields.py +91 -0
- hyperstack/models/power_usage_model.py +89 -0
- hyperstack/models/pricebook_model.py +100 -0
- hyperstack/models/pricebook_resource_object_response.py +107 -0
- hyperstack/models/pricebook_resource_object_response_for_customer.py +99 -0
- hyperstack/models/profile_fields.py +96 -0
- hyperstack/models/profile_list_response.py +99 -0
- hyperstack/models/profile_object_fields.py +89 -0
- hyperstack/models/rbac_role_detail_response_model.py +95 -0
- hyperstack/models/rbac_role_detail_response_model_fixed.py +95 -0
- hyperstack/models/rbac_role_field.py +87 -0
- hyperstack/models/rbac_role_fields.py +114 -0
- hyperstack/models/refresh_token_payload.py +89 -0
- hyperstack/models/region_fields.py +91 -0
- hyperstack/models/region_payload.py +89 -0
- hyperstack/models/region_response.py +95 -0
- hyperstack/models/regions.py +99 -0
- hyperstack/models/remove_member_from_organization_response_model.py +89 -0
- hyperstack/models/remove_member_payload.py +88 -0
- hyperstack/models/request_console.py +91 -0
- hyperstack/models/resource_billing_events_history_metrics.py +95 -0
- hyperstack/models/resource_billing_events_history_response.py +99 -0
- hyperstack/models/resource_billing_response_for_customer.py +95 -0
- hyperstack/models/resource_level_billing_details_attributes.py +91 -0
- hyperstack/models/resource_level_billing_details_metrics.py +101 -0
- hyperstack/models/resource_level_billing_details_vm.py +99 -0
- hyperstack/models/resource_level_billing_details_volume.py +99 -0
- hyperstack/models/resource_level_billing_details_volume_attributes.py +95 -0
- hyperstack/models/resource_level_billing_details_volume_metrics.py +95 -0
- hyperstack/models/resource_level_billing_history.py +105 -0
- hyperstack/models/resource_level_billing_history_resources.py +97 -0
- hyperstack/models/resource_level_billing_history_response_attributes.py +93 -0
- hyperstack/models/resource_level_billing_history_response_metrics.py +91 -0
- hyperstack/models/resource_level_billing_vm_details_resources.py +97 -0
- hyperstack/models/resource_level_billing_volume_details_resources.py +97 -0
- hyperstack/models/resource_level_graph_billing_detail_volume.py +101 -0
- hyperstack/models/resource_level_graph_billing_details_attributes.py +91 -0
- hyperstack/models/resource_level_graph_billing_details_metrics.py +97 -0
- hyperstack/models/resource_level_graph_billing_details_vm.py +101 -0
- hyperstack/models/resource_level_graph_billing_vm_details_resources.py +97 -0
- hyperstack/models/resource_level_graph_billing_volume_details_resources.py +97 -0
- hyperstack/models/resource_level_vm_billing_details_response_model.py +95 -0
- hyperstack/models/resource_level_vm_billing_history_response_model.py +95 -0
- hyperstack/models/resource_level_vm_graph_billing_details_response_model.py +95 -0
- hyperstack/models/resource_level_volume_billing_details_response_model.py +95 -0
- hyperstack/models/resource_level_volume_billing_history_response_model.py +95 -0
- hyperstack/models/resource_level_volume_graph_billing_details_response_model.py +95 -0
- hyperstack/models/resource_object_response_for_customer.py +93 -0
- hyperstack/models/response_model.py +89 -0
- hyperstack/models/role_permission_fields.py +91 -0
- hyperstack/models/role_policy_fields.py +91 -0
- hyperstack/models/security_group_rule.py +95 -0
- hyperstack/models/security_group_rule_fields.py +104 -0
- hyperstack/models/security_rules_fieldsfor_instance.py +104 -0
- hyperstack/models/security_rules_protocol_fields.py +91 -0
- hyperstack/models/set_defaults_payload.py +89 -0
- hyperstack/models/single_visibility_user_response.py +91 -0
- hyperstack/models/snapshot_fields.py +105 -0
- hyperstack/models/snapshot_restore_request.py +89 -0
- hyperstack/models/snapshot_retrieve.py +95 -0
- hyperstack/models/snapshot_retrieve_fields.py +103 -0
- hyperstack/models/snapshots.py +105 -0
- hyperstack/models/start_deployment.py +95 -0
- hyperstack/models/start_deployment_payload.py +93 -0
- hyperstack/models/stock_visibility_user_list_response.py +99 -0
- hyperstack/models/stock_visibility_user_payload.py +87 -0
- hyperstack/models/sub_resource_graph_billing_details_metrics.py +152 -0
- hyperstack/models/sub_resources_costs_response_model.py +101 -0
- hyperstack/models/sub_resources_graph_billing_history_fields.py +97 -0
- hyperstack/models/sub_resources_graph_response_model.py +95 -0
- hyperstack/models/subscribeorunsubscribeupdatepayload.py +87 -0
- hyperstack/models/success_response_model.py +89 -0
- hyperstack/models/template.py +95 -0
- hyperstack/models/template_fields.py +98 -0
- hyperstack/models/templates.py +99 -0
- hyperstack/models/token_fields.py +91 -0
- hyperstack/models/update_contract_payload.py +104 -0
- hyperstack/models/update_discounts_payload.py +102 -0
- hyperstack/models/update_discounts_status_payload.py +87 -0
- hyperstack/models/update_environment.py +88 -0
- hyperstack/models/update_gpu.py +91 -0
- hyperstack/models/update_keypair_name.py +88 -0
- hyperstack/models/update_keypairnameresponse.py +95 -0
- hyperstack/models/update_organization_payload.py +88 -0
- hyperstack/models/update_organization_response_model.py +89 -0
- hyperstack/models/update_template.py +91 -0
- hyperstack/models/user_default_choice_for_user_fields.py +91 -0
- hyperstack/models/user_default_choices_for_user_response.py +99 -0
- hyperstack/models/user_permission_fields.py +91 -0
- hyperstack/models/user_transfer_payload.py +89 -0
- hyperstack/models/userinfopostpayload.py +107 -0
- hyperstack/models/users_info_fields.py +114 -0
- hyperstack/models/users_info_list_response.py +95 -0
- hyperstack/models/verify_api_key_payload.py +87 -0
- hyperstack/models/verify_api_key_response_model.py +95 -0
- hyperstack/models/virtual_machine_usage.py +93 -0
- hyperstack/models/vm_usage_request_payload.py +87 -0
- hyperstack/models/vm_usage_response.py +101 -0
- hyperstack/models/vncurl.py +95 -0
- hyperstack/models/vncurl_fields.py +89 -0
- hyperstack/models/volume.py +95 -0
- hyperstack/models/volume_attachment_fields.py +98 -0
- hyperstack/models/volume_fields.py +116 -0
- hyperstack/models/volume_fieldsfor_instance.py +97 -0
- hyperstack/models/volume_overview_fields.py +91 -0
- hyperstack/models/volume_status_change_fields.py +96 -0
- hyperstack/models/volume_types.py +91 -0
- hyperstack/models/volumes.py +99 -0
- hyperstack/models/volumes_last_status_change_response.py +99 -0
- hyperstack/models/warning_mail_log_fields.py +99 -0
- hyperstack/models/warning_mail_log_response.py +101 -0
- hyperstack/py.typed +0 -0
- hyperstack/rest.py +257 -0
- hyperstack-1.25.0a0.dist-info/METADATA +23 -0
- hyperstack-1.25.0a0.dist-info/RECORD +401 -0
- hyperstack-1.25.0a0.dist-info/WHEEL +5 -0
- hyperstack-1.25.0a0.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1161 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
|
|
3
|
+
"""
|
|
4
|
+
Infrahub-API
|
|
5
|
+
|
|
6
|
+
Leverage the Infrahub API and Hyperstack platform to easily create, manage, and scale powerful GPU virtual machines and their associated resources. Access this SDK to automate the deployment of your workloads and streamline your infrastructure management. To contribute, please raise an issue with a bug report, feature request, feedback, or general inquiry.
|
|
7
|
+
|
|
8
|
+
The version of the OpenAPI document: 1.0
|
|
9
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
10
|
+
|
|
11
|
+
Do not edit the class manually.
|
|
12
|
+
""" # noqa: E501
|
|
13
|
+
|
|
14
|
+
import warnings
|
|
15
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
16
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
|
+
from typing_extensions import Annotated
|
|
18
|
+
|
|
19
|
+
from pydantic import StrictInt
|
|
20
|
+
from ..models.common_response_model import CommonResponseModel
|
|
21
|
+
from ..models.generate_update_api_key_payload import GenerateUpdateApiKeyPayload
|
|
22
|
+
from ..models.generate_update_api_key_response_model import GenerateUpdateApiKeyResponseModel
|
|
23
|
+
from ..models.get_api_keys_response_model import GetApiKeysResponseModel
|
|
24
|
+
|
|
25
|
+
from ..api_client import ApiClient, RequestSerialized
|
|
26
|
+
from ..api_response import ApiResponse
|
|
27
|
+
from ..rest import RESTResponseType
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
class ApiKeyApi:
|
|
31
|
+
"""NOTE: This class is auto generated by OpenAPI Generator
|
|
32
|
+
Ref: https://openapi-generator.tech
|
|
33
|
+
|
|
34
|
+
Do not edit the class manually.
|
|
35
|
+
"""
|
|
36
|
+
|
|
37
|
+
def __init__(self, api_client=None) -> None:
|
|
38
|
+
if api_client is None:
|
|
39
|
+
api_client = ApiClient.get_default()
|
|
40
|
+
self.api_client = api_client
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
@validate_call
|
|
44
|
+
def delete_api_key(
|
|
45
|
+
self,
|
|
46
|
+
api_key_id: StrictInt,
|
|
47
|
+
_request_timeout: Union[
|
|
48
|
+
None,
|
|
49
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
50
|
+
Tuple[
|
|
51
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
52
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
53
|
+
]
|
|
54
|
+
] = None,
|
|
55
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
56
|
+
_content_type: Optional[StrictStr] = None,
|
|
57
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
58
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
59
|
+
) -> CommonResponseModel:
|
|
60
|
+
"""Delete API Key
|
|
61
|
+
|
|
62
|
+
Delete a specified API key by including the ID of the API key in the path.
|
|
63
|
+
|
|
64
|
+
:param api_key_id: (required)
|
|
65
|
+
:type api_key_id: int
|
|
66
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
67
|
+
number provided, it will be total request
|
|
68
|
+
timeout. It can also be a pair (tuple) of
|
|
69
|
+
(connection, read) timeouts.
|
|
70
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
71
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
72
|
+
request; this effectively ignores the
|
|
73
|
+
authentication in the spec for a single request.
|
|
74
|
+
:type _request_auth: dict, optional
|
|
75
|
+
:param _content_type: force content-type for the request.
|
|
76
|
+
:type _content_type: str, Optional
|
|
77
|
+
:param _headers: set to override the headers for a single
|
|
78
|
+
request; this effectively ignores the headers
|
|
79
|
+
in the spec for a single request.
|
|
80
|
+
:type _headers: dict, optional
|
|
81
|
+
:param _host_index: set to override the host_index for a single
|
|
82
|
+
request; this effectively ignores the host_index
|
|
83
|
+
in the spec for a single request.
|
|
84
|
+
:type _host_index: int, optional
|
|
85
|
+
:return: Returns the result object.
|
|
86
|
+
""" # noqa: E501
|
|
87
|
+
|
|
88
|
+
_param = self._delete_api_key_serialize(
|
|
89
|
+
api_key_id=api_key_id,
|
|
90
|
+
_request_auth=_request_auth,
|
|
91
|
+
_content_type=_content_type,
|
|
92
|
+
_headers=_headers,
|
|
93
|
+
_host_index=_host_index
|
|
94
|
+
)
|
|
95
|
+
|
|
96
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
97
|
+
'200': "CommonResponseModel",
|
|
98
|
+
'400': "ErrorResponseModel",
|
|
99
|
+
'401': "ErrorResponseModel",
|
|
100
|
+
'404': "ErrorResponseModel",
|
|
101
|
+
'500': None,
|
|
102
|
+
}
|
|
103
|
+
response_data = self.api_client.call_api(
|
|
104
|
+
*_param,
|
|
105
|
+
_request_timeout=_request_timeout
|
|
106
|
+
)
|
|
107
|
+
response_data.read()
|
|
108
|
+
return self.api_client.response_deserialize(
|
|
109
|
+
response_data=response_data,
|
|
110
|
+
response_types_map=_response_types_map,
|
|
111
|
+
).data
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
@validate_call
|
|
115
|
+
def delete_api_key_with_http_info(
|
|
116
|
+
self,
|
|
117
|
+
api_key_id: StrictInt,
|
|
118
|
+
_request_timeout: Union[
|
|
119
|
+
None,
|
|
120
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
121
|
+
Tuple[
|
|
122
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
123
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
124
|
+
]
|
|
125
|
+
] = None,
|
|
126
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
127
|
+
_content_type: Optional[StrictStr] = None,
|
|
128
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
129
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
130
|
+
) -> ApiResponse[CommonResponseModel]:
|
|
131
|
+
"""Delete API Key
|
|
132
|
+
|
|
133
|
+
Delete a specified API key by including the ID of the API key in the path.
|
|
134
|
+
|
|
135
|
+
:param api_key_id: (required)
|
|
136
|
+
:type api_key_id: int
|
|
137
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
138
|
+
number provided, it will be total request
|
|
139
|
+
timeout. It can also be a pair (tuple) of
|
|
140
|
+
(connection, read) timeouts.
|
|
141
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
142
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
143
|
+
request; this effectively ignores the
|
|
144
|
+
authentication in the spec for a single request.
|
|
145
|
+
:type _request_auth: dict, optional
|
|
146
|
+
:param _content_type: force content-type for the request.
|
|
147
|
+
:type _content_type: str, Optional
|
|
148
|
+
:param _headers: set to override the headers for a single
|
|
149
|
+
request; this effectively ignores the headers
|
|
150
|
+
in the spec for a single request.
|
|
151
|
+
:type _headers: dict, optional
|
|
152
|
+
:param _host_index: set to override the host_index for a single
|
|
153
|
+
request; this effectively ignores the host_index
|
|
154
|
+
in the spec for a single request.
|
|
155
|
+
:type _host_index: int, optional
|
|
156
|
+
:return: Returns the result object.
|
|
157
|
+
""" # noqa: E501
|
|
158
|
+
|
|
159
|
+
_param = self._delete_api_key_serialize(
|
|
160
|
+
api_key_id=api_key_id,
|
|
161
|
+
_request_auth=_request_auth,
|
|
162
|
+
_content_type=_content_type,
|
|
163
|
+
_headers=_headers,
|
|
164
|
+
_host_index=_host_index
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
168
|
+
'200': "CommonResponseModel",
|
|
169
|
+
'400': "ErrorResponseModel",
|
|
170
|
+
'401': "ErrorResponseModel",
|
|
171
|
+
'404': "ErrorResponseModel",
|
|
172
|
+
'500': None,
|
|
173
|
+
}
|
|
174
|
+
response_data = self.api_client.call_api(
|
|
175
|
+
*_param,
|
|
176
|
+
_request_timeout=_request_timeout
|
|
177
|
+
)
|
|
178
|
+
response_data.read()
|
|
179
|
+
return self.api_client.response_deserialize(
|
|
180
|
+
response_data=response_data,
|
|
181
|
+
response_types_map=_response_types_map,
|
|
182
|
+
)
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
@validate_call
|
|
186
|
+
def delete_api_key_without_preload_content(
|
|
187
|
+
self,
|
|
188
|
+
api_key_id: StrictInt,
|
|
189
|
+
_request_timeout: Union[
|
|
190
|
+
None,
|
|
191
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
192
|
+
Tuple[
|
|
193
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
194
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
195
|
+
]
|
|
196
|
+
] = None,
|
|
197
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
198
|
+
_content_type: Optional[StrictStr] = None,
|
|
199
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
200
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
201
|
+
) -> RESTResponseType:
|
|
202
|
+
"""Delete API Key
|
|
203
|
+
|
|
204
|
+
Delete a specified API key by including the ID of the API key in the path.
|
|
205
|
+
|
|
206
|
+
:param api_key_id: (required)
|
|
207
|
+
:type api_key_id: int
|
|
208
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
209
|
+
number provided, it will be total request
|
|
210
|
+
timeout. It can also be a pair (tuple) of
|
|
211
|
+
(connection, read) timeouts.
|
|
212
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
213
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
214
|
+
request; this effectively ignores the
|
|
215
|
+
authentication in the spec for a single request.
|
|
216
|
+
:type _request_auth: dict, optional
|
|
217
|
+
:param _content_type: force content-type for the request.
|
|
218
|
+
:type _content_type: str, Optional
|
|
219
|
+
:param _headers: set to override the headers for a single
|
|
220
|
+
request; this effectively ignores the headers
|
|
221
|
+
in the spec for a single request.
|
|
222
|
+
:type _headers: dict, optional
|
|
223
|
+
:param _host_index: set to override the host_index for a single
|
|
224
|
+
request; this effectively ignores the host_index
|
|
225
|
+
in the spec for a single request.
|
|
226
|
+
:type _host_index: int, optional
|
|
227
|
+
:return: Returns the result object.
|
|
228
|
+
""" # noqa: E501
|
|
229
|
+
|
|
230
|
+
_param = self._delete_api_key_serialize(
|
|
231
|
+
api_key_id=api_key_id,
|
|
232
|
+
_request_auth=_request_auth,
|
|
233
|
+
_content_type=_content_type,
|
|
234
|
+
_headers=_headers,
|
|
235
|
+
_host_index=_host_index
|
|
236
|
+
)
|
|
237
|
+
|
|
238
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
239
|
+
'200': "CommonResponseModel",
|
|
240
|
+
'400': "ErrorResponseModel",
|
|
241
|
+
'401': "ErrorResponseModel",
|
|
242
|
+
'404': "ErrorResponseModel",
|
|
243
|
+
'500': None,
|
|
244
|
+
}
|
|
245
|
+
response_data = self.api_client.call_api(
|
|
246
|
+
*_param,
|
|
247
|
+
_request_timeout=_request_timeout
|
|
248
|
+
)
|
|
249
|
+
return response_data.response
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
def _delete_api_key_serialize(
|
|
253
|
+
self,
|
|
254
|
+
api_key_id,
|
|
255
|
+
_request_auth,
|
|
256
|
+
_content_type,
|
|
257
|
+
_headers,
|
|
258
|
+
_host_index,
|
|
259
|
+
) -> RequestSerialized:
|
|
260
|
+
|
|
261
|
+
_host = None
|
|
262
|
+
|
|
263
|
+
_collection_formats: Dict[str, str] = {
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
_path_params: Dict[str, str] = {}
|
|
267
|
+
_query_params: List[Tuple[str, str]] = []
|
|
268
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
269
|
+
_form_params: List[Tuple[str, str]] = []
|
|
270
|
+
_files: Dict[
|
|
271
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
272
|
+
] = {}
|
|
273
|
+
_body_params: Optional[bytes] = None
|
|
274
|
+
|
|
275
|
+
# process the path parameters
|
|
276
|
+
if api_key_id is not None:
|
|
277
|
+
_path_params['api_key_id'] = api_key_id
|
|
278
|
+
# process the query parameters
|
|
279
|
+
# process the header parameters
|
|
280
|
+
# process the form parameters
|
|
281
|
+
# process the body parameter
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
# set the HTTP header `Accept`
|
|
285
|
+
if 'Accept' not in _header_params:
|
|
286
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
287
|
+
[
|
|
288
|
+
'application/json'
|
|
289
|
+
]
|
|
290
|
+
)
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
# authentication setting
|
|
294
|
+
_auth_settings: List[str] = [
|
|
295
|
+
'apiKey',
|
|
296
|
+
'accessToken'
|
|
297
|
+
]
|
|
298
|
+
|
|
299
|
+
return self.api_client.param_serialize(
|
|
300
|
+
method='DELETE',
|
|
301
|
+
resource_path='/api-key/{api_key_id}',
|
|
302
|
+
path_params=_path_params,
|
|
303
|
+
query_params=_query_params,
|
|
304
|
+
header_params=_header_params,
|
|
305
|
+
body=_body_params,
|
|
306
|
+
post_params=_form_params,
|
|
307
|
+
files=_files,
|
|
308
|
+
auth_settings=_auth_settings,
|
|
309
|
+
collection_formats=_collection_formats,
|
|
310
|
+
_host=_host,
|
|
311
|
+
_request_auth=_request_auth
|
|
312
|
+
)
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
@validate_call
|
|
318
|
+
def generate_api_key(
|
|
319
|
+
self,
|
|
320
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
321
|
+
_request_timeout: Union[
|
|
322
|
+
None,
|
|
323
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
324
|
+
Tuple[
|
|
325
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
326
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
327
|
+
]
|
|
328
|
+
] = None,
|
|
329
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
330
|
+
_content_type: Optional[StrictStr] = None,
|
|
331
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
332
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
333
|
+
) -> GenerateUpdateApiKeyResponseModel:
|
|
334
|
+
"""Generate API Key
|
|
335
|
+
|
|
336
|
+
Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
|
|
337
|
+
|
|
338
|
+
:param payload: (required)
|
|
339
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
340
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
341
|
+
number provided, it will be total request
|
|
342
|
+
timeout. It can also be a pair (tuple) of
|
|
343
|
+
(connection, read) timeouts.
|
|
344
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
345
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
346
|
+
request; this effectively ignores the
|
|
347
|
+
authentication in the spec for a single request.
|
|
348
|
+
:type _request_auth: dict, optional
|
|
349
|
+
:param _content_type: force content-type for the request.
|
|
350
|
+
:type _content_type: str, Optional
|
|
351
|
+
:param _headers: set to override the headers for a single
|
|
352
|
+
request; this effectively ignores the headers
|
|
353
|
+
in the spec for a single request.
|
|
354
|
+
:type _headers: dict, optional
|
|
355
|
+
:param _host_index: set to override the host_index for a single
|
|
356
|
+
request; this effectively ignores the host_index
|
|
357
|
+
in the spec for a single request.
|
|
358
|
+
:type _host_index: int, optional
|
|
359
|
+
:return: Returns the result object.
|
|
360
|
+
""" # noqa: E501
|
|
361
|
+
|
|
362
|
+
_param = self._generate_api_key_serialize(
|
|
363
|
+
payload=payload,
|
|
364
|
+
_request_auth=_request_auth,
|
|
365
|
+
_content_type=_content_type,
|
|
366
|
+
_headers=_headers,
|
|
367
|
+
_host_index=_host_index
|
|
368
|
+
)
|
|
369
|
+
|
|
370
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
371
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
372
|
+
'400': "ErrorResponseModel",
|
|
373
|
+
'401': "ErrorResponseModel",
|
|
374
|
+
'403': "ErrorResponseModel",
|
|
375
|
+
'409': "ErrorResponseModel",
|
|
376
|
+
'500': None,
|
|
377
|
+
}
|
|
378
|
+
response_data = self.api_client.call_api(
|
|
379
|
+
*_param,
|
|
380
|
+
_request_timeout=_request_timeout
|
|
381
|
+
)
|
|
382
|
+
response_data.read()
|
|
383
|
+
return self.api_client.response_deserialize(
|
|
384
|
+
response_data=response_data,
|
|
385
|
+
response_types_map=_response_types_map,
|
|
386
|
+
).data
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
@validate_call
|
|
390
|
+
def generate_api_key_with_http_info(
|
|
391
|
+
self,
|
|
392
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
393
|
+
_request_timeout: Union[
|
|
394
|
+
None,
|
|
395
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
396
|
+
Tuple[
|
|
397
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
398
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
399
|
+
]
|
|
400
|
+
] = None,
|
|
401
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
402
|
+
_content_type: Optional[StrictStr] = None,
|
|
403
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
404
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
405
|
+
) -> ApiResponse[GenerateUpdateApiKeyResponseModel]:
|
|
406
|
+
"""Generate API Key
|
|
407
|
+
|
|
408
|
+
Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
|
|
409
|
+
|
|
410
|
+
:param payload: (required)
|
|
411
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
412
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
413
|
+
number provided, it will be total request
|
|
414
|
+
timeout. It can also be a pair (tuple) of
|
|
415
|
+
(connection, read) timeouts.
|
|
416
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
417
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
418
|
+
request; this effectively ignores the
|
|
419
|
+
authentication in the spec for a single request.
|
|
420
|
+
:type _request_auth: dict, optional
|
|
421
|
+
:param _content_type: force content-type for the request.
|
|
422
|
+
:type _content_type: str, Optional
|
|
423
|
+
:param _headers: set to override the headers for a single
|
|
424
|
+
request; this effectively ignores the headers
|
|
425
|
+
in the spec for a single request.
|
|
426
|
+
:type _headers: dict, optional
|
|
427
|
+
:param _host_index: set to override the host_index for a single
|
|
428
|
+
request; this effectively ignores the host_index
|
|
429
|
+
in the spec for a single request.
|
|
430
|
+
:type _host_index: int, optional
|
|
431
|
+
:return: Returns the result object.
|
|
432
|
+
""" # noqa: E501
|
|
433
|
+
|
|
434
|
+
_param = self._generate_api_key_serialize(
|
|
435
|
+
payload=payload,
|
|
436
|
+
_request_auth=_request_auth,
|
|
437
|
+
_content_type=_content_type,
|
|
438
|
+
_headers=_headers,
|
|
439
|
+
_host_index=_host_index
|
|
440
|
+
)
|
|
441
|
+
|
|
442
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
443
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
444
|
+
'400': "ErrorResponseModel",
|
|
445
|
+
'401': "ErrorResponseModel",
|
|
446
|
+
'403': "ErrorResponseModel",
|
|
447
|
+
'409': "ErrorResponseModel",
|
|
448
|
+
'500': None,
|
|
449
|
+
}
|
|
450
|
+
response_data = self.api_client.call_api(
|
|
451
|
+
*_param,
|
|
452
|
+
_request_timeout=_request_timeout
|
|
453
|
+
)
|
|
454
|
+
response_data.read()
|
|
455
|
+
return self.api_client.response_deserialize(
|
|
456
|
+
response_data=response_data,
|
|
457
|
+
response_types_map=_response_types_map,
|
|
458
|
+
)
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
@validate_call
|
|
462
|
+
def generate_api_key_without_preload_content(
|
|
463
|
+
self,
|
|
464
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
465
|
+
_request_timeout: Union[
|
|
466
|
+
None,
|
|
467
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
468
|
+
Tuple[
|
|
469
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
470
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
471
|
+
]
|
|
472
|
+
] = None,
|
|
473
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
474
|
+
_content_type: Optional[StrictStr] = None,
|
|
475
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
476
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
477
|
+
) -> RESTResponseType:
|
|
478
|
+
"""Generate API Key
|
|
479
|
+
|
|
480
|
+
Generates your API key, providing access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/generate-api-key).
|
|
481
|
+
|
|
482
|
+
:param payload: (required)
|
|
483
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
484
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
485
|
+
number provided, it will be total request
|
|
486
|
+
timeout. It can also be a pair (tuple) of
|
|
487
|
+
(connection, read) timeouts.
|
|
488
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
489
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
490
|
+
request; this effectively ignores the
|
|
491
|
+
authentication in the spec for a single request.
|
|
492
|
+
:type _request_auth: dict, optional
|
|
493
|
+
:param _content_type: force content-type for the request.
|
|
494
|
+
:type _content_type: str, Optional
|
|
495
|
+
:param _headers: set to override the headers for a single
|
|
496
|
+
request; this effectively ignores the headers
|
|
497
|
+
in the spec for a single request.
|
|
498
|
+
:type _headers: dict, optional
|
|
499
|
+
:param _host_index: set to override the host_index for a single
|
|
500
|
+
request; this effectively ignores the host_index
|
|
501
|
+
in the spec for a single request.
|
|
502
|
+
:type _host_index: int, optional
|
|
503
|
+
:return: Returns the result object.
|
|
504
|
+
""" # noqa: E501
|
|
505
|
+
|
|
506
|
+
_param = self._generate_api_key_serialize(
|
|
507
|
+
payload=payload,
|
|
508
|
+
_request_auth=_request_auth,
|
|
509
|
+
_content_type=_content_type,
|
|
510
|
+
_headers=_headers,
|
|
511
|
+
_host_index=_host_index
|
|
512
|
+
)
|
|
513
|
+
|
|
514
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
515
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
516
|
+
'400': "ErrorResponseModel",
|
|
517
|
+
'401': "ErrorResponseModel",
|
|
518
|
+
'403': "ErrorResponseModel",
|
|
519
|
+
'409': "ErrorResponseModel",
|
|
520
|
+
'500': None,
|
|
521
|
+
}
|
|
522
|
+
response_data = self.api_client.call_api(
|
|
523
|
+
*_param,
|
|
524
|
+
_request_timeout=_request_timeout
|
|
525
|
+
)
|
|
526
|
+
return response_data.response
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
def _generate_api_key_serialize(
|
|
530
|
+
self,
|
|
531
|
+
payload,
|
|
532
|
+
_request_auth,
|
|
533
|
+
_content_type,
|
|
534
|
+
_headers,
|
|
535
|
+
_host_index,
|
|
536
|
+
) -> RequestSerialized:
|
|
537
|
+
|
|
538
|
+
_host = None
|
|
539
|
+
|
|
540
|
+
_collection_formats: Dict[str, str] = {
|
|
541
|
+
}
|
|
542
|
+
|
|
543
|
+
_path_params: Dict[str, str] = {}
|
|
544
|
+
_query_params: List[Tuple[str, str]] = []
|
|
545
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
546
|
+
_form_params: List[Tuple[str, str]] = []
|
|
547
|
+
_files: Dict[
|
|
548
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
549
|
+
] = {}
|
|
550
|
+
_body_params: Optional[bytes] = None
|
|
551
|
+
|
|
552
|
+
# process the path parameters
|
|
553
|
+
# process the query parameters
|
|
554
|
+
# process the header parameters
|
|
555
|
+
# process the form parameters
|
|
556
|
+
# process the body parameter
|
|
557
|
+
if payload is not None:
|
|
558
|
+
_body_params = payload
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
# set the HTTP header `Accept`
|
|
562
|
+
if 'Accept' not in _header_params:
|
|
563
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
564
|
+
[
|
|
565
|
+
'application/json'
|
|
566
|
+
]
|
|
567
|
+
)
|
|
568
|
+
|
|
569
|
+
# set the HTTP header `Content-Type`
|
|
570
|
+
if _content_type:
|
|
571
|
+
_header_params['Content-Type'] = _content_type
|
|
572
|
+
else:
|
|
573
|
+
_default_content_type = (
|
|
574
|
+
self.api_client.select_header_content_type(
|
|
575
|
+
[
|
|
576
|
+
'application/json'
|
|
577
|
+
]
|
|
578
|
+
)
|
|
579
|
+
)
|
|
580
|
+
if _default_content_type is not None:
|
|
581
|
+
_header_params['Content-Type'] = _default_content_type
|
|
582
|
+
|
|
583
|
+
# authentication setting
|
|
584
|
+
_auth_settings: List[str] = [
|
|
585
|
+
'accessToken'
|
|
586
|
+
]
|
|
587
|
+
|
|
588
|
+
return self.api_client.param_serialize(
|
|
589
|
+
method='POST',
|
|
590
|
+
resource_path='/api-key/generate',
|
|
591
|
+
path_params=_path_params,
|
|
592
|
+
query_params=_query_params,
|
|
593
|
+
header_params=_header_params,
|
|
594
|
+
body=_body_params,
|
|
595
|
+
post_params=_form_params,
|
|
596
|
+
files=_files,
|
|
597
|
+
auth_settings=_auth_settings,
|
|
598
|
+
collection_formats=_collection_formats,
|
|
599
|
+
_host=_host,
|
|
600
|
+
_request_auth=_request_auth
|
|
601
|
+
)
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
@validate_call
|
|
607
|
+
def retrieve_api_keys(
|
|
608
|
+
self,
|
|
609
|
+
_request_timeout: Union[
|
|
610
|
+
None,
|
|
611
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
612
|
+
Tuple[
|
|
613
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
614
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
615
|
+
]
|
|
616
|
+
] = None,
|
|
617
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
618
|
+
_content_type: Optional[StrictStr] = None,
|
|
619
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
620
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
621
|
+
) -> GetApiKeysResponseModel:
|
|
622
|
+
"""Retrieve API Keys
|
|
623
|
+
|
|
624
|
+
Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
|
|
625
|
+
|
|
626
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
627
|
+
number provided, it will be total request
|
|
628
|
+
timeout. It can also be a pair (tuple) of
|
|
629
|
+
(connection, read) timeouts.
|
|
630
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
631
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
632
|
+
request; this effectively ignores the
|
|
633
|
+
authentication in the spec for a single request.
|
|
634
|
+
:type _request_auth: dict, optional
|
|
635
|
+
:param _content_type: force content-type for the request.
|
|
636
|
+
:type _content_type: str, Optional
|
|
637
|
+
:param _headers: set to override the headers for a single
|
|
638
|
+
request; this effectively ignores the headers
|
|
639
|
+
in the spec for a single request.
|
|
640
|
+
:type _headers: dict, optional
|
|
641
|
+
:param _host_index: set to override the host_index for a single
|
|
642
|
+
request; this effectively ignores the host_index
|
|
643
|
+
in the spec for a single request.
|
|
644
|
+
:type _host_index: int, optional
|
|
645
|
+
:return: Returns the result object.
|
|
646
|
+
""" # noqa: E501
|
|
647
|
+
|
|
648
|
+
_param = self._retrieve_api_keys_serialize(
|
|
649
|
+
_request_auth=_request_auth,
|
|
650
|
+
_content_type=_content_type,
|
|
651
|
+
_headers=_headers,
|
|
652
|
+
_host_index=_host_index
|
|
653
|
+
)
|
|
654
|
+
|
|
655
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
656
|
+
'200': "GetApiKeysResponseModel",
|
|
657
|
+
'400': "ErrorResponseModel",
|
|
658
|
+
'401': "ErrorResponseModel",
|
|
659
|
+
'500': None,
|
|
660
|
+
}
|
|
661
|
+
response_data = self.api_client.call_api(
|
|
662
|
+
*_param,
|
|
663
|
+
_request_timeout=_request_timeout
|
|
664
|
+
)
|
|
665
|
+
response_data.read()
|
|
666
|
+
return self.api_client.response_deserialize(
|
|
667
|
+
response_data=response_data,
|
|
668
|
+
response_types_map=_response_types_map,
|
|
669
|
+
).data
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
@validate_call
|
|
673
|
+
def retrieve_api_keys_with_http_info(
|
|
674
|
+
self,
|
|
675
|
+
_request_timeout: Union[
|
|
676
|
+
None,
|
|
677
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
678
|
+
Tuple[
|
|
679
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
680
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
681
|
+
]
|
|
682
|
+
] = None,
|
|
683
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
684
|
+
_content_type: Optional[StrictStr] = None,
|
|
685
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
686
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
687
|
+
) -> ApiResponse[GetApiKeysResponseModel]:
|
|
688
|
+
"""Retrieve API Keys
|
|
689
|
+
|
|
690
|
+
Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
|
|
691
|
+
|
|
692
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
693
|
+
number provided, it will be total request
|
|
694
|
+
timeout. It can also be a pair (tuple) of
|
|
695
|
+
(connection, read) timeouts.
|
|
696
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
697
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
698
|
+
request; this effectively ignores the
|
|
699
|
+
authentication in the spec for a single request.
|
|
700
|
+
:type _request_auth: dict, optional
|
|
701
|
+
:param _content_type: force content-type for the request.
|
|
702
|
+
:type _content_type: str, Optional
|
|
703
|
+
:param _headers: set to override the headers for a single
|
|
704
|
+
request; this effectively ignores the headers
|
|
705
|
+
in the spec for a single request.
|
|
706
|
+
:type _headers: dict, optional
|
|
707
|
+
:param _host_index: set to override the host_index for a single
|
|
708
|
+
request; this effectively ignores the host_index
|
|
709
|
+
in the spec for a single request.
|
|
710
|
+
:type _host_index: int, optional
|
|
711
|
+
:return: Returns the result object.
|
|
712
|
+
""" # noqa: E501
|
|
713
|
+
|
|
714
|
+
_param = self._retrieve_api_keys_serialize(
|
|
715
|
+
_request_auth=_request_auth,
|
|
716
|
+
_content_type=_content_type,
|
|
717
|
+
_headers=_headers,
|
|
718
|
+
_host_index=_host_index
|
|
719
|
+
)
|
|
720
|
+
|
|
721
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
722
|
+
'200': "GetApiKeysResponseModel",
|
|
723
|
+
'400': "ErrorResponseModel",
|
|
724
|
+
'401': "ErrorResponseModel",
|
|
725
|
+
'500': None,
|
|
726
|
+
}
|
|
727
|
+
response_data = self.api_client.call_api(
|
|
728
|
+
*_param,
|
|
729
|
+
_request_timeout=_request_timeout
|
|
730
|
+
)
|
|
731
|
+
response_data.read()
|
|
732
|
+
return self.api_client.response_deserialize(
|
|
733
|
+
response_data=response_data,
|
|
734
|
+
response_types_map=_response_types_map,
|
|
735
|
+
)
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
@validate_call
|
|
739
|
+
def retrieve_api_keys_without_preload_content(
|
|
740
|
+
self,
|
|
741
|
+
_request_timeout: Union[
|
|
742
|
+
None,
|
|
743
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
744
|
+
Tuple[
|
|
745
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
746
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
747
|
+
]
|
|
748
|
+
] = None,
|
|
749
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
750
|
+
_content_type: Optional[StrictStr] = None,
|
|
751
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
752
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
753
|
+
) -> RESTResponseType:
|
|
754
|
+
"""Retrieve API Keys
|
|
755
|
+
|
|
756
|
+
Retrieves your API keys, granting access to the Infrahub APIs. For further details on API keys, [**click here**](https://infrahub-doc.nexgencloud.com/docs/api-reference/auth-resources/api-key/retrieve-api-key).
|
|
757
|
+
|
|
758
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
759
|
+
number provided, it will be total request
|
|
760
|
+
timeout. It can also be a pair (tuple) of
|
|
761
|
+
(connection, read) timeouts.
|
|
762
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
763
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
764
|
+
request; this effectively ignores the
|
|
765
|
+
authentication in the spec for a single request.
|
|
766
|
+
:type _request_auth: dict, optional
|
|
767
|
+
:param _content_type: force content-type for the request.
|
|
768
|
+
:type _content_type: str, Optional
|
|
769
|
+
:param _headers: set to override the headers for a single
|
|
770
|
+
request; this effectively ignores the headers
|
|
771
|
+
in the spec for a single request.
|
|
772
|
+
:type _headers: dict, optional
|
|
773
|
+
:param _host_index: set to override the host_index for a single
|
|
774
|
+
request; this effectively ignores the host_index
|
|
775
|
+
in the spec for a single request.
|
|
776
|
+
:type _host_index: int, optional
|
|
777
|
+
:return: Returns the result object.
|
|
778
|
+
""" # noqa: E501
|
|
779
|
+
|
|
780
|
+
_param = self._retrieve_api_keys_serialize(
|
|
781
|
+
_request_auth=_request_auth,
|
|
782
|
+
_content_type=_content_type,
|
|
783
|
+
_headers=_headers,
|
|
784
|
+
_host_index=_host_index
|
|
785
|
+
)
|
|
786
|
+
|
|
787
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
788
|
+
'200': "GetApiKeysResponseModel",
|
|
789
|
+
'400': "ErrorResponseModel",
|
|
790
|
+
'401': "ErrorResponseModel",
|
|
791
|
+
'500': None,
|
|
792
|
+
}
|
|
793
|
+
response_data = self.api_client.call_api(
|
|
794
|
+
*_param,
|
|
795
|
+
_request_timeout=_request_timeout
|
|
796
|
+
)
|
|
797
|
+
return response_data.response
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
def _retrieve_api_keys_serialize(
|
|
801
|
+
self,
|
|
802
|
+
_request_auth,
|
|
803
|
+
_content_type,
|
|
804
|
+
_headers,
|
|
805
|
+
_host_index,
|
|
806
|
+
) -> RequestSerialized:
|
|
807
|
+
|
|
808
|
+
_host = None
|
|
809
|
+
|
|
810
|
+
_collection_formats: Dict[str, str] = {
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
_path_params: Dict[str, str] = {}
|
|
814
|
+
_query_params: List[Tuple[str, str]] = []
|
|
815
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
816
|
+
_form_params: List[Tuple[str, str]] = []
|
|
817
|
+
_files: Dict[
|
|
818
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
819
|
+
] = {}
|
|
820
|
+
_body_params: Optional[bytes] = None
|
|
821
|
+
|
|
822
|
+
# process the path parameters
|
|
823
|
+
# process the query parameters
|
|
824
|
+
# process the header parameters
|
|
825
|
+
# process the form parameters
|
|
826
|
+
# process the body parameter
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
# set the HTTP header `Accept`
|
|
830
|
+
if 'Accept' not in _header_params:
|
|
831
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
832
|
+
[
|
|
833
|
+
'application/json'
|
|
834
|
+
]
|
|
835
|
+
)
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
# authentication setting
|
|
839
|
+
_auth_settings: List[str] = [
|
|
840
|
+
'apiKey',
|
|
841
|
+
'accessToken'
|
|
842
|
+
]
|
|
843
|
+
|
|
844
|
+
return self.api_client.param_serialize(
|
|
845
|
+
method='GET',
|
|
846
|
+
resource_path='/api-key',
|
|
847
|
+
path_params=_path_params,
|
|
848
|
+
query_params=_query_params,
|
|
849
|
+
header_params=_header_params,
|
|
850
|
+
body=_body_params,
|
|
851
|
+
post_params=_form_params,
|
|
852
|
+
files=_files,
|
|
853
|
+
auth_settings=_auth_settings,
|
|
854
|
+
collection_formats=_collection_formats,
|
|
855
|
+
_host=_host,
|
|
856
|
+
_request_auth=_request_auth
|
|
857
|
+
)
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
@validate_call
|
|
863
|
+
def update_api_key(
|
|
864
|
+
self,
|
|
865
|
+
api_key_id: StrictInt,
|
|
866
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
867
|
+
_request_timeout: Union[
|
|
868
|
+
None,
|
|
869
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
870
|
+
Tuple[
|
|
871
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
872
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
873
|
+
]
|
|
874
|
+
] = None,
|
|
875
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
876
|
+
_content_type: Optional[StrictStr] = None,
|
|
877
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
878
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
879
|
+
) -> GenerateUpdateApiKeyResponseModel:
|
|
880
|
+
"""Update API Key
|
|
881
|
+
|
|
882
|
+
Updates the name and optionally the description of a specified API key. Include the ID of the API key in the path and the new name and optional description in the body of the request.
|
|
883
|
+
|
|
884
|
+
:param api_key_id: (required)
|
|
885
|
+
:type api_key_id: int
|
|
886
|
+
:param payload: (required)
|
|
887
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
888
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
889
|
+
number provided, it will be total request
|
|
890
|
+
timeout. It can also be a pair (tuple) of
|
|
891
|
+
(connection, read) timeouts.
|
|
892
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
893
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
894
|
+
request; this effectively ignores the
|
|
895
|
+
authentication in the spec for a single request.
|
|
896
|
+
:type _request_auth: dict, optional
|
|
897
|
+
:param _content_type: force content-type for the request.
|
|
898
|
+
:type _content_type: str, Optional
|
|
899
|
+
:param _headers: set to override the headers for a single
|
|
900
|
+
request; this effectively ignores the headers
|
|
901
|
+
in the spec for a single request.
|
|
902
|
+
:type _headers: dict, optional
|
|
903
|
+
:param _host_index: set to override the host_index for a single
|
|
904
|
+
request; this effectively ignores the host_index
|
|
905
|
+
in the spec for a single request.
|
|
906
|
+
:type _host_index: int, optional
|
|
907
|
+
:return: Returns the result object.
|
|
908
|
+
""" # noqa: E501
|
|
909
|
+
|
|
910
|
+
_param = self._update_api_key_serialize(
|
|
911
|
+
api_key_id=api_key_id,
|
|
912
|
+
payload=payload,
|
|
913
|
+
_request_auth=_request_auth,
|
|
914
|
+
_content_type=_content_type,
|
|
915
|
+
_headers=_headers,
|
|
916
|
+
_host_index=_host_index
|
|
917
|
+
)
|
|
918
|
+
|
|
919
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
920
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
921
|
+
'400': "ErrorResponseModel",
|
|
922
|
+
'401': "ErrorResponseModel",
|
|
923
|
+
'404': "ErrorResponseModel",
|
|
924
|
+
'500': None,
|
|
925
|
+
}
|
|
926
|
+
response_data = self.api_client.call_api(
|
|
927
|
+
*_param,
|
|
928
|
+
_request_timeout=_request_timeout
|
|
929
|
+
)
|
|
930
|
+
response_data.read()
|
|
931
|
+
return self.api_client.response_deserialize(
|
|
932
|
+
response_data=response_data,
|
|
933
|
+
response_types_map=_response_types_map,
|
|
934
|
+
).data
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
@validate_call
|
|
938
|
+
def update_api_key_with_http_info(
|
|
939
|
+
self,
|
|
940
|
+
api_key_id: StrictInt,
|
|
941
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
942
|
+
_request_timeout: Union[
|
|
943
|
+
None,
|
|
944
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
945
|
+
Tuple[
|
|
946
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
947
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
948
|
+
]
|
|
949
|
+
] = None,
|
|
950
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
951
|
+
_content_type: Optional[StrictStr] = None,
|
|
952
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
953
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
954
|
+
) -> ApiResponse[GenerateUpdateApiKeyResponseModel]:
|
|
955
|
+
"""Update API Key
|
|
956
|
+
|
|
957
|
+
Updates the name and optionally the description of a specified API key. Include the ID of the API key in the path and the new name and optional description in the body of the request.
|
|
958
|
+
|
|
959
|
+
:param api_key_id: (required)
|
|
960
|
+
:type api_key_id: int
|
|
961
|
+
:param payload: (required)
|
|
962
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
963
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
964
|
+
number provided, it will be total request
|
|
965
|
+
timeout. It can also be a pair (tuple) of
|
|
966
|
+
(connection, read) timeouts.
|
|
967
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
968
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
969
|
+
request; this effectively ignores the
|
|
970
|
+
authentication in the spec for a single request.
|
|
971
|
+
:type _request_auth: dict, optional
|
|
972
|
+
:param _content_type: force content-type for the request.
|
|
973
|
+
:type _content_type: str, Optional
|
|
974
|
+
:param _headers: set to override the headers for a single
|
|
975
|
+
request; this effectively ignores the headers
|
|
976
|
+
in the spec for a single request.
|
|
977
|
+
:type _headers: dict, optional
|
|
978
|
+
:param _host_index: set to override the host_index for a single
|
|
979
|
+
request; this effectively ignores the host_index
|
|
980
|
+
in the spec for a single request.
|
|
981
|
+
:type _host_index: int, optional
|
|
982
|
+
:return: Returns the result object.
|
|
983
|
+
""" # noqa: E501
|
|
984
|
+
|
|
985
|
+
_param = self._update_api_key_serialize(
|
|
986
|
+
api_key_id=api_key_id,
|
|
987
|
+
payload=payload,
|
|
988
|
+
_request_auth=_request_auth,
|
|
989
|
+
_content_type=_content_type,
|
|
990
|
+
_headers=_headers,
|
|
991
|
+
_host_index=_host_index
|
|
992
|
+
)
|
|
993
|
+
|
|
994
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
995
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
996
|
+
'400': "ErrorResponseModel",
|
|
997
|
+
'401': "ErrorResponseModel",
|
|
998
|
+
'404': "ErrorResponseModel",
|
|
999
|
+
'500': None,
|
|
1000
|
+
}
|
|
1001
|
+
response_data = self.api_client.call_api(
|
|
1002
|
+
*_param,
|
|
1003
|
+
_request_timeout=_request_timeout
|
|
1004
|
+
)
|
|
1005
|
+
response_data.read()
|
|
1006
|
+
return self.api_client.response_deserialize(
|
|
1007
|
+
response_data=response_data,
|
|
1008
|
+
response_types_map=_response_types_map,
|
|
1009
|
+
)
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
@validate_call
|
|
1013
|
+
def update_api_key_without_preload_content(
|
|
1014
|
+
self,
|
|
1015
|
+
api_key_id: StrictInt,
|
|
1016
|
+
payload: GenerateUpdateApiKeyPayload,
|
|
1017
|
+
_request_timeout: Union[
|
|
1018
|
+
None,
|
|
1019
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1020
|
+
Tuple[
|
|
1021
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1022
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1023
|
+
]
|
|
1024
|
+
] = None,
|
|
1025
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1026
|
+
_content_type: Optional[StrictStr] = None,
|
|
1027
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1028
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1029
|
+
) -> RESTResponseType:
|
|
1030
|
+
"""Update API Key
|
|
1031
|
+
|
|
1032
|
+
Updates the name and optionally the description of a specified API key. Include the ID of the API key in the path and the new name and optional description in the body of the request.
|
|
1033
|
+
|
|
1034
|
+
:param api_key_id: (required)
|
|
1035
|
+
:type api_key_id: int
|
|
1036
|
+
:param payload: (required)
|
|
1037
|
+
:type payload: GenerateUpdateApiKeyPayload
|
|
1038
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1039
|
+
number provided, it will be total request
|
|
1040
|
+
timeout. It can also be a pair (tuple) of
|
|
1041
|
+
(connection, read) timeouts.
|
|
1042
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1043
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1044
|
+
request; this effectively ignores the
|
|
1045
|
+
authentication in the spec for a single request.
|
|
1046
|
+
:type _request_auth: dict, optional
|
|
1047
|
+
:param _content_type: force content-type for the request.
|
|
1048
|
+
:type _content_type: str, Optional
|
|
1049
|
+
:param _headers: set to override the headers for a single
|
|
1050
|
+
request; this effectively ignores the headers
|
|
1051
|
+
in the spec for a single request.
|
|
1052
|
+
:type _headers: dict, optional
|
|
1053
|
+
:param _host_index: set to override the host_index for a single
|
|
1054
|
+
request; this effectively ignores the host_index
|
|
1055
|
+
in the spec for a single request.
|
|
1056
|
+
:type _host_index: int, optional
|
|
1057
|
+
:return: Returns the result object.
|
|
1058
|
+
""" # noqa: E501
|
|
1059
|
+
|
|
1060
|
+
_param = self._update_api_key_serialize(
|
|
1061
|
+
api_key_id=api_key_id,
|
|
1062
|
+
payload=payload,
|
|
1063
|
+
_request_auth=_request_auth,
|
|
1064
|
+
_content_type=_content_type,
|
|
1065
|
+
_headers=_headers,
|
|
1066
|
+
_host_index=_host_index
|
|
1067
|
+
)
|
|
1068
|
+
|
|
1069
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1070
|
+
'200': "GenerateUpdateApiKeyResponseModel",
|
|
1071
|
+
'400': "ErrorResponseModel",
|
|
1072
|
+
'401': "ErrorResponseModel",
|
|
1073
|
+
'404': "ErrorResponseModel",
|
|
1074
|
+
'500': None,
|
|
1075
|
+
}
|
|
1076
|
+
response_data = self.api_client.call_api(
|
|
1077
|
+
*_param,
|
|
1078
|
+
_request_timeout=_request_timeout
|
|
1079
|
+
)
|
|
1080
|
+
return response_data.response
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
def _update_api_key_serialize(
|
|
1084
|
+
self,
|
|
1085
|
+
api_key_id,
|
|
1086
|
+
payload,
|
|
1087
|
+
_request_auth,
|
|
1088
|
+
_content_type,
|
|
1089
|
+
_headers,
|
|
1090
|
+
_host_index,
|
|
1091
|
+
) -> RequestSerialized:
|
|
1092
|
+
|
|
1093
|
+
_host = None
|
|
1094
|
+
|
|
1095
|
+
_collection_formats: Dict[str, str] = {
|
|
1096
|
+
}
|
|
1097
|
+
|
|
1098
|
+
_path_params: Dict[str, str] = {}
|
|
1099
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1100
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1101
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1102
|
+
_files: Dict[
|
|
1103
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1104
|
+
] = {}
|
|
1105
|
+
_body_params: Optional[bytes] = None
|
|
1106
|
+
|
|
1107
|
+
# process the path parameters
|
|
1108
|
+
if api_key_id is not None:
|
|
1109
|
+
_path_params['api_key_id'] = api_key_id
|
|
1110
|
+
# process the query parameters
|
|
1111
|
+
# process the header parameters
|
|
1112
|
+
# process the form parameters
|
|
1113
|
+
# process the body parameter
|
|
1114
|
+
if payload is not None:
|
|
1115
|
+
_body_params = payload
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
# set the HTTP header `Accept`
|
|
1119
|
+
if 'Accept' not in _header_params:
|
|
1120
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1121
|
+
[
|
|
1122
|
+
'application/json'
|
|
1123
|
+
]
|
|
1124
|
+
)
|
|
1125
|
+
|
|
1126
|
+
# set the HTTP header `Content-Type`
|
|
1127
|
+
if _content_type:
|
|
1128
|
+
_header_params['Content-Type'] = _content_type
|
|
1129
|
+
else:
|
|
1130
|
+
_default_content_type = (
|
|
1131
|
+
self.api_client.select_header_content_type(
|
|
1132
|
+
[
|
|
1133
|
+
'application/json'
|
|
1134
|
+
]
|
|
1135
|
+
)
|
|
1136
|
+
)
|
|
1137
|
+
if _default_content_type is not None:
|
|
1138
|
+
_header_params['Content-Type'] = _default_content_type
|
|
1139
|
+
|
|
1140
|
+
# authentication setting
|
|
1141
|
+
_auth_settings: List[str] = [
|
|
1142
|
+
'apiKey',
|
|
1143
|
+
'accessToken'
|
|
1144
|
+
]
|
|
1145
|
+
|
|
1146
|
+
return self.api_client.param_serialize(
|
|
1147
|
+
method='PUT',
|
|
1148
|
+
resource_path='/api-key/{api_key_id}',
|
|
1149
|
+
path_params=_path_params,
|
|
1150
|
+
query_params=_query_params,
|
|
1151
|
+
header_params=_header_params,
|
|
1152
|
+
body=_body_params,
|
|
1153
|
+
post_params=_form_params,
|
|
1154
|
+
files=_files,
|
|
1155
|
+
auth_settings=_auth_settings,
|
|
1156
|
+
collection_formats=_collection_formats,
|
|
1157
|
+
_host=_host,
|
|
1158
|
+
_request_auth=_request_auth
|
|
1159
|
+
)
|
|
1160
|
+
|
|
1161
|
+
|