pulp_file_client 1.10.5 → 1.11.0

data/lib/pulp_file_client/api/acs_file_api.rb

@@ -19,6 +19,74 @@ module PulpFileClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Add a role for this object to users/groups.
+    # @param file_file_alternate_content_source_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def add_role(file_file_alternate_content_source_href, nested_role, opts = {})
+      data, _status_code, _headers = add_role_with_http_info(file_file_alternate_content_source_href, nested_role, opts)
+      data
+    end
+
+    # Add a role for this object to users/groups.
+    # @param file_file_alternate_content_source_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_alternate_content_source_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AcsFileApi.add_role ...'
+      end
+      # verify the required parameter 'file_file_alternate_content_source_href' is set
+      if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.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 AcsFileApi.add_role"
+      end
+      # resource path
+      local_var_path = '{file_file_alternate_content_source_href}add_role/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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: AcsFileApi#add_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create a file alternate content source
     # Alternate Content Source ViewSet for File  ACS support is provided as a tech preview in pulp_file.
     # @param file_file_alternate_content_source [FileFileAlternateContentSource] 
@@ -155,7 +223,7 @@ module PulpFileClient
     # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
     # @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 [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 [PaginatedfileFileAlternateContentSourceResponseList]
@@ -174,7 +242,7 @@ module PulpFileClient
     # @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values
     # @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 [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<(PaginatedfileFileAlternateContentSourceResponseList, Integer, Hash)>] PaginatedfileFileAlternateContentSourceResponseList data, response status code and response headers
@@ -182,6 +250,10 @@ module PulpFileClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AcsFileApi.list ...'
       end
