pulpcore_client 3.19.1 → 3.20.0

data/lib/pulpcore_client/api/distributions_api.rb

@@ -19,8 +19,134 @@ module PulpcoreClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Create a distribution
+    # Trigger an asynchronous create task
+    # @param distribution [Distribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def create(distribution, opts = {})
+      data, _status_code, _headers = create_with_http_info(distribution, opts)
+      data
+    end
+
+    # Create a distribution
+    # Trigger an asynchronous create task
+    # @param distribution [Distribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def create_with_http_info(distribution, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DistributionsApi.create ...'
+      end
+      # verify the required parameter 'distribution' is set
+      if @api_client.config.client_side_validation && distribution.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution' when calling DistributionsApi.create"
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/distributions/'
+
+      # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(distribution) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      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: DistributionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a distribution
+    # Trigger an asynchronous delete task
+    # @param distribution_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def delete(distribution_href, opts = {})
+      data, _status_code, _headers = delete_with_http_info(distribution_href, opts)
+      data
+    end
+
+    # Delete a distribution
+    # Trigger an asynchronous delete task
+    # @param distribution_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def delete_with_http_info(distribution_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DistributionsApi.delete ...'
+      end
+      # verify the required parameter 'distribution_href' is set
+      if @api_client.config.client_side_validation && distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_href' when calling DistributionsApi.delete"
+      end
+      # resource path
+      local_var_path = '{distribution_href}'.sub('{' + 'distribution_href' + '}', CGI.escape(distribution_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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      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: DistributionsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # List distributions
-    # A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \"Normal\" Django Models and Master/Detail models are supported by the ``register_with`` method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to 'pk'     endpoint_name (str): The name of the final path segment that should identify the ViewSet's         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \"parent_prefix\" of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object's         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
+    # Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path 
     # @option opts [String] :base_path__contains Filter results where base_path contains value
@@ -33,7 +159,7 @@ module PulpcoreClient
     # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
     # @option opts [String] :name__startswith Filter results where name starts with value
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
@@ -44,7 +170,7 @@ module PulpcoreClient
     end
 
     # List distributions
-    # A customized named ModelViewSet that knows how to register itself with the Pulp API router.  This viewset is discoverable by its name. \&quot;Normal\&quot; Django Models and Master/Detail models are supported by the &#x60;&#x60;register_with&#x60;&#x60; method.  Attributes:     lookup_field (str): The name of the field by which an object should be looked up, in         addition to any parent lookups if this ViewSet is nested. Defaults to &#39;pk&#39;     endpoint_name (str): The name of the final path segment that should identify the ViewSet&#39;s         collection endpoint.     nest_prefix (str): Optional prefix under which this ViewSet should be nested. This must         correspond to the \&quot;parent_prefix\&quot; of a router with rest_framework_nested.NestedMixin.         None indicates this ViewSet should not be nested.     parent_lookup_kwargs (dict): Optional mapping of key names that would appear in self.kwargs         to django model filter expressions that can be used with the corresponding value from         self.kwargs, used only by a nested ViewSet to filter based on the parent object&#39;s         identity.     schema (DefaultSchema): The schema class to use by default in a viewset.
+    # Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :base_path 
     # @option opts [String] :base_path__contains Filter results where base_path contains value
@@ -57,7 +183,7 @@ module PulpcoreClient
     # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
     # @option opts [String] :name__startswith Filter results where name starts with value
     # @option opts [Integer] :offset The initial index from which to return the results.
-    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Array<String>] :ordering Ordering
     # @option opts [String] :pulp_label_select Filter labels by search string
     # @option opts [String] :fields A list of fields to include in the response.
     # @option opts [String] :exclude_fields A list of fields to exclude from the response.
@@ -66,6 +192,10 @@ module PulpcoreClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DistributionsApi.list ...'
       end
+      allowable_values = ["-base_path", "-content_guard", "-file_filedistribution", "-group_roles", "-name", "-pk", "-publication", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-remote", "-repository", "-repository_version", "-user_roles", "base_path", "content_guard", "file_filedistribution", "group_roles", "name", "pk", "publication", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "remote", "repository", "repository_version", "user_roles"]
+      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/distributions/'
 
@@ -82,7 +212,7 @@ module PulpcoreClient
       query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
       query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
-      query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
+      query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil?
       query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
       query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
@@ -119,5 +249,213 @@ module PulpcoreClient
       end
       return data, status_code, headers
     end
+
+    # Update a distribution
+    # Trigger an asynchronous partial update task
+    # @param distribution_href [String] 
+    # @param patched_distribution [PatchedDistribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def partial_update(distribution_href, patched_distribution, opts = {})
+      data, _status_code, _headers = partial_update_with_http_info(distribution_href, patched_distribution, opts)
+      data
+    end
+
+    # Update a distribution
+    # Trigger an asynchronous partial update task
+    # @param distribution_href [String] 
+    # @param patched_distribution [PatchedDistribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def partial_update_with_http_info(distribution_href, patched_distribution, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DistributionsApi.partial_update ...'
+      end
+      # verify the required parameter 'distribution_href' is set
+      if @api_client.config.client_side_validation && distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_href' when calling DistributionsApi.partial_update"
+      end
+      # verify the required parameter 'patched_distribution' is set
+      if @api_client.config.client_side_validation && patched_distribution.nil?
+        fail ArgumentError, "Missing the required parameter 'patched_distribution' when calling DistributionsApi.partial_update"
+      end
+      # resource path
+      local_var_path = '{distribution_href}'.sub('{' + 'distribution_href' + '}', CGI.escape(distribution_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(patched_distribution) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DistributionsApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect a distribution
+    # Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
+    # @param distribution_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @option opts [String] :exclude_fields A list of fields to exclude from the response.
+    # @return [DistributionResponse]
+    def read(distribution_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(distribution_href, opts)
+      data
+    end
+
+    # Inspect a distribution
+    # Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.
+    # @param distribution_href [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :fields A list of fields to include in the response.
+    # @option opts [String] :exclude_fields A list of fields to exclude from the response.
+    # @return [Array<(DistributionResponse, Integer, Hash)>] DistributionResponse data, response status code and response headers
+    def read_with_http_info(distribution_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DistributionsApi.read ...'
+      end
+      # verify the required parameter 'distribution_href' is set
+      if @api_client.config.client_side_validation && distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_href' when calling DistributionsApi.read"
+      end
+      # resource path
+      local_var_path = '{distribution_href}'.sub('{' + 'distribution_href' + '}', CGI.escape(distribution_href.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
+      query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'DistributionResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      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: DistributionsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a distribution
+    # Trigger an asynchronous update task
+    # @param distribution_href [String] 
+    # @param distribution [Distribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def update(distribution_href, distribution, opts = {})
+      data, _status_code, _headers = update_with_http_info(distribution_href, distribution, opts)
+      data
+    end
+
+    # Update a distribution
+    # Trigger an asynchronous update task
+    # @param distribution_href [String] 
+    # @param distribution [Distribution] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def update_with_http_info(distribution_href, distribution, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DistributionsApi.update ...'
+      end
+      # verify the required parameter 'distribution_href' is set
+      if @api_client.config.client_side_validation && distribution_href.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_href' when calling DistributionsApi.update"
+      end
+      # verify the required parameter 'distribution' is set
+      if @api_client.config.client_side_validation && distribution.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution' when calling DistributionsApi.update"
+      end
+      # resource path
+      local_var_path = '{distribution_href}'.sub('{' + 'distribution_href' + '}', CGI.escape(distribution_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(distribution) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['basicAuth']
+
+      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: DistributionsApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end