pulpcore_client 3.19.1 → 3.20.0

data/lib/pulpcore_client/api/users_api.rb

@@ -165,7 +165,7 @@ module PulpcoreClient
     # @option opts [Array<String>] :last_name__in Filter results where last_name is in a comma-separated list of values
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :username Filter results where username matches value
     # @option opts [String] :username__contains Filter results where username contains value
     # @option opts [String] :username__icontains Filter results where username contains value
@@ -201,7 +201,7 @@ module PulpcoreClient
     # @option opts [Array<String>] :last_name__in Filter results where last_name is in a comma-separated list of values
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :username Filter results where username matches value
     # @option opts [String] :username__contains Filter results where username contains value
     # @option opts [String] :username__icontains Filter results where username contains value
@@ -214,6 +214,10 @@ module PulpcoreClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: UsersApi.list ...'
       end
+      allowable_values = ["-date_joined", "-email", "-first_name", "-groups", "-id", "-is_active", "-is_staff", "-is_superuser", "-last_login", "-last_name", "-object_roles", "-password", "-pk", "-user_permissions", "-username", "date_joined", "email", "first_name", "groups", "id", "is_active", "is_staff", "is_superuser", "last_login", "last_name", "object_roles", "password", "pk", "user_permissions", "username"]
+      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/users/'
 
@@ -238,7 +242,7 @@ module PulpcoreClient
       query_params[:'last_name__in'] = @api_client.build_collection_param(opts[:'last_name__in'], :csv) if !opts[:'last_name__in'].nil?
       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[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
       query_params[:'username__contains'] = opts[:'username__contains'] if !opts[:'username__contains'].nil?
       query_params[:'username__icontains'] = opts[:'username__icontains'] if !opts[:'username__icontains'].nil?
@@ -350,72 +354,6 @@ module PulpcoreClient
       return data, status_code, headers
     end
 
-    # List user permissions.
-    # @param auth_user_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 [PermissionResponse]
-    def permissions(auth_user_href, opts = {})
-      data, _status_code, _headers = permissions_with_http_info(auth_user_href, opts)
-      data
-    end
-
-    # List user permissions.
-    # @param auth_user_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<(PermissionResponse, Integer, Hash)>] PermissionResponse data, response status code and response headers
-    def permissions_with_http_info(auth_user_href, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: UsersApi.permissions ...'
-      end
-      # verify the required parameter 'auth_user_href' is set
-      if @api_client.config.client_side_validation && auth_user_href.nil?
-        fail ArgumentError, "Missing the required parameter 'auth_user_href' when calling UsersApi.permissions"
-      end
-      # resource path
-      local_var_path = '{auth_user_href}permissions/'.sub('{' + 'auth_user_href' + '}', CGI.escape(auth_user_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] || 'PermissionResponse' 
-
-      # 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: UsersApi#permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Inspect an user
     # ViewSet for User.  NOTE: This API endpoint is in \"tech preview\" and subject to change
     # @param auth_user_href [String] 

data/lib/pulpcore_client/api/users_roles_api.rb

@@ -156,7 +156,7 @@ module PulpcoreClient
     # @option opts [String] :content_object content_object
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :role 
     # @option opts [String] :role__contains 
     # @option opts [String] :role__icontains 
@@ -177,7 +177,7 @@ module PulpcoreClient
     # @option opts [String] :content_object content_object
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :role 
     # @option opts [String] :role__contains 
     # @option opts [String] :role__icontains 
@@ -194,6 +194,10 @@ module PulpcoreClient
       if @api_client.config.client_side_validation && auth_user_href.nil?
         fail ArgumentError, "Missing the required parameter 'auth_user_href' when calling UsersRolesApi.list"
       end
+      allowable_values = ["-description", "-pk", "-pulp_created", "-role", "description", "pk", "pulp_created", "role"]
+      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 = '{auth_user_href}roles/'.sub('{' + 'auth_user_href' + '}', CGI.escape(auth_user_href.to_s).gsub('%2F', '/'))
 
@@ -202,7 +206,7 @@ module PulpcoreClient
       query_params[:'content_object'] = opts[:'content_object'] if !opts[:'content_object'].nil?
       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[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
       query_params[:'role__contains'] = opts[:'role__contains'] if !opts[:'role__contains'].nil?
       query_params[:'role__icontains'] = opts[:'role__icontains'] if !opts[:'role__icontains'].nil?

data/lib/pulpcore_client/api/workers_api.rb

@@ -37,7 +37,7 @@ module PulpcoreClient
     # @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 [Boolean] :online 
-    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Array<String>] :ordering Ordering
     # @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 [PaginatedWorkerResponseList]
@@ -64,7 +64,7 @@ module PulpcoreClient
     # @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 [Boolean] :online 
-    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Array<String>] :ordering Ordering
     # @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<(PaginatedWorkerResponseList, Integer, Hash)>] PaginatedWorkerResponseList data, response status code and response headers
@@ -72,6 +72,10 @@ module PulpcoreClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WorkersApi.list ...'
       end
+      allowable_values = ["-group_roles", "-last_heartbeat", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-tasks", "-user_roles", "group_roles", "last_heartbeat", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "tasks", "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/workers/'
 
@@ -92,7 +96,7 @@ module PulpcoreClient
       query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
       query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
       query_params[:'online'] = opts[:'online'] if !opts[:'online'].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[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
       query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
 

data/lib/pulpcore_client/models/access_policy.rb

@@ -24,12 +24,16 @@ module PulpcoreClient
     # List of policy statements defining the policy.
     attr_accessor :statements
 
+    # A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.
+    attr_accessor :queryset_scoping
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'permissions_assignment' => :'permissions_assignment',
         :'creation_hooks' => :'creation_hooks',
-        :'statements' => :'statements'
+        :'statements' => :'statements',
+        :'queryset_scoping' => :'queryset_scoping'
       }
     end
 
@@ -38,7 +42,8 @@ module PulpcoreClient
       {
         :'permissions_assignment' => :'Array<Object>',
         :'creation_hooks' => :'Array<Object>',
-        :'statements' => :'Array<Object>'
+        :'statements' => :'Array<Object>',
+        :'queryset_scoping' => :'Object'
       }
     end
 
@@ -80,6 +85,10 @@ module PulpcoreClient
           self.statements = value
         end
       end
+
+      if attributes.key?(:'queryset_scoping')
+        self.queryset_scoping = attributes[:'queryset_scoping']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -107,7 +116,8 @@ module PulpcoreClient
       self.class == o.class &&
           permissions_assignment == o.permissions_assignment &&
           creation_hooks == o.creation_hooks &&
-          statements == o.statements
+          statements == o.statements &&
+          queryset_scoping == o.queryset_scoping
     end
 
     # @see the `==` method
@@ -119,7 +129,7 @@ module PulpcoreClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [permissions_assignment, creation_hooks, statements].hash
+      [permissions_assignment, creation_hooks, statements, queryset_scoping].hash
     end
 
     # Builds the object from hash

data/lib/pulpcore_client/models/access_policy_response.rb

@@ -35,6 +35,9 @@ module PulpcoreClient
     # True if the AccessPolicy has been user-modified. False otherwise.
     attr_accessor :customized
 
+    # A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.
+    attr_accessor :queryset_scoping
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -44,7 +47,8 @@ module PulpcoreClient
         :'creation_hooks' => :'creation_hooks',
         :'statements' => :'statements',
         :'viewset_name' => :'viewset_name',
-        :'customized' => :'customized'
+        :'customized' => :'customized',
+        :'queryset_scoping' => :'queryset_scoping'
       }
     end
 
@@ -57,7 +61,8 @@ module PulpcoreClient
         :'creation_hooks' => :'Array<Object>',
         :'statements' => :'Array<Object>',
         :'viewset_name' => :'String',
-        :'customized' => :'Boolean'
+        :'customized' => :'Boolean',
+        :'queryset_scoping' => :'Object'
       }
     end
 
@@ -115,6 +120,10 @@ module PulpcoreClient
       if attributes.key?(:'customized')
         self.customized = attributes[:'customized']
       end
+
+      if attributes.key?(:'queryset_scoping')
+        self.queryset_scoping = attributes[:'queryset_scoping']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -146,7 +155,8 @@ module PulpcoreClient
           creation_hooks == o.creation_hooks &&
           statements == o.statements &&
           viewset_name == o.viewset_name &&
-          customized == o.customized
+          customized == o.customized &&
+          queryset_scoping == o.queryset_scoping
     end
 
     # @see the `==` method
@@ -158,7 +168,7 @@ module PulpcoreClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pulp_href, pulp_created, permissions_assignment, creation_hooks, statements, viewset_name, customized].hash
+      [pulp_href, pulp_created, permissions_assignment, creation_hooks, statements, viewset_name, customized, queryset_scoping].hash
     end
 
     # Builds the object from hash

