# Copyright (c) 2020, Moritz E. Beber.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.


"""Provide the Structurizr client."""


from typing import Optional

from pydantic import Field

from ..base_model import BaseModel


__all__ = ("APIResponse",)


class APIResponse(BaseModel):
    """
    Define a Structurizr API response.

    An API response indicating success or failure.

    Attributes:
        success (bool): `True` if the API call was successful, `False` otherwise.
        message (str): A human readable response message.
        revision (int, optional): The internal revision number.

    """

    success: bool = Field(
        ..., description="`True` if the API call was successful, `False` otherwise."
    )
    message: str = Field(..., description="A human readable response message.")
    revision: Optional[int] = Field(None, description="The internal revision number.")
