domain

Short.io Domain API implementation.

This module provides classes and methods for interacting with the Short.io Domain-related API endpoints. It includes the Domain model class and API methods for retrieving domain information.

class pyshortio.domain.DomainMixin

Mixin class providing Domain-related API methods for the Client.

list_domains(limit: int | None = _NOTHING(), offset: int | None = _NOTHING(), no_team_id: bool | None = _NOTHING(), pattern: str | None = _NOTHING(), team_id: str | None = _NOTHING(), raise_for_status: bool = True) → tuple[Response, list[Domain]]

Retrieve a list of all domains with optional filtering.

Ref:

• https://developers.short.io/reference/get_api-domains

get_domain(domain_id: int, raise_for_status: bool = True) → tuple[Response, Domain | None]

Retrieve a specific domain by its ID.

Ref:

• https://developers.short.io/reference/get_domains-domainid

get_domain_by_hostname(hostname: str, raise_for_status: bool = True) → Tuple[Response, Domain | None]

Find a domain by its hostname.

This method lists all domains and finds the one matching the specified hostname. This is a convenience method that combines list_domains() and filtering.