Data Export API Schemas

apis/data_events/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_events/models.py module.

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

"""
# Data Export API Schemas

`apis/data_events/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_events/models.py` module.

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

# External
import marshmallow
from marshmallow import fields

# From Current API
from . import models as dexport_models

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


class DataExportJobSchema(SchemaBase):
    """ Schema for the DataExportJob model.

    Attributes:
        job_identifier (str): The identifier of the job.
        status (str): The status of the job.
        download_expires_at (str): The time at which the download expires.
        download_url (str): The URL to download the job.
    """
    job_identifier = fields.Str()
    status = fields.Str()
    download_expires_at = fields.Str()
    download_url = fields.Str()

    @marshmallow.post_load
    def make(self, data, **kwargs):
        return dexport_models.DataExportJob(**data)

Classes

class DataExportJobSchema (*, 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)

Schema for the DataExportJob model.

Attributes

job_identifier : str

The identifier of the job.

status : str

The status of the job.

download_expires_at : str

The time at which the download expires.

download_url : str

The URL to download the job.

Expand source code

class DataExportJobSchema(SchemaBase):
    """ Schema for the DataExportJob model.

    Attributes:
        job_identifier (str): The identifier of the job.
        status (str): The status of the job.
        download_expires_at (str): The time at which the download expires.
        download_url (str): The URL to download the job.
    """
    job_identifier = fields.Str()
    status = fields.Str()
    download_expires_at = fields.Str()
    download_url = fields.Str()

    @marshmallow.post_load
    def make(self, data, **kwargs):
        return dexport_models.DataExportJob(**data)

Ancestors

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

Class variables

var opts

Methods

def make(self, data, **kwargs)

Expand source code

@marshmallow.post_load
def make(self, data, **kwargs):
    return dexport_models.DataExportJob(**data)

Inherited members

• SchemaBase:
  • Meta