horde_sdk.ai_horde_api.apimodels.collections¶

class ResponseModelStylesShort(HordeAPIObjectBaseModel):
    """The name and ID of a style.

    v2 API Model: `ResponseModelStylesShort`
    """

    name: str = Field(
        description="The unique name for this style",
    )
    id_: str = Field(
        alias="id",
        description="The ID of this style",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "ResponseModelStylesShort"

@Unhashable
@Unequatable
class ResponseModelCollection(HordeResponseBaseModel):
    """A collection of styles.

    Represents the data returned from the following endpoints and http status codes:
        - /v2/collection_by_name/{collection_name} | CollectionByNameRequest [GET] -> 200
        - /v2/collections/{collection_id} | CollectionByIDRequest [GET] -> 200

    v2 API Model: `ResponseModelCollection`
    """

    id: str
    """The UUID of the collection. Use this to use this collection of retrieve its information in the future."""

    name: str = Field()
    """The name for the collection. Case-sensitive and unique per user."""

    type: Literal["image"] = Field()
    """The kind of styles stored in this collection."""

    info: str | None = Field(default=None)
    """Extra information about this collection."""

    public: bool = Field(default=True)
    """When true this collection will be listed among all collection publicly.When false, information about this
    collection can only be seen by people who know its ID or name."""

    styles: list[ResponseModelStylesShort] = Field()
    """The styles contained in this collection."""

    use_count: int | None = Field()
    """The number of times this collection has been used."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "ResponseModelCollection"

@Unhashable
@Unequatable
class AllCollectionsResponse(HordeResponseRootModel[list[ResponseModelCollection]]):
    """A list of collections.

    Represents the data returned from the /v2/collections endpoint with http status code 200.

    v2 API Model: `_ANONYMOUS_MODEL`
    """

    root: list[ResponseModelCollection]
    """The underlying list of collections."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return _ANONYMOUS_MODEL

class AllCollectionsRequest(BaseAIHordeRequest):
    """Request to get all collections, optionally filtered by type and sorted by popularity or age.

    Data is paginated. Each page has 25 collections. Set `page` to get the next page.

    Represents a GET request to the /v2/collections endpoint.
    """

    sort: Literal["popular", "age"] = Field(
        default="popular",
        description="The sort order for the collections.",
    )

    page: int = Field(
        default=1,
        description="The page number for the collections. Each page has 25 styles.",
    )

    type_: Literal["image", "text", "all"] = Field(
        alias="type",
        default="all",
        description="The type of collections to retrieve.",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_query_fields(cls) -> list[str]:
        return ["sort", "page", "type"]

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[AllCollectionsResponse]:
        return AllCollectionsResponse

class CollectionByIDRequest(BaseAIHordeRequest):
    """Request to get a collection by its ID.

    Represents a GET request to the /v2/collections/{collection_id} endpoint.
    """

    collection_id: str = Field(
        description="The ID of the collection.",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections_by_id

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[ResponseModelCollection]:
        return ResponseModelCollection

class CollectionByNameRequest(BaseAIHordeRequest):
    """Request to get a collection by its name.

    Represents a GET request to the /v2/collection_by_name/{collection_name} endpoint.
    """

    collection_name: str = Field(
        description="The name of the collection.",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections_by_name

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[ResponseModelCollection]:
        return ResponseModelCollection

class CreateCollectionResponse(
    HordeResponseBaseModel,
    ContainsMessageResponseMixin,
    ContainsWarningsResponseMixin,
):
    """Indicates that a collection was created and provides its ID and any warnings.

    Represents the data returned from the /v2/collections endpoint with http status code 200.

    v2 API Model: `StyleModify`
    """

    id_: str = Field(
        alias="id",
        description="The ID of the collection.",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "StyleModify"

@Unhashable
@Unequatable
class CreateCollectionRequest(
    _InputModelCollectionMixin,
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
):
    """Request to create a collection.

    Represents a POST request to the /v2/collections endpoint.

    v2 API Model: `InputModelCollection`
    """

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "InputModelCollection"

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.POST

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[CreateCollectionResponse]:
        return CreateCollectionResponse

    @override
    @classmethod
    def is_api_key_required(cls) -> bool:
        return True

class DeleteCollectionResponse(
    HordeResponseBaseModel,
    ContainsMessageResponseMixin,
):
    """Returns an "OK" message when a collection is successfully deleted with http status code 200.

    Represents the data returned from the /v2/collections/{collection_id} endpoint with http status code 200.

    v2 API Model: `SimpleResponse`
    """

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "SimpleResponse"

class DeleteCollectionRequest(
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
):
    """Request to delete a collection by its ID.

    Represents a DELETE request to the /v2/collections/{collection_id} endpoint.
    """

    collection_id: str = Field(
        description="The ID of the collection.",
    )

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.DELETE

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections_by_id

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[DeleteCollectionResponse]:
        return DeleteCollectionResponse

    @override
    @classmethod
    def is_api_key_required(cls) -> bool:
        return True

class UpdateCollectionResponse(
    HordeResponseBaseModel,
    ContainsMessageResponseMixin,
    ContainsWarningsResponseMixin,
):
    """Returns an "OK" message when a collection is successfully updated with http status code 200.

    Note: If issues are detected, they will be returned in the warnings field.

    Represents the data returned from the /v2/collections/{collection_id} endpoint with http status code 200.

    v2 API Model: `StyleModify`
    """

    id_: str = Field(
        alias="id",
    )
    """The ID of the collection that was updated."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "StyleModify"

@Unhashable
@Unequatable
class UpdateCollectionRequest(
    _InputModelCollectionMixin,
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
):
    """Request to update a collection by its ID.

    Note: Always check the warnings field on response for any issues that may have occurred during the update.

    Represents a PATCH request to the /v2/collections/{collection_id} endpoint.

    v2 API Model: `InputModelCollection`
    """

    collection_id: str
    """The ID of the collection to update."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "InputModelCollection"

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.PATCH

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_collections_by_id

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[UpdateCollectionResponse]:
        return UpdateCollectionResponse

    @override
    @classmethod
    def is_api_key_required(cls) -> bool:
        return True