Data Types & Enums¶

All client methods accept and return plain dictionaries. The Pydantic models below are optional sugar for callers who want validation and typed access. They use PascalCase aliases (matching the API JSON) with snake_case attributes, and populate_by_name is enabled so you can construct them either way.

from signtraker.models import Agent

agent = Agent.model_validate(client.agents.get_agent(123))
payload = agent.model_dump(by_alias=True, exclude_none=True)

Enums¶

signtraker.enums ¶

Shared enumerations for the SignTraker API.

These mirror the closed value sets documented by the API. Where the API only publishes a partial set of values (for example order statuses), the affected field is modeled as a plain string in :mod:signtraker.models instead of an enum.

PaymentMode ¶

Bases: str, Enum

Billing/payment mode for an agent.

DiscountLevel ¶

Bases: str, Enum

Manager discount level.

CountryCode ¶

Bases: str, Enum

Supported country codes (API pattern ^US|CA|AU$).

AwardRestriction ¶

Bases: str, Enum

Restrictions that may be placed on a credit award.

SortDirection ¶

Bases: str, Enum

Sort direction usable in OData $orderby clauses.

Models¶

signtraker.models ¶

Pydantic data models for SignTraker API payloads.

Models are optional sugar: every client method also accepts and returns plain dictionaries. The models give IDE support and validation for callers who want it. Because the API uses PascalCase JSON keys, each field declares a PascalCase alias while keeping a Pythonic snake_case attribute name. populate_by_name is enabled, so you may construct a model with either the alias or the attribute name.

Example

from signtraker.models import Agent

agent = Agent.model_validate(client.agents.get_agent(123))
print(agent.first_name, agent.email)
payload = agent.model_dump(by_alias=True, exclude_none=True)

SignTrakerModel ¶

Bases: BaseModel

Base model enabling alias population and tolerance of unknown fields.

Data Types & Enums¶

Enums¶

signtraker.enums ¶

PaymentMode ¶

DiscountLevel ¶

CountryCode ¶

AwardRestriction ¶

SortDirection ¶

Models¶

signtraker.models ¶

SignTrakerModel ¶

NamedRef ¶

AgentAddress ¶

ManagerData ¶

Agent ¶

JobSite ¶

SalesOrderRef ¶

ChangeOrder ¶

ServiceOrder ¶

SignageOrder ¶

Award ¶

Enterprise ¶

Office ¶

OrderPreset ¶

CreateOrderRequest ¶

CreateOrderResult ¶

ServiceOrderCreateRequest ¶

ChangeOrderCreateRequest ¶

RequestRemovalRequest ¶

RequestRemovalResult ¶