Module intercom_python_sdk.apis.teams.schemas

Help Center API Schemas

apis/teams/schemas.py

This module contains the schema definitions provided by the Intercom API Reference [1]. These schemas provide serialization/deserialization to and from the models defined in the apis/teams/models.py module.

Expand source code 
"""
# Help Center API Schemas

`apis/teams/schemas.py`

This module contains the schema definitions provided by the Intercom API Reference [1].
These schemas provide serialization/deserialization to and from the models defined in the 
`apis/teams/models.py` module.

---
- [1] https://developers.intercom.com/intercom-api-reference/reference/listteams
"""

# External
from marshmallow import fields

# From Current Package
from ...core.schema_base import SchemaBase


class AdminPriorityLevelSchema(SchemaBase):
    """
    This schema represents a AdminPriorityLevel on Intercom.

    Attributes:
        primary_admin_ids (list): The IDs of the primary admins of the AdminPriorityLevel.
        secondary_admin_ids (list): The IDs of the secondary admins of the AdminPriorityLevel.
    """
    primary_admin_ids = fields.List(fields.Int())
    secondary_admin_ids = fields.List(fields.Int())


class TeamSchema(SchemaBase):
    """
    This schema represents a Team on Intercom.

    Attributes:
        id (int): The ID of the Team.
        type (str): The type of the Team.
        name (str): The name of the Team.
        admin_ids (list): The IDs of the admins of the Team.
        admin_priority_level (dict): The priority level of the admins of the Team.
    """
    id = fields.Int()
    type = fields.Str()
    name = fields.Str()
    admin_ids = fields.List(fields.Int())
    admin_priority_level = fields.Nested(AdminPriorityLevelSchema)


class TeamListSchema(SchemaBase):
    """
    This schema represents a TeamList on Intercom.

    Attributes:
        teams (list): The Teams of the TeamList.
    """
    teams = fields.List(fields.Nested(TeamSchema))

Classes

class AdminPriorityLevelSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

This schema represents a AdminPriorityLevel on Intercom.

Attributes

primary_admin_ids : list
The IDs of the primary admins of the AdminPriorityLevel.
secondary_admin_ids : list
The IDs of the secondary admins of the AdminPriorityLevel.
Expand source code 
class AdminPriorityLevelSchema(SchemaBase):
    """
    This schema represents a AdminPriorityLevel on Intercom.

    Attributes:
        primary_admin_ids (list): The IDs of the primary admins of the AdminPriorityLevel.
        secondary_admin_ids (list): The IDs of the secondary admins of the AdminPriorityLevel.
    """
    primary_admin_ids = fields.List(fields.Int())
    secondary_admin_ids = fields.List(fields.Int())

Ancestors

  • SchemaBase
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

var opts

Inherited members

class TeamListSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

This schema represents a TeamList on Intercom.

Attributes

teams : list
The Teams of the TeamList.
Expand source code 
class TeamListSchema(SchemaBase):
    """
    This schema represents a TeamList on Intercom.

    Attributes:
        teams (list): The Teams of the TeamList.
    """
    teams = fields.List(fields.Nested(TeamSchema))

Ancestors

  • SchemaBase
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

var opts

Inherited members

class TeamSchema (*, only: types.StrSequenceOrSet | None = None, exclude: types.StrSequenceOrSet = (), many: bool = False, context: dict | None = None, load_only: types.StrSequenceOrSet = (), dump_only: types.StrSequenceOrSet = (), partial: bool | types.StrSequenceOrSet | None = None, unknown: str | None = None)

This schema represents a Team on Intercom.

Attributes

id : int
The ID of the Team.
type : str
The type of the Team.
name : str
The name of the Team.
admin_ids : list
The IDs of the admins of the Team.
admin_priority_level : dict
The priority level of the admins of the Team.
Expand source code 
class TeamSchema(SchemaBase):
    """
    This schema represents a Team on Intercom.

    Attributes:
        id (int): The ID of the Team.
        type (str): The type of the Team.
        name (str): The name of the Team.
        admin_ids (list): The IDs of the admins of the Team.
        admin_priority_level (dict): The priority level of the admins of the Team.
    """
    id = fields.Int()
    type = fields.Str()
    name = fields.Str()
    admin_ids = fields.List(fields.Int())
    admin_priority_level = fields.Nested(AdminPriorityLevelSchema)

Ancestors

  • SchemaBase
  • marshmallow.schema.Schema
  • marshmallow.base.SchemaABC
  • abc.ABC

Class variables

var opts

Inherited members