singstat.types Response Types

SingStat custom types for client methods’ responses.

resource_id()

class singstat.types.ResourceIdDict

Bases: TypedDict

Type definition for resource_id()

Data: _ResourceIdDataDict

Data

DataCount: int

Data count

StatusCode: int

Status code

Message: str

Message

class singstat.types._ResourceIdDataDict

Bases: TypedDict

Type definition for ResourceIdDict

generatedBy: str

Generated by

dateGenerated: date

Data generated

total: int

Total

records: list[_ResourceIdDataRecordDict]

Records

class singstat.types._ResourceIdDataRecordDict

Bases: TypedDict

Type definition for _ResourceIdDataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

id: NotRequired[str]

ID

tableType: NotRequired[str]

Table type

title: NotRequired[str]

Title

metadata()

class singstat.types.MetadataDict

Bases: TypedDict

Type definition for metadata()

Data: _MetadataDataDict

Data

DataCount: int

Data count

StatusCode: int

Status code

Message: str

Message

class singstat.types._MetadataDataDict

Bases: TypedDict

Type definition for MetadataDict

generatedBy: str

Generated by

dateGenerated: date

Date generated

records: _MetadataDataRecordsDict

Records

class singstat.types._MetadataDataRecordsDict

Bases: TypedDict

Type definition for _MetadataDataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

id: NotRequired[str]

ID

title: NotRequired[str]

Title

frequency: NotRequired[str]

Frequency

dataSource: NotRequired[str]

Data source

footnote: NotRequired[str]

Footnote

dataLastUpdated: NotRequired[date]

Data last updated

startPeriod: NotRequired[str]

Start period

endPeriod: NotRequired[str]

End period

total: NotRequired[int]

Total

row: NotRequired[list[_MetadataDataRecordsRowDict]]

Row

class singstat.types._MetadataDataRecordsRowDict

Bases: TypedDict

Type definition for _MetadataDataRecordsDict

seriesNo: str

Series number

rowText: str

Row text

uoM: str

Unit of measurement

footnote: str

Footnote

tabledata()

class singstat.types.TabledataDict

Bases: TypedDict

Type definition for tabledata()

Data: _TabledataDataTimeseriesDict | _TabledataDataCrossSectionalMultiDimensionalCubeDict

Data

DataCount: int

Data count

StatusCode: int

Status code

Message: str

Message

class singstat.types._TabledataDataTimeseriesDict

Bases: TypedDict

Type definition for _TabledataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

id: NotRequired[str]

ID

title: NotRequired[str]

Title

footnote: NotRequired[str]

Footnote

frequency: NotRequired[str]

Frequency

datasource: NotRequired[str]

Data source

generatedBy: NotRequired[str]

Generated by

dataLastUpdated: NotRequired[date]

Data last updated

dateGenerated: NotRequired[date]

Date generated

offset: NotRequired[int | None]

Offset

limit: NotRequired[int]

Limit

sortBy: NotRequired[str | None]

Sort by

timeFilter: NotRequired[str | None]

Time filter

between: NotRequired[tuple[int, ...] | None]

Between

search: NotRequired[str | None]

Search

row: NotRequired[list[_TabledataDataTimeseriesRowDict]]

Row

class singstat.types._TabledataDataTimeseriesRowDict

Bases: TypedDict

Type definition for _TabledataDataTimeseriesDict

seriesNo: str

Series number

rowText: str

Row text

uoM: str

Unit of measurement

footnote: str

Footnote

columns: NotRequired[list[_TabledataDataRowColumnDict]]

Columns

class singstat.types._TabledataDataCrossSectionalMultiDimensionalCubeDict

Bases: TypedDict

Type definition for TabledataDict

All fields are required. But they are typed as NotRequired because when the endpoint returns empty data, then this dict has no keys at all.

id: NotRequired[str]

ID

tableType: NotRequired[str]

Table type

title: NotRequired[str]

Title

footnote: NotRequired[str]

Footnote

frequency: NotRequired[str]

Frequency

dataSource: NotRequired[str]

Data source

generatedBy: NotRequired[str]

Generated by

dataLastUpdated: NotRequired[date]

Data last updated

dateGenerated: NotRequired[date]

Date generated

offset: NotRequired[int | None]

Offset

limit: NotRequired[int]

Limit

between: NotRequired[tuple[int, ...] | None]

Between

search: NotRequired[str | None]

Search

row: NotRequired[list[_TabledataDataCrossSectionalMultiDimensionalCubeRowDict]]

Row

class singstat.types._TabledataDataCrossSectionalMultiDimensionalCubeRowDict

Bases: TypedDict

Type definition for _TabledataDataCrossSectionalMultiDimensionalCubeDict

rowNo: int

Row number

rowText: str

Row text

uoM: str

Unit of measurement

footnote: str

Footnote

columns: NotRequired[list[_TabledataDataRowColumnDict | _TabledataDataRowColumnColumnDict]]

Columns

class singstat.types._TabledataDataRowColumnColumnDict

Bases: TypedDict

Type definition for _TabledataDataCrossSectionalMultiDimensionalCubeRowDict

key: str

Key

columns: NotRequired[list[_TabledataDataRowColumnDict]]

Columns

class singstat.types._TabledataDataRowColumnDict

Bases: TypedDict

Type definition for _TabledataDataRowColumnColumnDict, _TabledataDataTimeseriesRowDict, and _TabledataDataCrossSectionalMultiDimensionalCubeRowDict

key: str

Key

value: Any

Value