data/lib/pulpcore_client/models/alternate_content_source.rb

@@ -0,0 +1,270 @@
+=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.3.1
+
+=end
+
+require 'date'
+
+module PulpcoreClient
+  # Serializer for the AlternateContentSource.
+  class AlternateContentSource
+    # Name of Alternate Content Source.
+    attr_accessor :name
+
+    # Date of last refresh of AlternateContentSource.
+    attr_accessor :last_refreshed
+
+    # List of paths that will be appended to the Remote url when searching for content.
+    attr_accessor :paths
+
+    # The remote to provide alternate content source.
+    attr_accessor :remote
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'last_refreshed' => :'last_refreshed',
+        :'paths' => :'paths',
+        :'remote' => :'remote'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'last_refreshed' => :'DateTime',
+        :'paths' => :'Array<String>',
+        :'remote' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_refreshed',
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PulpcoreClient::AlternateContentSource` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PulpcoreClient::AlternateContentSource`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'last_refreshed')
+        self.last_refreshed = attributes[:'last_refreshed']
+      end
+
+      if attributes.key?(:'paths')
+        if (value = attributes[:'paths']).is_a?(Array)
+          self.paths = value
+        end
+      end
+
+      if attributes.key?(:'remote')
+        self.remote = attributes[:'remote']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
+      end
+
+      if @remote.nil?
+        invalid_properties.push('invalid value for "remote", remote cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @name.nil?
+      return false if @name.to_s.length < 1
+      return false if @remote.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          name == o.name &&
+          last_refreshed == o.last_refreshed &&
+          paths == o.paths &&
+          remote == o.remote
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [name, last_refreshed, paths, remote].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        PulpcoreClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end