volcano-sdk 0.5.2

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

@@ -0,0 +1,471 @@
+=begin
+#Volcano Hosting API
+
+#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.
+
+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 AnonKeysApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create anon key
+    # @param id [String] Project ID
+    # @param create_anon_key_request [CreateAnonKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [AnonKey]
+    def create_anon_key(id, create_anon_key_request, opts = {})
+      data, _status_code, _headers = create_anon_key_with_http_info(id, create_anon_key_request, opts)
+      data
+    end
+
+    # Create anon key
+    # @param id [String] Project ID
+    # @param create_anon_key_request [CreateAnonKeyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnonKey, Integer, Hash)>] AnonKey data, response status code and response headers
+    def create_anon_key_with_http_info(id, create_anon_key_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.create_anon_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 AnonKeysApi.create_anon_key"
+      end
+      # verify the required parameter 'create_anon_key_request' is set
+      if @api_client.config.client_side_validation && create_anon_key_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_anon_key_request' when calling AnonKeysApi.create_anon_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys'.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(create_anon_key_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AnonKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.create_anon_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnonKeysApi#create_anon_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get anon key
+    # Get details of a specific anon key
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AnonKey]
+    def get_anon_key(id, key_id, opts = {})
+      data, _status_code, _headers = get_anon_key_with_http_info(id, key_id, opts)
+      data
+    end
+
+    # Get anon key
+    # Get details of a specific anon key
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnonKey, Integer, Hash)>] AnonKey data, response status code and response headers
+    def get_anon_key_with_http_info(id, key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.get_anon_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 AnonKeysApi.get_anon_key"
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling AnonKeysApi.get_anon_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys/{keyId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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] || 'AnonKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.get_anon_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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnonKeysApi#get_anon_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List anon keys
+    # Supports two mutually exclusive pagination modes. Offset mode uses `page` and `limit` and is the default when neither `cursor` nor `search` is supplied (first page, default `limit`). Cursor mode uses `cursor` and `limit`, supports `search` (case-insensitive name match), and returns `next_cursor`. Sending both `page` and `cursor` (or `page` and `search`) returns 400. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @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 &#x60;page&#x60; 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 &#x60;page&#x60; selects offset pagination. 
+    # @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
+    # @option opts [String] :cursor Opaque keyset pagination cursor from a previous response&#39;s &#x60;next_cursor&#x60; — pages forward. Mutually exclusive with &#x60;page&#x60; and &#x60;ending_before&#x60;; combining them returns 400. When supplied, the request&#39;s &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response&#39;s &#x60;prev_cursor&#x60; — pages backward (the page immediately preceding this cursor). Mutually exclusive with &#x60;page&#x60; and &#x60;cursor&#x60;; combining them returns 400. &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [Integer] :offset Bounded row offset past the keyset anchor named by &#x60;cursor&#x60; (forward) or &#x60;ending_before&#x60; (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)
+    # @option opts [String] :search Case-insensitive substring match on the resource &#x60;name&#x60;. See the endpoint description for supported pagination modes. 
+    # @return [ListAnonKeys200Response]
+    def list_anon_keys(id, opts = {})
+      data, _status_code, _headers = list_anon_keys_with_http_info(id, opts)
+      data
+    end
+
+    # List anon keys
+    # Supports two mutually exclusive pagination modes. Offset mode uses &#x60;page&#x60; and &#x60;limit&#x60; and is the default when neither &#x60;cursor&#x60; nor &#x60;search&#x60; is supplied (first page, default &#x60;limit&#x60;). Cursor mode uses &#x60;cursor&#x60; and &#x60;limit&#x60;, supports &#x60;search&#x60; (case-insensitive name match), and returns &#x60;next_cursor&#x60;. Sending both &#x60;page&#x60; and &#x60;cursor&#x60; (or &#x60;page&#x60; and &#x60;search&#x60;) returns 400. 
+    # @param id [String] Project ID
+    # @param [Hash] opts the optional parameters
+    # @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 &#x60;page&#x60; 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 &#x60;page&#x60; selects offset pagination. 
+    # @option opts [Integer] :limit Number of items per page (max 100) (default to 10)
+    # @option opts [String] :cursor Opaque keyset pagination cursor from a previous response&#39;s &#x60;next_cursor&#x60; — pages forward. Mutually exclusive with &#x60;page&#x60; and &#x60;ending_before&#x60;; combining them returns 400. When supplied, the request&#39;s &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [String] :ending_before Opaque keyset pagination cursor from a previous response&#39;s &#x60;prev_cursor&#x60; — pages backward (the page immediately preceding this cursor). Mutually exclusive with &#x60;page&#x60; and &#x60;cursor&#x60;; combining them returns 400. &#x60;search&#x60; and &#x60;limit&#x60; must match the values bound to the cursor or the request returns 400. 
+    # @option opts [Integer] :offset Bounded row offset past the keyset anchor named by &#x60;cursor&#x60; (forward) or &#x60;ending_before&#x60; (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)
+    # @option opts [String] :search Case-insensitive substring match on the resource &#x60;name&#x60;. See the endpoint description for supported pagination modes. 
+    # @return [Array<(ListAnonKeys200Response, Integer, Hash)>] ListAnonKeys200Response data, response status code and response headers
+    def list_anon_keys_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.list_anon_keys ...'
+      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 AnonKeysApi.list_anon_keys"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling AnonKeysApi.list_anon_keys, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnonKeysApi.list_anon_keys, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling AnonKeysApi.list_anon_keys, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
+        fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling AnonKeysApi.list_anon_keys, must be greater than or equal to 0.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"search"]" when calling AnonKeysApi.list_anon_keys, the character length must be smaller than or equal to 256.'
+      end
+
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+      query_params[:'ending_before'] = opts[:'ending_before'] if !opts[:'ending_before'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+
+      # 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] || 'ListAnonKeys200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.list_anon_keys",
+        :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: AnonKeysApi#list_anon_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Regenerate anon key
+    # Generate new JWT value for existing key
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AnonKey]
+    def regenerate_anon_key(id, key_id, opts = {})
+      data, _status_code, _headers = regenerate_anon_key_with_http_info(id, key_id, opts)
+      data
+    end
+
+    # Regenerate anon key
+    # Generate new JWT value for existing key
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnonKey, Integer, Hash)>] AnonKey data, response status code and response headers
+    def regenerate_anon_key_with_http_info(id, key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.regenerate_anon_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 AnonKeysApi.regenerate_anon_key"
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling AnonKeysApi.regenerate_anon_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys/{keyId}/regenerate'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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] || 'AnonKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.regenerate_anon_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnonKeysApi#regenerate_anon_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke anon key
+    # Revokes key - it will immediately stop working
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def revoke_anon_key(id, key_id, opts = {})
+      revoke_anon_key_with_http_info(id, key_id, opts)
+      nil
+    end
+
+    # Revoke anon key
+    # Revokes key - it will immediately stop working
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def revoke_anon_key_with_http_info(id, key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.revoke_anon_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 AnonKeysApi.revoke_anon_key"
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling AnonKeysApi.revoke_anon_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys/{keyId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.revoke_anon_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: AnonKeysApi#revoke_anon_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set default anon key
+    # Promotes the given key to the project's configured default. At most one key per project can be default.
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AnonKey]
+    def set_default_anon_key(id, key_id, opts = {})
+      data, _status_code, _headers = set_default_anon_key_with_http_info(id, key_id, opts)
+      data
+    end
+
+    # Set default anon key
+    # Promotes the given key to the project&#39;s configured default. At most one key per project can be default.
+    # @param id [String] Project ID
+    # @param key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnonKey, Integer, Hash)>] AnonKey data, response status code and response headers
+    def set_default_anon_key_with_http_info(id, key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnonKeysApi.set_default_anon_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 AnonKeysApi.set_default_anon_key"
+      end
+      # verify the required parameter 'key_id' is set
+      if @api_client.config.client_side_validation && key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'key_id' when calling AnonKeysApi.set_default_anon_key"
+      end
+      # resource path
+      local_var_path = '/projects/{id}/anon-keys/{keyId}/set-default'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'keyId' + '}', CGI.escape(key_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] || 'AnonKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['UserToken']
+
+      new_options = opts.merge(
+        :operation => :"AnonKeysApi.set_default_anon_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AnonKeysApi#set_default_anon_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end