"""
    Mender API

    Combined API specification for the features of the different Mender backend services, suitable for code generation applications 

    The version of the OpenAPI document: 1
    Contact: support@mender.io
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


import warnings
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
from typing import Any, Dict, List, Optional, Tuple, Union
from typing_extensions import Annotated

from pydantic import Field, StrictInt, StrictStr, field_validator
from typing import List, Optional
from typing_extensions import Annotated
from mender_client.models.software import Software

from mender_client.api_client import ApiClient, RequestSerialized
from mender_client.api_response import ApiResponse
from mender_client.rest import RESTResponseType


class DeploymentsV1alpha1ManagementAPIApi:
    """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) -> None:
        if api_client is None:
            api_client = ApiClient.get_default()
        self.api_client = api_client


    @validate_call
    def get_deployment_software(
        self,
        name: Annotated[Optional[List[StrictStr]], Field(description="Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.")] = None,
        name_prefix: Annotated[Optional[StrictStr], Field(description="Software name prefix filter. Mutually exclusive with `name`.")] = None,
        kind: Annotated[Optional[StrictStr], Field(description="Software kind filter.")] = None,
        tag: Annotated[Optional[List[StrictStr]], Field(description="Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).")] = None,
        update_type: Annotated[Optional[StrictStr], Field(description="Update type filter.")] = None,
        page: Annotated[Optional[StrictInt], Field(description="Starting page.")] = None,
        per_page: Annotated[Optional[Annotated[int, Field(le=500, strict=True)]], Field(description="Maximum number of results per page.")] = None,
        sort: Annotated[Optional[StrictStr], Field(description="Sort the Software list by the specified field and direction.")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> List[Software]:
        """Get Mender Software

        Returns software information according to the specified parameters. \"Software\" in this context refers to base information shared across both Releases and Manifests. Note that the operation between the `name` and `kind` parameters is an AND operation.

        :param name: Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.
        :type name: List[str]
        :param name_prefix: Software name prefix filter. Mutually exclusive with `name`.
        :type name_prefix: str
        :param kind: Software kind filter.
        :type kind: str
        :param tag: Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).
        :type tag: List[str]
        :param update_type: Update type filter.
        :type update_type: str
        :param page: Starting page.
        :type page: int
        :param per_page: Maximum number of results per page.
        :type per_page: int
        :param sort: Sort the Software list by the specified field and direction.
        :type sort: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._get_deployment_software_serialize(
            name=name,
            name_prefix=name_prefix,
            kind=kind,
            tag=tag,
            update_type=update_type,
            page=page,
            per_page=per_page,
            sort=sort,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[Software]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        response_data.read()
        return self.api_client.response_deserialize(
            response_data=response_data,
            response_types_map=_response_types_map,
        ).data


    @validate_call
    def get_deployment_software_with_http_info(
        self,
        name: Annotated[Optional[List[StrictStr]], Field(description="Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.")] = None,
        name_prefix: Annotated[Optional[StrictStr], Field(description="Software name prefix filter. Mutually exclusive with `name`.")] = None,
        kind: Annotated[Optional[StrictStr], Field(description="Software kind filter.")] = None,
        tag: Annotated[Optional[List[StrictStr]], Field(description="Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).")] = None,
        update_type: Annotated[Optional[StrictStr], Field(description="Update type filter.")] = None,
        page: Annotated[Optional[StrictInt], Field(description="Starting page.")] = None,
        per_page: Annotated[Optional[Annotated[int, Field(le=500, strict=True)]], Field(description="Maximum number of results per page.")] = None,
        sort: Annotated[Optional[StrictStr], Field(description="Sort the Software list by the specified field and direction.")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> ApiResponse[List[Software]]:
        """Get Mender Software

        Returns software information according to the specified parameters. \"Software\" in this context refers to base information shared across both Releases and Manifests. Note that the operation between the `name` and `kind` parameters is an AND operation.

        :param name: Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.
        :type name: List[str]
        :param name_prefix: Software name prefix filter. Mutually exclusive with `name`.
        :type name_prefix: str
        :param kind: Software kind filter.
        :type kind: str
        :param tag: Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).
        :type tag: List[str]
        :param update_type: Update type filter.
        :type update_type: str
        :param page: Starting page.
        :type page: int
        :param per_page: Maximum number of results per page.
        :type per_page: int
        :param sort: Sort the Software list by the specified field and direction.
        :type sort: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._get_deployment_software_serialize(
            name=name,
            name_prefix=name_prefix,
            kind=kind,
            tag=tag,
            update_type=update_type,
            page=page,
            per_page=per_page,
            sort=sort,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[Software]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        response_data.read()
        return self.api_client.response_deserialize(
            response_data=response_data,
            response_types_map=_response_types_map,
        )


    @validate_call
    def get_deployment_software_without_preload_content(
        self,
        name: Annotated[Optional[List[StrictStr]], Field(description="Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.")] = None,
        name_prefix: Annotated[Optional[StrictStr], Field(description="Software name prefix filter. Mutually exclusive with `name`.")] = None,
        kind: Annotated[Optional[StrictStr], Field(description="Software kind filter.")] = None,
        tag: Annotated[Optional[List[StrictStr]], Field(description="Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).")] = None,
        update_type: Annotated[Optional[StrictStr], Field(description="Update type filter.")] = None,
        page: Annotated[Optional[StrictInt], Field(description="Starting page.")] = None,
        per_page: Annotated[Optional[Annotated[int, Field(le=500, strict=True)]], Field(description="Maximum number of results per page.")] = None,
        sort: Annotated[Optional[StrictStr], Field(description="Sort the Software list by the specified field and direction.")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> RESTResponseType:
        """Get Mender Software

        Returns software information according to the specified parameters. \"Software\" in this context refers to base information shared across both Releases and Manifests. Note that the operation between the `name` and `kind` parameters is an AND operation.

        :param name: Software name filter. Can be repeated to query a set of entries. Mutually exclusive with `name_prefix`.
        :type name: List[str]
        :param name_prefix: Software name prefix filter. Mutually exclusive with `name`.
        :type name_prefix: str
        :param kind: Software kind filter.
        :type kind: str
        :param tag: Filter the software based on their associated tags and only return software that have at least one matching tag (i.e. OR matching).
        :type tag: List[str]
        :param update_type: Update type filter.
        :type update_type: str
        :param page: Starting page.
        :type page: int
        :param per_page: Maximum number of results per page.
        :type per_page: int
        :param sort: Sort the Software list by the specified field and direction.
        :type sort: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._get_deployment_software_serialize(
            name=name,
            name_prefix=name_prefix,
            kind=kind,
            tag=tag,
            update_type=update_type,
            page=page,
            per_page=per_page,
            sort=sort,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[Software]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        return response_data.response


    def _get_deployment_software_serialize(
        self,
        name,
        name_prefix,
        kind,
        tag,
        update_type,
        page,
        per_page,
        sort,
        _request_auth,
        _content_type,
        _headers,
        _host_index,
    ) -> RequestSerialized:

        _host = None

        _collection_formats: Dict[str, str] = {
            'name': 'multi',
            'tag': 'multi',
        }

        _path_params: Dict[str, str] = {}
        _query_params: List[Tuple[str, str]] = []
        _header_params: Dict[str, Optional[str]] = _headers or {}
        _form_params: List[Tuple[str, str]] = []
        _files: Dict[
            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
        ] = {}
        _body_params: Optional[bytes] = None

        # process the path parameters
        # process the query parameters
        if name is not None:
            
            _query_params.append(('name', name))
            
        if name_prefix is not None:
            
            _query_params.append(('name_prefix', name_prefix))
            
        if kind is not None:
            
            _query_params.append(('kind', kind))
            
        if tag is not None:
            
            _query_params.append(('tag', tag))
            
        if update_type is not None:
            
            _query_params.append(('update_type', update_type))
            
        if page is not None:
            
            _query_params.append(('page', page))
            
        if per_page is not None:
            
            _query_params.append(('per_page', per_page))
            
        if sort is not None:
            
            _query_params.append(('sort', sort))
            
        # process the header parameters
        # process the form parameters
        # process the body parameter


        # set the HTTP header `Accept`
        if 'Accept' not in _header_params:
            _header_params['Accept'] = self.api_client.select_header_accept(
                [
                    'application/json'
                ]
            )


        # authentication setting
        _auth_settings: List[str] = [
            'ManagementJWT'
        ]

        return self.api_client.param_serialize(
            method='GET',
            resource_path='/api/management/v1alpha1/deployments/software',
            path_params=_path_params,
            query_params=_query_params,
            header_params=_header_params,
            body=_body_params,
            post_params=_form_params,
            files=_files,
            auth_settings=_auth_settings,
            collection_formats=_collection_formats,
            _host=_host,
            _request_auth=_request_auth
        )




    @validate_call
    def list_software_tags(
        self,
        kind: Annotated[Optional[StrictStr], Field(description="Only list tags used on software of a particular kind")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> List[str]:
        """Lists all available tags for software (releases and/or manifests). 


        :param kind: Only list tags used on software of a particular kind
        :type kind: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._list_software_tags_serialize(
            kind=kind,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[str]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        response_data.read()
        return self.api_client.response_deserialize(
            response_data=response_data,
            response_types_map=_response_types_map,
        ).data


    @validate_call
    def list_software_tags_with_http_info(
        self,
        kind: Annotated[Optional[StrictStr], Field(description="Only list tags used on software of a particular kind")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> ApiResponse[List[str]]:
        """Lists all available tags for software (releases and/or manifests). 


        :param kind: Only list tags used on software of a particular kind
        :type kind: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._list_software_tags_serialize(
            kind=kind,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[str]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        response_data.read()
        return self.api_client.response_deserialize(
            response_data=response_data,
            response_types_map=_response_types_map,
        )


    @validate_call
    def list_software_tags_without_preload_content(
        self,
        kind: Annotated[Optional[StrictStr], Field(description="Only list tags used on software of a particular kind")] = None,
        _request_timeout: Union[
            None,
            Annotated[StrictFloat, Field(gt=0)],
            Tuple[
                Annotated[StrictFloat, Field(gt=0)],
                Annotated[StrictFloat, Field(gt=0)]
            ]
        ] = None,
        _request_auth: Optional[Dict[StrictStr, Any]] = None,
        _content_type: Optional[StrictStr] = None,
        _headers: Optional[Dict[StrictStr, Any]] = None,
        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
    ) -> RESTResponseType:
        """Lists all available tags for software (releases and/or manifests). 


        :param kind: Only list tags used on software of a particular kind
        :type kind: str
        :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.
        :type _request_timeout: int, tuple(int, int), optional
        :param _request_auth: set to override the auth_settings for an a single
                              request; this effectively ignores the
                              authentication in the spec for a single request.
        :type _request_auth: dict, optional
        :param _content_type: force content-type for the request.
        :type _content_type: str, Optional
        :param _headers: set to override the headers for a single
                         request; this effectively ignores the headers
                         in the spec for a single request.
        :type _headers: dict, optional
        :param _host_index: set to override the host_index for a single
                            request; this effectively ignores the host_index
                            in the spec for a single request.
        :type _host_index: int, optional
        :return: Returns the result object.
        """ # noqa: E501

        _param = self._list_software_tags_serialize(
            kind=kind,
            _request_auth=_request_auth,
            _content_type=_content_type,
            _headers=_headers,
            _host_index=_host_index
        )

        _response_types_map: Dict[str, Optional[str]] = {
            '200': "List[str]",
            '400': "Error",
            '401': "Error",
            '500': "Error",
        }
        response_data = self.api_client.call_api(
            *_param,
            _request_timeout=_request_timeout
        )
        return response_data.response


    def _list_software_tags_serialize(
        self,
        kind,
        _request_auth,
        _content_type,
        _headers,
        _host_index,
    ) -> RequestSerialized:

        _host = None

        _collection_formats: Dict[str, str] = {
        }

        _path_params: Dict[str, str] = {}
        _query_params: List[Tuple[str, str]] = []
        _header_params: Dict[str, Optional[str]] = _headers or {}
        _form_params: List[Tuple[str, str]] = []
        _files: Dict[
            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
        ] = {}
        _body_params: Optional[bytes] = None

        # process the path parameters
        # process the query parameters
        if kind is not None:
            
            _query_params.append(('kind', kind))
            
        # process the header parameters
        # process the form parameters
        # process the body parameter


        # set the HTTP header `Accept`
        if 'Accept' not in _header_params:
            _header_params['Accept'] = self.api_client.select_header_accept(
                [
                    'application/json'
                ]
            )


        # authentication setting
        _auth_settings: List[str] = [
            'ManagementJWT'
        ]

        return self.api_client.param_serialize(
            method='GET',
            resource_path='/api/management/v1alpha1/deployments/software/tags',
            path_params=_path_params,
            query_params=_query_params,
            header_params=_header_params,
            body=_body_params,
            post_params=_form_params,
            files=_files,
            auth_settings=_auth_settings,
            collection_formats=_collection_formats,
            _host=_host,
            _request_auth=_request_auth
        )


