dependency-tracker-client 1.0.0

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

@@ -0,0 +1,254 @@
+=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 DependencyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Adds one or more components as a dependency to a project
+    # @param [Hash] opts the optional parameters
+    # @option opts [DependencyRequest] :body 
+    # @return [nil]
+    def add_dependency(opts = {})
+      add_dependency_with_http_info(opts)
+      nil
+    end
+
+    # Adds one or more components as a dependency to a project
+    # @param [Hash] opts the optional parameters
+    # @option opts [DependencyRequest] :body 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def add_dependency_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DependencyApi.add_dependency ...'
+      end
+      # resource path
+      local_var_path = '/v1/dependency'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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] 
+
+      # 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: DependencyApi#add_dependency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of all dependencies for a specific component
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Dependency>]
+    def get_dependencies_by_component(uuid, opts = {})
+      data, _status_code, _headers = get_dependencies_by_component_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns a list of all dependencies for a specific component
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Dependency>, Integer, Hash)>] Array<Dependency> data, response status code and response headers
+    def get_dependencies_by_component_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DependencyApi.get_dependencies_by_component ...'
+      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 DependencyApi.get_dependencies_by_component"
+      end
+      # resource path
+      local_var_path = '/v1/dependency/component/{uuid}'.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<Dependency>' 
+
+      # 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: DependencyApi#get_dependencies_by_component\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of all dependencies for a specific project
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Dependency>]
+    def get_dependencies_by_project(uuid, opts = {})
+      data, _status_code, _headers = get_dependencies_by_project_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns a list of all dependencies for a specific project
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Dependency>, Integer, Hash)>] Array<Dependency> data, response status code and response headers
+    def get_dependencies_by_project_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DependencyApi.get_dependencies_by_project ...'
+      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 DependencyApi.get_dependencies_by_project"
+      end
+      # resource path
+      local_var_path = '/v1/dependency/project/{uuid}'.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<Dependency>' 
+
+      # 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: DependencyApi#get_dependencies_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Removes a component as a dependency from a project
+    # @param [Hash] opts the optional parameters
+    # @option opts [DependencyRequest] :body 
+    # @return [nil]
+    def remove_dependency(opts = {})
+      remove_dependency_with_http_info(opts)
+      nil
+    end
+
+    # Removes a component as a dependency from a project
+    # @param [Hash] opts the optional parameters
+    # @option opts [DependencyRequest] :body 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def remove_dependency_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DependencyApi.remove_dependency ...'
+      end
+      # resource path
+      local_var_path = '/v1/dependency'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # 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] 
+
+      # 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: DependencyApi#remove_dependency\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,140 @@
+=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 FindingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Returns a the findings for the specified project as FPF
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def export_findings_by_project(uuid, opts = {})
+      export_findings_by_project_with_http_info(uuid, opts)
+      nil
+    end
+
+    # Returns a the findings for the specified project as FPF
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def export_findings_by_project_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FindingApi.export_findings_by_project ...'
+      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 FindingApi.export_findings_by_project"
+      end
+      # resource path
+      local_var_path = '/v1/finding/project/{uuid}/export'.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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FindingApi#export_findings_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns a list of all findings for a specific project
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Finding>]
+    def get_findings_by_project(uuid, opts = {})
+      data, _status_code, _headers = get_findings_by_project_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns a list of all findings for a specific project
+    # @param uuid [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Finding>, Integer, Hash)>] Array<Finding> data, response status code and response headers
+    def get_findings_by_project_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FindingApi.get_findings_by_project ...'
+      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 FindingApi.get_findings_by_project"
+      end
+      # resource path
+      local_var_path = '/v1/finding/project/{uuid}'.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<Finding>' 
+
+      # 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: FindingApi#get_findings_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

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

@@ -0,0 +1,254 @@
+=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 LdapApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Adds a mapping
+    # @param [Hash] opts the optional parameters
+    # @option opts [MappedLdapGroupRequest] :body 
+    # @return [MappedLdapGroup]
+    def add_mapping(opts = {})
+      data, _status_code, _headers = add_mapping_with_http_info(opts)
+      data
+    end
+
+    # Adds a mapping
+    # @param [Hash] opts the optional parameters
+    # @option opts [MappedLdapGroupRequest] :body 
+    # @return [Array<(MappedLdapGroup, Integer, Hash)>] MappedLdapGroup data, response status code and response headers
+    def add_mapping_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LdapApi.add_mapping ...'
+      end
+      # resource path
+      local_var_path = '/v1/ldap/mapping'
+
+      # 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] || @api_client.object_to_http_body(opts[:'body']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'MappedLdapGroup' 
+
+      # 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: LdapApi#add_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Removes a mapping
+    # @param uuid [String] The UUID of the mapping to delete
+    # @param [Hash] opts the optional parameters
+    # @return [MappedLdapGroup]
+    def delete_mapping(uuid, opts = {})
+      data, _status_code, _headers = delete_mapping_with_http_info(uuid, opts)
+      data
+    end
+
+    # Removes a mapping
+    # @param uuid [String] The UUID of the mapping to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MappedLdapGroup, Integer, Hash)>] MappedLdapGroup data, response status code and response headers
+    def delete_mapping_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LdapApi.delete_mapping ...'
+      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 LdapApi.delete_mapping"
+      end
+      # resource path
+      local_var_path = '/v1/ldap/mapping/{uuid}'.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] || 'MappedLdapGroup' 
+
+      # 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: LdapApi#delete_mapping\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the DNs of all accessible groups within the directory
+    # This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def retrieve_ldap_groups(opts = {})
+      data, _status_code, _headers = retrieve_ldap_groups_with_http_info(opts)
+      data
+    end
+
+    # Returns the DNs of all accessible groups within the directory
+    # This API performs a pass-thru query to the configured LDAP server. Search criteria results are cached using default Alpine CacheManager policy
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def retrieve_ldap_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LdapApi.retrieve_ldap_groups ...'
+      end
+      # resource path
+      local_var_path = '/v1/ldap/groups'
+
+      # 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<String>' 
+
+      # 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: LdapApi#retrieve_ldap_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Returns the DNs of all groups mapped to the specified team
+    # @param uuid [String] The UUID of the team to retrieve mappings for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def retrieve_ldap_groups1(uuid, opts = {})
+      data, _status_code, _headers = retrieve_ldap_groups1_with_http_info(uuid, opts)
+      data
+    end
+
+    # Returns the DNs of all groups mapped to the specified team
+    # @param uuid [String] The UUID of the team to retrieve mappings for
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def retrieve_ldap_groups1_with_http_info(uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: LdapApi.retrieve_ldap_groups1 ...'
+      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 LdapApi.retrieve_ldap_groups1"
+      end
+      # resource path
+      local_var_path = '/v1/ldap/team/{uuid}'.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<String>' 
+
+      # 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: LdapApi#retrieve_ldap_groups1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end