cmsgov.provider_data.v1.model

JsonOrCsvQueryOkResponse

JsonOrCsvQueryOkResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    results: (
        cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponseResults
        | None
    ) = None,
    count: int | None = None,
    schema: sob.Array | sob.Dictionary | None = None,
    query: sob.Dictionary | None = None,
)

Bases: sob.Object

Attributes:

• results (cmsgov.provider_data.v1.model.JsonOrCsvQueryOkResponseResults | None) –
• count (int | None) –
• schema (sob.Array | sob.Dictionary | None) –
• query (sob.Dictionary | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    results: (
        JsonOrCsvQueryOkResponseResults
        | None
    ) = None,
    count: (
        int
        | None
    ) = None,
    schema: (
        sob.Array
        | sob.Dictionary
        | None
    ) = None,
    query: (
        sob.Dictionary
        | None
    ) = None
) -> None:
    self.results: (
        JsonOrCsvQueryOkResponseResults
        | None
    ) = results
    self.count: (
        int
        | None
    ) = count
    self.schema: (
        sob.Array
        | sob.Dictionary
        | None
    ) = schema
    self.query: (
        sob.Dictionary
        | None
    ) = query
    super().__init__(_data)

Dataset

Dataset(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    identifier: str | None = None,
    description: str | None = None,
    access_level: str | None = None,
    rights: str | sob.Null | None = None,
    accrual_periodicity: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
    issued: str | None = None,
    modified: str | None = None,
    released: str | None = None,
    next_update_date: str | None = None,
    license_: str | None = None,
    spatial: str | None = None,
    temporal: str | None = None,
    is_part_of: str | None = None,
    publisher: (
        cmsgov.provider_data.v1.model.DatasetPublisher
        | None
    ) = None,
    bureau_code: (
        cmsgov.provider_data.v1.model.DatasetBureauCode
        | None
    ) = None,
    program_code: (
        cmsgov.provider_data.v1.model.DatasetProgramCode
        | None
    ) = None,
    contact_point: (
        cmsgov.provider_data.v1.model.DatasetContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cmsgov.provider_data.v1.model.DatasetTheme | None
    ) = None,
    keyword: (
        cmsgov.provider_data.v1.model.DatasetKeyword | None
    ) = None,
    distribution: (
        cmsgov.provider_data.v1.model.DatasetDistributions
        | None
    ) = None,
    references: (
        cmsgov.provider_data.v1.model.DatasetReferences
        | None
    ) = None,
    archive_exclude: bool | None = None,
    landing_page: str | None = None,
)

Bases: sob.Object

The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat:Dataset for each Dataset.

• title (str | None) –

  Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.

• identifier (str | None) –

  A unique identifier for the dataset or API as maintained within an Agency catalog or database.

• description (str | None) –

  Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.

• access_level (str | None) –

  The degree to which this dataset could be made publicly-available, regardless of whether it has been made available. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public ( Data asset is not available to members of the public).

• rights (str | sob.Null | None) –

  This may include information regarding access or restrictions based on privacy, security, or other policies. This should also provide an explanation for the selected "accessLevel" including instructions for how to access a restricted file, if applicable, or explanation for why a "non-public" or "restricted public" data assetis not "public," if applicable. Text, 255 characters.

• accrual_periodicity (str | None) –

  Frequency with which dataset is published.

• described_by (str | None) –

  URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

• issued (str | None) –

  Date of formal issuance.

• modified (str | None) –

  Most recent date on which the dataset was changed, updated or modified.

• released (str | None) –

  Date on which the dataset is scheduled to be published.

• next_update_date (str | None) –

  The date on which the dataset is expected to be updated next.

• license_ (str | None) –

  The license dataset or API is published with. See Open Licenses</ a> for more information.

• spatial (str | None) –

  The spatial coverage of the dataset. Could include a spatial region like a bounding box or a named place.

• temporal (str | None) –

  The start and end dates for which the dataset is applicable, separated by a "/" (i.e., 2000-01-15T00:45:00Z/2010-01- 15T00:06:00Z).

• is_part_of (str | None) –

  The collection of which the dataset is a subset.

• publisher (cmsgov.provider_data.v1.model.DatasetPublisher | None) –

  A Dataset Publisher Organization.

• bureau_code (cmsgov.provider_data.v1.model.DatasetBureauCode | None) –

  Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

• program_code (cmsgov.provider_data.v1.model.DatasetProgramCode | None) –

  Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

• contact_point (cmsgov.provider_data.v1.model.DatasetContactPoint | sob.Dictionary | None) –

  A Dataset ContactPoint as a vCard object.

• theme (cmsgov.provider_data.v1.model.DatasetTheme | None) –

  Main thematic category of the dataset.

• keyword (cmsgov.provider_data.v1.model.DatasetKeyword | None) –

  Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non- technical users.

• distribution (cmsgov.provider_data.v1.model.DatasetDistributions | None) –

  A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

• references (cmsgov.provider_data.v1.model.DatasetReferences | None) –

  Related documents such as technical information about a dataset, developer documentation, etc.

• archive_exclude (bool | None) –

  For excluding this dataset from its provider's ' download all datasets'.

