gamesheet_sdk.admin.roster<a class="headerlink" href="#module-gamesheet_sdk.admin.roster" title="Link to this heading">¶

model_copy(*, update=None, deep=False)¶

!!! abstract “Usage Documentation”: [model_copy](../concepts/models.md#model-copy)

Returns a copy of the model.

!!! note: The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:

update (Mapping[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Returns:

New model instance.

Return type:

model_dump(*, mode='python', include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False, polymorphic_serialization=None)¶

!!! abstract “Usage Documentation”: [model_dump](../concepts/serialization.md#python-mode)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Literal['json', 'python'] | str) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to include in the output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.
polymorphic_serialization (bool | None) – Whether to use model and dataclass polymorphic serialization for this call.

Returns:

A dictionary representation of the model.

Return type:

model_dump_json(*, indent=None, ensure_ascii=False, include=None, exclude=None, context=None, by_alias=None, exclude_unset=False, exclude_defaults=False, exclude_none=False, exclude_computed_fields=False, round_trip=False, warnings=True, fallback=None, serialize_as_any=False, polymorphic_serialization=None)¶

!!! abstract “Usage Documentation”: [model_dump_json](../concepts/serialization.md#json-mode)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
ensure_ascii (bool) – If True, the output is guaranteed to have all incoming non-ASCII characters escaped. If False (the default), these characters will be output as-is.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to include in the JSON output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.
polymorphic_serialization (bool | None) – Whether to use model and dataclass polymorphic serialization for this call.

Returns:

A JSON string representation of the model.

Return type:

str

property model_extra: dict[str, Any] | None¶

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields = {'created_at': FieldInfo(annotation=datetime, required=True, description='When the coach record was created.'), 'external_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='External identifier.'), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Coach's first name."), 'id': FieldInfo(annotation=str, required=True, description='Coach identifier (string in JSON:API).'), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Coach's last name."), 'position': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Coach's position (team roster only)."), 'season_id': FieldInfo(annotation=str, required=True, description='Parent season identifier.'), 'signature': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Coach's signature (team roster only)."), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Coach's status (team roster only)."), 'updated_at': FieldInfo(annotation=datetime, required=True, description='Last time the coach record was updated.')}¶

property model_fields_set: set[str]¶

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

classmethod model_json_schema(by_alias=True, ref_template='#/$defs/{model}', schema_generator=<class 'pydantic.json_schema.GenerateJsonSchema'>, mode='validation', *, union_format='any_of')¶

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
union_format (Literal['any_of', 'primitive_type_array']) –
The format to use when combining schemas from unions together. Can be one of:
- ’any_of’: Use the [anyOf](https://json-schema.org/understanding-json-schema/reference/combining#anyOf)
keyword to combine schemas (the default). - ‘primitive_type_array’: Use the [type](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (string, boolean, null, integer or number) or contains constraints/metadata, falls back to any_of.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Returns:

The JSON schema for the given model class.

Return type:

classmethod model_parametrized_name(params)¶

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.
Return type:: str

model_post_init(context, /)¶

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)¶

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (MappingNamespace | None) – The types namespace, defaults to None.

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

Return type:

bool | None

classmethod model_validate(obj, *, strict=None, extra=None, from_attributes=None, context=None, by_alias=None, by_name=None)¶

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError – If the object could not be validated.

Returns:

The validated model instance.

Return type:

classmethod model_validate_json(json_data, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)¶

!!! abstract “Usage Documentation”: [JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

Return type:

classmethod model_validate_strings(obj, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)¶

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Return type:

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)¶

Return type:: Self

classmethod parse_obj(obj)¶

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)¶

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')¶

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)¶

Return type:: str

classmethod update_forward_refs(**localns)¶

classmethod validate(value)¶

Return type:: Self

class gamesheet_sdk.admin.roster.Player[source]¶

Bases: BaseModel

A single player.

Maps the data[*] items in the JSON: API response of GET /api/seasons/{id}/players to a flat typed model. Includes both base player data and roster-specific metadata (position, jersey, etc.).

id¶

Player identifier (string in JSON:API).

Type:: str

season_id¶

Parent season identifier.

Type:: str

external_id¶

External identifier.

Type:: str | None

first_name¶

Player’s first name.

Type:: str | None

last_name¶

Player’s last name.

Type:: str | None

birthdate¶

Player’s birthdate.

Type:: str | None

photo_url¶

URL to player photo.

Type:: str | None

biography¶

Player biography.

Type:: str | None

height¶

Player height.

Type:: str | None

weight¶

Player weight.

Type:: str | None

shot_hand¶

Player’s shooting hand.

Type:: str | None

province¶

Player’s province.

Type:: str | None

hometown¶

Player’s hometown.

Type:: str | None

country¶

Player’s country.

Type:: str | None

drafted_by¶

Team that drafted the player.

Type:: str | None

committed_to¶

School/team player committed to.

Type:: str | None

number¶

Player’s jersey number (team roster only).

Type:: str | None

position¶

Player’s position (team roster only).

Type:: str | None

duty¶

Player’s duty (team roster only).

Type:: str | None

designation¶

Player’s designation (team roster only).

Type:: str | None

status¶

Player’s status (team roster only).

Type:: str | None

starting¶

Whether player is starting (team roster only).

Type:: bool | None

added_at_game_time¶

Whether player was added at game time (team roster only).

Type:: bool | None

affiliated¶

Whether player is affiliated (team roster only).

Type:: bool | None

created_at¶

When the player record was created.

Type:: datetime

updated_at¶

Last time the player record was updated.

Type:: datetime

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

id: str¶

season_id: str¶

external_id: str | None¶

first_name: str | None¶

last_name: str | None¶

birthdate: str | None¶

photo_url: str | None¶

biography: str | None¶

height: str | None¶

weight: str | None¶

shot_hand: str | None¶

province: str | None¶

hometown: str | None¶

country: str | None¶

drafted_by: str | None¶

committed_to: str | None¶

number: str | None¶

position: str | None¶

duty: str | None¶

designation: str | None¶

status: str | None¶

starting: bool | None¶

added_at_game_time: bool | None¶

affiliated: bool | None¶

created_at: datetime¶

updated_at: datetime¶

__init__(**data)¶

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

classmethod construct(_fields_set=None, **values)¶

Return type:: Self

copy(*, include=None, exclude=None, update=None, deep=False)¶

Returns a copy of the model.

!!! warning “Deprecated”: This method is now deprecated; use model_copy instead.

If you need include or exclude, use:

`python {test="skip" lint="skip"} data = self.model_dump(include=include, exclude=exclude, round_trip=True) data = {**data, **(update or {})} copied = self.model_validate(data) `

Parameters:

include (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to include in the copied model.
exclude (AbstractSetIntStr | MappingIntStrAny | None) – Optional set or mapping specifying which fields to exclude in the copied model.
update (Dict[str, Any] | None) – Optional dictionary of field-value pairs to override field values in the copied model.
deep (bool) – If True, the values of fields that are Pydantic models will be deep-copied.

Returns:

A copy of the model with included, excluded and updated fields as specified.

Return type:

Self

dict(*, include=None, exclude=None, by_alias=False, exclude_unset=False, exclude_defaults=False, exclude_none=False)¶

Return type:: Dict[str, Any]

classmethod from_orm(obj)¶

Return type:: Self

Return type:: str

model_computed_fields = {}¶

model_config = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

classmethod model_construct(_fields_set=None, **values)¶

Creates a new instance of the Model class with validated data.

Creates a new model setting __dict__ and __pydantic_fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed.

!!! note: model_construct() generally respects the model_config.extra setting on the provided model. That is, if model_config.extra == ‘allow’, then all extra passed values are added to the model instance’s __dict__ and __pydantic_extra__ fields. If model_config.extra == ‘ignore’ (the default), then all extra passed values are ignored. Because no validation is performed with a call to model_construct(), having model_config.extra == ‘forbid’ does not result in an error if extra values are passed, but they will be ignored.

Parameters:

_fields_set (set[str] | None) – A set of field names that were originally explicitly set during instantiation. If provided, this is directly used for the [model_fields_set][pydantic.BaseModel.model_fields_set] attribute. Otherwise, the field names from the values argument will be used.
values (Any) – Trusted or pre-validated data dictionary.

Returns:

A new instance of the Model class with validated data.

Return type:

model_copy(*, update=None, deep=False)¶

!!! abstract “Usage Documentation”: [model_copy](../concepts/models.md#model-copy)

Returns a copy of the model.

!!! note: The underlying instance’s [__dict__][object.__dict__] attribute is copied. This might have unexpected side effects if you store anything in it, on top of the model fields (e.g. the value of [cached properties][functools.cached_property]).

Parameters:

update (Mapping[str, Any] | None) – Values to change/add in the new model. Note: the data is not validated before creating the new model. You should trust this data.
deep (bool) – Set to True to make a deep copy of the model.

Returns:

New model instance.

Return type:

!!! abstract “Usage Documentation”: [model_dump](../concepts/serialization.md#python-mode)

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters:

mode (Literal['json', 'python'] | str) – The mode in which to_python should run. If mode is ‘json’, the output will only contain JSON serializable types. If mode is ‘python’, the output may contain non-JSON-serializable Python objects.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to include in the output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – A set of fields to exclude from the output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to use the field’s alias in the dictionary key if defined.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.
polymorphic_serialization (bool | None) – Whether to use model and dataclass polymorphic serialization for this call.

Returns:

A dictionary representation of the model.

Return type:

!!! abstract “Usage Documentation”: [model_dump_json](../concepts/serialization.md#json-mode)

Generates a JSON representation of the model using Pydantic’s to_json method.

Parameters:

indent (int | None) – Indentation to use in the JSON output. If None is passed, the output will be compact.
ensure_ascii (bool) – If True, the output is guaranteed to have all incoming non-ASCII characters escaped. If False (the default), these characters will be output as-is.
include (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to include in the JSON output.
exclude (set[int] | set[str] | Mapping[int, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | Mapping[str, set[int] | set[str] | Mapping[int, IncEx | bool] | Mapping[str, IncEx | bool] | bool] | None) – Field(s) to exclude from the JSON output.
context (Any | None) – Additional context to pass to the serializer.
by_alias (bool | None) – Whether to serialize using field aliases.
exclude_unset (bool) – Whether to exclude fields that have not been explicitly set.
exclude_defaults (bool) – Whether to exclude fields that are set to their default value.
exclude_none (bool) – Whether to exclude fields that have a value of None.
exclude_computed_fields (bool) – Whether to exclude computed fields. While this can be useful for round-tripping, it is usually recommended to use the dedicated round_trip parameter instead.
round_trip (bool) – If True, dumped values should be valid as input for non-idempotent types such as Json[T].
warnings (bool | Literal['none', 'warn', 'error']) – How to handle serialization errors. False/”none” ignores them, True/”warn” logs errors, “error” raises a [PydanticSerializationError][pydantic_core.PydanticSerializationError].
fallback (Callable[[Any], Any] | None) – A function to call when an unknown value is encountered. If not provided, a [PydanticSerializationError][pydantic_core.PydanticSerializationError] error is raised.
serialize_as_any (bool) – Whether to serialize fields with duck-typing serialization behavior.
polymorphic_serialization (bool | None) – Whether to use model and dataclass polymorphic serialization for this call.

Returns:

A JSON string representation of the model.

Return type:

str

property model_extra: dict[str, Any] | None¶

Get extra fields set during validation.

Returns:: A dictionary of extra fields, or None if config.extra is not set to “allow”.

model_fields = {'added_at_game_time': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Whether player was added at game time (team roster only).'), 'affiliated': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Whether player is affiliated (team roster only).'), 'biography': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Player biography.'), 'birthdate': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's birthdate."), 'committed_to': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='School/team player committed to.'), 'country': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's country."), 'created_at': FieldInfo(annotation=datetime, required=True, description='When the player record was created.'), 'designation': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's designation (team roster only)."), 'drafted_by': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Team that drafted the player.'), 'duty': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's duty (team roster only)."), 'external_id': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='External identifier.'), 'first_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's first name."), 'height': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Player height.'), 'hometown': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's hometown."), 'id': FieldInfo(annotation=str, required=True, description='Player identifier (string in JSON:API).'), 'last_name': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's last name."), 'number': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's jersey number (team roster only)."), 'photo_url': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='URL to player photo.'), 'position': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's position (team roster only)."), 'province': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's province."), 'season_id': FieldInfo(annotation=str, required=True, description='Parent season identifier.'), 'shot_hand': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's shooting hand."), 'starting': FieldInfo(annotation=Union[bool, NoneType], required=False, default=None, description='Whether player is starting (team roster only).'), 'status': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description="Player's status (team roster only)."), 'updated_at': FieldInfo(annotation=datetime, required=True, description='Last time the player record was updated.'), 'weight': FieldInfo(annotation=Union[str, NoneType], required=False, default=None, description='Player weight.')}¶

