pulp_python_client 3.3.0 → 3.4.0

data/lib/pulp_python_client/api/pypi_legacy_api.rb

@@ -0,0 +1,111 @@
+=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.2.3
+
+=end
+
+require 'cgi'
+
+module PulpPythonClient
+  class PypiLegacyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Upload a package
+    # Upload package to the index.  This is the endpoint that tools like Twine and Poetry use for their upload commands.
+    # @param path [String] 
+    # @param content [File] A Python package release file to upload to the index.
+    # @param sha256_digest [String] SHA256 of package to validate upload integrity.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail! (default to 'file_upload')
+    # @return [PackageUploadTaskResponse]
+    def create(path, content, sha256_digest, opts = {})
+      data, _status_code, _headers = create_with_http_info(path, content, sha256_digest, opts)
+      data
+    end
+
+    # Upload a package
+    # Upload package to the index.  This is the endpoint that tools like Twine and Poetry use for their upload commands.
+    # @param path [String] 
+    # @param content [File] A Python package release file to upload to the index.
+    # @param sha256_digest [String] SHA256 of package to validate upload integrity.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail!
+    # @return [Array<(PackageUploadTaskResponse, Integer, Hash)>] PackageUploadTaskResponse data, response status code and response headers
+    def create_with_http_info(path, content, sha256_digest, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PypiLegacyApi.create ...'
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling PypiLegacyApi.create"
+      end
+      # verify the required parameter 'content' is set
+      if @api_client.config.client_side_validation && content.nil?
+        fail ArgumentError, "Missing the required parameter 'content' when calling PypiLegacyApi.create"
+      end
+      # verify the required parameter 'sha256_digest' is set
+      if @api_client.config.client_side_validation && sha256_digest.nil?
+        fail ArgumentError, "Missing the required parameter 'sha256_digest' when calling PypiLegacyApi.create"
+      end
+      if @api_client.config.client_side_validation && sha256_digest.to_s.length > 64
+        fail ArgumentError, 'invalid value for "sha256_digest" when calling PypiLegacyApi.create, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && sha256_digest.to_s.length < 64
+        fail ArgumentError, 'invalid value for "sha256_digest" when calling PypiLegacyApi.create, the character length must be great than or equal to 64.'
+      end
+
+      # resource path
+      local_var_path = '/pypi/{path}/legacy/'.sub('{' + 'path' + '}', CGI.escape(path.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(['multipart/form-data', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['content'] = content
+      form_params['sha256_digest'] = sha256_digest
+      form_params['action'] = opts[:'action'] if !opts[:'action'].nil?
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PackageUploadTaskResponse' 
+
+      # 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: PypiLegacyApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pulp_python_client/api/pypi_metadata_api.rb

@@ -0,0 +1,96 @@
+=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.2.3
+
+=end
+
+require 'cgi'
+
+module PulpPythonClient
+  class PypiMetadataApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get package metadata
+    # Retrieves the package's core-metadata specified by https://packaging.python.org/specifications/core-metadata/. `meta` must be a path in form of `{package}/json/` or `{package}/{version}/json/`
+    # @param meta [String] 
+    # @param path [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 [PackageMetadataResponse]
+    def read(meta, path, opts = {})
+      data, _status_code, _headers = read_with_http_info(meta, path, opts)
+      data
+    end
+
+    # Get package metadata
+    # Retrieves the package's core-metadata specified by https://packaging.python.org/specifications/core-metadata/. `meta` must be a path in form of `{package}/json/` or `{package}/{version}/json/`
+    # @param meta [String] 
+    # @param path [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<(PackageMetadataResponse, Integer, Hash)>] PackageMetadataResponse data, response status code and response headers
+    def read_with_http_info(meta, path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PypiMetadataApi.read ...'
+      end
+      # verify the required parameter 'meta' is set
+      if @api_client.config.client_side_validation && meta.nil?
+        fail ArgumentError, "Missing the required parameter 'meta' when calling PypiMetadataApi.read"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling PypiMetadataApi.read"
+      end
+      # resource path
+      local_var_path = '/pypi/{path}/pypi/{meta}/'.sub('{' + 'meta' + '}', CGI.escape(meta.to_s).gsub('%2F', '/')).sub('{' + 'path' + '}', CGI.escape(path.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] || 'PackageMetadataResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      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: PypiMetadataApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pulp_python_client/api/pypi_simple_api.rb

@@ -0,0 +1,249 @@
+=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.2.3
+
+=end
+
+require 'cgi'
+
+module PulpPythonClient
+  class PypiSimpleApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Upload a package
+    # Upload package to the index. This endpoint has the same functionality as the upload endpoint at the `/legacy` url of the index. This is provided for convenience for users who want a single index url for all their Python tools. (pip, twine, poetry, pipenv, ...)
+    # @param path [String] 
+    # @param content [File] A Python package release file to upload to the index.
+    # @param sha256_digest [String] SHA256 of package to validate upload integrity.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail! (default to 'file_upload')
+    # @return [PackageUploadTaskResponse]
+    def create(path, content, sha256_digest, opts = {})
+      data, _status_code, _headers = create_with_http_info(path, content, sha256_digest, opts)
+      data
+    end
+
+    # Upload a package
+    # Upload package to the index. This endpoint has the same functionality as the upload endpoint at the `/legacy` url of the index. This is provided for convenience for users who want a single index url for all their Python tools. (pip, twine, poetry, pipenv, ...)
+    # @param path [String] 
+    # @param content [File] A Python package release file to upload to the index.
+    # @param sha256_digest [String] SHA256 of package to validate upload integrity.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :action Defaults to `file_upload`, don't change it or request will fail!
+    # @return [Array<(PackageUploadTaskResponse, Integer, Hash)>] PackageUploadTaskResponse data, response status code and response headers
+    def create_with_http_info(path, content, sha256_digest, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PypiSimpleApi.create ...'
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling PypiSimpleApi.create"
+      end
+      # verify the required parameter 'content' is set
+      if @api_client.config.client_side_validation && content.nil?
+        fail ArgumentError, "Missing the required parameter 'content' when calling PypiSimpleApi.create"
+      end
+      # verify the required parameter 'sha256_digest' is set
+      if @api_client.config.client_side_validation && sha256_digest.nil?
+        fail ArgumentError, "Missing the required parameter 'sha256_digest' when calling PypiSimpleApi.create"
+      end
+      if @api_client.config.client_side_validation && sha256_digest.to_s.length > 64
+        fail ArgumentError, 'invalid value for "sha256_digest" when calling PypiSimpleApi.create, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && sha256_digest.to_s.length < 64
+        fail ArgumentError, 'invalid value for "sha256_digest" when calling PypiSimpleApi.create, the character length must be great than or equal to 64.'
+      end
+
+      # resource path
+      local_var_path = '/pypi/{path}/simple/'.sub('{' + 'path' + '}', CGI.escape(path.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(['multipart/form-data', 'application/x-www-form-urlencoded'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+      form_params['content'] = content
+      form_params['sha256_digest'] = sha256_digest
+      form_params['action'] = opts[:'action'] if !opts[:'action'].nil?
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'PackageUploadTaskResponse' 
+
+      # 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: PypiSimpleApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get index simple page
+    # Gets the simple api html page for the index.
+    # @param path [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 [nil]
+    def read(path, opts = {})
+      read_with_http_info(path, opts)
+      nil
+    end
+
+    # Get index simple page
+    # Gets the simple api html page for the index.
+    # @param path [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<(nil, Integer, Hash)>] nil, response status code and response headers
+    def read_with_http_info(path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PypiSimpleApi.read ...'
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling PypiSimpleApi.read"
+      end
+      # resource path
+      local_var_path = '/pypi/{path}/simple/'.sub('{' + 'path' + '}', CGI.escape(path.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] || {}
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PypiSimpleApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get package simple page
+    # Retrieves the simple api html page for a package.
+    # @param package [String] 
+    # @param path [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 [nil]
+    def read_0(package, path, opts = {})
+      read_0_with_http_info(package, path, opts)
+      nil
+    end
+
+    # Get package simple page
+    # Retrieves the simple api html page for a package.
+    # @param package [String] 
+    # @param path [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<(nil, Integer, Hash)>] nil, response status code and response headers
+    def read_0_with_http_info(package, path, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PypiSimpleApi.read_0 ...'
+      end
+      # verify the required parameter 'package' is set
+      if @api_client.config.client_side_validation && package.nil?
+        fail ArgumentError, "Missing the required parameter 'package' when calling PypiSimpleApi.read_0"
+      end
+      # verify the required parameter 'path' is set
+      if @api_client.config.client_side_validation && path.nil?
+        fail ArgumentError, "Missing the required parameter 'path' when calling PypiSimpleApi.read_0"
+      end
+      # resource path
+      local_var_path = '/pypi/{path}/simple/{package}/'.sub('{' + 'package' + '}', CGI.escape(package.to_s).gsub('%2F', '/')).sub('{' + 'path' + '}', CGI.escape(path.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] || {}
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PypiSimpleApi#read_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/pulp_python_client/api/remotes_python_api.rb

@@ -146,11 +146,11 @@ module PulpPythonClient
     end
 
     # Create from Bandersnatch
-    # Create a remote from a Bandersnatch config
+    #  Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
     # @param config [File] A Bandersnatch config that may be used to construct a Python Remote.
     # @param name [String] A unique name for this remote
     # @param [Hash] opts the optional parameters
-    # @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default.
+    # @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.
     # @return [PythonPythonRemoteResponse]
     def from_bandersnatch(config, name, opts = {})
       data, _status_code, _headers = from_bandersnatch_with_http_info(config, name, opts)
@@ -158,11 +158,11 @@ module PulpPythonClient
     end
 
     # Create from Bandersnatch
-    # Create a remote from a Bandersnatch config
+    #  Takes the fields specified in the Bandersnatch config and creates a Python Remote from it.
     # @param config [File] A Bandersnatch config that may be used to construct a Python Remote.
     # @param name [String] A unique name for this remote
     # @param [Hash] opts the optional parameters
-    # @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'cache_only'. 'immediate' is the default.
+    # @option opts [PolicyEnum] :policy The policy to use when downloading content. The possible values include: 'immediate', 'on_demand', and 'streamed'. 'on_demand' is the default.
     # @return [Array<(PythonPythonRemoteResponse, Integer, Hash)>] PythonPythonRemoteResponse data, response status code and response headers
     def from_bandersnatch_with_http_info(config, name, opts = {})
       if @api_client.config.debugging

data/lib/pulp_python_client/api/repositories_python_api.rb

@@ -20,7 +20,7 @@ module PulpPythonClient
       @api_client = api_client
     end
     # Create a python repository
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param python_python_repository [PythonPythonRepository] 
     # @param [Hash] opts the optional parameters
     # @return [PythonPythonRepositoryResponse]
@@ -30,7 +30,7 @@ module PulpPythonClient
     end
 
     # Create a python repository
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param python_python_repository [PythonPythonRepository] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(PythonPythonRepositoryResponse, Integer, Hash)>] PythonPythonRepositoryResponse data, response status code and response headers
@@ -146,7 +146,7 @@ module PulpPythonClient
     end
 
     # List python repositorys
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
     # @option opts [String] :name 
@@ -166,7 +166,7 @@ module PulpPythonClient
     end
 
     # List python repositorys
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :limit Number of results to return per page.
     # @option opts [String] :name 
@@ -375,7 +375,7 @@ module PulpPythonClient
     end
 
     # Inspect a python repository
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param python_python_repository_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
@@ -387,7 +387,7 @@ module PulpPythonClient
     end
 
     # Inspect a python repository
-    # A ViewSet for PythonRepository.
+    # PythonRepository represents a single Python repository, to which content can be synced, added, or removed.
     # @param python_python_repository_href [String] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :fields A list of fields to include in the response.
@@ -443,7 +443,7 @@ module PulpPythonClient
     end
 
     # Sync from remote
-    # Trigger an asynchronous task to sync Python content.
+    #  Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified `Remote` and update the specified `Respository`, creating a new  `RepositoryVersion`.
     # @param python_python_repository_href [String] 
     # @param repository_sync_url [RepositorySyncURL] 
     # @param [Hash] opts the optional parameters
@@ -454,7 +454,7 @@ module PulpPythonClient
     end
 
     # Sync from remote
-    # Trigger an asynchronous task to sync Python content.
+    #  Trigger an asynchronous task to sync python content. The sync task will retrieve Python content from the specified &#x60;Remote&#x60; and update the specified &#x60;Respository&#x60;, creating a new  &#x60;RepositoryVersion&#x60;.
     # @param python_python_repository_href [String] 
     # @param repository_sync_url [RepositorySyncURL] 
     # @param [Hash] opts the optional parameters