• landing_page (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    access_level: (
        str
        | None
    ) = None,
    rights: (
        str
        | sob.Null
        | None
    ) = None,
    accrual_periodicity: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None,
    issued: (
        str
        | None
    ) = None,
    modified: (
        str
        | None
    ) = None,
    released: (
        str
        | None
    ) = None,
    next_update_date: (
        str
        | None
    ) = None,
    license_: (
        str
        | None
    ) = None,
    spatial: (
        str
        | None
    ) = None,
    temporal: (
        str
        | None
    ) = None,
    is_part_of: (
        str
        | None
    ) = None,
    publisher: (
        DatasetPublisher
        | None
    ) = None,
    bureau_code: (
        DatasetBureauCode
        | None
    ) = None,
    program_code: (
        DatasetProgramCode
        | None
    ) = None,
    contact_point: (
        DatasetContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        DatasetTheme
        | None
    ) = None,
    keyword: (
        DatasetKeyword
        | None
    ) = None,
    distribution: (
        DatasetDistributions
        | None
    ) = None,
    references: (
        DatasetReferences
        | None
    ) = None,
    archive_exclude: (
        bool
        | None
    ) = None,
    landing_page: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.identifier: (
        str
        | None
    ) = identifier
    self.description: (
        str
        | None
    ) = description
    self.access_level: (
        str
        | None
    ) = access_level
    self.rights: (
        str
        | sob.Null
        | None
    ) = rights
    self.accrual_periodicity: (
        str
        | None
    ) = accrual_periodicity
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    self.issued: (
        str
        | None
    ) = issued
    self.modified: (
        str
        | None
    ) = modified
    self.released: (
        str
        | None
    ) = released
    self.next_update_date: (
        str
        | None
    ) = next_update_date
    self.license_: (
        str
        | None
    ) = license_
    self.spatial: (
        str
        | None
    ) = spatial
    self.temporal: (
        str
        | None
    ) = temporal
    self.is_part_of: (
        str
        | None
    ) = is_part_of
    self.publisher: (
        DatasetPublisher
        | None
    ) = publisher
    self.bureau_code: (
        DatasetBureauCode
        | None
    ) = bureau_code
    self.program_code: (
        DatasetProgramCode
        | None
    ) = program_code
    self.contact_point: (
        DatasetContactPoint
        | sob.Dictionary
        | None
    ) = contact_point
    self.theme: (
        DatasetTheme
        | None
    ) = theme
    self.keyword: (
        DatasetKeyword
        | None
    ) = keyword
    self.distribution: (
        DatasetDistributions
        | None
    ) = distribution
    self.references: (
        DatasetReferences
        | None
    ) = references
    self.archive_exclude: (
        bool
        | None
    ) = archive_exclude
    self.landing_page: (
        str
        | None
    ) = landing_page
    super().__init__(_data)

DatasetBureauCode

DatasetBureauCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatasetContactPoint

DatasetContactPoint(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    fn: str | None = None,
    has_email: str | None = None,
    has_url: str | None = None,
)

Bases: sob.Object

A Dataset ContactPoint as a vCard object.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be vcard:Contact for contactPoint.

• fn (str | None) –

  A full formatted name, e.g. Firstname Lastname.

• has_email (str | None) –

  Email address for the contact name.

• has_url (str | None) –

  URL for the contact

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    fn: (
        str
        | None
    ) = None,
    has_email: (
        str
        | None
    ) = None,
    has_url: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.fn: (
        str
        | None
    ) = fn
    self.has_email: (
        str
        | None
    ) = has_email
    self.has_url: (
        str
        | None
    ) = has_url
    super().__init__(_data)

DatasetDistributions

DatasetDistributions(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatasetDistribution
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatasetDistribution
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatasetDistribution

DatasetDistribution(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    description: str | None = None,
    format_: str | None = None,
    media_type: str | None = None,
    download_url: str | None = None,
    access_url: str | None = None,
    conforms_to: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat: Distribution for each Distribution.

• title (str | None) –

  Human-readable name of the file.

• description (str | None) –

  Human-readable description of the file.

• format_ (str | None) –

  A human-readable description of the file format of a distribution (i.e. csv, pdf, kml, etc.).

• media_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s downloadURL.

• download_url (str | None) –

  URL providing direct access to a downloadable file of a dataset.

• access_url (str | None) –

  URL providing indirect access to a dataset.

• conforms_to (str | None) –

  URI used to identify a standardized specification the distribution conforms to.

• described_by (str | None) –

  URL to the data dictionary for the distribution found at the downloadURL.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    media_type: (
        str
        | None
    ) = None,
    download_url: (
        str
        | None
    ) = None,
    access_url: (
        str
        | None
    ) = None,
    conforms_to: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.description: (
        str
        | None
    ) = description
    self.format_: (
        str
        | None
    ) = format_
    self.media_type: (
        str
        | None
    ) = media_type
    self.download_url: (
        str
        | None
    ) = download_url
    self.access_url: (
        str
        | None
    ) = access_url
    self.conforms_to: (
        str
        | None
    ) = conforms_to
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    super().__init__(_data)

DatasetKeyword

DatasetKeyword(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatasetProgramCode

DatasetProgramCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatasetPublisher

DatasetPublisher(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    name: str | None = None,
    sub_organization_of: str | None = None,
)

Bases: sob.Object

A Dataset Publisher Organization.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be org: Organization for each publisher

• name (str | None) –
• sub_organization_of (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    sub_organization_of: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.name: (
        str
        | None
    ) = name
    self.sub_organization_of: (
        str
        | None
    ) = sub_organization_of
    super().__init__(_data)

DatasetReferences

DatasetReferences(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Related documents such as technical information about a dataset, developer documentation, etc.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatasetTheme

DatasetTheme(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Main thematic category of the dataset.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

Datasets

Datasets(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.Dataset
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

An array of datasets.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            Dataset
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQuery

DatastoreQuery(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resources: (
        cmsgov.provider_data.v1.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cmsgov.provider_data.v1.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreQueryGroupings
        | None
    ) = None,
    limit: int | None = None,
    offset: int | None = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreQuerySorts
        | None
    ) = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
)

Bases: sob.Object

Schema for DKAN datastore queries

Attributes:

• resources (cmsgov.provider_data.v1.model.DatastoreQueryResources | None) –

  Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

• properties (cmsgov.provider_data.v1.model.DatastoreQueryProperties | None) –
• conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditions | None) –

  Conditions or groups of conditions for the query, bound by 'and' operator.

• joins (cmsgov.provider_data.v1.model.DatastoreQueryJoins | None) –

  Joins

• groupings (cmsgov.provider_data.v1.model.DatastoreQueryGroupings | None) –

  Properties or aliases to group results by.

• limit (int | None) –

  Limit for maximum number of records returned. Pass zero for no limit (may be restricted by user permissions).

• offset (int | None) –

  Number of records to offset by or skip before returning first record.

• sorts (cmsgov.provider_data.v1.model.DatastoreQuerySorts | None) –

  Result sorting directives.

• count (bool | None) –

  Return a count of the total rows returned by the query, ignoring the limit/offset.

• results (bool | None) –

  Return the result set. Set to false and set count to true to receive only a count of matches.

• schema (bool | None) –

  Return the schema for the datastore collection.

• keys (bool | None) –

  Return results as an array of keyed objects, with the column machine names as keys. If false, results will be an array of simple arrays of values.

• format_ (str | None) –

  Format to return data in. Default is JSON, can be set to CSV.

• row_ids (bool | None) –

  Flag to include the result_number column in output. Default is FALSE

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resources: (
        DatastoreQueryResources
        | None
    ) = None,
    properties: (
        DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        DatastoreQueryGroupings
        | None
    ) = None,
    limit: (
        int
        | None
    ) = None,
    offset: (
        int
        | None
    ) = None,
    sorts: (
        DatastoreQuerySorts
        | None
    ) = None,
    count: (
        bool
        | None
    ) = None,
    results: (
        bool
        | None
    ) = None,
    schema: (
        bool
        | None
    ) = None,
    keys: (
        bool
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    row_ids: (
        bool
        | None
    ) = None
) -> None:
    self.resources: (
        DatastoreQueryResources
        | None
    ) = resources
    self.properties: (
        DatastoreQueryProperties
        | None
    ) = properties
    self.conditions: (
        DatastoreQueryConditions
        | None
    ) = conditions
    self.joins: (
        DatastoreQueryJoins
        | None
    ) = joins
    self.groupings: (
        DatastoreQueryGroupings
        | None
    ) = groupings
    self.limit: (
        int
        | None
    ) = limit
    self.offset: (
        int
        | None
    ) = offset
    self.sorts: (
        DatastoreQuerySorts
        | None
    ) = sorts
    self.count: (
        bool
        | None
    ) = count
    self.results: (
        bool
        | None
    ) = results
    self.schema: (
        bool
        | None
    ) = schema
    self.keys: (
        bool
        | None
    ) = keys
    self.format_: (
        str
        | None
    ) = format_
    self.row_ids: (
        bool
        | None
    ) = row_ids
    super().__init__(_data)

DatastoreQueryConditions

DatastoreQueryConditions(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQueryCondition
            | cmsgov.provider_data.v1.model.DatastoreQueryConditionGroup
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Conditions or groups of conditions for the query, bound by 'and' operator.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQueryCondition
            | DatastoreQueryConditionGroup
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryGroupings

DatastoreQueryGroupings(
    items: (
        typing.Iterable[
            str
            | cmsgov.provider_data.v1.model.DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Properties or aliases to group results by.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
            | DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryJoins

DatastoreQueryJoins(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQueryJoinsItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Joins

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQueryJoinsItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryJoinsItem

DatastoreQueryJoinsItem(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    condition: (
        cmsgov.provider_data.v1.model.DatastoreQueryCondition
        | None
    ) = None,
)

Bases: sob.Object

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• condition (cmsgov.provider_data.v1.model.DatastoreQueryCondition | None) –

  Condition object including property, value and operator. If querying only one resource, the "resource" does not need to be specified.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    condition: (
        DatastoreQueryCondition
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.condition: (
        DatastoreQueryCondition
        | None
    ) = condition
    super().__init__(_data)

DatastoreQueryPropertyResource

DatastoreQueryPropertyResource(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    property_: str | None = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• property_ (str | None) –

  The property/column or alias to filter by. Should not include collection/table alias.

• alias (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    property_: (
        str
        | None
    ) = None,
    alias: (
        str
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.property_: (
        str
        | None
    ) = property_
    self.alias: (
        str
        | None
    ) = alias
    super().__init__(_data)

DatastoreQueryPropertyExpression

DatastoreQueryPropertyExpression(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: (
        cmsgov.provider_data.v1.model.DatastoreQueryExpression
        | None
    ) = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

• expression (cmsgov.provider_data.v1.model.DatastoreQueryExpression | None) –

  Arithmetic or aggregate expression performed on one or more properties.

• alias (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: (
        DatastoreQueryExpression
        | None
    ) = None,
    alias: (
        str
        | None
    ) = None
) -> None:
    self.expression: (
        DatastoreQueryExpression
        | None
    ) = expression
    self.alias: (
        str
        | None
    ) = alias
    super().__init__(_data)

DatastoreQueryResources

DatastoreQueryResources(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQueryResource
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Resources to query against and aliases. Usually you will add only one resource to this array, but if performing a join, list the primary resource first and then add resources to be used in the joins array.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQueryResource
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryResource

DatastoreQueryResource(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    alias: str | None = None,
    id_: str | None = None,
)

Bases: sob.Object

Attributes:

• alias (str | None) –

  Alias to use to refer to this resource elsewhere in the query.

• id_ (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    alias: (
        str
        | None
    ) = None,
    id_: (
        str
        | None
    ) = None
) -> None:
    self.alias: (
        str
        | None
    ) = alias
    self.id_: (
        str
        | None
    ) = id_
    super().__init__(_data)

DatastoreQuerySorts

DatastoreQuerySorts(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQuerySort
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Result sorting directives.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQuerySort
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryCondition

DatastoreQueryCondition(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    property_: str | None = None,
    value: (
        sob.Array
        | str
        | decimal.Decimal
        | float
        | int
        | cmsgov.provider_data.v1.model.DatastoreQueryConditionValueAnyOf2
        | cmsgov.provider_data.v1.model.DatastoreQueryResourceProperty
        | None
    ) = None,
    operator: str | None = None,
)

Bases: sob.Object

Condition object including property, value and operator. If querying only one resource, the "resource" does not need to be specified.

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• property_ (str | None) –

  The property/column or alias to filter by. Should not include collection/table alias.

• value (sob.Array | str | decimal.Decimal | float | int | cmsgov.provider_data.v1.model.DatastoreQueryConditionValueAnyOf2 | cmsgov.provider_data.v1.model.DatastoreQueryResourceProperty | None) –

  The value to filter against.

• operator (str | None) –

  Condition operator

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    property_: (
        str
        | None
    ) = None,
    value: (
        sob.Array
        | str
        | decimal.Decimal
        | float
        | int
        | DatastoreQueryConditionValueAnyOf2
        | DatastoreQueryResourceProperty
        | None
    ) = None,
    operator: (
        str
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.property_: (
        str
        | None
    ) = property_
    self.value: (
        sob.Array
        | str
        | decimal.Decimal
        | float
        | int
        | DatastoreQueryConditionValueAnyOf2
        | DatastoreQueryResourceProperty
        | None
    ) = value
    self.operator: (
        str
        | None
    ) = operator
    super().__init__(_data)

DatastoreQueryConditionGroup

DatastoreQueryConditionGroup(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    group_operator: str | None = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreQueryConditionGroupConditions
        | None
    ) = None,
)

Bases: sob.Object

Group of conditions bound by 'and'/'or' operators.

Attributes:

• group_operator (str | None) –
• conditions (cmsgov.provider_data.v1.model.DatastoreQueryConditionGroupConditions | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    group_operator: (
        str
        | None
    ) = None,
    conditions: (
        DatastoreQueryConditionGroupConditions
        | None
    ) = None
) -> None:
    self.group_operator: (
        str
        | None
    ) = group_operator
    self.conditions: (
        DatastoreQueryConditionGroupConditions
        | None
    ) = conditions
    super().__init__(_data)

DatastoreQueryExpression

DatastoreQueryExpression(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    operator: str | None = None,
    operands: (
        cmsgov.provider_data.v1.model.DatastoreQueryExpressionOperands
        | None
    ) = None,
)

Bases: sob.Object

Arithmetic or aggregate expression performed on one or more properties.

Attributes:

• operator (str | None) –

  Expression operator. Note that performing expressions on text or other non-numeric data types my yield unexpected results.

• operands (cmsgov.provider_data.v1.model.DatastoreQueryExpressionOperands | None) –

  Arithmetic operators will require two operands, aggregate operators should take only one. Do not combine arithmetic and aggregate operators in a single query.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    operator: (
        str
        | None
    ) = None,
    operands: (
        DatastoreQueryExpressionOperands
        | None
    ) = None
) -> None:
    self.operator: (
        str
        | None
    ) = operator
    self.operands: (
        DatastoreQueryExpressionOperands
        | None
    ) = operands
    super().__init__(_data)

DatastoreQueryExpressionOperands

DatastoreQueryExpressionOperands(
    items: (
        typing.Iterable[
            float
            | int
            | decimal.Decimal
            | str
            | cmsgov.provider_data.v1.model.DatastoreQueryResourceProperty
            | cmsgov.provider_data.v1.model.DatastoreQueryExpressionOperandsItemAnyOf3
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Arithmetic operators will require two operands, aggregate operators should take only one. Do not combine arithmetic and aggregate operators in a single query.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            float
            | int
            | decimal.Decimal
            | str
            | DatastoreQueryResourceProperty
            | DatastoreQueryExpressionOperandsItemAnyOf3
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryExpressionOperandsItemAnyOf3

DatastoreQueryExpressionOperandsItemAnyOf3(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: typing.Any | None = None,
)

Bases: sob.Object

Attributes:

• expression (typing.Any | None) –

  Arithmetic or aggregate expression performed on one or more properties.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: (
        typing.Any
        | None
    ) = None
) -> None:
    self.expression: (
        typing.Any
        | None
    ) = expression
    super().__init__(_data)

DatastoreQueryResourceProperty

DatastoreQueryResourceProperty(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    property_: str | None = None,
)

Bases: sob.Object

Property name with optional collection/table alias.

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• property_ (str | None) –

  The property/column or alias to filter by. Should not include collection/table alias.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    property_: (
        str
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.property_: (
        str
        | None
    ) = property_
    super().__init__(_data)

DatastoreQuerySort

DatastoreQuerySort(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    property_: str | None = None,
    order: str | None = None,
)

Bases: sob.Object

Properties to sort by in a particular order.

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• property_ (str | None) –

  The property/column or alias to filter by. Should not include collection/table alias.

• order (str | None) –

  Order to sort in, lowercase.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    property_: (
        str
        | None
    ) = None,
    order: (
        str
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.property_: (
        str
        | None
    ) = property_
    self.order: (
        str
        | None
    ) = order
    super().__init__(_data)

DatastoreResourceQuery

DatastoreResourceQuery(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    properties: (
        cmsgov.provider_data.v1.model.DatastoreResourceQueryProperties
        | None
    ) = None,
    conditions: (
        cmsgov.provider_data.v1.model.DatastoreResourceQueryConditions
        | None
    ) = None,
    groupings: (
        cmsgov.provider_data.v1.model.DatastoreResourceQueryGroupings
        | None
    ) = None,
    limit: int | None = None,
    offset: int | None = None,
    sorts: (
        cmsgov.provider_data.v1.model.DatastoreResourceQuerySorts
        | None
    ) = None,
    count: bool | None = None,
    results: bool | None = None,
    schema: bool | None = None,
    keys: bool | None = None,
    format_: str | None = None,
    row_ids: bool | None = None,
)

Bases: sob.Object

Schema for DKAN datastore queries. When querying against a specific resource, the "resource" property is always optional. If you want to set it explicitly, note that it will be aliased to simply "t".

Attributes:

• properties (cmsgov.provider_data.v1.model.DatastoreResourceQueryProperties | None) –
• conditions (cmsgov.provider_data.v1.model.DatastoreResourceQueryConditions | None) –

  Conditions or groups of conditions for the query, bound by 'and' operator.

• groupings (cmsgov.provider_data.v1.model.DatastoreResourceQueryGroupings | None) –

  Properties or aliases to group results by.

• limit (int | None) –

  Limit for maximum number of records returned. Pass zero for no limit (may be restricted by user permissions).

• offset (int | None) –

  Number of records to offset by or skip before returning first record.

• sorts (cmsgov.provider_data.v1.model.DatastoreResourceQuerySorts | None) –

  Result sorting directives.

• count (bool | None) –

  Return a count of the total rows returned by the query, ignoring the limit/offset.

• results (bool | None) –

  Return the result set. Set to false and set count to true to receive only a count of matches.

• schema (bool | None) –

  Return the schema for the datastore collection.

• keys (bool | None) –

  Return results as an array of keyed objects, with the column machine names as keys. If false, results will be an array of simple arrays of values.

• format_ (str | None) –

  Format to return data in. Default is JSON, can be set to CSV.

• row_ids (bool | None) –

  Flag to include the result_number column in output. Default is FALSE

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    properties: (
        DatastoreResourceQueryProperties
        | None
    ) = None,
    conditions: (
        DatastoreResourceQueryConditions
        | None
    ) = None,
    groupings: (
        DatastoreResourceQueryGroupings
        | None
    ) = None,
    limit: (
        int
        | None
    ) = None,
    offset: (
        int
        | None
    ) = None,
    sorts: (
        DatastoreResourceQuerySorts
        | None
    ) = None,
    count: (
        bool
        | None
    ) = None,
    results: (
        bool
        | None
    ) = None,
    schema: (
        bool
        | None
    ) = None,
    keys: (
        bool
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    row_ids: (
        bool
        | None
    ) = None
) -> None:
    self.properties: (
        DatastoreResourceQueryProperties
        | None
    ) = properties
    self.conditions: (
        DatastoreResourceQueryConditions
        | None
    ) = conditions
    self.groupings: (
        DatastoreResourceQueryGroupings
        | None
    ) = groupings
    self.limit: (
        int
        | None
    ) = limit
    self.offset: (
        int
        | None
    ) = offset
    self.sorts: (
        DatastoreResourceQuerySorts
        | None
    ) = sorts
    self.count: (
        bool
        | None
    ) = count
    self.results: (
        bool
        | None
    ) = results
    self.schema: (
        bool
        | None
    ) = schema
    self.keys: (
        bool
        | None
    ) = keys
    self.format_: (
        str
        | None
    ) = format_
    self.row_ids: (
        bool
        | None
    ) = row_ids
    super().__init__(_data)

DatastoreResourceQueryConditions

DatastoreResourceQueryConditions(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQueryCondition
            | cmsgov.provider_data.v1.model.DatastoreQueryConditionGroup
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Conditions or groups of conditions for the query, bound by 'and' operator.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQueryCondition
            | DatastoreQueryConditionGroup
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreResourceQueryGroupings

DatastoreResourceQueryGroupings(
    items: (
        typing.Iterable[
            str
            | cmsgov.provider_data.v1.model.DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Properties or aliases to group results by.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
            | DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreResourceQueryPropertiesItemAnyOf1

DatastoreResourceQueryPropertiesItemAnyOf1(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: str | None = None,
    property_: str | None = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

• resource (str | None) –

  Alias to resource set in resources array. Not needed when only querying against one resource.

• property_ (str | None) –

  The property/column or alias to filter by. Should not include collection/table alias.

• alias (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    resource: (
        str
        | None
    ) = None,
    property_: (
        str
        | None
    ) = None,
    alias: (
        str
        | None
    ) = None
) -> None:
    self.resource: (
        str
        | None
    ) = resource
    self.property_: (
        str
        | None
    ) = property_
    self.alias: (
        str
        | None
    ) = alias
    super().__init__(_data)

DatastoreResourceQueryPropertiesItemAnyOf2

DatastoreResourceQueryPropertiesItemAnyOf2(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: (
        cmsgov.provider_data.v1.model.DatastoreQueryExpression
        | None
    ) = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

• expression (cmsgov.provider_data.v1.model.DatastoreQueryExpression | None) –

  Arithmetic or aggregate expression performed on one or more properties.

• alias (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    expression: (
        DatastoreQueryExpression
        | None
    ) = None,
    alias: (
        str
        | None
    ) = None
) -> None:
    self.expression: (
        DatastoreQueryExpression
        | None
    ) = expression
    self.alias: (
        str
        | None
    ) = alias
    super().__init__(_data)

DatastoreResourceQuerySorts

DatastoreResourceQuerySorts(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.DatastoreQuerySort
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Result sorting directives.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQuerySort
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

ErrorResponse

ErrorResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: str | None = None,
    status: int | None = None,
    timestamp: datetime.datetime | None = None,
    data: sob.Dictionary | None = None,
)

Bases: sob.Object

Attributes:

• message (str | None) –

  Error message.

• status (int | None) –
• timestamp (datetime.datetime | None) –
• data (sob.Dictionary | None) –

  Arbitrary object storing more detailed data on the error message.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: (
        str
        | None
    ) = None,
    status: (
        int
        | None
    ) = None,
    timestamp: (
        datetime.datetime
        | None
    ) = None,
    data: (
        sob.Dictionary
        | None
    ) = None
) -> None:
    self.message: (
        str
        | None
    ) = message
    self.status: (
        int
        | None
    ) = status
    self.timestamp: (
        datetime.datetime
        | None
    ) = timestamp
    self.data: (
        sob.Dictionary
        | None
    ) = data
    super().__init__(_data)

Facets

Facets(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.FacetsItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Array of facet values.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            FacetsItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

FacetsItem

FacetsItem(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    name: str | None = None,
    total: str | int | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –

  Machine name for the metastore property to filter on.

• name (str | None) –

  The facet filter value, for instance, the tet of a keyword to filter by

• total (str | int | None) –

  Number of results in the current result set that match this filter.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    total: (
        str
        | int
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.name: (
        str
        | None
    ) = name
    self.total: (
        str
        | int
        | None
    ) = total
    super().__init__(_data)

HarvestPlan

HarvestPlan(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: str | None = None,
    extract: (
        cmsgov.provider_data.v1.model.HarvestPlanExtract
        | None
    ) = None,
    load: (
        cmsgov.provider_data.v1.model.HarvestPlanLoad | None
    ) = None,
)

Bases: sob.Object

Attributes:

• identifier (str | None) –
• extract (cmsgov.provider_data.v1.model.HarvestPlanExtract | None) –
• load (cmsgov.provider_data.v1.model.HarvestPlanLoad | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    extract: (
        HarvestPlanExtract
        | None
    ) = None,
    load: (
        HarvestPlanLoad
        | None
    ) = None
) -> None:
    self.identifier: (
        str
        | None
    ) = identifier
    self.extract: (
        HarvestPlanExtract
        | None
    ) = extract
    self.load: (
        HarvestPlanLoad
        | None
    ) = load
    super().__init__(_data)

HarvestPlanExtract

HarvestPlanExtract(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    uri: str | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –
• uri (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    uri: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.uri: (
        str
        | None
    ) = uri
    super().__init__(_data)

HarvestPlanLoad

HarvestPlanLoad(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    super().__init__(_data)

MetastoreNewRevision

MetastoreNewRevision(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: str | None = None,
    state: str | None = None,
)

Bases: sob.Object

When creating a new revision, you may only submit a message and state.

Attributes:

• message (str | None) –

  Revision log message.

• state (str | None) –

  The workflow state of this revision. Currently five states are supported in DKAN.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: (
        str
        | None
    ) = None,
    state: (
        str
        | None
    ) = None
) -> None:
    self.message: (
        str
        | None
    ) = message
    self.state: (
        str
        | None
    ) = state
    super().__init__(_data)

MetastoreRevision

MetastoreRevision(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: str | None = None,
    published: bool | None = None,
    message: str | None = None,
    modified: datetime.datetime | None = None,
    state: str | None = None,
)

Bases: sob.Object

Attributes:

• identifier (str | None) –

  Revision identifier.

• published (bool | None) –

  Is this the currently published revision?.

• message (str | None) –

  Revision log message.

• modified (datetime.datetime | None) –

  Timestamp of this revision/modification.

• state (str | None) –

  The workflow state of this revision. Currently five states are supported in DKAN.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    published: (
        bool
        | None
    ) = None,
    message: (
        str
        | None
    ) = None,
    modified: (
        datetime.datetime
        | None
    ) = None,
    state: (
        str
        | None
    ) = None
) -> None:
    self.identifier: (
        str
        | None
    ) = identifier
    self.published: (
        bool
        | None
    ) = published
    self.message: (
        str
        | None
    ) = message
    self.modified: (
        datetime.datetime
        | None
    ) = modified
    self.state: (
        str
        | None
    ) = state
    super().__init__(_data)

MetastoreWriteResponse

MetastoreWriteResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    endpoint: str | None = None,
    identifier: str | None = None,
)

Bases: sob.Object

Attributes:

• endpoint (str | None) –

  Path to the metadata from the API.

• identifier (str | None) –

  Identifier for metadata just created or modified.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    endpoint: (
        str
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None
) -> None:
    self.endpoint: (
        str
        | None
    ) = endpoint
    self.identifier: (
        str
        | None
    ) = identifier
    super().__init__(_data)

DatastoreImportsPostRequest

DatastoreImportsPostRequest(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    plan_id: str | None = None,
)

Bases: sob.Object

Attributes:

• plan_id (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    plan_id: (
        str
        | None
    ) = None
) -> None:
    self.plan_id: (
        str
        | None
    ) = plan_id
    super().__init__(_data)

DatastoreImportDeleteResponse

DatastoreImportDeleteResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: str | None = None,
)

Bases: sob.Object

Attributes:

• message (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: (
        str
        | None
    ) = None
) -> None:
    self.message: (
        str
        | None
    ) = message
    super().__init__(_data)

DatastoreImportGetResponse

DatastoreImportGetResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    num_of_rows: int | None = None,
    num_of_columns: int | None = None,
    columns: sob.Dictionary | None = None,
)

Bases: sob.Object

Attributes:

• num_of_rows (int | None) –
• num_of_columns (int | None) –
• columns (sob.Dictionary | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    num_of_rows: (
        int
        | None
    ) = None,
    num_of_columns: (
        int
        | None
    ) = None,
    columns: (
        sob.Dictionary
        | None
    ) = None
) -> None:
    self.num_of_rows: (
        int
        | None
    ) = num_of_rows
    self.num_of_columns: (
        int
        | None
    ) = num_of_columns
    self.columns: (
        sob.Dictionary
        | None
    ) = columns
    super().__init__(_data)

HarvestPlansPostResponse

HarvestPlansPostResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    endpoint: str | None = None,
    identifier: str | None = None,
)

Bases: sob.Object

Attributes:

• endpoint (str | None) –
• identifier (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    endpoint: (
        str
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None
) -> None:
    self.endpoint: (
        str
        | None
    ) = endpoint
    self.identifier: (
        str
        | None
    ) = identifier
    super().__init__(_data)

HarvestRunsPostRequest

HarvestRunsPostRequest(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    plan_id: str | None = None,
)

Bases: sob.Object

Attributes:

• plan_id (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    plan_id: (
        str
        | None
    ) = None
) -> None:
    self.plan_id: (
        str
        | None
    ) = plan_id
    super().__init__(_data)

HarvestRunsPostResponse

HarvestRunsPostResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: str | None = None,
    result: str | None = None,
)

Bases: sob.Object

Attributes:

• identifier (str | None) –
• result (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    result: (
        str
        | None
    ) = None
) -> None:
    self.identifier: (
        str
        | None
    ) = identifier
    self.result: (
        str
        | None
    ) = result
    super().__init__(_data)

MetastoreSchemasDatasetItemsPatchRequest

MetastoreSchemasDatasetItemsPatchRequest(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    identifier: str | None = None,
    description: str | None = None,
    access_level: str | None = None,
    rights: str | sob.Null | None = None,
    accrual_periodicity: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
    issued: str | None = None,
    modified: str | None = None,
    released: str | None = None,
    next_update_date: str | None = None,
    license_: str | None = None,
    spatial: str | None = None,
    temporal: str | None = None,
    is_part_of: str | None = None,
    publisher: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher
        | None
    ) = None,
    bureau_code: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode
        | None
    ) = None,
    program_code: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode
        | None
    ) = None,
    contact_point: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme
        | None
    ) = None,
    keyword: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword
        | None
    ) = None,
    distribution: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution
        | None
    ) = None,
    references: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences
        | None
    ) = None,
    archive_exclude: bool | None = None,
)

Bases: sob.Object

The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat:Dataset for each Dataset.

• title (str | None) –

  Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.

• identifier (str | None) –

  A unique identifier for the dataset or API as maintained within an Agency catalog or database.

• description (str | None) –

  Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.

• access_level (str | None) –

  The degree to which this dataset could be made publicly-available, regardless of whether it has been made available. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public ( Data asset is not available to members of the public).

• rights (str | sob.Null | None) –

  This may include information regarding access or restrictions based on privacy, security, or other policies. This should also provide an explanation for the selected "accessLevel" including instructions for how to access a restricted file, if applicable, or explanation for why a "non-public" or "restricted public" data assetis not "public," if applicable. Text, 255 characters.

• accrual_periodicity (str | None) –

  Frequency with which dataset is published.

• described_by (str | None) –

  URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

• issued (str | None) –

  Date of formal issuance.

• modified (str | None) –

  Most recent date on which the dataset was changed, updated or modified.

• released (str | None) –

  Date on which the dataset is scheduled to be published.

• next_update_date (str | None) –

  The date on which the dataset is expected to be updated next.

• license_ (str | None) –

  The license dataset or API is published with. See Open Licenses</ a> for more information.

• spatial (str | None) –

  The spatial coverage of the dataset. Could include a spatial region like a bounding box or a named place.

• temporal (str | None) –

  The start and end dates for which the dataset is applicable, separated by a "/" (i.e., 2000-01-15T00:45:00Z/2010-01- 15T00:06:00Z).

• is_part_of (str | None) –

  The collection of which the dataset is a subset.

• publisher (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher | None) –

  A Dataset Publisher Organization.

• bureau_code (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode | None) –

  Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

• program_code (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode | None) –

  Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

• contact_point (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint | sob.Dictionary | None) –

  A Dataset ContactPoint as a vCard object.

• theme (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme | None) –

  Main thematic category of the dataset.

• keyword (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword | None) –

  Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non- technical users.

• distribution (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution | None) –

  A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

• references (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences | None) –

  Related documents such as technical information about a dataset, developer documentation, etc.

• archive_exclude (bool | None) –

  For excluding this dataset from its provider's ' download all datasets'.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    access_level: (
        str
        | None
    ) = None,
    rights: (
        str
        | sob.Null
        | None
    ) = None,
    accrual_periodicity: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None,
    issued: (
        str
        | None
    ) = None,
    modified: (
        str
        | None
    ) = None,
    released: (
        str
        | None
    ) = None,
    next_update_date: (
        str
        | None
    ) = None,
    license_: (
        str
        | None
    ) = None,
    spatial: (
        str
        | None
    ) = None,
    temporal: (
        str
        | None
    ) = None,
    is_part_of: (
        str
        | None
    ) = None,
    publisher: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher  # noqa: E501
        | None
    ) = None,
    bureau_code: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode  # noqa: E501
        | None
    ) = None,
    program_code: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode  # noqa: E501
        | None
    ) = None,
    contact_point: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint  # noqa: E501
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme  # noqa: E501
        | None
    ) = None,
    keyword: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword  # noqa: E501
        | None
    ) = None,
    distribution: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution  # noqa: E501
        | None
    ) = None,
    references: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences  # noqa: E501
        | None
    ) = None,
    archive_exclude: (
        bool
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.identifier: (
        str
        | None
    ) = identifier
    self.description: (
        str
        | None
    ) = description
    self.access_level: (
        str
        | None
    ) = access_level
    self.rights: (
        str
        | sob.Null
        | None
    ) = rights
    self.accrual_periodicity: (
        str
        | None
    ) = accrual_periodicity
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    self.issued: (
        str
        | None
    ) = issued
    self.modified: (
        str
        | None
    ) = modified
    self.released: (
        str
        | None
    ) = released
    self.next_update_date: (
        str
        | None
    ) = next_update_date
    self.license_: (
        str
        | None
    ) = license_
    self.spatial: (
        str
        | None
    ) = spatial
    self.temporal: (
        str
        | None
    ) = temporal
    self.is_part_of: (
        str
        | None
    ) = is_part_of
    self.publisher: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher  # noqa: E501
        | None
    ) = publisher
    self.bureau_code: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode  # noqa: E501
        | None
    ) = bureau_code
    self.program_code: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode  # noqa: E501
        | None
    ) = program_code
    self.contact_point: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint  # noqa: E501
        | sob.Dictionary
        | None
    ) = contact_point
    self.theme: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme  # noqa: E501
        | None
    ) = theme
    self.keyword: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword  # noqa: E501
        | None
    ) = keyword
    self.distribution: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution  # noqa: E501
        | None
    ) = distribution
    self.references: (
        MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences  # noqa: E501
        | None
    ) = references
    self.archive_exclude: (
        bool
        | None
    ) = archive_exclude
    super().__init__(_data)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    fn: str | None = None,
    has_email: str | None = None,
    has_url: str | None = None,
)

Bases: sob.Object

A Dataset ContactPoint as a vCard object.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be vcard:Contact for contactPoint.

• fn (str | None) –

  A full formatted name, e.g. Firstname Lastname.

• has_email (str | None) –

  Email address for the contact name.

• has_url (str | None) –

  URL for the contact

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    fn: (
        str
        | None
    ) = None,
    has_email: (
        str
        | None
    ) = None,
    has_url: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.fn: (
        str
        | None
    ) = fn
    self.has_email: (
        str
        | None
    ) = has_email
    self.has_url: (
        str
        | None
    ) = has_url
    super().__init__(_data)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistributionItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistributionItem  # noqa: E501
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistributionItem

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistributionItem(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    description: str | None = None,
    format_: str | None = None,
    media_type: str | None = None,
    download_url: str | None = None,
    access_url: str | None = None,
    conforms_to: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat: Distribution for each Distribution.

• title (str | None) –

  Human-readable name of the file.

• description (str | None) –

  Human-readable description of the file.

• format_ (str | None) –

  A human-readable description of the file format of a distribution (i.e. csv, pdf, kml, etc.).

• media_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s downloadURL.

• download_url (str | None) –

  URL providing direct access to a downloadable file of a dataset.

• access_url (str | None) –

  URL providing indirect access to a dataset.

• conforms_to (str | None) –

  URI used to identify a standardized specification the distribution conforms to.

• described_by (str | None) –

  URL to the data dictionary for the distribution found at the downloadURL.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    media_type: (
        str
        | None
    ) = None,
    download_url: (
        str
        | None
    ) = None,
    access_url: (
        str
        | None
    ) = None,
    conforms_to: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.description: (
        str
        | None
    ) = description
    self.format_: (
        str
        | None
    ) = format_
    self.media_type: (
        str
        | None
    ) = media_type
    self.download_url: (
        str
        | None
    ) = download_url
    self.access_url: (
        str
        | None
    ) = access_url
    self.conforms_to: (
        str
        | None
    ) = conforms_to
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    super().__init__(_data)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    name: str | None = None,
    sub_organization_of: str | None = None,
)

Bases: sob.Object

A Dataset Publisher Organization.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be org: Organization for each publisher

• name (str | None) –
• sub_organization_of (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    sub_organization_of: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.name: (
        str
        | None
    ) = name
    self.sub_organization_of: (
        str
        | None
    ) = sub_organization_of
    super().__init__(_data)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaReferences(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Related documents such as technical information about a dataset, developer documentation, etc.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Main thematic category of the dataset.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequest

MetastoreSchemasDatasetItemsIdentifierPatchRequest(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    identifier: str | None = None,
    description: str | None = None,
    access_level: str | None = None,
    rights: str | sob.Null | None = None,
    accrual_periodicity: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
    issued: str | None = None,
    modified: str | None = None,
    released: str | None = None,
    next_update_date: str | None = None,
    license_: str | None = None,
    spatial: str | None = None,
    temporal: str | None = None,
    is_part_of: str | None = None,
    publisher: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher
        | None
    ) = None,
    bureau_code: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode
        | None
    ) = None,
    program_code: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode
        | None
    ) = None,
    contact_point: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme
        | None
    ) = None,
    keyword: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword
        | None
    ) = None,
    distribution: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution
        | None
    ) = None,
    references: (
        cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences
        | None
    ) = None,
    archive_exclude: bool | None = None,
)