property model_fields_set: set[str]¶

Returns the set of fields that have been explicitly set on this model instance.

Returns:

A set of strings representing the fields that have been set,: i.e. that were not filled from defaults.

Generates a JSON schema for a model class.

Parameters:

by_alias (bool) – Whether to use attribute aliases or not.
ref_template (str) – The reference template.
union_format (Literal['any_of', 'primitive_type_array']) –
The format to use when combining schemas from unions together. Can be one of:
- ’any_of’: Use the [anyOf](https://json-schema.org/understanding-json-schema/reference/combining#anyOf)
keyword to combine schemas (the default). - ‘primitive_type_array’: Use the [type](https://json-schema.org/understanding-json-schema/reference/type) keyword as an array of strings, containing each type of the combination. If any of the schemas is not a primitive type (string, boolean, null, integer or number) or contains constraints/metadata, falls back to any_of.
schema_generator (type[GenerateJsonSchema]) – To override the logic used to generate the JSON schema, as a subclass of GenerateJsonSchema with your desired modifications
mode (Literal['validation', 'serialization']) – The mode in which to generate the schema.

Returns:

The JSON schema for the given model class.

Return type:

classmethod model_parametrized_name(params)¶

Compute the class name for parametrizations of generic classes.

This method can be overridden to achieve a custom naming scheme for generic BaseModels.

Parameters:: params (tuple[type[Any], ...]) – Tuple of types of the class. Given a generic class Model with 2 type variables and a concrete model Model[str, int], the value (str, int) would be passed to params.
Returns:: String representing the new class where params are passed to cls as type variables.
Raises:: TypeError – Raised when trying to generate concrete names for non-generic models.
Return type:: str

model_post_init(context, /)¶

Override this method to perform additional initialization after __init__ and model_construct. This is useful if you want to do some validation that requires the entire model to be initialized.

classmethod model_rebuild(*, force=False, raise_errors=True, _parent_namespace_depth=2, _types_namespace=None)¶

Try to rebuild the pydantic-core schema for the model.

This may be necessary when one of the annotations is a ForwardRef which could not be resolved during the initial attempt to build the schema, and automatic rebuilding fails.

Parameters:

force (bool) – Whether to force the rebuilding of the model schema, defaults to False.
raise_errors (bool) – Whether to raise errors, defaults to True.
_parent_namespace_depth (int) – The depth level of the parent namespace, defaults to 2.
_types_namespace (MappingNamespace | None) – The types namespace, defaults to None.

Returns:

Returns None if the schema is already “complete” and rebuilding was not required. If rebuilding _was_ required, returns True if rebuilding was successful, otherwise False.

Return type:

bool | None

classmethod model_validate(obj, *, strict=None, extra=None, from_attributes=None, context=None, by_alias=None, by_name=None)¶

Validate a pydantic model instance.

Parameters:

obj (Any) – The object to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
from_attributes (bool | None) – Whether to extract data from object attributes.
context (Any | None) – Additional context to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Raises:

ValidationError – If the object could not be validated.

Returns:

The validated model instance.

Return type:

classmethod model_validate_json(json_data, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)¶

!!! abstract “Usage Documentation”: [JSON Parsing](../concepts/json.md#json-parsing)

Validate the given JSON data against the Pydantic model.

Parameters:

json_data (str | bytes | bytearray) – The JSON data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Raises:

ValidationError – If json_data is not a JSON string or the object could not be validated.

Return type:

classmethod model_validate_strings(obj, *, strict=None, extra=None, context=None, by_alias=None, by_name=None)¶

Validate the given object with string data against the Pydantic model.

Parameters:

obj (Any) – The object containing string data to validate.
strict (bool | None) – Whether to enforce types strictly.
extra (Literal['allow', 'ignore', 'forbid'] | None) – Whether to ignore, allow, or forbid extra data during model validation. See the [extra configuration value][pydantic.ConfigDict.extra] for details.
context (Any | None) – Extra variables to pass to the validator.
by_alias (bool | None) – Whether to use the field’s alias when validating against the provided input data.
by_name (bool | None) – Whether to use the field’s name when validating against the provided input data.

Returns:

The validated Pydantic model.

Return type:

classmethod parse_file(path, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)¶

Return type:: Self

classmethod parse_obj(obj)¶

Return type:: Self

classmethod parse_raw(b, *, content_type=None, encoding='utf8', proto=None, allow_pickle=False)¶

Return type:: Self

classmethod schema(by_alias=True, ref_template='#/$defs/{model}')¶

Return type:: Dict[str, Any]

classmethod schema_json(*, by_alias=True, ref_template='#/$defs/{model}', **dumps_kwargs)¶

Return type:: str

classmethod update_forward_refs(**localns)¶

classmethod validate(value)¶

Return type:: Self

gamesheet_sdk.admin.roster.assign_coach(session, season_id, coach_id, team_id, *, position=None)[source]¶

Assign an existing coach to a team’s roster.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
coach_id (str) – The coach identifier to assign.
team_id (str) – The team identifier to assign the coach to.
position (str | None) – Optional position (Head Coach, Assistant Coach, etc.).

Returns:

Coach – The Coach with roster metadata populated.

Raises:

GameSheetError – If the coach is already assigned to the team.

Return type:

gamesheet_sdk.admin.roster.assign_player(session, season_id, player_id, team_id, *, jersey=None, position=None, status=None, designation=None)[source]¶

Assign an existing player to a team’s roster.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
player_id (str) – The player identifier to assign.
team_id (str) – The team identifier to assign the player to.
jersey (str | None) – Optional jersey number.
position (str | None) – Optional position (Forward, Defence, Goalie, etc.).
status (str | None) – Optional status (Regular, Affiliated, etc.).
designation (str | None) – Optional designation (Captain, Alternate Captain, etc.).

Returns:

Player – The Player with roster metadata populated.

Raises:

GameSheetError – If the player is already assigned to the team.

Return type:

gamesheet_sdk.admin.roster.assign_team_coach(session, season_id, team_id, coach_id, *, position=None)[source]¶

Assign an existing coach to a team’s roster (team-scoped alias).

This is an alias for assign_coach() provided for consistency with the team-scoped command structure. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to assign the coach to.
coach_id (str) – The coach identifier to assign.
position (str | None) – Optional position (Head Coach, Assistant Coach, etc.).

Returns:

Coach – Return value.

Return type:

gamesheet_sdk.admin.roster.assign_team_player(session, season_id, team_id, player_id, *, jersey=None, position=None, status=None, designation=None)[source]¶

Assign an existing player to a team’s roster (team-scoped alias).

This is an alias for assign_player() provided for consistency with the team-scoped command structure. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to assign the player to.
player_id (str) – The player identifier to assign.
jersey (str | None) – Optional jersey number.
position (str | None) – Optional position (Forward, Defence, Goalie, etc.).
status (str | None) – Optional status (Regular, Affiliated, etc.).
designation (str | None) – Optional designation (Captain, Alternate Captain, etc.).

Returns:

Player – The Player with roster metadata populated.

Return type:

gamesheet_sdk.admin.roster.create_coach(session, season_id, first_name, last_name, *, external_id=None, position=None, team_id=None)[source]¶

Create a new coach in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier to create the coach in.
first_name (str) – Coach’s first name.
last_name (str) – Coach’s last name.
external_id (str | None) – Optional external identifier for the coach.
position (str | None) – Optional position (Head Coach, Assistant Coach, etc.).
team_id (str | None) – Optional team identifier to associate the coach with.

Returns:

Coach – Return value.

Return type:

gamesheet_sdk.admin.roster.create_player(session, season_id, first_name, last_name, *, external_id=None, jersey=None, position=None, status=None, designation=None, team_id=None, biography=None, height=None, weight=None, shot_hand=None, birthdate=None, hometown=None, country=None, province=None, drafted_by=None, committed_to=None, photo_path=None)[source]¶

Create a new player in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier to create the player in.
first_name (str) – Player’s first name.
last_name (str) – Player’s last name.
external_id (str | None) – Optional external identifier for the player.
jersey (str | None) – Optional jersey number.
position (str | None) – Optional position (Forward, Defence, Goalie, etc.).
status (str | None) – Optional status (Regular, Affiliated, etc.).
designation (str | None) – Optional designation (Captain, Alternate Captain, etc.).
team_id (str | None) – Optional team identifier to associate the player with.
biography (str | None) – Optional biography text.
height (str | None) – Optional height (e.g., “6’2"”).
weight (str | None) – Optional weight (e.g., “185”).
shot_hand (str | None) – Optional shooting hand (left, right).
birthdate (str | None) – Optional birthdate (ISO format: YYYY-MM-DD).
hometown (str | None) – Optional hometown.
country (str | None) – Optional country code (e.g., “US”, “CA”).
province (str | None) – Optional province/state.
drafted_by (str | None) – Optional drafted by team name.
committed_to (str | None) – Optional committed to institution.
photo_path (str | None) – Optional path to a local photo image file.

Returns:

Player – The newly created Player model instance.

Return type:

gamesheet_sdk.admin.roster.create_team_coach(session, season_id, team_id, first_name, last_name, *, external_id=None, position=None)[source]¶

Create a new coach and add to the specified team’s roster.

This function performs two operations: (1) creates the coach at the season level, (2) updates the team’s roster to include the new coach with position and other metadata. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to add the coach to.
first_name (str) – Coach’s first name.
last_name (str) – Coach’s last name.
external_id (str | None) – Optional external identifier for the coach.
position (str | None) – Optional position (Head Coach, Assistant Coach, etc.).

Returns:

Coach – Return value.

Return type:

gamesheet_sdk.admin.roster.create_team_player(session, season_id, team_id, first_name, last_name, *, external_id=None, jersey=None, position=None, status=None, designation=None, biography=None, height=None, weight=None, shot_hand=None, birthdate=None, hometown=None, country=None, province=None, drafted_by=None, committed_to=None, photo_path=None)[source]¶

Create a new player and add to the specified team’s roster.

This function performs two operations: (1) creates the player at the season level, (2) updates the team’s roster to include the new player with position and other metadata. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to add the player to.
first_name (str) – Player’s first name.
last_name (str) – Player’s last name.
external_id (str | None) – Optional external identifier for the player.
jersey (str | None) – Optional jersey number.
position (str | None) – Optional position (Forward, Defence, Goalie, etc.).
status (str | None) – Optional status (Regular, Affiliated, etc.).
designation (str | None) – Optional designation (Captain, Alternate Captain, etc.).
biography (str | None) – Optional biography text.
height (str | None) – Optional height (e.g., “6’2"”).
weight (str | None) – Optional weight (e.g., “185”).
shot_hand (str | None) – Optional shooting hand (left, right).
birthdate (str | None) – Optional birthdate (ISO format: YYYY-MM-DD).
hometown (str | None) – Optional hometown.
country (str | None) – Optional country code (e.g., “US”, “CA”).
province (str | None) – Optional province/state.
drafted_by (str | None) – Optional drafted by team name.
committed_to (str | None) – Optional committed to institution.
photo_path (str | None) – Optional path to a local photo image file.

Returns:

Player – The newly created Player model instance with roster metadata populated.

Return type:

gamesheet_sdk.admin.roster.delete_coach(session, season_id, coach_id)[source]¶

Delete a coach from the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier containing the coach.
coach_id (str) – The coach identifier to delete.

gamesheet_sdk.admin.roster.delete_player(session, season_id, player_id)[source]¶

Delete a player from the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier containing the player.
player_id (str) – The player identifier to delete.

gamesheet_sdk.admin.roster.delete_team_coach(session, season_id, team_id, coach_id)[source]¶

Delete a coach from a team’s roster and the season.

This function performs two operations: (1) removes the coach from the team’s roster, (2) deletes the coach at the season level. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
coach_id (str) – The coach identifier to delete.

gamesheet_sdk.admin.roster.delete_team_player(session, season_id, team_id, player_id)[source]¶

Delete a player from a team’s roster and the season.

This function performs two operations: (1) removes the player from the team’s roster, (2) deletes the player at the season level. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
player_id (str) – The player identifier to delete.

gamesheet_sdk.admin.roster.get_coach(session, season_id, coach_id)[source]¶

Get a single coach by ID.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The parent season identifier.
coach_id (str) – The coach identifier to retrieve.

Returns:

Coach – Return value.

Return type:

gamesheet_sdk.admin.roster.get_coach_penalty_report(session, season_id, coach_id)[source]¶

Fetch penalty report for a coach.

First retrieves the coach to get their external_id, then fetches the penalty report from the BFF API. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
coach_id (str) – The coach identifier.

Returns:

dict[str, Any] –

Penalty report data including coach_games, coach_penalties, rostered_coaches, and: season_coaches.

Raises:

GameSheetError – If the penalty report API returns a non-success status.

Return type:

dict[str, Any]

gamesheet_sdk.admin.roster.get_player(session, season_id, player_id)[source]¶

Get a single player by ID.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The parent season identifier.
player_id (str) – The player identifier to retrieve.

Returns:

Player – The requested Player model instance.

Return type:

gamesheet_sdk.admin.roster.get_player_penalty_report(session, season_id, player_id)[source]¶

Fetch penalty report for a player.

First retrieves the player to get their external_id, then fetches the penalty report from the BFF API. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
player_id (str) – The player identifier.

Returns:

dict[str, Any] –

Penalty report data including player_games, player_penalties, rostered_players, and: season_players.

Raises:

GameSheetError – If the penalty report API returns a non-success status.

Return type:

dict[str, Any]

gamesheet_sdk.admin.roster.get_team_coach(session, season_id, team_id, coach_id)[source]¶

Get a single coach from a team’s roster.

This function retrieves team roster metadata (position, status, signature) that is only available in the team context, unlike get_coach() which fetches from the season-level coaches endpoint without roster metadata. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
coach_id (str) – The coach identifier to retrieve.

Returns:

Coach – The Coach with team roster metadata populated.

Raises:

GameSheetError – If the coach is not found on the team’s roster.

Return type:

gamesheet_sdk.admin.roster.get_team_player(session, season_id, team_id, player_id)[source]¶

Get a single player from a team’s roster.

This function retrieves team roster metadata (number, position, status, etc.) that is only available in the team context, unlike get_player() which fetches from the season-level players endpoint without roster metadata. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
player_id (str) – The player identifier to retrieve.

Returns:

Player – The Player with team roster metadata populated.

Raises:

GameSheetError – If the player is not found on the team’s roster.

Return type:

gamesheet_sdk.admin.roster.list_coaches(session, season_id)[source]¶

Return every coach in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier whose coaches to list.

Returns:

list[Coach] –

A list of Coach, in the order the server returned them. The list may be empty if: the season has no coaches.

Return type:

list[Coach]

gamesheet_sdk.admin.roster.list_players(session, season_id)[source]¶

Return every player in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier whose players to list.

Returns:

list[Player] –

A list of Player, in the order the server returned them. The list may be empty: if the season has no players.

Return type:

list[Player]

gamesheet_sdk.admin.roster.list_team_coaches(session, season_id, team_id)[source]¶

Return every coach for the specified team.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier whose coaches to list.

Returns:

list[Coach] –

A list of Coach, in the order the server returned them. The list may be empty if: the team has no coaches.

Return type:

list[Coach]

gamesheet_sdk.admin.roster.list_team_players(session, season_id, team_id)[source]¶

Return every player for the specified team.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier whose players to list.

Returns:

list[Player] –

A list of Player, in the order the server returned them. The list may be empty: if the team has no players.

Return type:

list[Player]

gamesheet_sdk.admin.roster.unassign_coach(session, season_id, coach_id, team_id)[source]¶

Unassign a coach from a team’s roster.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
coach_id (str) – The coach identifier to unassign.
team_id (str) – The team identifier to unassign the coach from.

Raises:

GameSheetError – If the coach is not assigned to the team.

gamesheet_sdk.admin.roster.unassign_player(session, season_id, player_id, team_id)[source]¶

Unassign a player from a team’s roster.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
player_id (str) – The player identifier to unassign.
team_id (str) – The team identifier to unassign the player from.

Raises:

GameSheetError – If the player is not assigned to the team.

gamesheet_sdk.admin.roster.unassign_team_coach(session, season_id, team_id, coach_id)[source]¶

Unassign a coach from a team’s roster (team-scoped alias).

This is an alias for unassign_coach() provided for consistency with the team-scoped command structure. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to unassign the coach from.
coach_id (str) – The coach identifier to unassign.

gamesheet_sdk.admin.roster.unassign_team_player(session, season_id, team_id, player_id)[source]¶

Unassign a player from a team’s roster (team-scoped alias).

This is an alias for unassign_player() provided for consistency with the team-scoped command structure. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier to unassign the player from.
player_id (str) – The player identifier to unassign.

gamesheet_sdk.admin.roster.update_coach(session, season_id, coach_id, *, first_name=None, last_name=None, external_id=None, position=None)[source]¶

Update an existing coach in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401. At least one field must be provided for update.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier containing the coach.
coach_id (str) – The coach identifier to update.
first_name (str | None) – Optional updated first name.
last_name (str | None) – Optional updated last name.
external_id (str | None) – Optional updated external identifier.
position (str | None) – Optional updated position.

Returns:

Coach – The updated Coach.

Raises:

ValueError – If no fields are provided for update.

Return type:

gamesheet_sdk.admin.roster.update_player(session, season_id, player_id, *, first_name=None, last_name=None, external_id=None, biography=None, height=None, weight=None, shot_hand=None, birthdate=None, hometown=None, country=None, province=None, drafted_by=None, committed_to=None, photo_path=None, remove_photo=False)[source]¶

Update an existing player in the specified season.

The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401. At least one field must be provided for update.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier containing the player.
player_id (str) – The player identifier to update.
first_name (str | None) – Optional updated first name.
last_name (str | None) – Optional updated last name.
external_id (str | None) – Optional updated external identifier.
biography (str | None) – Optional updated biography text.
height (str | None) – Optional updated height (e.g., “6’2"”).
weight (str | None) – Optional updated weight (e.g., “185”).
shot_hand (str | None) – Optional updated shooting hand (left, right).
birthdate (str | None) – Optional updated birthdate (ISO format: YYYY-MM-DD).
hometown (str | None) – Optional updated hometown.
country (str | None) – Optional updated country code (e.g., “US”, “CA”).
province (str | None) – Optional updated province/state.
drafted_by (str | None) – Optional updated drafted by team name.
committed_to (str | None) – Optional updated committed to institution.
photo_path (str | None) – Optional path to a new photo image file.
remove_photo (bool) – If True, remove the player’s photo.

Returns:

Player – The updated Player.

Return type:

gamesheet_sdk.admin.roster.update_team_coach(session, season_id, team_id, coach_id, *, first_name=None, last_name=None, external_id=None, position=None)[source]¶

Update a coach and update the team’s roster in one operation.

This function performs two operations: (1) updates the coach at the season level, (2) updates the team’s roster with any position changes. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
coach_id (str) – The coach identifier to update.
first_name (str | None) – Optional updated first name.
last_name (str | None) – Optional updated last name.
external_id (str | None) – Optional updated external identifier.
position (str | None) – Optional updated position.

Returns:

Coach – The updated Coach.

Raises:

ValueError – If no fields are provided for update.

Return type:

gamesheet_sdk.admin.roster.update_team_player(session, season_id, team_id, player_id, *, first_name=None, last_name=None, external_id=None, biography=None, height=None, weight=None, shot_hand=None, birthdate=None, hometown=None, country=None, province=None, drafted_by=None, committed_to=None, photo_path=None, remove_photo=False)[source]¶

Update a player for a specific team.

This function updates the player at the season level. The supplied Session must already carry a bearer token (e.g. via Session.set_bearer_token()); the call is otherwise unauthenticated and will 401.

Parameters:

session (Session) – An authenticated Session.
season_id (str) – The season identifier.
team_id (str) – The team identifier.
player_id (str) – The player identifier to update.
first_name (str | None) – Optional updated first name.
last_name (str | None) – Optional updated last name.
external_id (str | None) – Optional updated external identifier.
biography (str | None) – Optional updated biography text.
height (str | None) – Optional updated height (e.g., “6’2"”).
weight (str | None) – Optional updated weight (e.g., “185”).
shot_hand (str | None) – Optional updated shooting hand (left, right).
birthdate (str | None) – Optional updated birthdate (ISO format: YYYY-MM-DD).
hometown (str | None) – Optional updated hometown.
country (str | None) – Optional updated country code (e.g., “US”, “CA”).
province (str | None) – Optional updated province/state.
drafted_by (str | None) – Optional updated drafted by team name.
committed_to (str | None) – Optional updated committed to institution.
photo_path (str | None) – Optional path to a new photo image file.
remove_photo (bool) – If True, remove the player’s photo.

Returns:

Player – The updated Player.

Return type: