ncbi-datasets-pyclient 18.4.0__py3-none-any.whl → 18.13.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (302) hide show
  1. ncbi/datasets/openapi/__init__.py +603 -250
  2. ncbi/datasets/openapi/api/bio_sample_api.py +1 -2
  3. ncbi/datasets/openapi/api/gene_api.py +1331 -1011
  4. ncbi/datasets/openapi/api/genome_api.py +1129 -1303
  5. ncbi/datasets/openapi/api/organelle_api.py +1 -2
  6. ncbi/datasets/openapi/api/prokaryote_api.py +31 -32
  7. ncbi/datasets/openapi/api/taxonomy_api.py +105 -106
  8. ncbi/datasets/openapi/api/version_api.py +1 -2
  9. ncbi/datasets/openapi/api/virus_api.py +772 -830
  10. ncbi/datasets/openapi/api_client.py +14 -8
  11. ncbi/datasets/openapi/configuration.py +8 -9
  12. ncbi/datasets/openapi/exceptions.py +1 -2
  13. ncbi/datasets/openapi/models/__init__.py +53 -3
  14. ncbi/datasets/openapi/models/ncbiprotddv2_chain_footprint.py +93 -0
  15. ncbi/datasets/openapi/models/ncbiprotddv2_query_structure_definition.py +97 -0
  16. ncbi/datasets/openapi/models/ncbiprotddv2_redundancy_level.py +39 -0
  17. ncbi/datasets/openapi/models/ncbiprotddv2_sdid_request.py +87 -0
  18. ncbi/datasets/openapi/models/ncbiprotddv2_similar_structure_report.py +121 -0
  19. ncbi/datasets/openapi/models/ncbiprotddv2_similar_structure_report_page.py +99 -0
  20. ncbi/datasets/openapi/models/ncbiprotddv2_similar_structure_request.py +97 -0
  21. ncbi/datasets/openapi/models/ncbiprotddv2_sort_by_id.py +51 -0
  22. ncbi/datasets/openapi/models/ncbiprotddv2_structure_data_report.py +141 -0
  23. ncbi/datasets/openapi/models/ncbiprotddv2_structure_data_report_biounit_chain.py +94 -0
  24. ncbi/datasets/openapi/models/ncbiprotddv2_structure_data_report_experiment.py +89 -0
  25. ncbi/datasets/openapi/models/ncbiprotddv2_structure_data_report_kind.py +42 -0
  26. ncbi/datasets/openapi/models/ncbiprotddv2_structure_data_report_ligand_chain.py +94 -0
  27. ncbi/datasets/openapi/models/ncbiprotddv2_structure_request.py +89 -0
  28. ncbi/datasets/openapi/models/ncbiprotddv2_vast_score.py +95 -0
  29. ncbi/datasets/openapi/models/protobuf_any.py +1 -2
  30. ncbi/datasets/openapi/models/rpc_status.py +1 -2
  31. ncbi/datasets/openapi/models/v2_accessions.py +87 -0
  32. ncbi/datasets/openapi/models/v2_annotation_for_assembly_type.py +2 -3
  33. ncbi/datasets/openapi/models/v2_annotation_for_organelle_type.py +2 -2
  34. ncbi/datasets/openapi/models/v2_assembly_accessions.py +1 -2
  35. ncbi/datasets/openapi/models/v2_assembly_check_m_histogram_reply.py +1 -2
  36. ncbi/datasets/openapi/models/v2_assembly_check_m_histogram_reply_histogram_interval.py +1 -2
  37. ncbi/datasets/openapi/models/v2_assembly_check_m_histogram_request.py +1 -2
  38. ncbi/datasets/openapi/models/v2_assembly_data_report_draft_request.py +87 -0
  39. ncbi/datasets/openapi/models/v2_assembly_dataset_availability.py +1 -2
  40. ncbi/datasets/openapi/models/v2_assembly_dataset_descriptors_filter.py +9 -10
  41. ncbi/datasets/openapi/models/v2_assembly_dataset_descriptors_filter_assembly_source.py +1 -2
  42. ncbi/datasets/openapi/models/v2_assembly_dataset_descriptors_filter_assembly_version.py +1 -2
  43. ncbi/datasets/openapi/models/v2_assembly_dataset_descriptors_filter_metagenome_derived_filter.py +1 -2
  44. ncbi/datasets/openapi/models/v2_assembly_dataset_descriptors_filter_type_material_category.py +1 -2
  45. ncbi/datasets/openapi/models/v2_assembly_dataset_reports_request.py +5 -6
  46. ncbi/datasets/openapi/models/v2_assembly_dataset_reports_request_content_type.py +1 -2
  47. ncbi/datasets/openapi/models/v2_assembly_dataset_request.py +3 -4
  48. ncbi/datasets/openapi/models/v2_assembly_dataset_request_resolution.py +1 -2
  49. ncbi/datasets/openapi/models/v2_assembly_links_reply.py +1 -2
  50. ncbi/datasets/openapi/models/v2_assembly_links_reply_assembly_link.py +3 -4
  51. ncbi/datasets/openapi/models/v2_assembly_links_reply_assembly_link_type.py +3 -3
  52. ncbi/datasets/openapi/models/v2_assembly_links_request.py +1 -2
  53. ncbi/datasets/openapi/models/v2_assembly_revision_history.py +1 -2
  54. ncbi/datasets/openapi/models/v2_assembly_revision_history_request.py +1 -2
  55. ncbi/datasets/openapi/models/v2_assembly_sequence_reports_request.py +3 -4
  56. ncbi/datasets/openapi/models/v2_bio_sample_dataset_reports_request.py +87 -0
  57. ncbi/datasets/openapi/models/v2_catalog_api_version.py +38 -0
  58. ncbi/datasets/openapi/models/v2_dataset_request.py +1 -2
  59. ncbi/datasets/openapi/models/v2_download_summary.py +1 -2
  60. ncbi/datasets/openapi/models/v2_download_summary_available_files.py +1 -2
  61. ncbi/datasets/openapi/models/v2_download_summary_dehydrated.py +1 -2
  62. ncbi/datasets/openapi/models/v2_download_summary_file_summary.py +1 -2
  63. ncbi/datasets/openapi/models/v2_download_summary_hydrated.py +1 -2
  64. ncbi/datasets/openapi/models/v2_element_flank_config.py +87 -0
  65. ncbi/datasets/openapi/models/v2_fasta.py +1 -2
  66. ncbi/datasets/openapi/models/v2_file_file_type.py +57 -0
  67. ncbi/datasets/openapi/models/v2_gene_chromosome_summary_reply.py +1 -2
  68. ncbi/datasets/openapi/models/v2_gene_chromosome_summary_reply_gene_chromosome_summary.py +1 -2
  69. ncbi/datasets/openapi/models/v2_gene_chromosome_summary_request.py +89 -0
  70. ncbi/datasets/openapi/models/v2_gene_counts_by_taxon_reply.py +1 -2
  71. ncbi/datasets/openapi/models/v2_gene_counts_by_taxon_reply_gene_type_and_count.py +1 -2
  72. ncbi/datasets/openapi/models/v2_gene_counts_by_taxon_request.py +1 -2
  73. ncbi/datasets/openapi/models/v2_gene_dataset_reports_request.py +20 -9
  74. ncbi/datasets/openapi/models/v2_gene_dataset_reports_request_content_type.py +1 -3
  75. ncbi/datasets/openapi/models/v2_gene_dataset_reports_request_symbols_for_taxon.py +1 -2
  76. ncbi/datasets/openapi/models/v2_gene_dataset_request.py +5 -6
  77. ncbi/datasets/openapi/models/v2_gene_dataset_request_content_type.py +1 -2
  78. ncbi/datasets/openapi/models/v2_gene_dataset_request_gene_dataset_report_type.py +1 -2
  79. ncbi/datasets/openapi/models/v2_gene_links_reply.py +1 -2
  80. ncbi/datasets/openapi/models/v2_gene_links_reply_gene_link.py +3 -4
  81. ncbi/datasets/openapi/models/v2_gene_links_reply_gene_link_type.py +2 -2
  82. ncbi/datasets/openapi/models/v2_gene_links_request.py +1 -2
  83. ncbi/datasets/openapi/models/v2_gene_pubmed_ids_request.py +87 -0
  84. ncbi/datasets/openapi/models/v2_gene_pubmed_ids_response.py +87 -0
  85. ncbi/datasets/openapi/models/v2_gene_type.py +1 -2
  86. ncbi/datasets/openapi/models/v2_genome_annotation_request.py +5 -6
  87. ncbi/datasets/openapi/models/v2_genome_annotation_request_annotation_type.py +2 -2
  88. ncbi/datasets/openapi/models/v2_genome_annotation_request_genome_annotation_table_format.py +1 -2
  89. ncbi/datasets/openapi/models/v2_genome_annotation_table_summary_reply.py +1 -2
  90. ncbi/datasets/openapi/models/v2_http_body.py +1 -2
  91. ncbi/datasets/openapi/models/v2_image_size.py +1 -2
  92. ncbi/datasets/openapi/models/v2_include_tabular_header.py +1 -2
  93. ncbi/datasets/openapi/models/v2_micro_bigge_dataset_request.py +96 -0
  94. ncbi/datasets/openapi/models/v2_micro_bigge_dataset_request_file_type.py +39 -0
  95. ncbi/datasets/openapi/models/v2_mol_type.py +40 -0
  96. ncbi/datasets/openapi/models/v2_organelle_download_request.py +1 -2
  97. ncbi/datasets/openapi/models/v2_organelle_metadata_request.py +7 -8
  98. ncbi/datasets/openapi/models/v2_organelle_metadata_request_content_type.py +1 -2
  99. ncbi/datasets/openapi/models/v2_organelle_metadata_request_organelle_table_format.py +1 -2
  100. ncbi/datasets/openapi/models/v2_organelle_sort.py +3 -4
  101. ncbi/datasets/openapi/models/v2_organism_query_request.py +5 -6
  102. ncbi/datasets/openapi/models/v2_organism_query_request_tax_rank_filter.py +1 -2
  103. ncbi/datasets/openapi/models/v2_organism_query_request_taxon_resource_filter.py +1 -2
  104. ncbi/datasets/openapi/models/v2_ortholog_request.py +3 -4
  105. ncbi/datasets/openapi/models/v2_ortholog_request_content_type.py +1 -2
  106. ncbi/datasets/openapi/models/v2_prokaryote_gene_request.py +1 -2
  107. ncbi/datasets/openapi/models/v2_prokaryote_gene_request_gene_flank_config.py +1 -2
  108. ncbi/datasets/openapi/models/v2_ref_gene_catalog_dataset_request.py +96 -0
  109. ncbi/datasets/openapi/models/v2_ref_gene_catalog_dataset_request_file_type.py +38 -0
  110. ncbi/datasets/openapi/models/v2_sars2_protein_dataset_request.py +3 -4
  111. ncbi/datasets/openapi/models/v2_sci_name_and_ids.py +1 -2
  112. ncbi/datasets/openapi/models/v2_sci_name_and_ids_sci_name_and_id.py +3 -4
  113. ncbi/datasets/openapi/models/v2_seq_range.py +94 -0
  114. ncbi/datasets/openapi/models/v2_seq_reply.py +96 -0
  115. ncbi/datasets/openapi/models/v2_sequence_accession_request.py +1 -2
  116. ncbi/datasets/openapi/models/v2_sequence_report_page.py +1 -2
  117. ncbi/datasets/openapi/models/v2_sleep_reply.py +87 -0
  118. ncbi/datasets/openapi/models/v2_sleep_request.py +89 -0
  119. ncbi/datasets/openapi/models/v2_sort_direction.py +1 -2
  120. ncbi/datasets/openapi/models/v2_sort_field.py +3 -4
  121. ncbi/datasets/openapi/models/v2_table_format.py +1 -2
  122. ncbi/datasets/openapi/models/v2_tabular_output.py +1 -2
  123. ncbi/datasets/openapi/models/v2_taxonomy_dataset_request.py +1 -2
  124. ncbi/datasets/openapi/models/v2_taxonomy_dataset_request_taxonomy_report_type.py +1 -2
  125. ncbi/datasets/openapi/models/v2_taxonomy_filtered_subtree_request.py +5 -4
  126. ncbi/datasets/openapi/models/v2_taxonomy_filtered_subtree_response.py +1 -2
  127. ncbi/datasets/openapi/models/v2_taxonomy_filtered_subtree_response_edge.py +3 -4
  128. ncbi/datasets/openapi/models/v2_taxonomy_filtered_subtree_response_edge_child_status.py +2 -2
  129. ncbi/datasets/openapi/models/v2_taxonomy_filtered_subtree_response_edges_entry.py +1 -2
  130. ncbi/datasets/openapi/models/v2_taxonomy_image_metadata_request.py +1 -2
  131. ncbi/datasets/openapi/models/v2_taxonomy_image_metadata_response.py +1 -2
  132. ncbi/datasets/openapi/models/v2_taxonomy_image_request.py +3 -4
  133. ncbi/datasets/openapi/models/v2_taxonomy_links_request.py +1 -2
  134. ncbi/datasets/openapi/models/v2_taxonomy_links_response.py +1 -2
  135. ncbi/datasets/openapi/models/v2_taxonomy_links_response_generic_link.py +1 -2
  136. ncbi/datasets/openapi/models/v2_taxonomy_match.py +1 -2
  137. ncbi/datasets/openapi/models/v2_taxonomy_metadata_request.py +7 -8
  138. ncbi/datasets/openapi/models/v2_taxonomy_metadata_request_content_type.py +1 -2
  139. ncbi/datasets/openapi/models/v2_taxonomy_metadata_request_table_format.py +1 -2
  140. ncbi/datasets/openapi/models/v2_taxonomy_metadata_response.py +1 -2
  141. ncbi/datasets/openapi/models/v2_taxonomy_node.py +3 -4
  142. ncbi/datasets/openapi/models/v2_taxonomy_node_count_by_type.py +3 -4
  143. ncbi/datasets/openapi/models/v2_taxonomy_related_id_request.py +1 -2
  144. ncbi/datasets/openapi/models/v2_taxonomy_tax_ids_page.py +1 -2
  145. ncbi/datasets/openapi/models/v2_version_reply.py +1 -2
  146. ncbi/datasets/openapi/models/v2_viral_sequence_type.py +1 -2
  147. ncbi/datasets/openapi/models/v2_virus_annotation_filter.py +1 -2
  148. ncbi/datasets/openapi/models/v2_virus_annotation_report_request.py +1 -2
  149. ncbi/datasets/openapi/models/v2_virus_availability.py +1 -2
  150. ncbi/datasets/openapi/models/v2_virus_availability_request.py +1 -2
  151. ncbi/datasets/openapi/models/v2_virus_data_report_request.py +3 -4
  152. ncbi/datasets/openapi/models/v2_virus_data_report_request_content_type.py +1 -2
  153. ncbi/datasets/openapi/models/v2_virus_dataset_filter.py +1 -2
  154. ncbi/datasets/openapi/models/v2_virus_dataset_report_type.py +1 -2
  155. ncbi/datasets/openapi/models/v2_virus_dataset_request.py +3 -4
  156. ncbi/datasets/openapi/models/v2_virus_table_field.py +1 -2
  157. ncbi/datasets/openapi/models/v2archive_affiliation.py +95 -0
  158. ncbi/datasets/openapi/models/v2archive_catalog.py +121 -0
  159. ncbi/datasets/openapi/models/v2archive_location.py +95 -0
  160. ncbi/datasets/openapi/models/v2archive_modifier.py +90 -0
  161. ncbi/datasets/openapi/models/v2archive_molecule_type.py +43 -0
  162. ncbi/datasets/openapi/models/v2archive_name.py +105 -0
  163. ncbi/datasets/openapi/models/v2archive_nuccore_request.py +87 -0
  164. ncbi/datasets/openapi/models/v2archive_sequence.py +90 -0
  165. ncbi/datasets/openapi/models/v2archive_sequence_length_units.py +39 -0
  166. ncbi/datasets/openapi/models/v2archive_submitter.py +105 -0
  167. ncbi/datasets/openapi/models/v2archive_taxonomy_node.py +118 -0
  168. ncbi/datasets/openapi/models/v2archive_taxonomy_subtype.py +77 -0
  169. ncbi/datasets/openapi/models/v2reports_additional_submitter.py +1 -2
  170. ncbi/datasets/openapi/models/v2reports_ani_match.py +3 -4
  171. ncbi/datasets/openapi/models/v2reports_ani_type_category.py +2 -3
  172. ncbi/datasets/openapi/models/v2reports_annotation.py +1 -2
  173. ncbi/datasets/openapi/models/v2reports_annotation_info.py +1 -2
  174. ncbi/datasets/openapi/models/v2reports_assembly_data_report.py +3 -4
  175. ncbi/datasets/openapi/models/v2reports_assembly_data_report_page.py +3 -4
  176. ncbi/datasets/openapi/models/v2reports_assembly_info.py +5 -6
  177. ncbi/datasets/openapi/models/v2reports_assembly_level.py +1 -2
  178. ncbi/datasets/openapi/models/v2reports_assembly_revision.py +8 -7
  179. ncbi/datasets/openapi/models/v2reports_assembly_stats.py +4 -3
  180. ncbi/datasets/openapi/models/v2reports_assembly_status.py +1 -2
  181. ncbi/datasets/openapi/models/v2reports_atypical_info.py +1 -2
  182. ncbi/datasets/openapi/models/v2reports_average_nucleotide_identity.py +7 -8
  183. ncbi/datasets/openapi/models/v2reports_average_nucleotide_identity_match_status.py +1 -2
  184. ncbi/datasets/openapi/models/v2reports_average_nucleotide_identity_taxonomy_check_status.py +1 -2
  185. ncbi/datasets/openapi/models/v2reports_bio_project.py +1 -2
  186. ncbi/datasets/openapi/models/v2reports_bio_project_lineage.py +1 -2
  187. ncbi/datasets/openapi/models/v2reports_bio_sample_attribute.py +1 -2
  188. ncbi/datasets/openapi/models/v2reports_bio_sample_contact.py +1 -2
  189. ncbi/datasets/openapi/models/v2reports_bio_sample_data_report.py +1 -2
  190. ncbi/datasets/openapi/models/v2reports_bio_sample_data_report_page.py +1 -2
  191. ncbi/datasets/openapi/models/v2reports_bio_sample_description.py +1 -2
  192. ncbi/datasets/openapi/models/v2reports_bio_sample_descriptor.py +1 -2
  193. ncbi/datasets/openapi/models/v2reports_bio_sample_id.py +1 -2
  194. ncbi/datasets/openapi/models/v2reports_bio_sample_owner.py +1 -2
  195. ncbi/datasets/openapi/models/v2reports_bio_sample_status.py +1 -2
  196. ncbi/datasets/openapi/models/v2reports_busco_stat.py +1 -2
  197. ncbi/datasets/openapi/models/v2reports_check_m.py +1 -2
  198. ncbi/datasets/openapi/models/v2reports_classification.py +8 -4
  199. ncbi/datasets/openapi/models/v2reports_collection_type.py +1 -2
  200. ncbi/datasets/openapi/models/v2reports_conserved_domain.py +1 -2
  201. ncbi/datasets/openapi/models/v2reports_content_type.py +1 -2
  202. ncbi/datasets/openapi/models/v2reports_count_type.py +1 -2
  203. ncbi/datasets/openapi/models/v2reports_error.py +11 -12
  204. ncbi/datasets/openapi/models/v2reports_error_assembly_error_code.py +1 -2
  205. ncbi/datasets/openapi/models/v2reports_error_gene_error_code.py +1 -2
  206. ncbi/datasets/openapi/models/v2reports_error_organelle_error_code.py +1 -2
  207. ncbi/datasets/openapi/models/v2reports_error_taxonomy_error_code.py +1 -2
  208. ncbi/datasets/openapi/models/v2reports_error_virus_error_code.py +1 -2
  209. ncbi/datasets/openapi/models/v2reports_feature_counts.py +1 -2
  210. ncbi/datasets/openapi/models/v2reports_functional_site.py +97 -0
  211. ncbi/datasets/openapi/models/v2reports_gene_counts.py +1 -2
  212. ncbi/datasets/openapi/models/v2reports_gene_data_report_page.py +1 -2
  213. ncbi/datasets/openapi/models/v2reports_gene_descriptor.py +7 -8
  214. ncbi/datasets/openapi/models/v2reports_gene_group.py +1 -2
  215. ncbi/datasets/openapi/models/v2reports_gene_ontology.py +1 -2
  216. ncbi/datasets/openapi/models/v2reports_gene_report_match.py +1 -2
  217. ncbi/datasets/openapi/models/v2reports_gene_summary.py +1 -2
  218. ncbi/datasets/openapi/models/v2reports_gene_type.py +1 -2
  219. ncbi/datasets/openapi/models/v2reports_genome_annotation.py +7 -8
  220. ncbi/datasets/openapi/models/v2reports_genome_annotation_report_match.py +1 -2
  221. ncbi/datasets/openapi/models/v2reports_genome_annotation_report_page.py +1 -2
  222. ncbi/datasets/openapi/models/v2reports_genomic_location.py +1 -2
  223. ncbi/datasets/openapi/models/v2reports_genomic_region.py +3 -4
  224. ncbi/datasets/openapi/models/v2reports_genomic_region_genomic_region_type.py +1 -2
  225. ncbi/datasets/openapi/models/v2reports_infraspecific_names.py +1 -2
  226. ncbi/datasets/openapi/models/v2reports_isolate.py +1 -2
  227. ncbi/datasets/openapi/models/v2reports_lineage_organism.py +1 -2
  228. ncbi/datasets/openapi/models/v2reports_linked_assembly.py +3 -4
  229. ncbi/datasets/openapi/models/v2reports_linked_assembly_type.py +1 -2
  230. ncbi/datasets/openapi/models/v2reports_mature_peptide.py +1 -2
  231. ncbi/datasets/openapi/models/v2reports_message.py +1 -2
  232. ncbi/datasets/openapi/models/v2reports_name_and_authority.py +1 -2
  233. ncbi/datasets/openapi/models/v2reports_name_and_authority_note.py +3 -4
  234. ncbi/datasets/openapi/models/v2reports_name_and_authority_note_classifier.py +1 -2
  235. ncbi/datasets/openapi/models/v2reports_name_and_authority_publication.py +1 -2
  236. ncbi/datasets/openapi/models/v2reports_nomenclature_authority.py +1 -2
  237. ncbi/datasets/openapi/models/v2reports_organelle.py +5 -6
  238. ncbi/datasets/openapi/models/v2reports_organelle_biosample.py +1 -2
  239. ncbi/datasets/openapi/models/v2reports_organelle_data_reports.py +1 -2
  240. ncbi/datasets/openapi/models/v2reports_organelle_gene_counts.py +1 -2
  241. ncbi/datasets/openapi/models/v2reports_organelle_info.py +1 -2
  242. ncbi/datasets/openapi/models/v2reports_organelle_topology.py +1 -2
  243. ncbi/datasets/openapi/models/v2reports_organelle_type.py +1 -2
  244. ncbi/datasets/openapi/models/v2reports_organism.py +1 -2
  245. ncbi/datasets/openapi/models/v2reports_orientation.py +1 -2
  246. ncbi/datasets/openapi/models/v2reports_paired_assembly.py +7 -6
  247. ncbi/datasets/openapi/models/v2reports_process_metadata.py +1 -2
  248. ncbi/datasets/openapi/models/v2reports_product_descriptor.py +5 -6
  249. ncbi/datasets/openapi/models/v2reports_prokaryote_gene_location_completeness.py +37 -0
  250. ncbi/datasets/openapi/models/v2reports_protein.py +1 -2
  251. ncbi/datasets/openapi/models/v2reports_protein_conserved_domain.py +103 -0
  252. ncbi/datasets/openapi/models/v2reports_protein_data_report.py +127 -0
  253. ncbi/datasets/openapi/models/v2reports_protein_data_report_page.py +95 -0
  254. ncbi/datasets/openapi/models/v2reports_protein_family.py +95 -0
  255. ncbi/datasets/openapi/models/v2reports_purpose_of_sampling.py +1 -2
  256. ncbi/datasets/openapi/models/v2reports_range.py +3 -4
  257. ncbi/datasets/openapi/models/v2reports_rank_type.py +3 -2
  258. ncbi/datasets/openapi/models/v2reports_reference.py +1 -2
  259. ncbi/datasets/openapi/models/v2reports_rna_type.py +1 -2
  260. ncbi/datasets/openapi/models/v2reports_seq_range_set.py +1 -2
  261. ncbi/datasets/openapi/models/v2reports_seq_range_set_fasta.py +1 -2
  262. ncbi/datasets/openapi/models/v2reports_sequence_info.py +1 -2
  263. ncbi/datasets/openapi/models/v2reports_sequence_information.py +1 -2
  264. ncbi/datasets/openapi/models/v2reports_source_database.py +1 -2
  265. ncbi/datasets/openapi/models/v2reports_tax_data.py +1 -2
  266. ncbi/datasets/openapi/models/v2reports_taxonomy_data_report_page.py +1 -2
  267. ncbi/datasets/openapi/models/v2reports_taxonomy_names_data_report_page.py +1 -2
  268. ncbi/datasets/openapi/models/v2reports_taxonomy_names_descriptor.py +3 -4
  269. ncbi/datasets/openapi/models/v2reports_taxonomy_names_descriptor_citation.py +1 -2
  270. ncbi/datasets/openapi/models/v2reports_taxonomy_names_report_match.py +1 -2
  271. ncbi/datasets/openapi/models/v2reports_taxonomy_node.py +7 -6
  272. ncbi/datasets/openapi/models/v2reports_taxonomy_node_count_by_type.py +3 -4
  273. ncbi/datasets/openapi/models/v2reports_taxonomy_report_match.py +1 -2
  274. ncbi/datasets/openapi/models/v2reports_taxonomy_type_material.py +1 -2
  275. ncbi/datasets/openapi/models/v2reports_transcript.py +5 -6
  276. ncbi/datasets/openapi/models/v2reports_transcript_select_category.py +1 -2
  277. ncbi/datasets/openapi/models/v2reports_transcript_transcript_type.py +1 -2
  278. ncbi/datasets/openapi/models/v2reports_transcript_type_count.py +3 -4
  279. ncbi/datasets/openapi/models/v2reports_type_material.py +1 -2
  280. ncbi/datasets/openapi/models/v2reports_virus_annotation_report.py +1 -2
  281. ncbi/datasets/openapi/models/v2reports_virus_annotation_report_page.py +1 -2
  282. ncbi/datasets/openapi/models/v2reports_virus_assembly.py +5 -6
  283. ncbi/datasets/openapi/models/v2reports_virus_assembly_collection_location.py +1 -2
  284. ncbi/datasets/openapi/models/v2reports_virus_assembly_completeness.py +1 -2
  285. ncbi/datasets/openapi/models/v2reports_virus_assembly_submitter_info.py +1 -2
  286. ncbi/datasets/openapi/models/v2reports_virus_data_report_page.py +1 -2
  287. ncbi/datasets/openapi/models/v2reports_virus_gene.py +1 -2
  288. ncbi/datasets/openapi/models/v2reports_virus_peptide.py +3 -4
  289. ncbi/datasets/openapi/models/v2reports_virus_peptide_uni_prot_id.py +1 -2
  290. ncbi/datasets/openapi/models/v2reports_virus_peptide_viral_peptide_completeness.py +1 -2
  291. ncbi/datasets/openapi/models/v2reports_warning.py +3 -4
  292. ncbi/datasets/openapi/models/v2reports_warning_gene_warning_code.py +1 -2
  293. ncbi/datasets/openapi/models/v2reports_warning_replaced_id.py +1 -2
  294. ncbi/datasets/openapi/models/v2reports_wgs_info.py +1 -2
  295. ncbi/datasets/openapi/rest.py +1 -2
  296. ncbi_datasets_pyclient-18.13.0.dist-info/METADATA +537 -0
  297. ncbi_datasets_pyclient-18.13.0.dist-info/RECORD +305 -0
  298. ncbi_datasets_pyclient-18.4.0.dist-info/METADATA +0 -25
  299. ncbi_datasets_pyclient-18.4.0.dist-info/RECORD +0 -254
  300. {ncbi_datasets_pyclient-18.4.0.dist-info → ncbi_datasets_pyclient-18.13.0.dist-info}/WHEEL +0 -0
  301. {ncbi_datasets_pyclient-18.4.0.dist-info → ncbi_datasets_pyclient-18.13.0.dist-info}/licenses/LICENSE +0 -0
  302. {ncbi_datasets_pyclient-18.4.0.dist-info → ncbi_datasets_pyclient-18.13.0.dist-info}/top_level.txt +0 -0