Bases: sob.Object

The metadata format for all federal open data. Validates a single JSON object entry (as opposed to entire Data.json catalog).

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat:Dataset for each Dataset.

• title (str | None) –

  Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery.

• identifier (str | None) –

  A unique identifier for the dataset or API as maintained within an Agency catalog or database.

• description (str | None) –

  Human-readable description (e.g., an abstract) with sufficient detail to enable a user to quickly understand whether the asset is of interest.

• access_level (str | None) –

  The degree to which this dataset could be made publicly-available, regardless of whether it has been made available. Choices: public (Data asset is or could be made publicly available to all without restrictions), restricted public (Data asset is available under certain use restrictions), or non-public ( Data asset is not available to members of the public).

• rights (str | sob.Null | None) –

  This may include information regarding access or restrictions based on privacy, security, or other policies. This should also provide an explanation for the selected "accessLevel" including instructions for how to access a restricted file, if applicable, or explanation for why a "non-public" or "restricted public" data assetis not "public," if applicable. Text, 255 characters.

• accrual_periodicity (str | None) –

  Frequency with which dataset is published.

• described_by (str | None) –

  URL to the data dictionary for the dataset or API. Note that documentation other than a data dictionary can be referenced using Related Documents as shown in the expanded fields.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

• issued (str | None) –

  Date of formal issuance.

