pulpcore_client 3.5.0 → 3.6.0

data/docs/WorkersApi.md

@@ -11,10 +11,12 @@ Method | HTTP request | Description
 
 ## list
 
-> InlineResponse2009 list(opts)
+> InlineResponse20014 list(opts)
 
 List workers
 
+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.
+
 ### Example
 
 ```ruby
@@ -22,26 +24,26 @@ List workers
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::WorkersApi.new
 opts = {
-  ordering: 'ordering_example', # String | Which field to use when ordering the results.
-  name: 'name_example', # String | 
-  name__in: 'name__in_example', # String | Filter results where name is in a comma-separated list of values
-  last_heartbeat__lt: 'last_heartbeat__lt_example', # String | Filter results where last_heartbeat is less than value
-  last_heartbeat__lte: 'last_heartbeat__lte_example', # String | Filter results where last_heartbeat is less than or equal to value
-  last_heartbeat__gt: 'last_heartbeat__gt_example', # String | Filter results where last_heartbeat is greater than value
-  last_heartbeat__gte: 'last_heartbeat__gte_example', # String | Filter results where last_heartbeat is greater than or equal to value
-  last_heartbeat__range: 'last_heartbeat__range_example', # String | Filter results where last_heartbeat is between two comma separated values
-  last_heartbeat: 'last_heartbeat_example', # String | ISO 8601 formatted dates are supported
-  online: 'online_example', # String | 
-  missing: 'missing_example', # String | 
+  last_heartbeat: 'last_heartbeat_example', # String | last_heartbeat
+  last_heartbeat__gt: 'last_heartbeat__gt_example', # String | last_heartbeat__gt
+  last_heartbeat__gte: 'last_heartbeat__gte_example', # String | last_heartbeat__gte
+  last_heartbeat__lt: 'last_heartbeat__lt_example', # String | last_heartbeat__lt
+  last_heartbeat__lte: 'last_heartbeat__lte_example', # String | last_heartbeat__lte
+  last_heartbeat__range: 'last_heartbeat__range_example', # String | last_heartbeat__range
   limit: 56, # Integer | Number of results to return per page.
+  missing: 'missing_example', # String | missing
+  name: 'name_example', # String | name
+  name__in: 'name__in_example', # String | name__in
   offset: 56, # Integer | The initial index from which to return the results.
+  online: 'online_example', # String | online
+  ordering: 'ordering_example', # String | Which field to use when ordering the results.
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
 }
@@ -60,29 +62,29 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **ordering** | **String**| Which field to use when ordering the results. | [optional] 
- **name** | **String**|  | [optional] 
- **name__in** | **String**| Filter results where name is in a comma-separated list of values | [optional] 
- **last_heartbeat__lt** | **String**| Filter results where last_heartbeat is less than value | [optional] 
- **last_heartbeat__lte** | **String**| Filter results where last_heartbeat is less than or equal to value | [optional] 
- **last_heartbeat__gt** | **String**| Filter results where last_heartbeat is greater than value | [optional] 
- **last_heartbeat__gte** | **String**| Filter results where last_heartbeat is greater than or equal to value | [optional] 
- **last_heartbeat__range** | **String**| Filter results where last_heartbeat is between two comma separated values | [optional] 
- **last_heartbeat** | **String**| ISO 8601 formatted dates are supported | [optional] 
- **online** | **String**|  | [optional] 
- **missing** | **String**|  | [optional] 
+ **last_heartbeat** | **String**| last_heartbeat | [optional] 
+ **last_heartbeat__gt** | **String**| last_heartbeat__gt | [optional] 
+ **last_heartbeat__gte** | **String**| last_heartbeat__gte | [optional] 
+ **last_heartbeat__lt** | **String**| last_heartbeat__lt | [optional] 
+ **last_heartbeat__lte** | **String**| last_heartbeat__lte | [optional] 
+ **last_heartbeat__range** | **String**| last_heartbeat__range | [optional] 
  **limit** | **Integer**| Number of results to return per page. | [optional] 
+ **missing** | **String**| missing | [optional] 
+ **name** | **String**| name | [optional] 
+ **name__in** | **String**| name__in | [optional] 
  **offset** | **Integer**| The initial index from which to return the results. | [optional] 
+ **online** | **String**| online | [optional] 
+ **ordering** | **String**| Which field to use when ordering the results. | [optional] 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
 ### Return type
 
-[**InlineResponse2009**](InlineResponse2009.md)
+[**InlineResponse20014**](InlineResponse20014.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 
@@ -92,10 +94,12 @@ Name | Type | Description  | Notes
 
 ## read
 
-> Worker read(worker_href, opts)
+> WorkerResponse read(worker_href, opts)
 
 Inspect a worker
 
+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.
+
 ### Example
 
 ```ruby
@@ -103,13 +107,13 @@ Inspect a worker
 require 'pulpcore_client'
 # setup authorization
 PulpcoreClient.configure do |config|
-  # Configure HTTP basic authorization: Basic
+  # Configure HTTP basic authorization: basicAuth
   config.username = 'YOUR USERNAME'
   config.password = 'YOUR PASSWORD'
 end
 
 api_instance = PulpcoreClient::WorkersApi.new
