# pyteamsnap.models package

## Module contents

class pyteamsnap.models.Availability(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  event_id
  is_current_user
  member_id
  notes
  notes_author_member_id
  rel: str = 'availabilities'
  status
  status_code
  team_id
  type = 'availability'
  version: str = '3.866.0'

class pyteamsnap.models.AvailabilityStatusCode(value)

  Bases: `Enum`

  An enumeration.

  MAYBE = 2
  NO = 0
  YES = 1

class pyteamsnap.models.AvailabilitySummary(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  event_id
  going_count
  maybe_count
  not_going_count
  player_going_count
  player_maybe_count
  player_not_going_count
  player_unknown_count
  rel: str = 'availability_summaries'
  team_id
  type = 'availability_summary'
  unknown_count
  version: str = '3.866.0'

class pyteamsnap.models.Event(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  Associated object to a team; and represents an event or game that is tracked in the TeamSnap system. https://www.teamsnap.com/documentation/apiv3/objects#Events

  additional_location_details
  arrival_date
  created_at
  division_location_id
  doesnt_count_towards_record
  duration_in_minutes
  end_date
  formatted_results
  formatted_title
  formatted_title_for_multi_team
  game_type
  game_type_code
  icon_color
  is_canceled
  is_game
  is_league_controlled
  is_overtime
  is_shootout
  is_tbd
  label
  location_id
  location_name
  minutes_to_arrive_early
  name
  notes
  opponent_id
  opponent_name
  points_for_opponent
  points_for_team
  rel: str = 'events'
  repeating_type
  repeating_type_code
  repeating_uuid
  results
  results_url
  shootout_points_for_opponent
  shootout_points_for_team
  source_time_zone_iana_name
  start_date
  team_id
  time_zone
  time_zone_description
  time_zone_iana_name
  time_zone_offset
  tracks_availability
  type = 'event'
  uniform
  updated_at
  version: str = '3.866.0'

class pyteamsnap.models.EventLineup(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  entries_count
  event_id
  is_published
  rel: str = 'event_lineups'
  type = 'event_lineup'
  version: str = '3.866.0'

class pyteamsnap.models.EventLineupEntry(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  availability_status_code
  event_id
  event_lineup_id
  label
  member_id
  member_name
  member_photo
  rel: str = 'event_lineup_entries'
  classmethod search(client, **kwargs)
    Parameters

      - client –

      - kwargs –

    Returns

      List of TeamSnapBaseObjects

  sequence
  type = 'event_lineup_entry'
  version: str = '3.866.0'

class pyteamsnap.models.Location(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  address
  is_retired
  latitude
  longitude
  name
  notes
  phone
  rel: str = 'locations'
  team_id
  type = 'location'
  url
  version: str = '3.866.0'

class pyteamsnap.models.Me(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `User`

  The current user’s object. It is not possible to create or delete users via the API; however, it is possible to update data on a user’s record. https://www.teamsnap.com/documentation/apiv3/objects#Me

  birthday
  email
  facebook_access_token
  facebook_id
  first_name
  is_lab_rat
  last_name
  password
  receives_newsletter
  rel: str = 'me'
  type = 'user'
  version: str = '3.866.0'

class pyteamsnap.models.Member(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  A member (also referred to as a roster in our web and mobile apps) is a member of a team. https://www.teamsnap.com/documentation/apiv3/objects#Members

  address_city
  address_state
  address_street1
  address_street2
  address_zip
  birthday
  first_name
  gender
  hide_address
  hide_age
  is_address_hidden
  is_age_hidden
  is_manager
  is_non_player
  is_ownership_pending
  jersey_number
  last_name
  position
  rel: str = 'members'
  source_action
  team_id
  type = 'member'
  version: str = '3.866.0'

class pyteamsnap.models.MemberStatistics(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  average
  average_ranking
  average_ranking_for_query
  count_games_played
  id
  member_id
  rel: str = 'member_statistics'
  statistic_id
  team_id
  total
  total_ranking
  total_ranking_for_query
  type = 'member_statistic'

class pyteamsnap.models.Opponent(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  contacts_email
  contacts_name
  contacts_phone
  name
  notes
  rel: str = 'opponents'
  team_id
  type = 'opponent'
  version: str = '3.866.0'

class pyteamsnap.models.Statistics(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  acronym
  always_display_decimals
  display_zero_totals
  formula
  is_in_descending_order
  is_percentage
  is_private
  is_team_statistic
  is_top_statistic
  name
  precision
  rel: str = 'statistics'
  statistic_group_id
  team_id
  type = 'statistic'
  version: str = '3.866.0'

class pyteamsnap.models.Team(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  Associated teams from your origin object. Full CRUD is possible with the teams endpoint. https://www.teamsnap.com/documentation/apiv3/objects#Teams

  ad_unit_hero_id
  ad_unit_hero_template_id
  ad_unit_inline_id
  division_id
  division_name
  is_ownership_pending
  league_name
  league_url
  location_country
  location_postal_code
  name
  owner_email
  owner_first_name
  owner_last_name
  rel: str = 'teams'
  season_name
  sport_id
  team
  time_zone
  type = 'team'
  version: str = '3.866.0'

class pyteamsnap.models.User(client: TeamSnap, data: Dict[str, Union[str, list]] = {})

  Bases: `BaseTeamsnapObject`

  birthday
  delete()

    It is not possible to create or delete users via the API; however, it is possible to update data on a user’s record.

  email
  facebook_access_token
  facebook_id
  first_name
  is_lab_rat
  last_name
  new()

    It is not possible to create or delete users via the API; however, it is possible to update data on a user’s record.

  password
  post()

    It is not possible to create or delete users via the API; however, it is possible to update data on a user’s record.

  receives_newsletter
  rel: str = 'users'
  type = 'user'
  version: str = '3.866.0'