• modified (str | None) –

  Most recent date on which the dataset was changed, updated or modified.

• released (str | None) –

  Date on which the dataset is scheduled to be published.

• next_update_date (str | None) –

  The date on which the dataset is expected to be updated next.

• license_ (str | None) –

  The license dataset or API is published with. See Open Licenses</ a> for more information.

• spatial (str | None) –

  The spatial coverage of the dataset. Could include a spatial region like a bounding box or a named place.

• temporal (str | None) –

  The start and end dates for which the dataset is applicable, separated by a "/" (i.e., 2000-01-15T00:45:00Z/2010-01- 15T00:06:00Z).

• is_part_of (str | None) –

  The collection of which the dataset is a subset.

• publisher (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher | None) –

  A Dataset Publisher Organization.

• bureau_code (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode | None) –

  Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

• program_code (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode | None) –

  Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

• contact_point (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint | sob.Dictionary | None) –

  A Dataset ContactPoint as a vCard object.

• theme (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme | None) –

  Main thematic category of the dataset.

• keyword (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword | None) –

  Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non- technical users.

• distribution (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution | None) –

  A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

• references (cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences | None) –

  Related documents such as technical information about a dataset, developer documentation, etc.

• archive_exclude (bool | None) –

  For excluding this dataset from its provider's ' download all datasets'.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    identifier: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    access_level: (
        str
        | None
    ) = None,
    rights: (
        str
        | sob.Null
        | None
    ) = None,
    accrual_periodicity: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None,
    issued: (
        str
        | None
    ) = None,
    modified: (
        str
        | None
    ) = None,
    released: (
        str
        | None
    ) = None,
    next_update_date: (
        str
        | None
    ) = None,
    license_: (
        str
        | None
    ) = None,
    spatial: (
        str
        | None
    ) = None,
    temporal: (
        str
        | None
    ) = None,
    is_part_of: (
        str
        | None
    ) = None,
    publisher: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher  # noqa: E501
        | None
    ) = None,
    bureau_code: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode  # noqa: E501
        | None
    ) = None,
    program_code: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode  # noqa: E501
        | None
    ) = None,
    contact_point: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint  # noqa: E501
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme  # noqa: E501
        | None
    ) = None,
    keyword: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword  # noqa: E501
        | None
    ) = None,
    distribution: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution  # noqa: E501
        | None
    ) = None,
    references: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences  # noqa: E501
        | None
    ) = None,
    archive_exclude: (
        bool
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.identifier: (
        str
        | None
    ) = identifier
    self.description: (
        str
        | None
    ) = description
    self.access_level: (
        str
        | None
    ) = access_level
    self.rights: (
        str
        | sob.Null
        | None
    ) = rights
    self.accrual_periodicity: (
        str
        | None
    ) = accrual_periodicity
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    self.issued: (
        str
        | None
    ) = issued
    self.modified: (
        str
        | None
    ) = modified
    self.released: (
        str
        | None
    ) = released
    self.next_update_date: (
        str
        | None
    ) = next_update_date
    self.license_: (
        str
        | None
    ) = license_
    self.spatial: (
        str
        | None
    ) = spatial
    self.temporal: (
        str
        | None
    ) = temporal
    self.is_part_of: (
        str
        | None
    ) = is_part_of
    self.publisher: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher  # noqa: E501
        | None
    ) = publisher
    self.bureau_code: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode  # noqa: E501
        | None
    ) = bureau_code
    self.program_code: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode  # noqa: E501
        | None
    ) = program_code
    self.contact_point: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint  # noqa: E501
        | sob.Dictionary
        | None
    ) = contact_point
    self.theme: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme  # noqa: E501
        | None
    ) = theme
    self.keyword: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword  # noqa: E501
        | None
    ) = keyword
    self.distribution: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution  # noqa: E501
        | None
    ) = distribution
    self.references: (
        MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences  # noqa: E501
        | None
    ) = references
    self.archive_exclude: (
        bool
        | None
    ) = archive_exclude
    super().__init__(_data)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, combined agency and bureau code from OMB Circular A-11, Appendix C in the format of 015:010.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    fn: str | None = None,
    has_email: str | None = None,
    has_url: str | None = None,
)

