allowlist

Serializable allowlist API request and response contracts.

class bedrock_server_manager.api.models.allowlist.AllowlistPlayer(*, name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], xuid: str | None = None, ignoresPlayerLimit: bool = False)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.AllowlistRemovalDetails(*, removed: list[str], not_found: list[str])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.AddToAllowlistRequest(*, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], new_players_data: list[AllowlistPlayer])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.AddToAllowlistResponse(*, status: Literal['success'] = 'success', message: str | None = None, added_count: Annotated[int, Ge(ge=0)])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.GetAllowlistRequest(*, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.GetAllowlistResponse(*, status: Literal['success'] = 'success', message: str | None = None, players: list[AllowlistPlayer])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.RemoveFromAllowlistRequest(*, server_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')], player_names: list[Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])]])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.allowlist.RemoveFromAllowlistResponse(*, status: Literal['success'] = 'success', message: str | None = None, details: AllowlistRemovalDetails)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].