beetkeeper-api-client 0.12.0__py3-none-any.whl

beetkeeper_api_client/exceptions.py

@@ -0,0 +1,218 @@
+"""
+    beetkeeper
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from typing import Any, Optional
+from typing_extensions import Self
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(self, msg, path_to_item=None, valid_classes=None,
+                 key_type=None) -> None:
+        """ Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = "{0} at {1}".format(msg, render_path(path_to_item))
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+
+    def __init__(
+        self, 
+        status=None, 
+        reason=None, 
+        http_resp=None,
+        *,
+        body: Optional[str] = None,
+        data: Optional[Any] = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode('utf-8')
+                except Exception:
+                    pass
+            self.headers = http_resp.headers
+
+    @classmethod
+    def from_response(
+        cls, 
+        *, 
+        http_resp, 
+        body: Optional[str], 
+        data: Optional[Any],
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        # Added new conditions for 409 and 422
+        if http_resp.status == 409:
+            raise ConflictException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 422:
+            raise UnprocessableEntityException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        if self.data:
+            error_message += "HTTP response data: {0}\n".format(self.data)
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+class ConflictException(ApiException):
+    """Exception for HTTP 409 Conflict."""
+    pass
+
+
+class UnprocessableEntityException(ApiException):
+    """Exception for HTTP 422 Unprocessable Entity."""
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += "[{0}]".format(pth)
+        else:
+            result += "['{0}']".format(pth)
+    return result

beetkeeper_api_client/models/__init__.py

@@ -0,0 +1,44 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    beetkeeper
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from beetkeeper_api_client.models.api_album import APIAlbum
+from beetkeeper_api_client.models.api_track import APITrack
+from beetkeeper_api_client.models.beets_event_type import BeetsEventType
+from beetkeeper_api_client.models.clean_slate_preview import CleanSlatePreview
+from beetkeeper_api_client.models.clean_slate_submit_request import CleanSlateSubmitRequest
+from beetkeeper_api_client.models.current_beets_subject_state import CurrentBeetsSubjectState
+from beetkeeper_api_client.models.decision_request import DecisionRequest
+from beetkeeper_api_client.models.event_search_response import EventSearchResponse
+from beetkeeper_api_client.models.event_search_result import EventSearchResult
+from beetkeeper_api_client.models.event_subject_summary import EventSubjectSummary
+from beetkeeper_api_client.models.events_list_response import EventsListResponse
+from beetkeeper_api_client.models.find_missing_source_path_request import FindMissingSourcePathRequest
+from beetkeeper_api_client.models.find_missing_source_path_response import FindMissingSourcePathResponse
+from beetkeeper_api_client.models.http_validation_error import HTTPValidationError
+from beetkeeper_api_client.models.health_info import HealthInfo
+from beetkeeper_api_client.models.import_action import ImportAction
+from beetkeeper_api_client.models.import_candidate import ImportCandidate
+from beetkeeper_api_client.models.import_decision import ImportDecision
+from beetkeeper_api_client.models.import_job import ImportJob
+from beetkeeper_api_client.models.import_job_status import ImportJobStatus
+from beetkeeper_api_client.models.import_submit_request import ImportSubmitRequest
+from beetkeeper_api_client.models.listener_event_details import ListenerEventDetails
+from beetkeeper_api_client.models.location_inner import LocationInner
+from beetkeeper_api_client.models.login_request_body import LoginRequestBody
+from beetkeeper_api_client.models.login_response_body import LoginResponseBody
+from beetkeeper_api_client.models.logout_response_body import LogoutResponseBody
+from beetkeeper_api_client.models.search_missing_source_path_result import SearchMissingSourcePathResult
+from beetkeeper_api_client.models.validation_error import ValidationError
+

beetkeeper_api_client/models/api_album.py

@@ -0,0 +1,285 @@
+# coding: utf-8
+
+"""
+    beetkeeper
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictBytes, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Tuple, Union
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class APIAlbum(BaseModel):
+    """
+    Model for the relevant parts of a `beets.library.Album` instance. used during beets plugin client push events for an event tied to a given album. For simplicity, we only mark `id` as required, with all other fields as optional (which might not be the case for beets internals).  NOTE: This was generated from `build_scripts/code_gen/pydantic_field_info_from_beets_model.py`.
+    """ # noqa: E501
+    id: StrictInt
+    added: Optional[Union[StrictFloat, StrictInt]] = None
+    album: Optional[StrictStr] = ''
+    albumartist: Optional[StrictStr] = ''
+    albumartist_credit: Optional[StrictStr] = ''
+    albumartist_sort: Optional[StrictStr] = ''
+    albumartists: Optional[List[Any]] = None
+    albumartists_credit: Optional[List[Any]] = None
+    albumartists_sort: Optional[List[Any]] = None
+    albumdisambig: Optional[StrictStr] = ''
+    albumstatus: Optional[StrictStr] = ''
+    albumtype: Optional[StrictStr] = ''
+    albumtypes: Optional[List[Any]] = None
+    artpath: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = ''
+    asin: Optional[StrictStr] = ''
+    barcode: Optional[StrictStr] = ''
+    catalognum: Optional[StrictStr] = ''
+    comp: Optional[StrictBool] = False
+    country: Optional[StrictStr] = ''
+    day: Optional[StrictInt] = None
+    discogs_albumid: Optional[StrictInt] = None
+    discogs_artistid: Optional[StrictInt] = None
+    discogs_labelid: Optional[StrictInt] = None
+    disctotal: Optional[StrictInt] = None
+    genres: Optional[List[Any]] = None
+    label: Optional[StrictStr] = ''
+    language: Optional[StrictStr] = ''
+    mb_albumartistid: Optional[StrictStr] = ''
+    mb_albumartistids: Optional[List[Any]] = None
+    mb_albumid: Optional[StrictStr] = ''
+    mb_releasegroupid: Optional[StrictStr] = ''
+    month: Optional[StrictInt] = None
+    original_day: Optional[StrictInt] = None
+    original_month: Optional[StrictInt] = None
+    original_year: Optional[StrictInt] = None
+    r128_album_gain: Optional[Union[StrictFloat, StrictInt]] = None
+    release_group_title: Optional[StrictStr] = ''
+    releasegroupdisambig: Optional[StrictStr] = ''
+    rg_album_gain: Optional[Union[StrictFloat, StrictInt]] = None
+    rg_album_peak: Optional[Union[StrictFloat, StrictInt]] = None
+    script: Optional[StrictStr] = ''
+    style: Optional[StrictStr] = ''
+    year: Optional[StrictInt] = None
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["id", "added", "album", "albumartist", "albumartist_credit", "albumartist_sort", "albumartists", "albumartists_credit", "albumartists_sort", "albumdisambig", "albumstatus", "albumtype", "albumtypes", "artpath", "asin", "barcode", "catalognum", "comp", "country", "day", "discogs_albumid", "discogs_artistid", "discogs_labelid", "disctotal", "genres", "label", "language", "mb_albumartistid", "mb_albumartistids", "mb_albumid", "mb_releasegroupid", "month", "original_day", "original_month", "original_year", "r128_album_gain", "release_group_title", "releasegroupdisambig", "rg_album_gain", "rg_album_peak", "script", "style", "year"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of APIAlbum from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        # set to None if added (nullable) is None
+        # and model_fields_set contains the field
+        if self.added is None and "added" in self.model_fields_set:
+            _dict['added'] = None
+
+        # set to None if albumartists (nullable) is None
+        # and model_fields_set contains the field
+        if self.albumartists is None and "albumartists" in self.model_fields_set:
+            _dict['albumartists'] = None
+
+        # set to None if albumartists_credit (nullable) is None
+        # and model_fields_set contains the field
+        if self.albumartists_credit is None and "albumartists_credit" in self.model_fields_set:
+            _dict['albumartists_credit'] = None
+
+        # set to None if albumartists_sort (nullable) is None
+        # and model_fields_set contains the field
+        if self.albumartists_sort is None and "albumartists_sort" in self.model_fields_set:
+            _dict['albumartists_sort'] = None
+
+        # set to None if albumtypes (nullable) is None
+        # and model_fields_set contains the field
+        if self.albumtypes is None and "albumtypes" in self.model_fields_set:
+            _dict['albumtypes'] = None
+
+        # set to None if day (nullable) is None
+        # and model_fields_set contains the field
+        if self.day is None and "day" in self.model_fields_set:
+            _dict['day'] = None
+
+        # set to None if discogs_albumid (nullable) is None
+        # and model_fields_set contains the field
+        if self.discogs_albumid is None and "discogs_albumid" in self.model_fields_set:
+            _dict['discogs_albumid'] = None
+
+        # set to None if discogs_artistid (nullable) is None
+        # and model_fields_set contains the field
+        if self.discogs_artistid is None and "discogs_artistid" in self.model_fields_set:
+            _dict['discogs_artistid'] = None
+
+        # set to None if discogs_labelid (nullable) is None
+        # and model_fields_set contains the field
+        if self.discogs_labelid is None and "discogs_labelid" in self.model_fields_set:
+            _dict['discogs_labelid'] = None
+
+        # set to None if disctotal (nullable) is None
+        # and model_fields_set contains the field
+        if self.disctotal is None and "disctotal" in self.model_fields_set:
+            _dict['disctotal'] = None
+
+        # set to None if genres (nullable) is None
+        # and model_fields_set contains the field
+        if self.genres is None and "genres" in self.model_fields_set:
+            _dict['genres'] = None
+
+        # set to None if mb_albumartistids (nullable) is None
+        # and model_fields_set contains the field
+        if self.mb_albumartistids is None and "mb_albumartistids" in self.model_fields_set:
+            _dict['mb_albumartistids'] = None
+
+        # set to None if month (nullable) is None
+        # and model_fields_set contains the field
+        if self.month is None and "month" in self.model_fields_set:
+            _dict['month'] = None
+
+        # set to None if original_day (nullable) is None
+        # and model_fields_set contains the field
+        if self.original_day is None and "original_day" in self.model_fields_set:
+            _dict['original_day'] = None
+
+        # set to None if original_month (nullable) is None
+        # and model_fields_set contains the field
+        if self.original_month is None and "original_month" in self.model_fields_set:
+            _dict['original_month'] = None
+
+        # set to None if original_year (nullable) is None
+        # and model_fields_set contains the field
+        if self.original_year is None and "original_year" in self.model_fields_set:
+            _dict['original_year'] = None
+
+        # set to None if r128_album_gain (nullable) is None
+        # and model_fields_set contains the field
+        if self.r128_album_gain is None and "r128_album_gain" in self.model_fields_set:
+            _dict['r128_album_gain'] = None
+
+        # set to None if rg_album_gain (nullable) is None
+        # and model_fields_set contains the field
+        if self.rg_album_gain is None and "rg_album_gain" in self.model_fields_set:
+            _dict['rg_album_gain'] = None
+
+        # set to None if rg_album_peak (nullable) is None
+        # and model_fields_set contains the field
+        if self.rg_album_peak is None and "rg_album_peak" in self.model_fields_set:
+            _dict['rg_album_peak'] = None
+
+        # set to None if year (nullable) is None
+        # and model_fields_set contains the field
+        if self.year is None and "year" in self.model_fields_set:
+            _dict['year'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of APIAlbum from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "added": obj.get("added"),
+            "album": obj.get("album") if obj.get("album") is not None else '',
+            "albumartist": obj.get("albumartist") if obj.get("albumartist") is not None else '',
+            "albumartist_credit": obj.get("albumartist_credit") if obj.get("albumartist_credit") is not None else '',
+            "albumartist_sort": obj.get("albumartist_sort") if obj.get("albumartist_sort") is not None else '',
+            "albumartists": obj.get("albumartists"),
+            "albumartists_credit": obj.get("albumartists_credit"),
+            "albumartists_sort": obj.get("albumartists_sort"),
+            "albumdisambig": obj.get("albumdisambig") if obj.get("albumdisambig") is not None else '',
+            "albumstatus": obj.get("albumstatus") if obj.get("albumstatus") is not None else '',
+            "albumtype": obj.get("albumtype") if obj.get("albumtype") is not None else '',
+            "albumtypes": obj.get("albumtypes"),
+            "artpath": obj.get("artpath") if obj.get("artpath") is not None else '',
+            "asin": obj.get("asin") if obj.get("asin") is not None else '',
+            "barcode": obj.get("barcode") if obj.get("barcode") is not None else '',
+            "catalognum": obj.get("catalognum") if obj.get("catalognum") is not None else '',
+            "comp": obj.get("comp") if obj.get("comp") is not None else False,
+            "country": obj.get("country") if obj.get("country") is not None else '',
+            "day": obj.get("day"),
+            "discogs_albumid": obj.get("discogs_albumid"),
+            "discogs_artistid": obj.get("discogs_artistid"),
+            "discogs_labelid": obj.get("discogs_labelid"),
+            "disctotal": obj.get("disctotal"),
+            "genres": obj.get("genres"),
+            "label": obj.get("label") if obj.get("label") is not None else '',
+            "language": obj.get("language") if obj.get("language") is not None else '',
+            "mb_albumartistid": obj.get("mb_albumartistid") if obj.get("mb_albumartistid") is not None else '',
+            "mb_albumartistids": obj.get("mb_albumartistids"),
+            "mb_albumid": obj.get("mb_albumid") if obj.get("mb_albumid") is not None else '',
+            "mb_releasegroupid": obj.get("mb_releasegroupid") if obj.get("mb_releasegroupid") is not None else '',
+            "month": obj.get("month"),
+            "original_day": obj.get("original_day"),
+            "original_month": obj.get("original_month"),
+            "original_year": obj.get("original_year"),
+            "r128_album_gain": obj.get("r128_album_gain"),
+            "release_group_title": obj.get("release_group_title") if obj.get("release_group_title") is not None else '',
+            "releasegroupdisambig": obj.get("releasegroupdisambig") if obj.get("releasegroupdisambig") is not None else '',
+            "rg_album_gain": obj.get("rg_album_gain"),
+            "rg_album_peak": obj.get("rg_album_peak"),
+            "script": obj.get("script") if obj.get("script") is not None else '',
+            "style": obj.get("style") if obj.get("style") is not None else '',
+            "year": obj.get("year")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+