Bases: sob.Object

A Dataset ContactPoint as a vCard object.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be vcard:Contact for contactPoint.

• fn (str | None) –

  A full formatted name, e.g. Firstname Lastname.

• has_email (str | None) –

  Email address for the contact name.

• has_url (str | None) –

  URL for the contact

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    fn: (
        str
        | None
    ) = None,
    has_email: (
        str
        | None
    ) = None,
    has_url: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.fn: (
        str
        | None
    ) = fn
    self.has_email: (
        str
        | None
    ) = has_email
    self.has_url: (
        str
        | None
    ) = has_url
    super().__init__(_data)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistributionItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

A distribution is a container for the data object. Each distribution should contain one accessURL or downloadURL. When providing a downloadURL, also include the format of the file.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistributionItem  # noqa: E501
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistributionItem

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistributionItem(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    title: str | None = None,
    description: str | None = None,
    format_: str | None = None,
    media_type: str | None = None,
    download_url: str | None = None,
    access_url: str | None = None,
    conforms_to: str | None = None,
    described_by: str | None = None,
    described_by_type: str | None = None,
)

Bases: sob.Object

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be dcat: Distribution for each Distribution.

• title (str | None) –

  Human-readable name of the file.

• description (str | None) –

  Human-readable description of the file.

• format_ (str | None) –

  A human-readable description of the file format of a distribution (i.e. csv, pdf, kml, etc.).

