Teams API

apis/teams/api.py

This module contains the HelpCenterAPI class, which defines a client for the Teams API. It is used to interact with the Intercom Help Center API [1] as defined in the Intercom API Reference [2].

[1] https://developers.intercom.com/intercom-api-reference/reference/listallteams [2] https://github.com/intercom/Intercom-OpenAPI

""" 
# Teams API

`apis/teams/api.py`

This module contains the HelpCenterAPI class, which defines a client for the Teams API.
It is used to interact with the Intercom Help Center API [1] as defined in the Intercom API Reference [2].

---
[1] https://developers.intercom.com/intercom-api-reference/reference/listallteams
[2] https://github.com/intercom/Intercom-OpenAPI
"""
# Built-ins
from typing import Union

# External
from uplink import (
    get,
    returns,
    response_handler,
)

# From Current API
from .schemas import (
    TeamSchema,
    TeamListSchema,
)

# From Current Package
from ...core.api_base import APIBase
from ...core.errors import catch_api_error


@response_handler(catch_api_error)
class TeamsAPI(APIBase):
    URI = "/teams/"

    @returns(TeamListSchema(many=False))  # type: ignore
    @get("")
    def get_all_teams(self):
        """ Get all Teams.

        Returns:
            TeamList: A list of all Teams.
        """
        pass

    @returns(TeamSchema(many=False))  # type: ignore
    @get("{team_id}")
    def get_team_by_id(self, team_id: Union[str, int]):
        """ Get a Team by ID.

        Args:
            team_id (Union[str, int]): The ID of the Team.

        Returns:
            Team: The Team with the given ID.
        """
        pass

Classes

class TeamsAPI (config: Configuration, **kwargs)

The base class for all API classes in the Intercom Python SDK.

Initializes a new instance of the APIBase class. Overrides the Consumer class from the Uplink library to configure the Consumer instance using a Configuration object.

Args

config

The configuration settings for the API.

Expand source code

@response_handler(catch_api_error)
class TeamsAPI(APIBase):
    URI = "/teams/"

    @returns(TeamListSchema(many=False))  # type: ignore
    @get("")
    def get_all_teams(self):
        """ Get all Teams.

        Returns:
            TeamList: A list of all Teams.
        """
        pass

    @returns(TeamSchema(many=False))  # type: ignore
    @get("{team_id}")
    def get_team_by_id(self, team_id: Union[str, int]):
        """ Get a Team by ID.

        Args:
            team_id (Union[str, int]): The ID of the Team.

        Returns:
            Team: The Team with the given ID.
        """
        pass

Ancestors

• APIBase
• uplink.builder.Consumer
• uplink.interfaces.Consumer
• uplink.builder._Consumer

Class variables

var URI

Methods

def get_all_teams(self)

Get all Teams.

Returns

TeamList

A list of all Teams.

Expand source code

@returns(TeamListSchema(many=False))  # type: ignore
@get("")
def get_all_teams(self):
    """ Get all Teams.

    Returns:
        TeamList: A list of all Teams.
    """
    pass

def get_team_by_id(self, team_id: Union[str, int])

Get a Team by ID.

Args

team_id : Union[str, int]

The ID of the Team.

Returns

Team

The Team with the given ID.

Expand source code

@returns(TeamSchema(many=False))  # type: ignore
@get("{team_id}")
def get_team_by_id(self, team_id: Union[str, int]):
    """ Get a Team by ID.

    Args:
        team_id (Union[str, int]): The ID of the Team.

    Returns:
        Team: The Team with the given ID.
    """
    pass