Skip to content

cms_gov_provider_data_sdk.model

JsonOrCsvQueryOkContentApplicationJsonSchema 

JsonOrCsvQueryOkContentApplicationJsonSchema(
    _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: (
        cms_gov_provider_data_sdk.model.JsonOrCsvQueryOkContentApplicationJsonSchemaResults
        | None
    ) = None,
    count: int | None = None,
    schema: sob.Dictionary | None = None,
    query: sob.Dictionary | None = None,
)

Bases: sob.Object

Attributes:

  • results (cms_gov_provider_data_sdk.model.JsonOrCsvQueryOkContentApplicationJsonSchemaResults | None) –
  • count (int | None) –
  • schema (sob.Dictionary | None) –

    Schema of all resources queries, keyed by ID.

  • query (sob.Dictionary | None) –
Source code in src/cms_gov_provider_data_sdk/model.py 
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
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: (
        JsonOrCsvQueryOkContentApplicationJsonSchemaResults
        | None
    ) = None,
    count: (
        int
        | None
    ) = None,
    schema: (
        sob.Dictionary
        | None
    ) = None,
    query: (
        sob.Dictionary
        | None
    ) = None
) -> None:
    self.results: (
        JsonOrCsvQueryOkContentApplicationJsonSchemaResults
        | None
    ) = results
    self.count: (
        int
        | None
    ) = count
    self.schema: (
        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: (
        cms_gov_provider_data_sdk.model.DatasetPublisher
        | None
    ) = None,
    bureau_code: (
        cms_gov_provider_data_sdk.model.DatasetBureauCode
        | None
    ) = None,
    program_code: (
        cms_gov_provider_data_sdk.model.DatasetProgramCode
        | None
    ) = None,
    contact_point: (
        cms_gov_provider_data_sdk.model.DatasetContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cms_gov_provider_data_sdk.model.DatasetTheme | None
    ) = None,
    keyword: (
        cms_gov_provider_data_sdk.model.DatasetKeyword
        | None
    ) = None,
    distribution: (
        cms_gov_provider_data_sdk.model.DatasetDistributions
        | None
    ) = None,
    references: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.DatasetPublisher | None) –

    A Dataset Publisher Organization.

  • bureau_code (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.DatasetContactPoint | sob.Dictionary | None) –

    A Dataset ContactPoint as a vCard object.

  • theme (cms_gov_provider_data_sdk.model.DatasetTheme | None) –

    Main thematic category of the dataset.

  • keyword (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
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/cms_gov_provider_data_sdk/model.py 
454
455
456
457
458
459
460
461
462
463
464
465
466
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/cms_gov_provider_data_sdk/model.py 
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
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[
            cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
551
552
553
554
555
556
557
558
559
560
561
562
563
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/cms_gov_provider_data_sdk/model.py 
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
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/cms_gov_provider_data_sdk/model.py 
712
713
714
715
716
717
718
719
720
721
722
723
724
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/cms_gov_provider_data_sdk/model.py 
735
736
737
738
739
740
741
742
743
744
745
746
747
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/cms_gov_provider_data_sdk/model.py 
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
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/cms_gov_provider_data_sdk/model.py 
821
822
823
824
825
826
827
828
829
830
831
832
833
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/cms_gov_provider_data_sdk/model.py 
841
842
843
844
845
846
847
848
849
850
851
852
853
def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

Datasets 

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

Bases: sob.Array

An array of datasets.

Source code in src/cms_gov_provider_data_sdk/model.py 
861
862
863
864
865
866
867
868
869
870
871
872
873
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: (
        cms_gov_provider_data_sdk.model.DatastoreQueryResources
        | None
    ) = None,
    properties: (
        cms_gov_provider_data_sdk.model.DatastoreQueryProperties
        | None
    ) = None,
    conditions: (
        cms_gov_provider_data_sdk.model.DatastoreQueryConditions
        | None
    ) = None,
    joins: (
        cms_gov_provider_data_sdk.model.DatastoreQueryJoins
        | None
    ) = None,
    groupings: (
        cms_gov_provider_data_sdk.model.DatastoreQueryGroupings
        | None
    ) = None,
    limit: int | None = None,
    offset: int | None = None,
    sorts: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.DatastoreQueryProperties | None) –
  • conditions (cms_gov_provider_data_sdk.model.DatastoreQueryConditions | None) –

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

  • joins (cms_gov_provider_data_sdk.model.DatastoreQueryJoins | None) –

    Joins

  • groupings (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
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[
            cms_gov_provider_data_sdk.model.DatastoreQueryCondition
            | cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
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
            | cms_gov_provider_data_sdk.model.DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Properties or aliases to group results by.

Source code in src/cms_gov_provider_data_sdk/model.py 
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
def __init__(
    self,
    items: (
        typing.Iterable[
            str
            | DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryJoins 

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

Bases: sob.Array

Joins

Source code in src/cms_gov_provider_data_sdk/model.py 
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
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: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
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)

DatastoreQueryPropertiesItemAnyOf1 

DatastoreQueryPropertiesItemAnyOf1(
    _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/cms_gov_provider_data_sdk/model.py 
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
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)

DatastoreQueryPropertiesItemAnyOf2 

DatastoreQueryPropertiesItemAnyOf2(
    _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: (
        cms_gov_provider_data_sdk.model.DatastoreQueryExpression
        | None
    ) = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

  • expression (cms_gov_provider_data_sdk.model.DatastoreQueryExpression | None) –

    Arithmetic or aggregate expression performed on one or more properties.

  • alias (str | None) –
Source code in src/cms_gov_provider_data_sdk/model.py 
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
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[
            cms_gov_provider_data_sdk.model.DatastoreQueryResourcesItem
        ]
        | 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/cms_gov_provider_data_sdk/model.py 
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
def __init__(
    self,
    items: (
        typing.Iterable[
            DatastoreQueryResourcesItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

DatastoreQueryResourcesItem 

DatastoreQueryResourcesItem(
    _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,
)

Bases: sob.Object

Attributes:

  • alias (str | None) –

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

Source code in src/cms_gov_provider_data_sdk/model.py 
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
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
) -> None:
    self.alias: (
        str
        | None
    ) = alias
    super().__init__(_data)

DatastoreQuerySorts 

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

Bases: sob.Array

Result sorting directives.

Source code in src/cms_gov_provider_data_sdk/model.py 
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
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
        | cms_gov_provider_data_sdk.model.DatastoreQueryConditionValueAnyOf2
        | cms_gov_provider_data_sdk.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 | cms_gov_provider_data_sdk.model.DatastoreQueryConditionValueAnyOf2 | cms_gov_provider_data_sdk.model.DatastoreQueryResourceProperty | None) –

    The value to filter against.

  • operator (str | None) –

    Condition operator

Source code in src/cms_gov_provider_data_sdk/model.py 
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
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: (
        cms_gov_provider_data_sdk.model.DatastoreQueryConditionGroupConditions
        | None
    ) = None,
)

Bases: sob.Object

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

Attributes:

  • group_operator (str | None) –
  • conditions (cms_gov_provider_data_sdk.model.DatastoreQueryConditionGroupConditions | None) –
Source code in src/cms_gov_provider_data_sdk/model.py 
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
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: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
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
            | cms_gov_provider_data_sdk.model.DatastoreQueryResourceProperty
            | cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
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/cms_gov_provider_data_sdk/model.py 
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
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/cms_gov_provider_data_sdk/model.py 
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
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/cms_gov_provider_data_sdk/model.py 
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
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: (
        cms_gov_provider_data_sdk.model.DatastoreResourceQueryProperties
        | None
    ) = None,
    conditions: (
        cms_gov_provider_data_sdk.model.DatastoreResourceQueryConditions
        | None
    ) = None,
    groupings: (
        cms_gov_provider_data_sdk.model.DatastoreResourceQueryGroupings
        | None
    ) = None,
    limit: int | None = None,
    offset: int | None = None,
    sorts: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.DatastoreResourceQueryProperties | None) –
  • conditions (cms_gov_provider_data_sdk.model.DatastoreResourceQueryConditions | None) –

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

  • groupings (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
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[
            cms_gov_provider_data_sdk.model.DatastoreQueryCondition
            | cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
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
            | cms_gov_provider_data_sdk.model.DatastoreQueryResourceProperty
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Properties or aliases to group results by.

Source code in src/cms_gov_provider_data_sdk/model.py 
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
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/cms_gov_provider_data_sdk/model.py 
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
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: (
        cms_gov_provider_data_sdk.model.DatastoreQueryExpression
        | None
    ) = None,
    alias: str | None = None,
)

Bases: sob.Object

Attributes:

  • expression (cms_gov_provider_data_sdk.model.DatastoreQueryExpression | None) –

    Arithmetic or aggregate expression performed on one or more properties.

  • alias (str | None) –
Source code in src/cms_gov_provider_data_sdk/model.py 
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
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[
            cms_gov_provider_data_sdk.model.DatastoreQuerySort
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Result sorting directives.

Source code in src/cms_gov_provider_data_sdk/model.py 
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
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/cms_gov_provider_data_sdk/model.py 
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
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[
            cms_gov_provider_data_sdk.model.FacetsItem
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None,
)

Bases: sob.Array

Array of facet values.

Source code in src/cms_gov_provider_data_sdk/model.py 
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
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: 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 (int | None) –

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

Source code in src/cms_gov_provider_data_sdk/model.py 
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
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: (
        int
        | None
    ) = None
) -> None:
    self.type_: (
        str
        | None
    ) = type_
    self.name: (
        str
        | None
    ) = name
    self.total: (
        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: (
        cms_gov_provider_data_sdk.model.HarvestPlanExtract
        | None
    ) = None,
    load: (
        cms_gov_provider_data_sdk.model.HarvestPlanLoad
        | None
    ) = None,
)

Bases: sob.Object

Attributes:

Source code in src/cms_gov_provider_data_sdk/model.py 
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
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/cms_gov_provider_data_sdk/model.py 
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
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/cms_gov_provider_data_sdk/model.py 
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
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/cms_gov_provider_data_sdk/model.py 
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
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/cms_gov_provider_data_sdk/model.py 
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
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/cms_gov_provider_data_sdk/model.py 
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
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)

DatastoreImportsPostRequestBodyContentApplicationJsonSchema 

DatastoreImportsPostRequestBodyContentApplicationJsonSchema(
    _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/cms_gov_provider_data_sdk/model.py 
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
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)

DatastoreImportsIdentifierDeleteResponse 

DatastoreImportsIdentifierDeleteResponse(
    _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/cms_gov_provider_data_sdk/model.py 
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
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)

DatastoreImportsIdentifierGetResponse 

DatastoreImportsIdentifierGetResponse(
    _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/cms_gov_provider_data_sdk/model.py 
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
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/cms_gov_provider_data_sdk/model.py 
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
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)

HarvestRunsPostRequestBodyContentApplicationJsonSchema 

HarvestRunsPostRequestBodyContentApplicationJsonSchema(
    _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/cms_gov_provider_data_sdk/model.py 
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
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/cms_gov_provider_data_sdk/model.py 
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
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)

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchema 

MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchema(
    _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: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher
        | None
    ) = None,
    bureau_code: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaBureauCode
        | None
    ) = None,
    program_code: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaProgramCode
        | None
    ) = None,
    contact_point: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme
        | None
    ) = None,
    keyword: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaKeyword
        | None
    ) = None,
    distribution: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaDistribution
        | None
    ) = None,
    references: (
        cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaPublisher | None) –

    A Dataset Publisher Organization.

  • bureau_code (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaContactPoint | sob.Dictionary | None) –

    A Dataset ContactPoint as a vCard object.

  • theme (cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsPatchRequestBodyContentApplicationJsonSchemaTheme | None) –

    Main thematic category of the dataset.

  • keyword (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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 (cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
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/cms_gov_provider_data_sdk/model.py 
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
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/cms_gov_provider_data_sdk/model.py 
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
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[
            cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
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/cms_gov_provider_data_sdk/model.py 
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
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/cms_gov_provider_data_sdk/model.py 
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
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/cms_gov_provider_data_sdk/model.py 
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
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/cms_gov_provider_data_sdk/model.py 
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
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/cms_gov_provider_data_sdk/model.py 
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
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/cms_gov_provider_data_sdk/model.py 
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
def __init__(
    self,
    items: (
        typing.Iterable[
            str
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchema 

MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchema(
    _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: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaPublisher
        | None
    ) = None,
    bureau_code: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaBureauCode
        | None
    ) = None,
    program_code: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaProgramCode
        | None
    ) = None,
    contact_point: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaContactPoint
        | sob.Dictionary
        | None
    ) = None,
    theme: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaTheme
        | None
    ) = None,
    keyword: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaKeyword
        | None
    ) = None,
    distribution: (
        cms_gov_provider_data_sdk.model.MetastoreSchemasDatasetItemsIdentifierPatchRequestBodyContentApplicationJsonSchemaDistribution
        | None
    ) = None,
    references: (
        cms_gov_provider_data_sdk.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:

Source code in src/cms_gov_provider_data_sdk/model.py 
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
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/cms_gov_provider_data_sdk/model.py 
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
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/cms_gov_provider_data_sdk/model.py 
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
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[
            cms_gov_provider_data_sdk.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/cms_gov_provider_data_sdk/model.py 
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
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/cms_gov_provider_data_sdk/model.py 
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
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/cms_gov_provider_data_sdk/model.py 
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
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/cms_gov_provider_data_sdk/model.py 
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
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/cms_gov_provider_data_sdk/model.py 
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
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/cms_gov_provider_data_sdk/model.py 
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
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/cms_gov_provider_data_sdk/model.py 
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
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/cms_gov_provider_data_sdk/model.py 
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
def __init__(
    self,
    items: (
        typing.Iterable[
            sob.Dictionary
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasSchemaIdItemsIdentifierRevisionsGetResponse 

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

Bases: sob.Array

Array of revision objects.

Source code in src/cms_gov_provider_data_sdk/model.py 
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
def __init__(
    self,
    items: (
        typing.Iterable[
            MetastoreRevision
        ]
        | sob.abc.Readable
        | str
        | bytes
        | None
    ) = None
) -> None:
    super().__init__(items)

MetastoreSchemasSchemaIdItemsIdentifierRevisionsPostRequestBodyContentApplicationJsonSchema 

MetastoreSchemasSchemaIdItemsIdentifierRevisionsPostRequestBodyContentApplicationJsonSchema(
    _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/cms_gov_provider_data_sdk/model.py 
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
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: int | None = None,
    results: sob.Dictionary | None = None,
    facets: (
        cms_gov_provider_data_sdk.model.Facets | None
    ) = None,
)

Bases: sob.Object

Attributes:

  • total (int | None) –

    Total search results for query.

  • results (sob.Dictionary | None) –

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

  • facets (cms_gov_provider_data_sdk.model.Facets | None) –

    Array of facet values.

Source code in src/cms_gov_provider_data_sdk/model.py 
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
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: (
        int
        | None
    ) = None,
    results: (
        sob.Dictionary
        | None
    ) = None,
    facets: (
        Facets
        | None
    ) = None
) -> None:
    self.total: (
        int
        | None
    ) = total
    self.results: (
        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: (
        cms_gov_provider_data_sdk.model.Facets | None
    ) = None,
    time: float | int | decimal.Decimal | None = None,
)

Bases: sob.Object

Attributes:

  • facets (cms_gov_provider_data_sdk.model.Facets | None) –

    Array of facet values.

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

    Execution time.

Source code in src/cms_gov_provider_data_sdk/model.py 
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
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
) -> None:
    self.facets: (
        Facets
        | None
    ) = facets
    self.time: (
        float
        | int
        | decimal.Decimal
        | None
    ) = time
    super().__init__(_data)