• media_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s downloadURL.

• download_url (str | None) –

  URL providing direct access to a downloadable file of a dataset.

• access_url (str | None) –

  URL providing indirect access to a dataset.

• conforms_to (str | None) –

  URI used to identify a standardized specification the distribution conforms to.

• described_by (str | None) –

  URL to the data dictionary for the distribution found at the downloadURL.

• described_by_type (str | None) –

  The machine-readable file format (IANA Media Type or MIME Type) of the distribution’s describedBy URL.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    title: (
        str
        | None
    ) = None,
    description: (
        str
        | None
    ) = None,
    format_: (
        str
        | None
    ) = None,
    media_type: (
        str
        | None
    ) = None,
    download_url: (
        str
        | None
    ) = None,
    access_url: (
        str
        | None
    ) = None,
    conforms_to: (
        str
        | None
    ) = None,
    described_by: (
        str
        | None
    ) = None,
    described_by_type: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.title: (
        str
        | None
    ) = title
    self.description: (
        str
        | None
    ) = description
    self.format_: (
        str
        | None
    ) = format_
    self.media_type: (
        str
        | None
    ) = media_type
    self.download_url: (
        str
        | None
    ) = download_url
    self.access_url: (
        str
        | None
    ) = access_url
    self.conforms_to: (
        str
        | None
    ) = conforms_to
    self.described_by: (
        str
        | None
    ) = described_by
    self.described_by_type: (
        str
        | None
    ) = described_by_type
    super().__init__(_data)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Federal agencies, list the primary program related to this data asset, from the Federal Program Inventory. Use the format of 015:001

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: str | None = None,
    name: str | None = None,
    sub_organization_of: str | None = None,
)

