dependency-tracker-client 1.0.0

data/lib/dependency-tracker-client/api/project_property_api.rb

@@ -0,0 +1,274 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module DependencyTracker
+  class ProjectPropertyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a new project property
+    # @param uuid [String] The UUID of the project to create a property for
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [ProjectProperty]
+    def create_property(uuid, opts = {})
+      data, _status_code, _headers = create_property_with_http_info(uuid, opts)
+      data
+    end
+
+    # Creates a new project property
+    # @param uuid [String] The UUID of the project to create a property for
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [Array<(ProjectProperty, Integer, Hash)>] ProjectProperty data, response status code and response headers
+    def create_property_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectPropertyApi.create_property ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling ProjectPropertyApi.create_property"
+      end
+      # resource path
+      local_var_path = '/v1/project/{uuid}/property'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectProperty' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: ProjectPropertyApi#create_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes a config property
+    # @param uuid [String] The UUID of the project to delete a property from
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [ProjectProperty]
+    def delete_property(uuid, opts = {})
+      data, _status_code, _headers = delete_property_with_http_info(uuid, opts)
+      data
+    end
+
+    # Deletes a config property
+    # @param uuid [String] The UUID of the project to delete a property from
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [Array<(ProjectProperty, Integer, Hash)>] ProjectProperty data, response status code and response headers
+    def delete_property_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectPropertyApi.delete_property ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling ProjectPropertyApi.delete_property"
+      end
+      # resource path
+      local_var_path = '/v1/project/{uuid}/property'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectProperty' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: ProjectPropertyApi#delete_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of all ProjectProperties for the specified project
+    # @param uuid [String] The UUID of the project to retrieve properties for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ProjectProperty>]
+    def get_properties(uuid, opts = {})
+      data, _status_code, _headers = get_properties_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns a list of all ProjectProperties for the specified project
+    # @param uuid [String] The UUID of the project to retrieve properties for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ProjectProperty>, Integer, Hash)>] Array<ProjectProperty> data, response status code and response headers
+    def get_properties_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectPropertyApi.get_properties ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling ProjectPropertyApi.get_properties"
+      end
+      # resource path
+      local_var_path = '/v1/project/{uuid}/property'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<ProjectProperty>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: ProjectPropertyApi#get_properties\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Updates a project property
+    # @param uuid [String] The UUID of the project to create a property for
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [ProjectProperty]
+    def update_property(uuid, opts = {})
+      data, _status_code, _headers = update_property_with_http_info(uuid, opts)
+      data
+    end
+
+    # Updates a project property
+    # @param uuid [String] The UUID of the project to create a property for
+    # @param [Hash] opts the optional parameters
+    # @option opts [ProjectProperty] :body 
+    # @return [Array<(ProjectProperty, Integer, Hash)>] ProjectProperty data, response status code and response headers
+    def update_property_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ProjectPropertyApi.update_property ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling ProjectPropertyApi.update_property"
+      end
+      # resource path
+      local_var_path = '/v1/project/{uuid}/property'.sub('{' + 'uuid' + '}', CGI.escape(uuid.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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ProjectProperty' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: ProjectPropertyApi#update_property\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/dependency-tracker-client/api/repository_api.rb

@@ -0,0 +1,376 @@
+=begin
+#Dependency-Track API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: 3.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'cgi'
+
+module DependencyTracker
+  class RepositoryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Creates a new repository
+    # @param [Hash] opts the optional parameters
+    # @option opts [Repository] :body 
+    # @return [Repository]
+    def create_repository(opts = {})
+      data, _status_code, _headers = create_repository_with_http_info(opts)
+      data
+    end
+
+    # Creates a new repository
+    # @param [Hash] opts the optional parameters
+    # @option opts [Repository] :body 
+    # @return [Array<(Repository, Integer, Hash)>] Repository data, response status code and response headers
+    def create_repository_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.create_repository ...'
+      end
+      # resource path
+      local_var_path = '/v1/repository'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Repository' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#create_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deletes a repository
+    # @param uuid [String] The UUID of the repository to delete
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_repository(uuid, opts = {})
+      delete_repository_with_http_info(uuid, opts)
+      nil
+    end
+
+    # Deletes a repository
+    # @param uuid [String] The UUID of the repository to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_repository_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.delete_repository ...'
+      end
+      # verify the required parameter 'uuid' is set
+      if @api_client.config.client_side_validation && uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'uuid' when calling RepositoryApi.delete_repository"
+      end
+      # resource path
+      local_var_path = '/v1/repository/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#delete_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of all repositories
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Repository>]
+    def get_repositories(opts = {})
+      data, _status_code, _headers = get_repositories_with_http_info(opts)
+      data
+    end
+
+    # Returns a list of all repositories
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Repository>, Integer, Hash)>] Array<Repository> data, response status code and response headers
+    def get_repositories_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.get_repositories ...'
+      end
+      # resource path
+      local_var_path = '/v1/repository'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Repository>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#get_repositories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns repositories that support the specific type
+    # @param type [String] The type of repositories to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Repository>]
+    def get_repositories_by_type(type, opts = {})
+      data, _status_code, _headers = get_repositories_by_type_with_http_info(type, opts)
+      data
+    end
+
+    # Returns repositories that support the specific type
+    # @param type [String] The type of repositories to retrieve
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Repository>, Integer, Hash)>] Array<Repository> data, response status code and response headers
+    def get_repositories_by_type_with_http_info(type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.get_repositories_by_type ...'
+      end
+      # verify the required parameter 'type' is set
+      if @api_client.config.client_side_validation && type.nil?
+        fail ArgumentError, "Missing the required parameter 'type' when calling RepositoryApi.get_repositories_by_type"
+      end
+      # verify enum value
+      allowable_values = ["MAVEN", "NPM", "GEM", "PYPI", "NUGET", "HEX", "UNSUPPORTED"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/repository/{type}'.sub('{' + 'type' + '}', CGI.escape(type.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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Repository>' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#get_repositories_by_type\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Attempts to resolve the latest version of the component available in the configured repositories
+    # @param purl [String] The Package URL for the component to query
+    # @param [Hash] opts the optional parameters
+    # @return [RepositoryMetaComponent]
+    def get_repository_meta_component(purl, opts = {})
+      data, _status_code, _headers = get_repository_meta_component_with_http_info(purl, opts)
+      data
+    end
+
+    # Attempts to resolve the latest version of the component available in the configured repositories
+    # @param purl [String] The Package URL for the component to query
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RepositoryMetaComponent, Integer, Hash)>] RepositoryMetaComponent data, response status code and response headers
+    def get_repository_meta_component_with_http_info(purl, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.get_repository_meta_component ...'
+      end
+      # verify the required parameter 'purl' is set
+      if @api_client.config.client_side_validation && purl.nil?
+        fail ArgumentError, "Missing the required parameter 'purl' when calling RepositoryApi.get_repository_meta_component"
+      end
+      # resource path
+      local_var_path = '/v1/repository/latest'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'purl'] = purl
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'RepositoryMetaComponent' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#get_repository_meta_component\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Updates a repository
+    # @param [Hash] opts the optional parameters
+    # @option opts [Repository] :body 
+    # @return [Repository]
+    def update_repository(opts = {})
+      data, _status_code, _headers = update_repository_with_http_info(opts)
+      data
+    end
+
+    # Updates a repository
+    # @param [Hash] opts the optional parameters
+    # @option opts [Repository] :body 
+    # @return [Array<(Repository, Integer, Hash)>] Repository data, response status code and response headers
+    def update_repository_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoryApi.update_repository ...'
+      end
+      # resource path
+      local_var_path = '/v1/repository'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'Repository' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['X-Api-Key']
+
+      new_options = opts.merge(
+        :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: RepositoryApi#update_repository\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end