+      allowable_values = ["-file_filealternatecontentsource", "-group_roles", "-last_refreshed", "-name", "-paths", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-remote", "-user_roles", "file_filealternatecontentsource", "group_roles", "last_refreshed", "name", "paths", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "remote", "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/acs/file/file/'
 
@@ -194,7 +266,7 @@ module PulpFileClient
       query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
       query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].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[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
       query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
 
@@ -231,6 +303,138 @@ module PulpFileClient
       return data, status_code, headers
     end
 
+    # List roles assigned to this object.
+    # @param file_file_alternate_content_source_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 [ObjectRolesResponse]
+    def list_roles(file_file_alternate_content_source_href, opts = {})
+      data, _status_code, _headers = list_roles_with_http_info(file_file_alternate_content_source_href, opts)
+      data
+    end
+
+    # List roles assigned to this object.
+    # @param file_file_alternate_content_source_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<(ObjectRolesResponse, Integer, Hash)>] ObjectRolesResponse data, response status code and response headers
+    def list_roles_with_http_info(file_file_alternate_content_source_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AcsFileApi.list_roles ...'
+      end
+      # verify the required parameter 'file_file_alternate_content_source_href' is set
+      if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.list_roles"
+      end
+      # resource path
+      local_var_path = '{file_file_alternate_content_source_href}list_roles/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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] || '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: AcsFileApi#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_alternate_content_source_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 [MyPermissionsResponse]
+    def my_permissions(file_file_alternate_content_source_href, opts = {})
+      data, _status_code, _headers = my_permissions_with_http_info(file_file_alternate_content_source_href, opts)
+      data
+    end
+
+    # List permissions available to the current user on this object.
+    # @param file_file_alternate_content_source_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<(MyPermissionsResponse, Integer, Hash)>] MyPermissionsResponse data, response status code and response headers
+    def my_permissions_with_http_info(file_file_alternate_content_source_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AcsFileApi.my_permissions ...'
+      end
+      # verify the required parameter 'file_file_alternate_content_source_href' is set
+      if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.my_permissions"
+      end
+      # resource path
+      local_var_path = '{file_file_alternate_content_source_href}my_permissions/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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] || '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: AcsFileApi#my_permissions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a file alternate content source
     # Trigger an asynchronous partial update task
     # @param file_file_alternate_content_source_href [String] 
@@ -369,22 +573,22 @@ module PulpFileClient
       return data, status_code, headers
     end
 
+    # Refresh metadata
     # Trigger an asynchronous task to create Alternate Content Source content.
     # @param file_file_alternate_content_source_href [String] 
-    # @param file_file_alternate_content_source [FileFileAlternateContentSource] 
     # @param [Hash] opts the optional parameters
     # @return [TaskGroupOperationResponse]
-    def refresh(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {})
-      data, _status_code, _headers = refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts)
+    def refresh(file_file_alternate_content_source_href, opts = {})
+      data, _status_code, _headers = refresh_with_http_info(file_file_alternate_content_source_href, opts)
       data
     end
 
+    # Refresh metadata
     # Trigger an asynchronous task to create Alternate Content Source content.
     # @param file_file_alternate_content_source_href [String] 
-    # @param file_file_alternate_content_source [FileFileAlternateContentSource] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(TaskGroupOperationResponse, Integer, Hash)>] TaskGroupOperationResponse data, response status code and response headers
-    def refresh_with_http_info(file_file_alternate_content_source_href, file_file_alternate_content_source, opts = {})
+    def refresh_with_http_info(file_file_alternate_content_source_href, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AcsFileApi.refresh ...'
       end
@@ -392,10 +596,6 @@ module PulpFileClient
       if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil?
         fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.refresh"
       end
-      # verify the required parameter 'file_file_alternate_content_source' is set
-      if @api_client.config.client_side_validation && file_file_alternate_content_source.nil?
-        fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source' when calling AcsFileApi.refresh"
-      end
       # resource path
       local_var_path = '{file_file_alternate_content_source_href}refresh/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_href.to_s).gsub('%2F', '/'))
 
@@ -406,14 +606,12 @@ module PulpFileClient
       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_alternate_content_source) 
+      post_body = opts[:body] 
 
       # return_type
       return_type = opts[:return_type] || 'TaskGroupOperationResponse' 
@@ -437,6 +635,74 @@ module PulpFileClient
       return data, status_code, headers
     end
 
+    # Remove a role for this object from users/groups.
+    # @param file_file_alternate_content_source_href [String] 
+    # @param nested_role [NestedRole] 
+    # @param [Hash] opts the optional parameters
+    # @return [NestedRoleResponse]
+    def remove_role(file_file_alternate_content_source_href, nested_role, opts = {})
+      data, _status_code, _headers = remove_role_with_http_info(file_file_alternate_content_source_href, nested_role, opts)
+      data
+    end
+
+    # Remove a role for this object from users/groups.
+    # @param file_file_alternate_content_source_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_alternate_content_source_href, nested_role, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AcsFileApi.remove_role ...'
+      end
+      # verify the required parameter 'file_file_alternate_content_source_href' is set
+      if @api_client.config.client_side_validation && file_file_alternate_content_source_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_file_alternate_content_source_href' when calling AcsFileApi.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 AcsFileApi.remove_role"
+      end
+      # resource path
+      local_var_path = '{file_file_alternate_content_source_href}remove_role/'.sub('{' + 'file_file_alternate_content_source_href' + '}', CGI.escape(file_file_alternate_content_source_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: AcsFileApi#remove_role\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a file alternate content source
     # Trigger an asynchronous update task
     # @param file_file_alternate_content_source_href [String] 

data/lib/pulp_file_client/api/content_files_api.rb

@@ -26,6 +26,7 @@ module PulpFileClient
     # @option opts [String] :artifact Artifact file representing the physical content
     # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
     # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
+    # @option opts [String] :upload An uncommitted upload that may be turned into the artifact of the content unit.
     # @return [AsyncOperationResponse]
     def create(relative_path, opts = {})
       data, _status_code, _headers = create_with_http_info(relative_path, opts)
@@ -39,6 +40,7 @@ module PulpFileClient
     # @option opts [String] :artifact Artifact file representing the physical content
     # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit.
     # @option opts [String] :repository A URI of a repository the new content unit should be associated with.
+    # @option opts [String] :upload An uncommitted upload that may be turned into the artifact of the content unit.
     # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
     def create_with_http_info(relative_path, opts = {})
       if @api_client.config.debugging
@@ -48,6 +50,10 @@ module PulpFileClient
       if @api_client.config.client_side_validation && relative_path.nil?
         fail ArgumentError, "Missing the required parameter 'relative_path' when calling ContentFilesApi.create"
       end
+      if @api_client.config.client_side_validation && relative_path.to_s.length < 1
+        fail ArgumentError, 'invalid value for "relative_path" when calling ContentFilesApi.create, the character length must be great than or equal to 1.'
+      end
+
       # resource path
       local_var_path = '/pulp/api/v3/content/file/files/'
 
@@ -67,6 +73,7 @@ module PulpFileClient
       form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
       form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
       form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
+      form_params['upload'] = opts[:'upload'] if !opts[:'upload'].nil?
 
       # http body (model)
       post_body = opts[:body] 
@@ -98,7 +105,7 @@ module PulpFileClient
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :relative_path Filter results where relative_path matches value
     # @option opts [String] :repository_version Repository Version referenced by HREF
     # @option opts [String] :repository_version_added Repository Version referenced by HREF
@@ -117,7 +124,7 @@ module PulpFileClient
     # @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 [Array<String>] :ordering Ordering
     # @option opts [String] :relative_path Filter results where relative_path matches value
     # @option opts [String] :repository_version Repository Version referenced by HREF
     # @option opts [String] :repository_version_added Repository Version referenced by HREF
@@ -130,6 +137,10 @@ module PulpFileClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ContentFilesApi.list ...'
       end
+      allowable_values = ["-_artifacts", "-content_ptr", "-contentartifact", "-digest", "-group_roles", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-relative_path", "-repositories", "-timestamp_of_interest", "-upstream_id", "-user_roles", "-version_memberships", "_artifacts", "content_ptr", "contentartifact", "digest", "group_roles", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "relative_path", "repositories", "timestamp_of_interest", "upstream_id", "user_roles", "version_memberships"]
+      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/content/file/files/'
 
@@ -137,7 +148,7 @@ module PulpFileClient
       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[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
       query_params[:'relative_path'] = opts[:'relative_path'] if !opts[:'relative_path'].nil?
       query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
       query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil?