pulp_python_client 3.3.0 → 3.4.0

data/build/lib/pulpcore/client/pulp_python/api/publications_pypi_api.py

@@ -0,0 +1,566 @@
+# coding: utf-8
+
+"""
+    Pulp 3 API
+
+    Fetch, Upload, Organize, and Distribute Software Packages  # noqa: E501
+
+    The version of the OpenAPI document: v3
+    Contact: pulp-list@redhat.com
+    Generated by: https://openapi-generator.tech
+"""
+
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from pulpcore.client.pulp_python.api_client import ApiClient
+from pulpcore.client.pulp_python.exceptions import (  # noqa: F401
+    ApiTypeError,
+    ApiValueError
+)
+
+
+class PublicationsPypiApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def create(self, python_python_publication, **kwargs):  # noqa: E501
+        """Create a python publication  # noqa: E501
+
+         Dispatches a publish task, which generates metadata that will be used by pip.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.create(python_python_publication, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param PythonPythonPublication python_python_publication: (required)
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: AsyncOperationResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.create_with_http_info(python_python_publication, **kwargs)  # noqa: E501
+
+    def create_with_http_info(self, python_python_publication, **kwargs):  # noqa: E501
+        """Create a python publication  # noqa: E501
+
+         Dispatches a publish task, which generates metadata that will be used by pip.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.create_with_http_info(python_python_publication, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param PythonPythonPublication python_python_publication: (required)
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(AsyncOperationResponse, status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'python_python_publication'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method create" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'python_python_publication' is set
+        if self.api_client.client_side_validation and ('python_python_publication' not in local_var_params or  # noqa: E501
+                                                        local_var_params['python_python_publication'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `python_python_publication` when calling `create`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        if 'python_python_publication' in local_var_params:
+            body_params = local_var_params['python_python_publication']
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # HTTP header `Content-Type`
+        header_params['Content-Type'] = self.api_client.select_header_content_type(  # noqa: E501
+            ['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth', 'cookieAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/pulp/api/v3/publications/python/pypi/', 'POST',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='AsyncOperationResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def delete(self, python_python_publication_href, **kwargs):  # noqa: E501
+        """Delete a python publication  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.delete(python_python_publication_href, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str python_python_publication_href: (required)
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.delete_with_http_info(python_python_publication_href, **kwargs)  # noqa: E501
+
+    def delete_with_http_info(self, python_python_publication_href, **kwargs):  # noqa: E501
+        """Delete a python publication  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.delete_with_http_info(python_python_publication_href, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str python_python_publication_href: (required)
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: None
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'python_python_publication_href'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method delete" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'python_python_publication_href' is set
+        if self.api_client.client_side_validation and ('python_python_publication_href' not in local_var_params or  # noqa: E501
+                                                        local_var_params['python_python_publication_href'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `python_python_publication_href` when calling `delete`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'python_python_publication_href' in local_var_params:
+            path_params['python_python_publication_href'] = local_var_params['python_python_publication_href']  # noqa: E501
+
+        query_params = []
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # Authentication setting
+        auth_settings = ['basicAuth', 'cookieAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '{python_python_publication_href}', 'DELETE',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type=None,  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def list(self, **kwargs):  # noqa: E501
+        """List python publications  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.list(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str content: Content Unit referenced by HREF
+        :param str content__in: Content Unit referenced by HREF
+        :param int limit: Number of results to return per page.
+        :param int offset: The initial index from which to return the results.
+        :param str ordering: Which field to use when ordering the results.
+        :param datetime pulp_created: ISO 8601 formatted dates are supported
+        :param datetime pulp_created__gt: Filter results where pulp_created is greater than value
+        :param datetime pulp_created__gte: Filter results where pulp_created is greater than or equal to value
+        :param datetime pulp_created__lt: Filter results where pulp_created is less than value
+        :param datetime pulp_created__lte: Filter results where pulp_created is less than or equal to value
+        :param list[datetime] pulp_created__range: Filter results where pulp_created is between two comma separated values
+        :param str repository_version: Repository Version referenced by HREF
+        :param str fields: A list of fields to include in the response.
+        :param str exclude_fields: A list of fields to exclude from the response.
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: PaginatedpythonPythonPublicationResponseList
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.list_with_http_info(**kwargs)  # noqa: E501
+
+    def list_with_http_info(self, **kwargs):  # noqa: E501
+        """List python publications  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.list_with_http_info(async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str content: Content Unit referenced by HREF
+        :param str content__in: Content Unit referenced by HREF
+        :param int limit: Number of results to return per page.
+        :param int offset: The initial index from which to return the results.
+        :param str ordering: Which field to use when ordering the results.
+        :param datetime pulp_created: ISO 8601 formatted dates are supported
+        :param datetime pulp_created__gt: Filter results where pulp_created is greater than value
+        :param datetime pulp_created__gte: Filter results where pulp_created is greater than or equal to value
+        :param datetime pulp_created__lt: Filter results where pulp_created is less than value
+        :param datetime pulp_created__lte: Filter results where pulp_created is less than or equal to value
+        :param list[datetime] pulp_created__range: Filter results where pulp_created is between two comma separated values
+        :param str repository_version: Repository Version referenced by HREF
+        :param str fields: A list of fields to include in the response.
+        :param str exclude_fields: A list of fields to exclude from the response.
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(PaginatedpythonPythonPublicationResponseList, status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'content',
+            'content__in',
+            'limit',
+            'offset',
+            'ordering',
+            'pulp_created',
+            'pulp_created__gt',
+            'pulp_created__gte',
+            'pulp_created__lt',
+            'pulp_created__lte',
+            'pulp_created__range',
+            'repository_version',
+            'fields',
+            'exclude_fields'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method list" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+
+        collection_formats = {}
+
+        path_params = {}
+
+        query_params = []
+        if 'content' in local_var_params and local_var_params['content'] is not None:  # noqa: E501
+            query_params.append(('content', local_var_params['content']))  # noqa: E501
+        if 'content__in' in local_var_params and local_var_params['content__in'] is not None:  # noqa: E501
+            query_params.append(('content__in', local_var_params['content__in']))  # noqa: E501
+        if 'limit' in local_var_params and local_var_params['limit'] is not None:  # noqa: E501
+            query_params.append(('limit', local_var_params['limit']))  # noqa: E501
+        if 'offset' in local_var_params and local_var_params['offset'] is not None:  # noqa: E501
+            query_params.append(('offset', local_var_params['offset']))  # noqa: E501
+        if 'ordering' in local_var_params and local_var_params['ordering'] is not None:  # noqa: E501
+            query_params.append(('ordering', local_var_params['ordering']))  # noqa: E501
+        if 'pulp_created' in local_var_params and local_var_params['pulp_created'] is not None:  # noqa: E501
+            query_params.append(('pulp_created', local_var_params['pulp_created']))  # noqa: E501
+        if 'pulp_created__gt' in local_var_params and local_var_params['pulp_created__gt'] is not None:  # noqa: E501
+            query_params.append(('pulp_created__gt', local_var_params['pulp_created__gt']))  # noqa: E501
+        if 'pulp_created__gte' in local_var_params and local_var_params['pulp_created__gte'] is not None:  # noqa: E501
+            query_params.append(('pulp_created__gte', local_var_params['pulp_created__gte']))  # noqa: E501
+        if 'pulp_created__lt' in local_var_params and local_var_params['pulp_created__lt'] is not None:  # noqa: E501
+            query_params.append(('pulp_created__lt', local_var_params['pulp_created__lt']))  # noqa: E501
+        if 'pulp_created__lte' in local_var_params and local_var_params['pulp_created__lte'] is not None:  # noqa: E501
+            query_params.append(('pulp_created__lte', local_var_params['pulp_created__lte']))  # noqa: E501
+        if 'pulp_created__range' in local_var_params and local_var_params['pulp_created__range'] is not None:  # noqa: E501
+            query_params.append(('pulp_created__range', local_var_params['pulp_created__range']))  # noqa: E501
+            collection_formats['pulp_created__range'] = 'csv'  # noqa: E501
+        if 'repository_version' in local_var_params and local_var_params['repository_version'] is not None:  # noqa: E501
+            query_params.append(('repository_version', local_var_params['repository_version']))  # noqa: E501
+        if 'fields' in local_var_params and local_var_params['fields'] is not None:  # noqa: E501
+            query_params.append(('fields', local_var_params['fields']))  # noqa: E501
+        if 'exclude_fields' in local_var_params and local_var_params['exclude_fields'] is not None:  # noqa: E501
+            query_params.append(('exclude_fields', local_var_params['exclude_fields']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth', 'cookieAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/pulp/api/v3/publications/python/pypi/', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='PaginatedpythonPythonPublicationResponseList',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)
+
+    def read(self, python_python_publication_href, **kwargs):  # noqa: E501
+        """Inspect a python publication  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.read(python_python_publication_href, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str python_python_publication_href: (required)
+        :param str fields: A list of fields to include in the response.
+        :param str exclude_fields: A list of fields to exclude from the response.
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: PythonPythonPublicationResponse
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        return self.read_with_http_info(python_python_publication_href, **kwargs)  # noqa: E501
+
+    def read_with_http_info(self, python_python_publication_href, **kwargs):  # noqa: E501
+        """Inspect a python publication  # noqa: E501
+
+         Python Publications refer to the Python Package content in a repository version, and include metadata about that content.  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.read_with_http_info(python_python_publication_href, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool: execute request asynchronously
+        :param str python_python_publication_href: (required)
+        :param str fields: A list of fields to include in the response.
+        :param str exclude_fields: A list of fields to exclude from the response.
+        :param _return_http_data_only: response data without head status code
+                                       and headers
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :return: tuple(PythonPythonPublicationResponse, status_code(int), headers(HTTPHeaderDict))
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        local_var_params = locals()
+
+        all_params = [
+            'python_python_publication_href',
+            'fields',
+            'exclude_fields'
+        ]
+        all_params.extend(
+            [
+                'async_req',
+                '_return_http_data_only',
+                '_preload_content',
+                '_request_timeout'
+            ]
+        )
+
+        for key, val in six.iteritems(local_var_params['kwargs']):
+            if key not in all_params:
+                raise ApiTypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method read" % key
+                )
+            local_var_params[key] = val
+        del local_var_params['kwargs']
+        # verify the required parameter 'python_python_publication_href' is set
+        if self.api_client.client_side_validation and ('python_python_publication_href' not in local_var_params or  # noqa: E501
+                                                        local_var_params['python_python_publication_href'] is None):  # noqa: E501
+            raise ApiValueError("Missing the required parameter `python_python_publication_href` when calling `read`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'python_python_publication_href' in local_var_params:
+            path_params['python_python_publication_href'] = local_var_params['python_python_publication_href']  # noqa: E501
+
+        query_params = []
+        if 'fields' in local_var_params and local_var_params['fields'] is not None:  # noqa: E501
+            query_params.append(('fields', local_var_params['fields']))  # noqa: E501
+        if 'exclude_fields' in local_var_params and local_var_params['exclude_fields'] is not None:  # noqa: E501
+            query_params.append(('exclude_fields', local_var_params['exclude_fields']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth', 'cookieAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '{python_python_publication_href}', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='PythonPythonPublicationResponse',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=local_var_params.get('async_req'),
+            _return_http_data_only=local_var_params.get('_return_http_data_only'),  # noqa: E501
+            _preload_content=local_var_params.get('_preload_content', True),
+            _request_timeout=local_var_params.get('_request_timeout'),
+            collection_formats=collection_formats)