-worker_href = 'worker_href_example' # String | URI of Worker. e.g.: /pulp/api/v3/workers/1/
+worker_href = 'worker_href_example' # String | 
 opts = {
   fields: 'fields_example', # String | A list of fields to include in the response.
   exclude_fields: 'exclude_fields_example' # String | A list of fields to exclude from the response.
@@ -129,17 +133,17 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **worker_href** | **String**| URI of Worker. e.g.: /pulp/api/v3/workers/1/ | 
+ **worker_href** | **String**|  | 
  **fields** | **String**| A list of fields to include in the response. | [optional] 
  **exclude_fields** | **String**| A list of fields to exclude from the response. | [optional] 
 
 ### Return type
 
-[**Worker**](Worker.md)
+[**WorkerResponse**](WorkerResponse.md)
 
 ### Authorization
 
-[Basic](../README.md#Basic)
+[basicAuth](../README.md#basicAuth)
 
 ### HTTP request headers
 

data/lib/pulpcore_client/api/access_policies_api.rb

@@ -0,0 +1,301 @@
+=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
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module PulpcoreClient
+  class AccessPoliciesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List access policys
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @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 [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 [InlineResponse200]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List access policys
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit Number of results to return per page.
+    # @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 [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<(InlineResponse200, Integer, Hash)>] InlineResponse200 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: AccessPoliciesApi.list ...'
+      end
+      # resource path
+      local_var_path = '/pulp/api/v3/access_policies/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
+      query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
+      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] || 'InlineResponse200' 
+
+      # 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: AccessPoliciesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+    # @param access_policy_href [String] 
+    # @param patched_access_policy [PatchedAccessPolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccessPolicyResponse]
+    def partial_update(access_policy_href, patched_access_policy, opts = {})
+      data, _status_code, _headers = partial_update_with_http_info(access_policy_href, patched_access_policy, opts)
+      data
+    end
+
+    # Update an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \&quot;tech preview\&quot; and subject to change
+    # @param access_policy_href [String] 
+    # @param patched_access_policy [PatchedAccessPolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccessPolicyResponse, Integer, Hash)>] AccessPolicyResponse data, response status code and response headers
+    def partial_update_with_http_info(access_policy_href, patched_access_policy, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessPoliciesApi.partial_update ...'
+      end
+      # verify the required parameter 'access_policy_href' is set
+      if @api_client.config.client_side_validation && access_policy_href.nil?
+        fail ArgumentError, "Missing the required parameter 'access_policy_href' when calling AccessPoliciesApi.partial_update"
+      end
+      # verify the required parameter 'patched_access_policy' is set
+      if @api_client.config.client_side_validation && patched_access_policy.nil?
+        fail ArgumentError, "Missing the required parameter 'patched_access_policy' when calling AccessPoliciesApi.partial_update"
+      end
+      # resource path
+      local_var_path = '{access_policy_href}'.sub('{' + 'access_policy_href' + '}', CGI.escape(access_policy_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_access_policy) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccessPolicyResponse' 
+
+      # 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: AccessPoliciesApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Inspect an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+    # @param access_policy_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 [AccessPolicyResponse]
+    def read(access_policy_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(access_policy_href, opts)
+      data
+    end
+
+    # Inspect an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \&quot;tech preview\&quot; and subject to change
+    # @param access_policy_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<(AccessPolicyResponse, Integer, Hash)>] AccessPolicyResponse data, response status code and response headers
+    def read_with_http_info(access_policy_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessPoliciesApi.read ...'
+      end
+      # verify the required parameter 'access_policy_href' is set
+      if @api_client.config.client_side_validation && access_policy_href.nil?
+        fail ArgumentError, "Missing the required parameter 'access_policy_href' when calling AccessPoliciesApi.read"
+      end
+      # resource path
+      local_var_path = '{access_policy_href}'.sub('{' + 'access_policy_href' + '}', CGI.escape(access_policy_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] || 'AccessPolicyResponse' 
+
+      # 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: AccessPoliciesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \"tech preview\" and subject to change
+    # @param access_policy_href [String] 
+    # @param access_policy [AccessPolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [AccessPolicyResponse]
+    def update(access_policy_href, access_policy, opts = {})
+      data, _status_code, _headers = update_with_http_info(access_policy_href, access_policy, opts)
+      data
+    end
+
+    # Update an access policy
+    # ViewSet for AccessPolicy.  NOTE: This API endpoint is in \&quot;tech preview\&quot; and subject to change
+    # @param access_policy_href [String] 
+    # @param access_policy [AccessPolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccessPolicyResponse, Integer, Hash)>] AccessPolicyResponse data, response status code and response headers
+    def update_with_http_info(access_policy_href, access_policy, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccessPoliciesApi.update ...'
+      end
+      # verify the required parameter 'access_policy_href' is set
+      if @api_client.config.client_side_validation && access_policy_href.nil?
+        fail ArgumentError, "Missing the required parameter 'access_policy_href' when calling AccessPoliciesApi.update"
+      end
+      # verify the required parameter 'access_policy' is set
+      if @api_client.config.client_side_validation && access_policy.nil?
+        fail ArgumentError, "Missing the required parameter 'access_policy' when calling AccessPoliciesApi.update"
+      end
+      # resource path
+      local_var_path = '{access_policy_href}'.sub('{' + 'access_policy_href' + '}', CGI.escape(access_policy_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(access_policy) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AccessPolicyResponse' 
+
+      # 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: AccessPoliciesApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end