Module `intercom_python_sdk.apis.data_attributes.schemas`

==================== Data Attributes API Schemas ==================== apis/data_attributes/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/data_attributes/models.py module.

[1] https://developers.intercom.com/intercom-api-reference/reference/the-data-attribute-model

Expand source code

"""
====================
Data Attributes API Schemas
====================
`apis/data_attributes/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/data_attributes/models.py` module.

----
[1] https://developers.intercom.com/intercom-api-reference/reference/the-data-attribute-model
"""

# External
import marshmallow
from marshmallow import fields

# From Current API
from . import models as da_models

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


class DataAttributeSchema(SchemaBase):
    """
    This schema represents a Data Attribute on Intercom.

    Attributes:
        name (str): The name of the Data Attribute. (Required)
        model (str): The model of the Data Attribute. (Required)
        data_type (str): The data type of the Data Attribute. (Required)
        type (str): The type of the Data Attribute.
        id (int): The ID of the Data Attribute.
        full_name (str): The full name of the Data Attribute.
        label (str): The label of the Data Attribute.
        description (str): The description of the Data Attribute.
        options (List[str]): The options of the Data Attribute.
        api_writeable (bool): True if the Data Attribute is API writeable, False otherwise.
        ui_writeable (bool): True if the Data Attribute is UI writeable, False otherwise.
        custom (bool): True if the Data Attribute is custom, False otherwise.
        archived (bool): True if the Data Attribute is archived, False otherwise.
        admin_id (str): The ID of the admin who created the Data Attribute.
        created_at (int): The timestamp of when the Data Attribute was created.
        updated_at (int): The timestamp of when the Data Attribute was updated.
    """
    name = fields.Str(required=True)
    model = fields.Str(required=True)
    data_type = fields.Str(required=True)
    type = fields.Str(default='data_attribute')
    id = fields.Int()
    full_name = fields.Str()
    label = fields.Str()
    description = fields.Str()
    options = fields.List(fields.Str())
    api_writable = fields.Bool()
    ui_writable = fields.Bool()
    custom = fields.Bool()
    archived = fields.Bool()
    admin_id = fields.Str()
    created_at = fields.Int()
    updated_at = fields.Int()

    @marshmallow.post_load
    def make_data_attribute(self, data, **kwargs):
        return da_models.DataAttribute(**data)


class DataAttributeListSchema(SchemaBase):
    """
    This schema represents a list of Data Attributes on Intercom.

    Attributes:
        type (str): The type of the Data Attribute list.
        data (List[DataAttributeSchema]): The list of Data Attributes.
        pages (PagesSchema): The pagination information for the Data Attribute list.
    """
    type = fields.Str()
    data = fields.Nested(DataAttributeSchema, many=True)

    @marshmallow.post_load
    def make_data_attribute_list(self, data, **kwargs):
        return da_models.DataAttributeList(**data)

Classes

class DataAttributeListSchema (*, 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 list of Data Attributes on Intercom.

Attributes

type : str: The type of the Data Attribute list.
data : List[DataAttributeSchema]: The list of Data Attributes.
pages : PagesSchema: The pagination information for the Data Attribute list.

Expand source code

class DataAttributeListSchema(SchemaBase):
    """
    This schema represents a list of Data Attributes on Intercom.

    Attributes:
        type (str): The type of the Data Attribute list.
        data (List[DataAttributeSchema]): The list of Data Attributes.
        pages (PagesSchema): The pagination information for the Data Attribute list.
    """
    type = fields.Str()
    data = fields.Nested(DataAttributeSchema, many=True)

    @marshmallow.post_load
    def make_data_attribute_list(self, data, **kwargs):
        return da_models.DataAttributeList(**data)

Ancestors

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

Class variables

var opts

Methods

def make_data_attribute_list(self, data, **kwargs)

Expand source code

@marshmallow.post_load
def make_data_attribute_list(self, data, **kwargs):
    return da_models.DataAttributeList(**data)

Inherited members

SchemaBase:
- Meta

class DataAttributeSchema (*, 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 Data Attribute on Intercom.

Attributes

name : str: The name of the Data Attribute. (Required)
model : str: The model of the Data Attribute. (Required)
data_type : str: The data type of the Data Attribute. (Required)
type : str: The type of the Data Attribute.
id : int: The ID of the Data Attribute.
full_name : str: The full name of the Data Attribute.
label : str: The label of the Data Attribute.
description : str: The description of the Data Attribute.
options : List[str]: The options of the Data Attribute.
api_writeable : bool: True if the Data Attribute is API writeable, False otherwise.
ui_writeable : bool: True if the Data Attribute is UI writeable, False otherwise.
custom : bool: True if the Data Attribute is custom, False otherwise.
archived : bool: True if the Data Attribute is archived, False otherwise.
admin_id : str: The ID of the admin who created the Data Attribute.
created_at : int: The timestamp of when the Data Attribute was created.
updated_at : int: The timestamp of when the Data Attribute was updated.

Expand source code

class DataAttributeSchema(SchemaBase):
    """
    This schema represents a Data Attribute on Intercom.

    Attributes:
        name (str): The name of the Data Attribute. (Required)
        model (str): The model of the Data Attribute. (Required)
        data_type (str): The data type of the Data Attribute. (Required)
        type (str): The type of the Data Attribute.
        id (int): The ID of the Data Attribute.
        full_name (str): The full name of the Data Attribute.
        label (str): The label of the Data Attribute.
        description (str): The description of the Data Attribute.
        options (List[str]): The options of the Data Attribute.
        api_writeable (bool): True if the Data Attribute is API writeable, False otherwise.
        ui_writeable (bool): True if the Data Attribute is UI writeable, False otherwise.
        custom (bool): True if the Data Attribute is custom, False otherwise.
        archived (bool): True if the Data Attribute is archived, False otherwise.
        admin_id (str): The ID of the admin who created the Data Attribute.
        created_at (int): The timestamp of when the Data Attribute was created.
        updated_at (int): The timestamp of when the Data Attribute was updated.
    """
    name = fields.Str(required=True)
    model = fields.Str(required=True)
    data_type = fields.Str(required=True)
    type = fields.Str(default='data_attribute')
    id = fields.Int()
    full_name = fields.Str()
    label = fields.Str()
    description = fields.Str()
    options = fields.List(fields.Str())
    api_writable = fields.Bool()
    ui_writable = fields.Bool()
    custom = fields.Bool()
    archived = fields.Bool()
    admin_id = fields.Str()
    created_at = fields.Int()
    updated_at = fields.Int()

    @marshmallow.post_load
    def make_data_attribute(self, data, **kwargs):
        return da_models.DataAttribute(**data)

Ancestors

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

Class variables

var opts

Methods

def make_data_attribute(self, data, **kwargs)

Expand source code

@marshmallow.post_load
def make_data_attribute(self, data, **kwargs):
    return da_models.DataAttribute(**data)

Inherited members

SchemaBase:
- Meta