Bases: sob.Object

A Dataset Publisher Organization.

Attributes:

• type_ (str | None) –

  IRI for the JSON-LD data type. This should be org: Organization for each publisher

• name (str | None) –
• sub_organization_of (str | None) –

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    type_: (
        str
        | None
    ) = None,
    name: (
        str
        | None
    ) = None,
    sub_organization_of: (
        str
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.name: (
        str
        | None
    ) = name
    self.sub_organization_of: (
        str
        | None
    ) = sub_organization_of
    super().__init__(_data)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaReferences(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Related documents such as technical information about a dataset, developer documentation, etc.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme(
    items: (
        typing.Iterable[str]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Main thematic category of the dataset.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasSchemaIdItemsGetResponse

MetastoreSchemasSchemaIdItemsGetResponse(
    items: (
        typing.Iterable[sob.Dictionary]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Array of metastore items matching the chosen schema.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            sob.Dictionary
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse

MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse(
    items: (
        typing.Iterable[
            cmsgov.provider_data.v1.model.MetastoreRevision
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Array of revision objects.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    items: (
        typing.Iterable[
            MetastoreRevision
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemaRevisionPostRequest

MetastoreSchemaRevisionPostRequest(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: str | None = None,
    state: str | None = None,
)

Bases: sob.Object

Attributes:

• message (str | None) –

  Revision log message.

• state (str | None) –

  The workflow state of this revision. Currently five states are supported in DKAN.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    message: (
        str
        | None
    ) = None,
    state: (
        str
        | None
    ) = None
) -> None:
    self.message: (
        str
        | None
    ) = message
    self.state: (
        str
        | None
    ) = state
    super().__init__(_data)

SearchGetResponse

SearchGetResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    total: str | int | None = None,
    results: sob.Array | sob.Dictionary | None = None,
    facets: (
        cmsgov.provider_data.v1.model.Facets | None
    ) = None,
)

Bases: sob.Object

Attributes:

• total (str | int | None) –

  Total search results for query.

• results (sob.Array | sob.Dictionary | None) –

  An object with keys following the format "dkan_dataset/[ uuid]", containing full dataset objects from the DKAN metastore.

• facets (cmsgov.provider_data.v1.model.Facets | None) –

  Array of facet values.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    total: (
        str
        | int
        | None
    ) = None,
    results: (
        sob.Array
        | sob.Dictionary
        | None
    ) = None,
    facets: (
        Facets
        | None
    ) = None
) -> None:
    self.total: (
        str
        | int
        | None
    ) = total
    self.results: (
        sob.Array
        | sob.Dictionary
        | None
    ) = results
    self.facets: (
        Facets
        | None
    ) = facets
    super().__init__(_data)

SearchFacetsGetResponse

SearchFacetsGetResponse(
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[str, sob.abc.MarshallableTypes]
        | typing.Iterable[
            tuple[str, sob.abc.MarshallableTypes]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    facets: (
        cmsgov.provider_data.v1.model.Facets | None
    ) = None,
    time: float | int | decimal.Decimal | None = None,
    results: sob.Array | sob.Dictionary | None = None,
    total: str | int | None = None,
)

Bases: sob.Object

Attributes:

• facets (cmsgov.provider_data.v1.model.Facets | None) –

  Array of facet values.

• time (float | int | decimal.Decimal | None) –

  Execution time.

• results (sob.Array | sob.Dictionary | None) –

  An object with keys following the format "dkan_dataset/[ uuid]", containing full dataset objects from the DKAN metastore.

• total (str | int | None) –

  Total search results for query.

Source code in src/cmsgov/provider_data/v1/model.py

def __init__(
    self,
    _data: (
        sob.abc.Dictionary
        | typing.Mapping[
            str,
            sob.abc.MarshallableTypes
        ]
        | typing.Iterable[
            tuple[
                str,
                sob.abc.MarshallableTypes
            ]
        ]
        | sob.abc.Readable
        | typing.IO
        | str
        | bytes
        | None
    ) = None,
    facets: (
        Facets
        | None
    ) = None,
    time: (
        float
        | int
        | decimal.Decimal
        | None
    ) = None,
    results: (
        sob.Array
        | sob.Dictionary
        | None
    ) = None,
    total: (
        str
        | int
        | None
    ) = None
) -> None:
    self.facets: (
        Facets
        | None
    ) = facets
    self.time: (
        float
        | int
        | decimal.Decimal
        | None
    ) = time
    self.results: (
        sob.Array
        | sob.Dictionary
        | None
    ) = results
    self.total: (
        str
        | int
        | None
    ) = total
    super().__init__(_data)