=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 'cgi' module PulpcoreClient class UsersRolesApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create an user role # ViewSet for UserRole. # @param auth_user_href [String] # @param user_role [UserRole] # @param [Hash] opts the optional parameters # @return [UserRoleResponse] def create(auth_user_href, user_role, opts = {}) data, _status_code, _headers = create_with_http_info(auth_user_href, user_role, opts) data end # Create an user role # ViewSet for UserRole. # @param auth_user_href [String] # @param user_role [UserRole] # @param [Hash] opts the optional parameters # @return [Array<(UserRoleResponse, Integer, Hash)>] UserRoleResponse data, response status code and response headers def create_with_http_info(auth_user_href, user_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersRolesApi.create ...' 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 UsersRolesApi.create" end # verify the required parameter 'user_role' is set if @api_client.config.client_side_validation && user_role.nil? fail ArgumentError, "Missing the required parameter 'user_role' when calling UsersRolesApi.create" end # resource path local_var_path = '{auth_user_href}roles/'.sub('{' + 'auth_user_href' + '}', CGI.escape(auth_user_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(user_role) # return_type return_type = opts[:return_type] || 'UserRoleResponse' # 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: UsersRolesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete an user role # ViewSet for UserRole. # @param auth_users_user_role_href [String] # @param [Hash] opts the optional parameters # @return [nil] def delete(auth_users_user_role_href, opts = {}) delete_with_http_info(auth_users_user_role_href, opts) nil end # Delete an user role # ViewSet for UserRole. # @param auth_users_user_role_href [String] # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def delete_with_http_info(auth_users_user_role_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersRolesApi.delete ...' end # verify the required parameter 'auth_users_user_role_href' is set if @api_client.config.client_side_validation && auth_users_user_role_href.nil? fail ArgumentError, "Missing the required parameter 'auth_users_user_role_href' when calling UsersRolesApi.delete" end # resource path local_var_path = '{auth_users_user_role_href}'.sub('{' + 'auth_users_user_role_href' + '}', CGI.escape(auth_users_user_role_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # 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: UsersRolesApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List user roles # ViewSet for UserRole. # @param auth_user_href [String] # @param [Hash] opts the optional parameters # @option opts [String] :content_object content_object # @option opts [String] :domain Foreign Key referenced by HREF # @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 [Array] :ordering Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Array] :prn__in Multiple values may be separated by commas. # @option opts [Array] :pulp_href__in Multiple values may be separated by commas. # @option opts [Array] :pulp_id__in Multiple values may be separated by commas. # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters # @option opts [String] :role # @option opts [String] :role__contains # @option opts [String] :role__icontains # @option opts [Array] :role__in Multiple values may be separated by commas. # @option opts [String] :role__startswith # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [PaginatedUserRoleResponseList] def list(auth_user_href, opts = {}) data, _status_code, _headers = list_with_http_info(auth_user_href, opts) data end # List user roles # ViewSet for UserRole. # @param auth_user_href [String] # @param [Hash] opts the optional parameters # @option opts [String] :content_object content_object # @option opts [String] :domain Foreign Key referenced by HREF # @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 [Array] :ordering Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Array] :prn__in Multiple values may be separated by commas. # @option opts [Array] :pulp_href__in Multiple values may be separated by commas. # @option opts [Array] :pulp_id__in Multiple values may be separated by commas. # @option opts [String] :q Filter results by using NOT, AND and OR operations on other filters # @option opts [String] :role # @option opts [String] :role__contains # @option opts [String] :role__icontains # @option opts [Array] :role__in Multiple values may be separated by commas. # @option opts [String] :role__startswith # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [Array<(PaginatedUserRoleResponseList, Integer, Hash)>] PaginatedUserRoleResponseList data, response status code and response headers def list_with_http_info(auth_user_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersRolesApi.list ...' 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 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', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'content_object'] = opts[:'content_object'] if !opts[:'content_object'].nil? query_params[:'domain'] = opts[:'domain'] if !opts[:'domain'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil? query_params[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].nil? query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil? query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil? query_params[:'q'] = opts[:'q'] if !opts[:'q'].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? query_params[:'role__in'] = @api_client.build_collection_param(opts[:'role__in'], :csv) if !opts[:'role__in'].nil? query_params[:'role__startswith'] = opts[:'role__startswith'] if !opts[:'role__startswith'].nil? query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) if !opts[:'exclude_fields'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PaginatedUserRoleResponseList' # 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: UsersRolesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Inspect an user role # ViewSet for UserRole. # @param auth_users_user_role_href [String] # @param [Hash] opts the optional parameters # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [UserRoleResponse] def read(auth_users_user_role_href, opts = {}) data, _status_code, _headers = read_with_http_info(auth_users_user_role_href, opts) data end # Inspect an user role # ViewSet for UserRole. # @param auth_users_user_role_href [String] # @param [Hash] opts the optional parameters # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [Array<(UserRoleResponse, Integer, Hash)>] UserRoleResponse data, response status code and response headers def read_with_http_info(auth_users_user_role_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: UsersRolesApi.read ...' end # verify the required parameter 'auth_users_user_role_href' is set if @api_client.config.client_side_validation && auth_users_user_role_href.nil? fail ArgumentError, "Missing the required parameter 'auth_users_user_role_href' when calling UsersRolesApi.read" end # resource path local_var_path = '{auth_users_user_role_href}'.sub('{' + 'auth_users_user_role_href' + '}', CGI.escape(auth_users_user_role_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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'UserRoleResponse' # 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: UsersRolesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end