@@ -3,10 +3,9 @@
3
3
  """
4
4
  NCBI Datasets API
5
5
 
6
- ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The Datasets version 2 API is still in alpha, and we're updating it often to add new functionality, iron out bugs and enhance usability. For some larger downloads, you may want to download a [dehydrated zip archive](https://www.ncbi.nlm.nih.gov/datasets/docs/v2/how-tos/genomes/large-download/), and retrieve the individual data files at a later time.
6
+ ### NCBI Datasets is a resource that lets you easily gather data from NCBI. The NCBI Datasets version 2 API is updated often to add new features, fix bugs, and enhance usability.
7
7
 
8
8
  The version of the OpenAPI document: v2
9
- Contact: help@ncbi.nlm.nih.gov
10
9
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
10
 
12
11
  Do not edit the class manually.
@@ -379,9 +378,9 @@ class TaxonomyApi:
379
378
  _headers: Optional[Dict[StrictStr, Any]] = None,
380
379
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
381
380
  ) -> bytearray:
382
- """Get a taxonomy data package by tax_id
381
+ """Get a taxonomy data package by Taxonomy ID
383
382
 
384
- Download a taxonomy report and names data package.
383
+ Download a taxonomy data package, including taxonomy and names reports, as a compressed zip archive.
385
384
 
386
385
  :param v2_taxonomy_dataset_request: (required)
387
386
  :type v2_taxonomy_dataset_request: V2TaxonomyDatasetRequest
@@ -450,9 +449,9 @@ class TaxonomyApi:
450
449
  _headers: Optional[Dict[StrictStr, Any]] = None,
451
450
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
452
451
  ) -> ApiResponse[bytearray]:
453
- """Get a taxonomy data package by tax_id
452
+ """Get a taxonomy data package by Taxonomy ID
454
453
 
455
- Download a taxonomy report and names data package.
454
+ Download a taxonomy data package, including taxonomy and names reports, as a compressed zip archive.
456
455
 
457
456
  :param v2_taxonomy_dataset_request: (required)
458
457
  :type v2_taxonomy_dataset_request: V2TaxonomyDatasetRequest
@@ -521,9 +520,9 @@ class TaxonomyApi:
521
520
  _headers: Optional[Dict[StrictStr, Any]] = None,
522
521
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
523
522
  ) -> RESTResponseType:
524
- """Get a taxonomy data package by tax_id
523
+ """Get a taxonomy data package by Taxonomy ID
525
524
 
526
- Download a taxonomy report and names data package.
525
+ Download a taxonomy data package, including taxonomy and names reports, as a compressed zip archive.
527
526
 
528
527
  :param v2_taxonomy_dataset_request: (required)
529
528
  :type v2_taxonomy_dataset_request: V2TaxonomyDatasetRequest
@@ -656,7 +655,7 @@ class TaxonomyApi:
656
655
  @validate_call
657
656
  def tax_name_query(
658
657
  self,
659
- taxon_query: Annotated[StrictStr, Field(description="NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank")],
658
+ taxon_query: Annotated[StrictStr, Field(description="Taxid or name (common or scientific) at any taxonomic rank")],
660
659
  tax_rank_filter: Annotated[Optional[V2OrganismQueryRequestTaxRankFilter], Field(description="Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'")] = None,
661
660
  taxon_resource_filter: Annotated[Optional[V2OrganismQueryRequestTaxonResourceFilter], Field(description="Limit results to those with gene or genome counts (no filter by default)")] = None,
662
661
  exact_match: Annotated[Optional[StrictBool], Field(description="If true, only return results that exactly match the provided name or tax-id")] = None,
@@ -677,7 +676,7 @@ class TaxonomyApi:
677
676
 
678
677
  This endpoint retrieves a list of taxonomy names and IDs given a possibly partial taxonomic name of any rank.
679
678
 
680
- :param taxon_query: NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank (required)
679
+ :param taxon_query: Taxid or name (common or scientific) at any taxonomic rank (required)
681
680
  :type taxon_query: str
682
681
  :param tax_rank_filter: Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'
683
682
  :type tax_rank_filter: V2OrganismQueryRequestTaxRankFilter
@@ -735,7 +734,7 @@ class TaxonomyApi:
735
734
  @validate_call
736
735
  def tax_name_query_with_http_info(
737
736
  self,
738
- taxon_query: Annotated[StrictStr, Field(description="NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank")],
737
+ taxon_query: Annotated[StrictStr, Field(description="Taxid or name (common or scientific) at any taxonomic rank")],
739
738
  tax_rank_filter: Annotated[Optional[V2OrganismQueryRequestTaxRankFilter], Field(description="Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'")] = None,
740
739
  taxon_resource_filter: Annotated[Optional[V2OrganismQueryRequestTaxonResourceFilter], Field(description="Limit results to those with gene or genome counts (no filter by default)")] = None,
741
740
  exact_match: Annotated[Optional[StrictBool], Field(description="If true, only return results that exactly match the provided name or tax-id")] = None,
@@ -756,7 +755,7 @@ class TaxonomyApi:
756
755
 
757
756
  This endpoint retrieves a list of taxonomy names and IDs given a possibly partial taxonomic name of any rank.
758
757
 
759
- :param taxon_query: NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank (required)
758
+ :param taxon_query: Taxid or name (common or scientific) at any taxonomic rank (required)
760
759
  :type taxon_query: str
761
760
  :param tax_rank_filter: Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'
762
761
  :type tax_rank_filter: V2OrganismQueryRequestTaxRankFilter
@@ -814,7 +813,7 @@ class TaxonomyApi:
814
813
  @validate_call
815
814
  def tax_name_query_without_preload_content(
816
815
  self,
817
- taxon_query: Annotated[StrictStr, Field(description="NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank")],
816
+ taxon_query: Annotated[StrictStr, Field(description="Taxid or name (common or scientific) at any taxonomic rank")],
818
817
  tax_rank_filter: Annotated[Optional[V2OrganismQueryRequestTaxRankFilter], Field(description="Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'")] = None,
819
818
  taxon_resource_filter: Annotated[Optional[V2OrganismQueryRequestTaxonResourceFilter], Field(description="Limit results to those with gene or genome counts (no filter by default)")] = None,
820
819
  exact_match: Annotated[Optional[StrictBool], Field(description="If true, only return results that exactly match the provided name or tax-id")] = None,
@@ -835,7 +834,7 @@ class TaxonomyApi:
835
834
 
836
835
  This endpoint retrieves a list of taxonomy names and IDs given a possibly partial taxonomic name of any rank.
837
836
 
838
- :param taxon_query: NCBI Taxonomy ID or name (common or scientific) at any taxonomic rank (required)
837
+ :param taxon_query: Taxid or name (common or scientific) at any taxonomic rank (required)
839
838
  :type taxon_query: str
840
839
  :param tax_rank_filter: Set the scope of searched tax ranks when filtering by gene or genome. Not used for 'all'
841
840
  :type tax_rank_filter: V2OrganismQueryRequestTaxRankFilter
@@ -1247,8 +1246,8 @@ class TaxonomyApi:
1247
1246
  taxons: List[StrictStr],
1248
1247
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
1249
1248
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
1250
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
1251
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
1249
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
1250
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
1252
1251
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
1253
1252
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
1254
1253
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -1275,9 +1274,9 @@ class TaxonomyApi:
1275
1274
  :type returned_content: V2TaxonomyMetadataRequestContentType
1276
1275
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
1277
1276
  :type page_size: int
1278
- :param include_tabular_header: Whether this request for tabular data should include the header row
1277
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
1279
1278
  :type include_tabular_header: V2IncludeTabularHeader
1280
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
1279
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
1281
1280
  :type page_token: str
1282
1281
  :param table_format:
1283
1282
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -1342,8 +1341,8 @@ class TaxonomyApi:
1342
1341
  taxons: List[StrictStr],
1343
1342
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
1344
1343
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
1345
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
1346
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
1344
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
1345
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
1347
1346
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
1348
1347
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
1349
1348
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -1370,9 +1369,9 @@ class TaxonomyApi:
1370
1369
  :type returned_content: V2TaxonomyMetadataRequestContentType
1371
1370
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
1372
1371
  :type page_size: int
1373
- :param include_tabular_header: Whether this request for tabular data should include the header row
1372
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
1374
1373
  :type include_tabular_header: V2IncludeTabularHeader
1375
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
1374
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
1376
1375
  :type page_token: str
1377
1376
  :param table_format:
1378
1377
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -1437,8 +1436,8 @@ class TaxonomyApi:
1437
1436
  taxons: List[StrictStr],
1438
1437
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
1439
1438
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
1440
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
1441
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
1439
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
1440
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
1442
1441
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
1443
1442
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
1444
1443
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -1465,9 +1464,9 @@ class TaxonomyApi:
1465
1464
  :type returned_content: V2TaxonomyMetadataRequestContentType
1466
1465
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
1467
1466
  :type page_size: int
1468
- :param include_tabular_header: Whether this request for tabular data should include the header row
1467
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
1469
1468
  :type include_tabular_header: V2IncludeTabularHeader
1470
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
1469
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
1471
1470
  :type page_token: str
1472
1471
  :param table_format:
1473
1472
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -1643,9 +1642,9 @@ class TaxonomyApi:
1643
1642
  _headers: Optional[Dict[StrictStr, Any]] = None,
1644
1643
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1645
1644
  ) -> V2reportsTaxonomyDataReportPage:
1646
- """Use taxonomic identifiers to get taxonomic names data report by post
1645
+ """Get a taxonomy data report by taxon
1647
1646
 
1648
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
1647
+ Get a taxonomy data report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.
1649
1648
 
1650
1649
  :param v2_taxonomy_metadata_request: (required)
1651
1650
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -1710,9 +1709,9 @@ class TaxonomyApi:
1710
1709
  _headers: Optional[Dict[StrictStr, Any]] = None,
1711
1710
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1712
1711
  ) -> ApiResponse[V2reportsTaxonomyDataReportPage]:
1713
- """Use taxonomic identifiers to get taxonomic names data report by post
1712
+ """Get a taxonomy data report by taxon
1714
1713
 
1715
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
1714
+ Get a taxonomy data report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.
1716
1715
 
1717
1716
  :param v2_taxonomy_metadata_request: (required)
1718
1717
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -1777,9 +1776,9 @@ class TaxonomyApi:
1777
1776
  _headers: Optional[Dict[StrictStr, Any]] = None,
1778
1777
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1779
1778
  ) -> RESTResponseType:
1780
- """Use taxonomic identifiers to get taxonomic names data report by post
1779
+ """Get a taxonomy data report by taxon
1781
1780
 
1782
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
1781
+ Get a taxonomy data report by taxon. By default, in paged JSON format, but also available in tabular (accept: text/tab-separated-values) or JSON Lines (accept: application/x-ndjson) formats.
1783
1782
 
1784
1783
  :param v2_taxonomy_metadata_request: (required)
1785
1784
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -1907,8 +1906,8 @@ class TaxonomyApi:
1907
1906
  def taxonomy_filtered_subtree(
1908
1907
  self,
1909
1908
  taxons: List[StrictStr],
1910
- specified_limit: Annotated[Optional[StrictBool], Field(description="Limit to specified species")] = None,
1911
1909
  rank_limits: Annotated[Optional[List[V2reportsRankType]], Field(description="Limit to the provided ranks. If empty, accept any rank.")] = None,
1910
+ include_incertae_sedis: Annotated[Optional[StrictBool], Field(description="Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).")] = None,
1912
1911
  _request_timeout: Union[
1913
1912
  None,
1914
1913
  Annotated[StrictFloat, Field(gt=0)],
@@ -1928,10 +1927,10 @@ class TaxonomyApi:
1928
1927
 
1929
1928
  :param taxons: (required)
1930
1929
  :type taxons: List[str]
1931
- :param specified_limit: Limit to specified species
1932
- :type specified_limit: bool
1933
1930
  :param rank_limits: Limit to the provided ranks. If empty, accept any rank.
1934
1931
  :type rank_limits: List[V2reportsRankType]
1932
+ :param include_incertae_sedis: Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).
1933
+ :type include_incertae_sedis: bool
1935
1934
  :param _request_timeout: timeout setting for this request. If one
1936
1935
  number provided, it will be total request
1937
1936
  timeout. It can also be a pair (tuple) of
@@ -1956,8 +1955,8 @@ class TaxonomyApi:
1956
1955
 
1957
1956
  _param = self._taxonomy_filtered_subtree_serialize(
1958
1957
  taxons=taxons,
1959
- specified_limit=specified_limit,
1960
1958
  rank_limits=rank_limits,
1959
+ include_incertae_sedis=include_incertae_sedis,
1961
1960
  _request_auth=_request_auth,
1962
1961
  _content_type=_content_type,
1963
1962
  _headers=_headers,
@@ -1982,8 +1981,8 @@ class TaxonomyApi:
1982
1981
  def taxonomy_filtered_subtree_with_http_info(
1983
1982
  self,
1984
1983
  taxons: List[StrictStr],
1985
- specified_limit: Annotated[Optional[StrictBool], Field(description="Limit to specified species")] = None,
1986
1984
  rank_limits: Annotated[Optional[List[V2reportsRankType]], Field(description="Limit to the provided ranks. If empty, accept any rank.")] = None,
1985
+ include_incertae_sedis: Annotated[Optional[StrictBool], Field(description="Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).")] = None,
1987
1986
  _request_timeout: Union[
1988
1987
  None,
1989
1988
  Annotated[StrictFloat, Field(gt=0)],
@@ -2003,10 +2002,10 @@ class TaxonomyApi:
2003
2002
 
2004
2003
  :param taxons: (required)
2005
2004
  :type taxons: List[str]
2006
- :param specified_limit: Limit to specified species
2007
- :type specified_limit: bool
2008
2005
  :param rank_limits: Limit to the provided ranks. If empty, accept any rank.
2009
2006
  :type rank_limits: List[V2reportsRankType]
2007
+ :param include_incertae_sedis: Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).
2008
+ :type include_incertae_sedis: bool
2010
2009
  :param _request_timeout: timeout setting for this request. If one
2011
2010
  number provided, it will be total request
2012
2011
  timeout. It can also be a pair (tuple) of
@@ -2031,8 +2030,8 @@ class TaxonomyApi:
2031
2030
 
2032
2031
  _param = self._taxonomy_filtered_subtree_serialize(
2033
2032
  taxons=taxons,
2034
- specified_limit=specified_limit,
2035
2033
  rank_limits=rank_limits,
2034
+ include_incertae_sedis=include_incertae_sedis,
2036
2035
  _request_auth=_request_auth,
2037
2036
  _content_type=_content_type,
2038
2037
  _headers=_headers,
@@ -2057,8 +2056,8 @@ class TaxonomyApi:
2057
2056
  def taxonomy_filtered_subtree_without_preload_content(
2058
2057
  self,
2059
2058
  taxons: List[StrictStr],
2060
- specified_limit: Annotated[Optional[StrictBool], Field(description="Limit to specified species")] = None,
2061
2059
  rank_limits: Annotated[Optional[List[V2reportsRankType]], Field(description="Limit to the provided ranks. If empty, accept any rank.")] = None,
2060
+ include_incertae_sedis: Annotated[Optional[StrictBool], Field(description="Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).")] = None,
2062
2061
  _request_timeout: Union[
2063
2062
  None,
2064
2063
  Annotated[StrictFloat, Field(gt=0)],
@@ -2078,10 +2077,10 @@ class TaxonomyApi:
2078
2077
 
2079
2078
  :param taxons: (required)
2080
2079
  :type taxons: List[str]
2081
- :param specified_limit: Limit to specified species
2082
- :type specified_limit: bool
2083
2080
  :param rank_limits: Limit to the provided ranks. If empty, accept any rank.
2084
2081
  :type rank_limits: List[V2reportsRankType]
2082
+ :param include_incertae_sedis: Include nodes with ranks not in 'rank_limits' if their names meet criteria for incertae sedis (of unknown origin).
2083
+ :type include_incertae_sedis: bool
2085
2084
  :param _request_timeout: timeout setting for this request. If one
2086
2085
  number provided, it will be total request
2087
2086
  timeout. It can also be a pair (tuple) of
@@ -2106,8 +2105,8 @@ class TaxonomyApi:
2106
2105
 
2107
2106
  _param = self._taxonomy_filtered_subtree_serialize(
2108
2107
  taxons=taxons,
2109
- specified_limit=specified_limit,
2110
2108
  rank_limits=rank_limits,
2109
+ include_incertae_sedis=include_incertae_sedis,
2111
2110
  _request_auth=_request_auth,
2112
2111
  _content_type=_content_type,
2113
2112
  _headers=_headers,
@@ -2127,8 +2126,8 @@ class TaxonomyApi:
2127
2126
  def _taxonomy_filtered_subtree_serialize(
2128
2127
  self,
2129
2128
  taxons,
2130
- specified_limit,
2131
2129
  rank_limits,
2130
+ include_incertae_sedis,
2132
2131
  _request_auth,
2133
2132
  _content_type,
2134
2133
  _headers,
@@ -2155,14 +2154,14 @@ class TaxonomyApi:
2155
2154
  if taxons is not None:
2156
2155
  _path_params['taxons'] = taxons
2157
2156
  # process the query parameters
2158
- if specified_limit is not None:
2159
-
2160
- _query_params.append(('specified_limit', specified_limit))
2161
-
2162
2157
  if rank_limits is not None:
2163
2158
 
2164
2159
  _query_params.append(('rank_limits', rank_limits))
2165
2160
 
2161
+ if include_incertae_sedis is not None:
2162
+
2163
+ _query_params.append(('include_incertae_sedis', include_incertae_sedis))
2164
+
2166
2165
  # process the header parameters
2167
2166
  # process the form parameters
2168
2167
  # process the body parameter
@@ -2218,9 +2217,9 @@ class TaxonomyApi:
2218
2217
  _headers: Optional[Dict[StrictStr, Any]] = None,
2219
2218
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2220
2219
  ) -> V2TaxonomyFilteredSubtreeResponse:
2221
- """Use taxonomic identifiers to get a filtered taxonomic subtree by post
2220
+ """Get a filtered taxonomic subtree by taxon
2222
2221
 
2223
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get a filtered taxonomic subtree that includes the full parent lineage and all immediate children from the selected taxonomic ranks in JSON format.
2222
+ Get a filtered taxonomic subtree, including parent and child nodes, in JSON format.
2224
2223
 
2225
2224
  :param v2_taxonomy_filtered_subtree_request: (required)
2226
2225
  :type v2_taxonomy_filtered_subtree_request: V2TaxonomyFilteredSubtreeRequest
@@ -2285,9 +2284,9 @@ class TaxonomyApi:
2285
2284
  _headers: Optional[Dict[StrictStr, Any]] = None,
2286
2285
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2287
2286
  ) -> ApiResponse[V2TaxonomyFilteredSubtreeResponse]:
2288
- """Use taxonomic identifiers to get a filtered taxonomic subtree by post
2287
+ """Get a filtered taxonomic subtree by taxon
2289
2288
 
2290
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get a filtered taxonomic subtree that includes the full parent lineage and all immediate children from the selected taxonomic ranks in JSON format.
2289
+ Get a filtered taxonomic subtree, including parent and child nodes, in JSON format.
2291
2290
 
2292
2291
  :param v2_taxonomy_filtered_subtree_request: (required)
2293
2292
  :type v2_taxonomy_filtered_subtree_request: V2TaxonomyFilteredSubtreeRequest
@@ -2352,9 +2351,9 @@ class TaxonomyApi:
2352
2351
  _headers: Optional[Dict[StrictStr, Any]] = None,
2353
2352
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2354
2353
  ) -> RESTResponseType:
2355
- """Use taxonomic identifiers to get a filtered taxonomic subtree by post
2354
+ """Get a filtered taxonomic subtree by taxon
2356
2355
 
2357
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get a filtered taxonomic subtree that includes the full parent lineage and all immediate children from the selected taxonomic ranks in JSON format.
2356
+ Get a filtered taxonomic subtree, including parent and child nodes, in JSON format.
2358
2357
 
2359
2358
  :param v2_taxonomy_filtered_subtree_request: (required)
2360
2359
  :type v2_taxonomy_filtered_subtree_request: V2TaxonomyFilteredSubtreeRequest
@@ -2494,9 +2493,9 @@ class TaxonomyApi:
2494
2493
  _headers: Optional[Dict[StrictStr, Any]] = None,
2495
2494
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2496
2495
  ) -> bytearray:
2497
- """Retrieve image associated with a taxonomic identifier
2496
+ """Get a taxonomy image by taxon
2498
2497
 
2499
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
2498
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
2500
2499
 
2501
2500
  :param taxon: (required)
2502
2501
  :type taxon: str
@@ -2565,9 +2564,9 @@ class TaxonomyApi:
2565
2564
  _headers: Optional[Dict[StrictStr, Any]] = None,
2566
2565
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2567
2566
  ) -> ApiResponse[bytearray]:
2568
- """Retrieve image associated with a taxonomic identifier
2567
+ """Get a taxonomy image by taxon
2569
2568
 
2570
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
2569
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
2571
2570
 
2572
2571
  :param taxon: (required)
2573
2572
  :type taxon: str
@@ -2636,9 +2635,9 @@ class TaxonomyApi:
2636
2635
  _headers: Optional[Dict[StrictStr, Any]] = None,
2637
2636
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2638
2637
  ) -> RESTResponseType:
2639
- """Retrieve image associated with a taxonomic identifier
2638
+ """Get a taxonomy image by taxon
2640
2639
 
2641
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
2640
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
2642
2641
 
2643
2642
  :param taxon: (required)
2644
2643
  :type taxon: str
@@ -3313,9 +3312,9 @@ class TaxonomyApi:
3313
3312
  _headers: Optional[Dict[StrictStr, Any]] = None,
3314
3313
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3315
3314
  ) -> bytearray:
3316
- """Retrieve image associated with a taxonomic identifier by post
3315
+ """Get a taxonomy image by taxon
3317
3316
 
3318
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
3317
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
3319
3318
 
3320
3319
  :param v2_taxonomy_image_request: (required)
3321
3320
  :type v2_taxonomy_image_request: V2TaxonomyImageRequest
@@ -3380,9 +3379,9 @@ class TaxonomyApi:
3380
3379
  _headers: Optional[Dict[StrictStr, Any]] = None,
3381
3380
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3382
3381
  ) -> ApiResponse[bytearray]:
3383
- """Retrieve image associated with a taxonomic identifier by post
3382
+ """Get a taxonomy image by taxon
3384
3383
 
3385
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
3384
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
3386
3385
 
3387
3386
  :param v2_taxonomy_image_request: (required)
3388
3387
  :type v2_taxonomy_image_request: V2TaxonomyImageRequest
@@ -3447,9 +3446,9 @@ class TaxonomyApi:
3447
3446
  _headers: Optional[Dict[StrictStr, Any]] = None,
3448
3447
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3449
3448
  ) -> RESTResponseType:
3450
- """Retrieve image associated with a taxonomic identifier by post
3449
+ """Get a taxonomy image by taxon
3451
3450
 
3452
- Using an NCBI Taxonomy ID or a name (common or scientific) at any rank, get the image associated with the taxon.
3451
+ Get an image associated with the specified taxon. By default, in JPEG format, but also available in PNG (accept: image/png), TIFF (accept: accept: image/tiff), and SVG+XML (accept: image/svg+xml) formats.
3453
3452
 
3454
3453
  :param v2_taxonomy_image_request: (required)
3455
3454
  :type v2_taxonomy_image_request: V2TaxonomyImageRequest
@@ -4117,8 +4116,8 @@ class TaxonomyApi:
4117
4116
  taxons: List[StrictStr],
4118
4117
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4119
4118
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4120
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4121
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4119
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4120
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4122
4121
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4123
4122
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4124
4123
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4135,7 +4134,7 @@ class TaxonomyApi:
4135
4134
  _headers: Optional[Dict[StrictStr, Any]] = None,
4136
4135
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4137
4136
  ) -> V2TaxonomyMetadataResponse:
4138
- """Use taxonomic identifiers to get taxonomic metadata
4137
+ """Use taxonomic identifiers to get taxonomic metadata (deprecated)
4139
4138
 
4140
4139
  Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4141
4140
 
@@ -4145,9 +4144,9 @@ class TaxonomyApi:
4145
4144
  :type returned_content: V2TaxonomyMetadataRequestContentType
4146
4145
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4147
4146
  :type page_size: int
4148
- :param include_tabular_header: Whether this request for tabular data should include the header row
4147
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4149
4148
  :type include_tabular_header: V2IncludeTabularHeader
4150
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4149
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4151
4150
  :type page_token: str
4152
4151
  :param table_format:
4153
4152
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -4212,8 +4211,8 @@ class TaxonomyApi:
4212
4211
  taxons: List[StrictStr],
4213
4212
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4214
4213
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4215
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4216
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4214
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4215
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4217
4216
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4218
4217
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4219
4218
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4230,7 +4229,7 @@ class TaxonomyApi:
4230
4229
  _headers: Optional[Dict[StrictStr, Any]] = None,
4231
4230
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4232
4231
  ) -> ApiResponse[V2TaxonomyMetadataResponse]:
4233
- """Use taxonomic identifiers to get taxonomic metadata
4232
+ """Use taxonomic identifiers to get taxonomic metadata (deprecated)
4234
4233
 
4235
4234
  Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4236
4235
 
@@ -4240,9 +4239,9 @@ class TaxonomyApi:
4240
4239
  :type returned_content: V2TaxonomyMetadataRequestContentType
4241
4240
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4242
4241
  :type page_size: int
4243
- :param include_tabular_header: Whether this request for tabular data should include the header row
4242
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4244
4243
  :type include_tabular_header: V2IncludeTabularHeader
4245
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4244
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4246
4245
  :type page_token: str
4247
4246
  :param table_format:
4248
4247
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -4307,8 +4306,8 @@ class TaxonomyApi:
4307
4306
  taxons: List[StrictStr],
4308
4307
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4309
4308
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4310
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4311
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4309
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4310
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4312
4311
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4313
4312
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4314
4313
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4325,7 +4324,7 @@ class TaxonomyApi:
4325
4324
  _headers: Optional[Dict[StrictStr, Any]] = None,
4326
4325
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4327
4326
  ) -> RESTResponseType:
4328
- """Use taxonomic identifiers to get taxonomic metadata
4327
+ """Use taxonomic identifiers to get taxonomic metadata (deprecated)
4329
4328
 
4330
4329
  Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4331
4330
 
@@ -4335,9 +4334,9 @@ class TaxonomyApi:
4335
4334
  :type returned_content: V2TaxonomyMetadataRequestContentType
4336
4335
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4337
4336
  :type page_size: int
4338
- :param include_tabular_header: Whether this request for tabular data should include the header row
4337
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4339
4338
  :type include_tabular_header: V2IncludeTabularHeader
4340
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4339
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4341
4340
  :type page_token: str
4342
4341
  :param table_format:
4343
4342
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -4511,9 +4510,9 @@ class TaxonomyApi:
4511
4510
  _headers: Optional[Dict[StrictStr, Any]] = None,
4512
4511
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4513
4512
  ) -> V2TaxonomyMetadataResponse:
4514
- """Use taxonomic identifiers to get taxonomic metadata by post
4513
+ """Get taxonomy metadata by taxon (deprecated)
4515
4514
 
4516
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4515
+ Get taxonomy metadata by taxon in JSON format.
4517
4516
 
4518
4517
  :param v2_taxonomy_metadata_request: (required)
4519
4518
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -4578,9 +4577,9 @@ class TaxonomyApi:
4578
4577
  _headers: Optional[Dict[StrictStr, Any]] = None,
4579
4578
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4580
4579
  ) -> ApiResponse[V2TaxonomyMetadataResponse]:
4581
- """Use taxonomic identifiers to get taxonomic metadata by post
4580
+ """Get taxonomy metadata by taxon (deprecated)
4582
4581
 
4583
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4582
+ Get taxonomy metadata by taxon in JSON format.
4584
4583
 
4585
4584
  :param v2_taxonomy_metadata_request: (required)
4586
4585
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -4645,9 +4644,9 @@ class TaxonomyApi:
4645
4644
  _headers: Optional[Dict[StrictStr, Any]] = None,
4646
4645
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4647
4646
  ) -> RESTResponseType:
4648
- """Use taxonomic identifiers to get taxonomic metadata by post
4647
+ """Get taxonomy metadata by taxon (deprecated)
4649
4648
 
4650
- Using NCBI Taxonomy IDs or names (common or scientific) at any rank, get metadata about a taxonomic node including taxonomic identifiers, lineage information, child nodes, and gene and genome counts in JSON format.
4649
+ Get taxonomy metadata by taxon in JSON format.
4651
4650
 
4652
4651
  :param v2_taxonomy_metadata_request: (required)
4653
4652
  :type v2_taxonomy_metadata_request: V2TaxonomyMetadataRequest
@@ -4775,8 +4774,8 @@ class TaxonomyApi:
4775
4774
  taxons: List[StrictStr],
4776
4775
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4777
4776
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4778
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4779
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4777
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4778
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4780
4779
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4781
4780
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4782
4781
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4803,9 +4802,9 @@ class TaxonomyApi:
4803
4802
  :type returned_content: V2TaxonomyMetadataRequestContentType
4804
4803
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4805
4804
  :type page_size: int
4806
- :param include_tabular_header: Whether this request for tabular data should include the header row
4805
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4807
4806
  :type include_tabular_header: V2IncludeTabularHeader
4808
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4807
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4809
4808
  :type page_token: str
4810
4809
  :param table_format:
4811
4810
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -4870,8 +4869,8 @@ class TaxonomyApi:
4870
4869
  taxons: List[StrictStr],
4871
4870
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4872
4871
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4873
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4874
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4872
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4873
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4875
4874
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4876
4875
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4877
4876
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4898,9 +4897,9 @@ class TaxonomyApi:
4898
4897
  :type returned_content: V2TaxonomyMetadataRequestContentType
4899
4898
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4900
4899
  :type page_size: int
4901
- :param include_tabular_header: Whether this request for tabular data should include the header row
4900
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4902
4901
  :type include_tabular_header: V2IncludeTabularHeader
4903
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4902
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4904
4903
  :type page_token: str
4905
4904
  :param table_format:
4906
4905
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -4965,8 +4964,8 @@ class TaxonomyApi:
4965
4964
  taxons: List[StrictStr],
4966
4965
  returned_content: Annotated[Optional[V2TaxonomyMetadataRequestContentType], Field(description="Return either tax-ids alone, or entire taxononmy-metadata records")] = None,
4967
4966
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
4968
- include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Whether this request for tabular data should include the header row")] = None,
4969
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.")] = None,
4967
+ include_tabular_header: Annotated[Optional[V2IncludeTabularHeader], Field(description="Specify when to include the table header when requesting a tabular report.")] = None,
4968
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
4970
4969
  table_format: Optional[V2TaxonomyMetadataRequestTableFormat] = None,
4971
4970
  children: Annotated[Optional[StrictBool], Field(description="Flag for tax explosion.")] = None,
4972
4971
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
@@ -4993,9 +4992,9 @@ class TaxonomyApi:
4993
4992
  :type returned_content: V2TaxonomyMetadataRequestContentType
4994
4993
  :param page_size: The maximum number of taxons to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
4995
4994
  :type page_size: int
4996
- :param include_tabular_header: Whether this request for tabular data should include the header row
4995
+ :param include_tabular_header: Specify when to include the table header when requesting a tabular report.
4997
4996
  :type include_tabular_header: V2IncludeTabularHeader
4998
- :param page_token: A page token is returned from `GetTaxonomyDataReportFor` and `GetTaxonomyNamesDataReportFor` calls with more than `page_size` results. When `page_token` is empty, all results have been retrieved.
4997
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
4999
4998
  :type page_token: str
5000
4999
  :param table_format:
5001
5000
  :type table_format: V2TaxonomyMetadataRequestTableFormat
@@ -5435,7 +5434,7 @@ class TaxonomyApi:
5435
5434
  include_subtree: Annotated[Optional[StrictBool], Field(description="This field is deprecated because all requests include the subtree, so it has no effect")] = None,
5436
5435
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
5437
5436
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
5438
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5437
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5439
5438
  _request_timeout: Union[
5440
5439
  None,
5441
5440
  Annotated[StrictFloat, Field(gt=0)],
@@ -5463,7 +5462,7 @@ class TaxonomyApi:
5463
5462
  :type ranks: List[V2reportsRankType]
5464
5463
  :param page_size: The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
5465
5464
  :type page_size: int
5466
- :param page_token: A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5465
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5467
5466
  :type page_token: str
5468
5467
  :param _request_timeout: timeout setting for this request. If one
5469
5468
  number provided, it will be total request
@@ -5522,7 +5521,7 @@ class TaxonomyApi:
5522
5521
  include_subtree: Annotated[Optional[StrictBool], Field(description="This field is deprecated because all requests include the subtree, so it has no effect")] = None,
5523
5522
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
5524
5523
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
5525
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5524
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5526
5525
  _request_timeout: Union[
5527
5526
  None,
5528
5527
  Annotated[StrictFloat, Field(gt=0)],
@@ -5550,7 +5549,7 @@ class TaxonomyApi:
5550
5549
  :type ranks: List[V2reportsRankType]
5551
5550
  :param page_size: The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
5552
5551
  :type page_size: int
5553
- :param page_token: A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5552
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5554
5553
  :type page_token: str
5555
5554
  :param _request_timeout: timeout setting for this request. If one
5556
5555
  number provided, it will be total request
@@ -5609,7 +5608,7 @@ class TaxonomyApi:
5609
5608
  include_subtree: Annotated[Optional[StrictBool], Field(description="This field is deprecated because all requests include the subtree, so it has no effect")] = None,
5610
5609
  ranks: Annotated[Optional[List[V2reportsRankType]], Field(description="Only include taxons of the provided ranks. If empty, return all ranks.")] = None,
5611
5610
  page_size: Annotated[Optional[StrictInt], Field(description="The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.")] = None,
5612
- page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5611
+ page_token: Annotated[Optional[StrictStr], Field(description="A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.")] = None,
5613
5612
  _request_timeout: Union[
5614
5613
  None,
5615
5614
  Annotated[StrictFloat, Field(gt=0)],
@@ -5637,7 +5636,7 @@ class TaxonomyApi:
5637
5636
  :type ranks: List[V2reportsRankType]
5638
5637
  :param page_size: The maximum number of taxids to return. Default is 20 and maximum is 1000. If the number of results exceeds the page size, `page_token` can be used to retrieve the remaining results.
5639
5638
  :type page_size: int
5640
- :param page_token: A page token is returned from a `GetRelatedTaxids` call with more than `page_size` results. Use this token, along with the previous `TaxonomyRelatedIdRequest` parameters, to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5639
+ :param page_token: A page token is returned when the results count exceeds `page size`. Use this token along with previous request parameters to retrieve the next page of results. When `page_token` is empty, all results have been retrieved.
5641
5640
  :type page_token: str
5642
5641
  :param _request_timeout: timeout setting for this request. If one
5643
5642
  number provided, it will be total request