volcano-sdk 0.34.0 → 0.35.0

data/lib/volcano/generated/lib/volcano-generated/api/autofix_api.rb

@@ -0,0 +1,222 @@
+=begin
+#Volcano API
+
+#Public API for Volcano 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.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@volcano.dev
+Generated by: https://openapi-generator.tech
+Generator version: 7.17.0
+
+=end
+
+require 'cgi'
+
+module Volcano::Generated
+  class AutofixApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete the API key
+    # Deletes the project's stored API key and returns the settings. Autofix on the key's provider runs on that key, so it turns off; on another provider it stays as it is. Deleting when no key is stored succeeds.  Turning autofix off or switching providers never deletes the key, and neither does applying a project configuration. This works where autofix is not available, for a project that saved settings.  Project access tokens are refused. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @return [AutofixSettings]
+    def delete_autofix_api_key(id, opts = {})
+      data, _status_code, _headers = delete_autofix_api_key_with_http_info(id, opts)
+      data
+    end
+
+    # Delete the API key
+    # Deletes the project's stored API key and returns the settings. Autofix on the key's provider runs on that key, so it turns off; on another provider it stays as it is. Deleting when no key is stored succeeds.  Turning autofix off or switching providers never deletes the key, and neither does applying a project configuration. This works where autofix is not available, for a project that saved settings.  Project access tokens are refused. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AutofixSettings, Integer, Hash)>] AutofixSettings data, response status code and response headers
+    def delete_autofix_api_key_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutofixApi.delete_autofix_api_key ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AutofixApi.delete_autofix_api_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/autofix/api-key'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutofixSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AutofixApi.delete_autofix_api_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutofixApi#delete_autofix_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get autofix settings
+    # Returns whether Volcano diagnoses the project's issues with AI, how far a run may go, and which model it uses. A project that never saved settings returns the defaults, with autofix off.  Your API key is never returned. `api_key_configured`, `api_key_provider`, and `api_key_last4` show whether one is set and which provider it belongs to.  Where autofix is not available, saved settings stay readable. A project that never saved any answers `404` with code `feature_unavailable`. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @return [AutofixSettings]
+    def get_autofix_settings(id, opts = {})
+      data, _status_code, _headers = get_autofix_settings_with_http_info(id, opts)
+      data
+    end
+
+    # Get autofix settings
+    # Returns whether Volcano diagnoses the project&#39;s issues with AI, how far a run may go, and which model it uses. A project that never saved settings returns the defaults, with autofix off.  Your API key is never returned. &#x60;api_key_configured&#x60;, &#x60;api_key_provider&#x60;, and &#x60;api_key_last4&#x60; show whether one is set and which provider it belongs to.  Where autofix is not available, saved settings stay readable. A project that never saved any answers &#x60;404&#x60; with code &#x60;feature_unavailable&#x60;. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AutofixSettings, Integer, Hash)>] AutofixSettings data, response status code and response headers
+    def get_autofix_settings_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutofixApi.get_autofix_settings ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AutofixApi.get_autofix_settings"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/autofix'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutofixSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken', 'ProjectAccessToken']
+
+      new_options = opts.merge(
+        :operation => :"AutofixApi.get_autofix_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutofixApi#get_autofix_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replace autofix settings
+    # Replaces the project's autofix settings. Omitted fields take their defaults, except three: an omitted `provider` or `model` keeps its saved value, and an omitted `api_key` keeps the stored key. So `{\"enabled\": false}` turns autofix off and keeps the key.  Project access tokens are refused. Autofix opens pull requests in the project's repository, so a person turns it on with a platform token or in the dashboard.  Turning autofix on needs a plan that includes it. Settings that are already on stay stored after a downgrade, and saving them again is not refused, but no run starts until the plan includes autofix again. Other saves need no plan.  Provider `anthropic` runs on your own API key. A key belongs to the provider it was saved with, and turning autofix on with a provider that runs on your own key needs one for it. Turning autofix off or switching providers keeps the stored key; only `DELETE /projects/{id}/autofix/api-key` removes it. Turning autofix on with provider `volcano` needs the `autofix.managed_models` capability; without it the request answers `400` with code `feature_unavailable`.  Where autofix is not available, a project with saved settings can still change them with `enabled: false`. Turning autofix on answers `404` with code `feature_unavailable`. 
+    # @param id [String] Project ID
+    # @param update_autofix_settings_request [UpdateAutofixSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AutofixSettings]
+    def update_autofix_settings(id, update_autofix_settings_request, opts = {})
+      data, _status_code, _headers = update_autofix_settings_with_http_info(id, update_autofix_settings_request, opts)
+      data
+    end
+
+    # Replace autofix settings
+    # Replaces the project&#39;s autofix settings. Omitted fields take their defaults, except three: an omitted &#x60;provider&#x60; or &#x60;model&#x60; keeps its saved value, and an omitted &#x60;api_key&#x60; keeps the stored key. So &#x60;{\&quot;enabled\&quot;: false}&#x60; turns autofix off and keeps the key.  Project access tokens are refused. Autofix opens pull requests in the project&#39;s repository, so a person turns it on with a platform token or in the dashboard.  Turning autofix on needs a plan that includes it. Settings that are already on stay stored after a downgrade, and saving them again is not refused, but no run starts until the plan includes autofix again. Other saves need no plan.  Provider &#x60;anthropic&#x60; runs on your own API key. A key belongs to the provider it was saved with, and turning autofix on with a provider that runs on your own key needs one for it. Turning autofix off or switching providers keeps the stored key; only &#x60;DELETE /projects/{id}/autofix/api-key&#x60; removes it. Turning autofix on with provider &#x60;volcano&#x60; needs the &#x60;autofix.managed_models&#x60; capability; without it the request answers &#x60;400&#x60; with code &#x60;feature_unavailable&#x60;.  Where autofix is not available, a project with saved settings can still change them with &#x60;enabled: false&#x60;. Turning autofix on answers &#x60;404&#x60; with code &#x60;feature_unavailable&#x60;. 
+    # @param id [String] Project ID
+    # @param update_autofix_settings_request [UpdateAutofixSettingsRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AutofixSettings, Integer, Hash)>] AutofixSettings data, response status code and response headers
+    def update_autofix_settings_with_http_info(id, update_autofix_settings_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutofixApi.update_autofix_settings ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling AutofixApi.update_autofix_settings"
+      end
+      # verify the required parameter 'update_autofix_settings_request' is set
+      if @api_client.config.client_side_validation && update_autofix_settings_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_autofix_settings_request' when calling AutofixApi.update_autofix_settings"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/autofix'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_autofix_settings_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutofixSettings'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AutofixApi.update_autofix_settings",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutofixApi#update_autofix_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end