=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 PulpFileClient class PublicationsFileApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Add a role for this object to users/groups. # @param file_file_publication_href [String] # @param nested_role [NestedRole] # @param [Hash] opts the optional parameters # @return [NestedRoleResponse] def add_role(file_file_publication_href, nested_role, opts = {}) data, _status_code, _headers = add_role_with_http_info(file_file_publication_href, nested_role, opts) data end # Add a role for this object to users/groups. # @param file_file_publication_href [String] # @param nested_role [NestedRole] # @param [Hash] opts the optional parameters # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers def add_role_with_http_info(file_file_publication_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.add_role ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.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 PublicationsFileApi.add_role" end # resource path local_var_path = '{file_file_publication_href}add_role/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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(nested_role) # return_type return_type = opts[:return_type] || 'NestedRoleResponse' # 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: PublicationsFileApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Create a file publication # Trigger an asynchronous task to publish file content. # @param file_file_publication [FileFilePublication] # @param [Hash] opts the optional parameters # @return [AsyncOperationResponse] def create(file_file_publication, opts = {}) data, _status_code, _headers = create_with_http_info(file_file_publication, opts) data end # Create a file publication # Trigger an asynchronous task to publish file content. # @param file_file_publication [FileFilePublication] # @param [Hash] opts the optional parameters # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers def create_with_http_info(file_file_publication, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.create ...' end # verify the required parameter 'file_file_publication' is set if @api_client.config.client_side_validation && file_file_publication.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication' when calling PublicationsFileApi.create" end # resource path local_var_path = '/pulp/api/v3/publications/file/file/' # 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(file_file_publication) # 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: PublicationsFileApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Delete a file publication # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param file_file_publication_href [String] # @param [Hash] opts the optional parameters # @return [nil] def delete(file_file_publication_href, opts = {}) delete_with_http_info(file_file_publication_href, opts) nil end # Delete a file publication # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param file_file_publication_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(file_file_publication_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.delete ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.delete" end # resource path local_var_path = '{file_file_publication_href}'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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: PublicationsFileApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List file publications # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param [Hash] opts the optional parameters # @option opts [String] :content Content Unit referenced by HREF # @option opts [String] :content__in Content Unit 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 # @option opts [DateTime] :pulp_created Filter results where pulp_created matches value # @option opts [DateTime] :pulp_created__gt Filter results where pulp_created is greater than value # @option opts [DateTime] :pulp_created__gte Filter results where pulp_created is greater than or equal to value # @option opts [DateTime] :pulp_created__lt Filter results where pulp_created is less than value # @option opts [DateTime] :pulp_created__lte Filter results where pulp_created is less than or equal to value # @option opts [Array] :pulp_created__range Filter results where pulp_created is between two comma separated values # @option opts [String] :repository Repository referenced by HREF # @option opts [String] :repository_version Repository Version referenced by HREF # @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 [PaginatedfileFilePublicationResponseList] def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end # List file publications # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param [Hash] opts the optional parameters # @option opts [String] :content Content Unit referenced by HREF # @option opts [String] :content__in Content Unit 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 # @option opts [DateTime] :pulp_created Filter results where pulp_created matches value # @option opts [DateTime] :pulp_created__gt Filter results where pulp_created is greater than value # @option opts [DateTime] :pulp_created__gte Filter results where pulp_created is greater than or equal to value # @option opts [DateTime] :pulp_created__lt Filter results where pulp_created is less than value # @option opts [DateTime] :pulp_created__lte Filter results where pulp_created is less than or equal to value # @option opts [Array] :pulp_created__range Filter results where pulp_created is between two comma separated values # @option opts [String] :repository Repository referenced by HREF # @option opts [String] :repository_version Repository Version referenced by HREF # @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<(PaginatedfileFilePublicationResponseList, Integer, Hash)>] PaginatedfileFilePublicationResponseList 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: PublicationsFileApi.list ...' end allowable_values = ["-complete", "-pass_through", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "complete", "pass_through", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type"] 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/publications/file/file/' # query parameters query_params = opts[:query_params] || {} query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil? query_params[:'content__in'] = opts[:'content__in'] if !opts[:'content__in'].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[:'pulp_created'] = opts[:'pulp_created'] if !opts[:'pulp_created'].nil? query_params[:'pulp_created__gt'] = opts[:'pulp_created__gt'] if !opts[:'pulp_created__gt'].nil? query_params[:'pulp_created__gte'] = opts[:'pulp_created__gte'] if !opts[:'pulp_created__gte'].nil? query_params[:'pulp_created__lt'] = opts[:'pulp_created__lt'] if !opts[:'pulp_created__lt'].nil? query_params[:'pulp_created__lte'] = opts[:'pulp_created__lte'] if !opts[:'pulp_created__lte'].nil? query_params[:'pulp_created__range'] = @api_client.build_collection_param(opts[:'pulp_created__range'], :csv) if !opts[:'pulp_created__range'].nil? query_params[:'repository'] = opts[:'repository'] if !opts[:'repository'].nil? query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].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] || 'PaginatedfileFilePublicationResponseList' # 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: PublicationsFileApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List roles assigned to this object. # @param file_file_publication_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 [ObjectRolesResponse] def list_roles(file_file_publication_href, opts = {}) data, _status_code, _headers = list_roles_with_http_info(file_file_publication_href, opts) data end # List roles assigned to this object. # @param file_file_publication_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<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers def list_roles_with_http_info(file_file_publication_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.list_roles ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.list_roles" end # resource path local_var_path = '{file_file_publication_href}list_roles/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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] || 'ObjectRolesResponse' # 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: PublicationsFileApi#list_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List permissions available to the current user on this object. # @param file_file_publication_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 [MyPermissionsResponse] def my_permissions(file_file_publication_href, opts = {}) data, _status_code, _headers = my_permissions_with_http_info(file_file_publication_href, opts) data end # List permissions available to the current user on this object. # @param file_file_publication_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<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers def my_permissions_with_http_info(file_file_publication_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.my_permissions ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.my_permissions" end # resource path local_var_path = '{file_file_publication_href}my_permissions/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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] || 'MyPermissionsResponse' # 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: PublicationsFileApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Inspect a file publication # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param file_file_publication_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 [FileFilePublicationResponse] def read(file_file_publication_href, opts = {}) data, _status_code, _headers = read_with_http_info(file_file_publication_href, opts) data end # Inspect a file publication # A FilePublication contains metadata about all the File Content in a particular File Repository Version. Once a FilePublication has been created, it can be hosted using the File Distribution API. # @param file_file_publication_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<(FileFilePublicationResponse, Integer, Hash)>] FileFilePublicationResponse data, response status code and response headers def read_with_http_info(file_file_publication_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.read ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.read" end # resource path local_var_path = '{file_file_publication_href}'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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] || 'FileFilePublicationResponse' # 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: PublicationsFileApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Remove a role for this object from users/groups. # @param file_file_publication_href [String] # @param nested_role [NestedRole] # @param [Hash] opts the optional parameters # @return [NestedRoleResponse] def remove_role(file_file_publication_href, nested_role, opts = {}) data, _status_code, _headers = remove_role_with_http_info(file_file_publication_href, nested_role, opts) data end # Remove a role for this object from users/groups. # @param file_file_publication_href [String] # @param nested_role [NestedRole] # @param [Hash] opts the optional parameters # @return [Array<(NestedRoleResponse, Integer, Hash)>] NestedRoleResponse data, response status code and response headers def remove_role_with_http_info(file_file_publication_href, nested_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PublicationsFileApi.remove_role ...' end # verify the required parameter 'file_file_publication_href' is set if @api_client.config.client_side_validation && file_file_publication_href.nil? fail ArgumentError, "Missing the required parameter 'file_file_publication_href' when calling PublicationsFileApi.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 PublicationsFileApi.remove_role" end # resource path local_var_path = '{file_file_publication_href}remove_role/'.sub('{' + 'file_file_publication_href' + '}', CGI.escape(file_file_publication_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(nested_role) # return_type return_type = opts[:return_type] || 'NestedRoleResponse' # 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: PublicationsFileApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end