pulp_file_client 0.1.0b1

data/lib/pulp_file_client/api/publications_file_api.rb

@@ -0,0 +1,273 @@
+=begin
+#Pulp 3 API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v3
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0
+
+=end
+
+require 'uri'
+
+module PulpFileClient
+  class PublicationsFileApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a file publication
+    # Trigger an asynchronous task to publish file content.
+    # @param data [FilePublication] 
+    # @param [Hash] opts the optional parameters
+    # @return [AsyncOperationResponse]
+    def create(data, opts = {})
+      data, _status_code, _headers = create_with_http_info(data, opts)
+      data
+    end
+
+    # Create a file publication
+    # Trigger an asynchronous task to publish file content.
+    # @param data [FilePublication] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers
+    def create_with_http_info(data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicationsFileApi.create ...'
+      end
+      # verify the required parameter 'data' is set
+      if @api_client.config.client_side_validation && data.nil?
+        fail ArgumentError, "Missing the required parameter 'data' 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(data) 
+
+      # return_type
+      return_type = opts[:return_type] || 'AsyncOperationResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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
+    # <!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+    # @param file_publication_href [String] URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete(file_publication_href, opts = {})
+      delete_with_http_info(file_publication_href, opts)
+      nil
+    end
+
+    # Delete a file publication
+    # &lt;!-- User-facing documentation, rendered as html--&gt; A FilePublication contains metadata about all the &lt;a href&#x3D;\&quot;#operation/content_file_files_list\&quot;&gt;File Content&lt;/a&gt; in a particular &lt;a href&#x3D;\&quot;https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\&quot;&gt;Repository Version.&lt;/a&gt; Once a FilePublication has been created, it can be hosted using the &lt;a href&#x3D;\&quot;#operation/distributions_file_file_list\&quot;&gt;File Distribution API.&lt;/a&gt;
+    # @param file_publication_href [String] URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_with_http_info(file_publication_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicationsFileApi.delete ...'
+      end
+      # verify the required parameter 'file_publication_href' is set
+      if @api_client.config.client_side_validation && file_publication_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_publication_href' when calling PublicationsFileApi.delete"
+      end
+      # resource path
+      local_var_path = '{file_publication_href}'.sub('{' + 'file_publication_href' + '}', file_publication_href.to_s)
+
+      # 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] || ['Basic']
+
+      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
+    # <!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @return [InlineResponse2002]
+    def list(opts = {})
+      data, _status_code, _headers = list_with_http_info(opts)
+      data
+    end
+
+    # List file publications
+    # &lt;!-- User-facing documentation, rendered as html--&gt; A FilePublication contains metadata about all the &lt;a href&#x3D;\&quot;#operation/content_file_files_list\&quot;&gt;File Content&lt;/a&gt; in a particular &lt;a href&#x3D;\&quot;https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\&quot;&gt;Repository Version.&lt;/a&gt; Once a FilePublication has been created, it can be hosted using the &lt;a href&#x3D;\&quot;#operation/distributions_file_file_list\&quot;&gt;File Distribution API.&lt;/a&gt;
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :ordering Which field to use when ordering the results.
+    # @option opts [Integer] :page A page number within the paginated result set.
+    # @option opts [Integer] :page_size Number of results to return per page.
+    # @return [Array<(InlineResponse2002, Integer, Hash)>] InlineResponse2002 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
+      # resource path
+      local_var_path = '/pulp/api/v3/publications/file/file/'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'InlineResponse2002' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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
+
+    # Inspect a file publication
+    # <!-- User-facing documentation, rendered as html--> A FilePublication contains metadata about all the <a href=\"#operation/content_file_files_list\">File Content</a> in a particular <a href=\"https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\">Repository Version.</a> Once a FilePublication has been created, it can be hosted using the <a href=\"#operation/distributions_file_file_list\">File Distribution API.</a>
+    # @param file_publication_href [String] URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+    # @param [Hash] opts the optional parameters
+    # @return [FilePublication]
+    def read(file_publication_href, opts = {})
+      data, _status_code, _headers = read_with_http_info(file_publication_href, opts)
+      data
+    end
+
+    # Inspect a file publication
+    # &lt;!-- User-facing documentation, rendered as html--&gt; A FilePublication contains metadata about all the &lt;a href&#x3D;\&quot;#operation/content_file_files_list\&quot;&gt;File Content&lt;/a&gt; in a particular &lt;a href&#x3D;\&quot;https://docs.pulpproject.org/en/3.0/nightly/restapi.html#operation/repositories_versions_list\&quot;&gt;Repository Version.&lt;/a&gt; Once a FilePublication has been created, it can be hosted using the &lt;a href&#x3D;\&quot;#operation/distributions_file_file_list\&quot;&gt;File Distribution API.&lt;/a&gt;
+    # @param file_publication_href [String] URI of File Publication. e.g.: /pulp/api/v3/publications/file/file/1/
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FilePublication, Integer, Hash)>] FilePublication data, response status code and response headers
+    def read_with_http_info(file_publication_href, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicationsFileApi.read ...'
+      end
+      # verify the required parameter 'file_publication_href' is set
+      if @api_client.config.client_side_validation && file_publication_href.nil?
+        fail ArgumentError, "Missing the required parameter 'file_publication_href' when calling PublicationsFileApi.read"
+      end
+      # resource path
+      local_var_path = '{file_publication_href}'.sub('{' + 'file_publication_href' + '}', file_publication_href.to_s)
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'FilePublication' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Basic']
+
+      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
+  end
+end