meet

  • Functions for interacting with the web services Meet API

delete(token: WebServicesToken, endpoint: str, params: dict = {}, body: dict = {}) dict | list[source]
  • sends a DELETE request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

  • body (dict) –

    • request body, if applicable

    • default: {} (empty)

Returns:

  • response body

Return type:

dict | list

get(token: WebServicesToken, endpoint: str, params: dict = {}) dict | list[source]
  • sends a GET request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

Returns:

  • response body

Return type:

dict | list

get_current_cotd(token: WebServicesToken) dict[source]
Parameters:

token (auth.WebServicesToken) –

  • authentication token

Returns:

  • Cup of the Day info

Return type:

dict

get_matchmaking_divisions(token: WebServicesToken, matchmaking_type: int | str) dict[source]
Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • matchmaking_type (int | str) –

    • either the ID or name for the type of matchmaking requested

Returns:

  • Cup of the Day info

Return type:

dict

get_matchmaking_ids(token: WebServicesToken) dict[source]
Parameters:

token (auth.WebServicesToken) –

  • authentication token

Returns:

  • matchmaking IDs

Return type:

dict

get_matchmaking_player_status(token: ServiceToken, matchmaking_type: int | str) dict[source]
Parameters:
  • token (auth.ServiceToken) –

    • authentication token

  • matchmaking_type (int | str) –

    • either the ID or name for the type of matchmaking requested

Returns:

  • player matchmaking status

Return type:

dict

head(token: WebServicesToken, endpoint: str, params: dict = {}) dict | list[source]
  • sends a HEAD request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

Returns:

  • response body

Return type:

dict | list

options(token: WebServicesToken, endpoint: str, params: dict = {}, body: dict = {}) dict | list[source]
  • sends an OPTIONS request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

  • body (dict) –

    • request body, if applicable

    • default: {} (empty)

Returns:

  • response body

Return type:

dict | list

patch(token: WebServicesToken, endpoint: str, params: dict = {}, body: dict = {}) dict | list[source]
  • sends a PATCH request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

  • body (dict) –

    • request body, if applicable

    • default: {} (empty)

Returns:

  • response body

Return type:

dict | list

post(token: WebServicesToken, endpoint: str, params: dict = {}, body: dict = {}) dict | list[source]
  • sends a POST request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

  • body (dict) –

    • request body, if applicable

    • default: {} (empty)

Returns:

  • response body

Return type:

dict | list

put(token: WebServicesToken, endpoint: str, params: dict = {}, body: dict = {}) dict | list[source]
  • sends a PUT request to the Meet API

Parameters:
  • token (auth.WebServicesToken) –

    • authentication token

  • endpoint (str) –

    • desired endpoint

    • base URL is optional

    • leading forward slash is optional

    • trailing parameters are optional, e.g. ?param1=true&param2=0

  • params (dict) –

    • request parameters, if applicable

    • if you put parameters at the end of the endpoint, do not put them here or they will be duplicated

  • body (dict) –

    • request body, if applicable

    • default: {} (empty)

Returns:

  • response body

Return type:

dict | list