pulp_npm_client 0.9.0 → 0.10.1

data/lib/pulp_npm_client/api/repositories_npm_api.rb

@@ -19,6 +19,83 @@ module PulpNpmClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Add a role
+    # Add a role for this object to users/groups.
+    # @param npm_npm_repository_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [NestedRoleResponse]
+    def add_role(npm_npm_repository_href, nested_role, opts = {})
+      data, _status_code, _headers = add_role_with_http_info(npm_npm_repository_href, nested_role, opts)
+      data
+    end
+
+    # Add a role
+    # Add a role for this object to users/groups.
+    # @param npm_npm_repository_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def add_role_with_http_info(npm_npm_repository_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoriesNpmApi.add_role ...'
+      end
+      # verify the required parameter 'npm_npm_repository_href' is set
+      if @api_client.config.client_side_validation && npm_npm_repository_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_repository_href' when calling RepositoriesNpmApi.add_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling RepositoriesNpmApi.add_role"
+      end
+      # resource path
+      local_var_path = '{npm_npm_repository_href}add_role/'.sub('{' + 'npm_npm_repository_href' + '}', CGI.escape(npm_npm_repository_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(nested_role)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NestedRoleResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"RepositoriesNpmApi.add_role",
+        :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: RepositoriesNpmApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a npm repository
     # A ViewSet for NpmRepository.  Similar to the NpmPackageViewSet above, define endpoint_name, queryset and serializer, at a minimum.
     # @param npm_npm_repository [NpmNpmRepository] 
@@ -334,6 +411,78 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # List roles
+    # List roles assigned to this object.
+    # @param npm_npm_repository_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 [ObjectRolesResponse]
+    def list_roles(npm_npm_repository_href, opts = {})
+      data, _status_code, _headers = list_roles_with_http_info(npm_npm_repository_href, opts)
+      data
+    end
+
+    # List roles
+    # List roles assigned to this object.
+    # @param npm_npm_repository_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<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers
+    def list_roles_with_http_info(npm_npm_repository_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoriesNpmApi.list_roles ...'
+      end
+      # verify the required parameter 'npm_npm_repository_href' is set
+      if @api_client.config.client_side_validation && npm_npm_repository_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_repository_href' when calling RepositoriesNpmApi.list_roles"
+      end
+      # resource path
+      local_var_path = '{npm_npm_repository_href}list_roles/'.sub('{' + 'npm_npm_repository_href' + '}', CGI.escape(npm_npm_repository_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] || 'ObjectRolesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"RepositoriesNpmApi.list_roles",
+        :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: RepositoriesNpmApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Modify Repository Content
     # Trigger an asynchronous task to create a new repository version.
     # @param npm_npm_repository_href [String] 
@@ -411,6 +560,78 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # List user permissions
+    # List permissions available to the current user on this object.
+    # @param npm_npm_repository_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 [MyPermissionsResponse]
+    def my_permissions(npm_npm_repository_href, opts = {})
+      data, _status_code, _headers = my_permissions_with_http_info(npm_npm_repository_href, opts)
+      data
+    end
+
+    # List user permissions
+    # List permissions available to the current user on this object.
+    # @param npm_npm_repository_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<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers
+    def my_permissions_with_http_info(npm_npm_repository_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoriesNpmApi.my_permissions ...'
+      end
+      # verify the required parameter 'npm_npm_repository_href' is set
+      if @api_client.config.client_side_validation && npm_npm_repository_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_repository_href' when calling RepositoriesNpmApi.my_permissions"
+      end
+      # resource path
+      local_var_path = '{npm_npm_repository_href}my_permissions/'.sub('{' + 'npm_npm_repository_href' + '}', CGI.escape(npm_npm_repository_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] || 'MyPermissionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"RepositoriesNpmApi.my_permissions",
+        :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: RepositoriesNpmApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a npm repository
     # Update the entity partially and trigger an asynchronous task if necessary
     # @param npm_npm_repository_href [String] 
@@ -560,6 +781,83 @@ module PulpNpmClient
       return data, status_code, headers
     end
 
+    # Remove a role
+    # Remove a role for this object from users/groups.
+    # @param npm_npm_repository_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [NestedRoleResponse]
+    def remove_role(npm_npm_repository_href, nested_role, opts = {})
+      data, _status_code, _headers = remove_role_with_http_info(npm_npm_repository_href, nested_role, opts)
+      data
+    end
+
+    # Remove a role
+    # Remove a role for this object from users/groups.
+    # @param npm_npm_repository_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :x_task_diagnostics List of profilers to use on tasks.
+    # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers
+    def remove_role_with_http_info(npm_npm_repository_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: RepositoriesNpmApi.remove_role ...'
+      end
+      # verify the required parameter 'npm_npm_repository_href' is set
+      if @api_client.config.client_side_validation && npm_npm_repository_href.nil?
+        fail ArgumentError, "Missing the required parameter 'npm_npm_repository_href' when calling RepositoriesNpmApi.remove_role"
+      end
+      # verify the required parameter 'nested_role' is set
+      if @api_client.config.client_side_validation && nested_role.nil?
+        fail ArgumentError, "Missing the required parameter 'nested_role' when calling RepositoriesNpmApi.remove_role"
+      end
+      # resource path
+      local_var_path = '{npm_npm_repository_href}remove_role/'.sub('{' + 'npm_npm_repository_href' + '}', CGI.escape(npm_npm_repository_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(nested_role)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'NestedRoleResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"RepositoriesNpmApi.remove_role",
+        :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: RepositoriesNpmApi#remove_role\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 npm_npm_repository_href [String] 

data/lib/pulp_npm_client/models/my_permissions_response.rb

@@ -0,0 +1,223 @@
+=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 'date'
+require 'time'
+
+module PulpNpmClient
+  class MyPermissionsResponse
+    attr_accessor :permissions
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'permissions' => :'permissions'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'permissions' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `PulpNpmClient::MyPermissionsResponse` 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 `PulpNpmClient::MyPermissionsResponse`. 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?(:'permissions')
+        if (value = attributes[:'permissions']).is_a?(Array)
+          self.permissions = value
+        end
+      else
+        self.permissions = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @permissions.nil?
+        invalid_properties.push('invalid value for "permissions", permissions 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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @permissions.nil?
+      true
+    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 &&
+          permissions == o.permissions
+    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
+      [permissions].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = PulpNpmClient.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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