pulp_maven_client 0.24.1 → 0.25.1

data/lib/pulp_maven_client/api/content_package_api.rb

@@ -0,0 +1,369 @@
+=begin
+#Pulp 3 API
+
+#Fetch, Upload, Organize, and Distribute Software Packages
+
+The version of the OpenAPI document: v3
+Contact: pulp-list@redhat.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module PulpMavenClient
+  class ContentPackageApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List maven packages
+    # A read-only ViewSet for MavenPackage.  MavenPackage represents a logical Maven package at the GAV (groupId, artifactId, version) level. Packages are automatically created when artifacts are added to a repository.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @option opts [String] :artifact_id Filter results where artifact_id matches value
+    # @option opts [String] :group_id Filter results where group_id matches value
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [String] :name Filter results where name matches value
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;group_id&#x60; - Group id * &#x60;-group_id&#x60; - Group id (descending) * &#x60;artifact_id&#x60; - Artifact id * &#x60;-artifact_id&#x60; - Artifact id (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;packaging&#x60; - Packaging * &#x60;-packaging&#x60; - Packaging (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;licenses&#x60; - Licenses * &#x60;-licenses&#x60; - Licenses (descending) * &#x60;dependencies&#x60; - Dependencies * &#x60;-dependencies&#x60; - Dependencies (descending) * &#x60;scm_url&#x60; - Scm url * &#x60;-scm_url&#x60; - Scm url (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
+    # @option opts [Float] :orphaned_for Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+    # @option opts [String] :packaging Filter results where packaging matches value
+    # @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
+    # @option opts [String] :repository_version 
+    # @option opts [String] :repository_version_added 
+    # @option opts [String] :repository_version_removed 
+    # @option opts [String] :version Filter results where version matches value
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [PaginatedmavenMavenPackageResponseList]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List maven packages
+    # A read-only ViewSet for MavenPackage.  MavenPackage represents a logical Maven package at the GAV (groupId, artifactId, version) level. Packages are automatically created when artifacts are added to a repository.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @option opts [String] :artifact_id Filter results where artifact_id matches value
+    # @option opts [String] :group_id Filter results where group_id matches value
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @option opts [String] :name Filter results where name matches value
+    # @option opts [Integer] :offset The initial index from which to return the results.
+    # @option opts [Array<String>] :ordering Ordering  * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;group_id&#x60; - Group id * &#x60;-group_id&#x60; - Group id (descending) * &#x60;artifact_id&#x60; - Artifact id * &#x60;-artifact_id&#x60; - Artifact id (descending) * &#x60;version&#x60; - Version * &#x60;-version&#x60; - Version (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;packaging&#x60; - Packaging * &#x60;-packaging&#x60; - Packaging (descending) * &#x60;url&#x60; - Url * &#x60;-url&#x60; - Url (descending) * &#x60;licenses&#x60; - Licenses * &#x60;-licenses&#x60; - Licenses (descending) * &#x60;dependencies&#x60; - Dependencies * &#x60;-dependencies&#x60; - Dependencies (descending) * &#x60;scm_url&#x60; - Scm url * &#x60;-scm_url&#x60; - Scm url (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)
+    # @option opts [Float] :orphaned_for Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
+    # @option opts [String] :packaging Filter results where packaging matches value
+    # @option opts [Array<String>] :prn__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas.
+    # @option opts [Array<String>] :pulp_id__in Multiple values may be separated by commas.
+    # @option opts [String] :pulp_label_select Filter labels by search string
+    # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters
+    # @option opts [String] :repository_version 
+    # @option opts [String] :repository_version_added 
+    # @option opts [String] :repository_version_removed 
+    # @option opts [String] :version Filter results where version matches value
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(PaginatedmavenMavenPackageResponseList, Integer, Hash)>] PaginatedmavenMavenPackageResponseList data, response status code and response headers
+    def list_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentPackageApi.list ...'
+      end
+      allowable_values = ["-artifact_id", "-dependencies", "-description", "-group_id", "-licenses", "-name", "-packaging", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-scm_url", "-timestamp_of_interest", "-upstream_id", "-url", "-version", "artifact_id", "dependencies", "description", "group_id", "licenses", "name", "packaging", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "scm_url", "timestamp_of_interest", "upstream_id", "url", "version"]
+      if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/content/maven/package/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'artifact_id'] = opts[:'artifact_id'] if !opts[:'artifact_id'].nil?
+      query_params[:'group_id'] = opts[:'group_id'] if !opts[:'group_id'].nil?
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
+      query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
+      query_params[:'packaging'] = opts[:'packaging'] if !opts[:'packaging'].nil?
+      query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].nil?
+      query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
+      query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil?
+      query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+      query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
+      query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?
+      query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil?
+      query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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']
+      header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PaginatedmavenMavenPackageResponseList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"ContentPackageApi.list",
+        :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: ContentPackageApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect a maven package
+    # A read-only ViewSet for MavenPackage.  MavenPackage represents a logical Maven package at the GAV (groupId, artifactId, version) level. Packages are automatically created when artifacts are added to a repository.
+    # @param maven_maven_package_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [MavenMavenPackageResponse]
+    def read(maven_maven_package_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(maven_maven_package_href, opts)
+      data
+    end
+
+    # Inspect a maven package
+    # A read-only ViewSet for MavenPackage.  MavenPackage represents a logical Maven package at the GAV (groupId, artifactId, version) level. Packages are automatically created when artifacts are added to a repository.
+    # @param maven_maven_package_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @option opts [Array<String>] :fields A list of fields to include in the response.
+    # @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(MavenMavenPackageResponse, Integer, Hash)>] MavenMavenPackageResponse data, response status code and response headers
+    def read_with_http_info(maven_maven_package_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentPackageApi.read ...'
+      end
+      # verify the required parameter 'maven_maven_package_href' is set
+      if @api_client.config.client_side_validation && maven_maven_package_href.nil?
+        fail ArgumentError, "Missing the required parameter 'maven_maven_package_href' when calling ContentPackageApi.read"
+      end
+      # resource path
+      local_var_path = '{maven_maven_package_href}'.sub('{' + 'maven_maven_package_href' + '}', CGI.escape(maven_maven_package_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
+      query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].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']
+      header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'MavenMavenPackageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"ContentPackageApi.read",
+        :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: ContentPackageApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set a label
+    # Set a single pulp_label on the object to a specific value or null.
+    # @param maven_maven_package_href [String] 
+    # @param set_label [SetLabel] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [SetLabelResponse]
+    def set_label(maven_maven_package_href, set_label, opts = {})
+      data, _status_code, _headers = set_label_with_http_info(maven_maven_package_href, set_label, opts)
+      data
+    end
+
+    # Set a label
+    # Set a single pulp_label on the object to a specific value or null.
+    # @param maven_maven_package_href [String] 
+    # @param set_label [SetLabel] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [Array<(SetLabelResponse, Integer, Hash)>] SetLabelResponse data, response status code and response headers
+    def set_label_with_http_info(maven_maven_package_href, set_label, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentPackageApi.set_label ...'
+      end
+      # verify the required parameter 'maven_maven_package_href' is set
+      if @api_client.config.client_side_validation && maven_maven_package_href.nil?
+        fail ArgumentError, "Missing the required parameter 'maven_maven_package_href' when calling ContentPackageApi.set_label"
+      end
+      # verify the required parameter 'set_label' is set
+      if @api_client.config.client_side_validation && set_label.nil?
+        fail ArgumentError, "Missing the required parameter 'set_label' when calling ContentPackageApi.set_label"
+      end
+      # resource path
+      local_var_path = '{maven_maven_package_href}set_label/'.sub('{' + 'maven_maven_package_href' + '}', CGI.escape(maven_maven_package_href.to_s).gsub('%2F', '/'))
+
+      # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(set_label)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SetLabelResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"ContentPackageApi.set_label",
+        :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: ContentPackageApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Unset a label
+    # Unset a single pulp_label on the object.
+    # @param maven_maven_package_href [String] 
+    # @param unset_label [UnsetLabel] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [UnsetLabelResponse]
+    def unset_label(maven_maven_package_href, unset_label, opts = {})
+      data, _status_code, _headers = unset_label_with_http_info(maven_maven_package_href, unset_label, opts)
+      data
+    end
+
+    # Unset a label
+    # Unset a single pulp_label on the object.
+    # @param maven_maven_package_href [String] 
+    # @param unset_label [UnsetLabel] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [Array<(UnsetLabelResponse, Integer, Hash)>] UnsetLabelResponse data, response status code and response headers
+    def unset_label_with_http_info(maven_maven_package_href, unset_label, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ContentPackageApi.unset_label ...'
+      end
+      # verify the required parameter 'maven_maven_package_href' is set
+      if @api_client.config.client_side_validation && maven_maven_package_href.nil?
+        fail ArgumentError, "Missing the required parameter 'maven_maven_package_href' when calling ContentPackageApi.unset_label"
+      end
+      # verify the required parameter 'unset_label' is set
+      if @api_client.config.client_side_validation && unset_label.nil?
+        fail ArgumentError, "Missing the required parameter 'unset_label' when calling ContentPackageApi.unset_label"
+      end
+      # resource path
+      local_var_path = '{maven_maven_package_href}unset_label/'.sub('{' + 'maven_maven_package_href' + '}', CGI.escape(maven_maven_package_href.to_s).gsub('%2F', '/'))
+
+      # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'X-Task-Diagnostics'] = @api_client.build_collection_param(opts[:'x_task_diagnostics'], :csv) if !opts[:'x_task_diagnostics'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(unset_label)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'UnsetLabelResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"ContentPackageApi.unset_label",
+        :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: ContentPackageApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end