npm package: @hra-api/ts-client
Description: OpenAPI client for @hra-api/ts-client
Author: OpenAPI-Generator
Latest version: 0.19.0

# @hra-api/ts-client@0.19.0

A TypeScript SDK client for the apps.humanatlas.io API.

## Usage

First, install the SDK from npm.

```bash
npm install @hra-api/ts-client --save
```

Next, try it out.


```ts
import {
  Configuration,
  DsGraphApi,
} from '@hra-api/ts-client';
import type { AtlasD2kRequest } from '@hra-api/ts-client';

async function example() {
  console.log("🚀 Testing @hra-api/ts-client SDK...");
  const api = new DsGraphApi();

  const body = {
    // string | Authentication token to use for authenticated searches (optional)
    token: token_example,
  } satisfies AtlasD2kRequest;

  try {
    const data = await api.atlasD2k(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);
```


## Documentation

### API Endpoints

All URIs are relative to *https://apps.humanatlas.io/api*

| Class | Method | HTTP request | Description
| ----- | ------ | ------------ | -------------
*DsGraphApi* | [**atlasD2k**](docs/DsGraphApi.md#atlasd2k) | **GET** /ds-graph/atlas-d2k | Get Atlas D2K Dataset Graph
*DsGraphApi* | [**gtex**](docs/DsGraphApi.md#gtex) | **GET** /ds-graph/gtex | Get GTEx Dataset Graph
*DsGraphApi* | [**hubmap**](docs/DsGraphApi.md#hubmap) | **GET** /ds-graph/hubmap | Get HuBMAP Dataset Graph
*DsGraphApi* | [**sennet**](docs/DsGraphApi.md#sennet) | **GET** /ds-graph/sennet | Get SenNet Dataset Graph
*HraKgApi* | [**asctbTermOccurences**](docs/HraKgApi.md#asctbtermoccurences) | **GET** /kg/asctb-term-occurences | Get number of ASCT+B term occurrences for a search
*HraKgApi* | [**digitalObjects**](docs/HraKgApi.md#digitalobjects) | **GET** /kg/digital-objects | List all digital objects in the HRA KG
*HraKgApi* | [**doSearch**](docs/HraKgApi.md#dosearch) | **GET** /kg/do-search | Search for Digital Object PURLs
*HraPopApi* | [**cellSummaryReport**](docs/HraPopApi.md#cellsummaryreportoperation) | **POST** /hra-pop/cell-summary-report | Given a cell summary in csv format, retrieve a predicted cell summary report from HRApop showing relative anatomical structures, datasets, and rui locations.
*HraPopApi* | [**ruiLocationCellSummary**](docs/HraPopApi.md#ruilocationcellsummary) | **POST** /hra-pop/rui-location-cell-summary | Given a SpatialEntity already placed relative to a reference SpatialEntity, retrieve a predicted cell summary from HRApop
*HraPopApi* | [**supportedOrgans**](docs/HraPopApi.md#supportedorgans) | **GET** /hra-pop/supported-organs | Get all organs supported by HRApop
*HraPopApi* | [**supportedReferenceOrgans**](docs/HraPopApi.md#supportedreferenceorgans) | **GET** /hra-pop/supported-reference-organs | Get all reference organs supported by HRApop
*HraPopApi* | [**supportedTools**](docs/HraPopApi.md#supportedtools) | **GET** /hra-pop/supported-tools | Get all tools supported by HRApop
*V1Api* | [**aggregateResults**](docs/V1Api.md#aggregateresults) | **GET** /v1/aggregate-results | Get aggregate results / statistics
*V1Api* | [**anatomicalSystemsTreeModel**](docs/V1Api.md#anatomicalsystemstreemodel) | **GET** /v1/anatomical-systems-tree-model | Get anatomical systems partonomy tree nodes
*V1Api* | [**asctbOmapSheetConfig**](docs/V1Api.md#asctbomapsheetconfig) | **GET** /v1/asctb-omap-sheet-config | Get OMAP sheet config data for the ASCT+B Reporter
*V1Api* | [**asctbSheetConfig**](docs/V1Api.md#asctbsheetconfig) | **GET** /v1/asctb-sheet-config | Get sheet config data for the ASCT+B Reporter
*V1Api* | [**biomarkerTermOccurences**](docs/V1Api.md#biomarkertermoccurences) | **GET** /v1/biomarker-term-occurences | Get number of biomarker type term occurrences for a search
*V1Api* | [**biomarkerTreeModel**](docs/V1Api.md#biomarkertreemodel) | **GET** /v1/biomarker-tree-model | Get biomarker tree nodes
*V1Api* | [**cellTypeTermOccurences**](docs/V1Api.md#celltypetermoccurences) | **GET** /v1/cell-type-term-occurences | Get number of cell type term occurrences for a search
*V1Api* | [**cellTypeTreeModel**](docs/V1Api.md#celltypetreemodel) | **GET** /v1/cell-type-tree-model | Get cell type tree nodes
*V1Api* | [**collisions**](docs/V1Api.md#collisions) | **POST** /v1/collisions | Given an extraction site, get mesh-based collisions with the reference organ.
*V1Api* | [**consortiumNames**](docs/V1Api.md#consortiumnames) | **GET** /v1/consortium-names | Get consortium names (for filtering)
*V1Api* | [**corridor**](docs/V1Api.md#corridor) | **POST** /v1/corridor | Given an extraction site, generate a corridor with the reference organ.
*V1Api* | [**dbStatus**](docs/V1Api.md#dbstatus) | **GET** /v1/db-status | Get current status of database
*V1Api* | [**dsGraph**](docs/V1Api.md#dsgraph) | **GET** /v1/ds-graph | Get dataset graph
*V1Api* | [**extractionSite**](docs/V1Api.md#extractionsite) | **GET** /v1/extraction-site | Lookup Extraction Site
*V1Api* | [**ftuIllustrations**](docs/V1Api.md#ftuillustrations) | **GET** /v1/ftu-illustrations | Get 2D FTU Illustration data
*V1Api* | [**getSpatialPlacement**](docs/V1Api.md#getspatialplacementoperation) | **POST** /v1/get-spatial-placement | Given a SpatialEntity already placed relative to a reference SpatialEntity, retrieve a new direct SpatialPlacement to the given SpatialEntity IRI
*V1Api* | [**gtexRuiLocations**](docs/V1Api.md#gtexruilocations) | **GET** /v1/gtex/rui_locations.jsonld | Get all GTEx rui locations (if enabled)
*V1Api* | [**hubmapRuiLocations**](docs/V1Api.md#hubmapruilocations) | **GET** /v1/hubmap/rui_locations.jsonld | Get all hubmap rui locations (if enabled)
*V1Api* | [**mesh3dCellPopulation**](docs/V1Api.md#mesh3dcellpopulationoperation) | **POST** /v1/mesh-3d-cell-population | Given a reference organ, 3d scene node, and cell population,  generate cells in that distribution to fit in that 3d scene node.
*V1Api* | [**ontologyTermOccurences**](docs/V1Api.md#ontologytermoccurences) | **GET** /v1/ontology-term-occurences | Get number of ontology term occurrences for a search
*V1Api* | [**ontologyTreeModel**](docs/V1Api.md#ontologytreemodel) | **GET** /v1/ontology-tree-model | Get ontology term tree nodes
*V1Api* | [**providerNames**](docs/V1Api.md#providernames) | **GET** /v1/provider-names | Get tissue provider names (for filtering)
*V1Api* | [**referenceOrganScene**](docs/V1Api.md#referenceorganscene) | **GET** /v1/reference-organ-scene | Get all nodes to form the 3D scene for an organ
*V1Api* | [**referenceOrgans**](docs/V1Api.md#referenceorgans) | **GET** /v1/reference-organs | Get all reference organs
*V1Api* | [**ruiReferenceData**](docs/V1Api.md#ruireferencedata) | **GET** /v1/rui-reference-data | Get reference data for the RUI tool
*V1Api* | [**scene**](docs/V1Api.md#scene) | **GET** /v1/scene | Get all nodes to form the 3D scene of reference body, organs, and tissues
*V1Api* | [**sennetRuiLocations**](docs/V1Api.md#sennetruilocations) | **GET** /v1/sennet/rui_locations.jsonld | Get all sennet rui locations (if enabled)
*V1Api* | [**sessionToken**](docs/V1Api.md#sessiontokenoperation) | **POST** /v1/session-token | Get a session token
*V1Api* | [**sparql**](docs/V1Api.md#sparql) | **GET** /v1/sparql | Run a SPARQL query
*V1Api* | [**sparqlPost**](docs/V1Api.md#sparqlpost) | **POST** /v1/sparql | Run a SPARQL query (POST)
*V1Api* | [**technologyNames**](docs/V1Api.md#technologynames) | **GET** /v1/technology-names | Get technology names (for filtering)
*V1Api* | [**tissueBlocks**](docs/V1Api.md#tissueblocks) | **GET** /v1/tissue-blocks | Get Tissue Block Results


### Models

- [AggregateCount](docs/AggregateCount.md)
- [CellSummaryReport](docs/CellSummaryReport.md)
- [CellSummaryReportRequest](docs/CellSummaryReportRequest.md)
- [CellSummaryRow](docs/CellSummaryRow.md)
- [DatabaseStatus](docs/DatabaseStatus.md)
- [DigitalObjectInfo](docs/DigitalObjectInfo.md)
- [DigitalObjectsJsonLd](docs/DigitalObjectsJsonLd.md)
- [ErrorMessage](docs/ErrorMessage.md)
- [ErrorMessageObject](docs/ErrorMessageObject.md)
- [Filter](docs/Filter.md)
- [FlatSpatialPlacement](docs/FlatSpatialPlacement.md)
- [GetSpatialPlacementRequest](docs/GetSpatialPlacementRequest.md)
- [IdLabelPair](docs/IdLabelPair.md)
- [JsonLdObject](docs/JsonLdObject.md)
- [Mesh3dCellPopulationRequest](docs/Mesh3dCellPopulationRequest.md)
- [MinMax](docs/MinMax.md)
- [MinMaxArray](docs/MinMaxArray.md)
- [OntologyTree](docs/OntologyTree.md)
- [OntologyTreeNode](docs/OntologyTreeNode.md)
- [Rgba](docs/Rgba.md)
- [SessionToken](docs/SessionToken.md)
- [SessionTokenRequest](docs/SessionTokenRequest.md)
- [SourceSimilarityRow](docs/SourceSimilarityRow.md)
- [SpacialPlacementSource](docs/SpacialPlacementSource.md)
- [SpacialPlacementTarget](docs/SpacialPlacementTarget.md)
- [SparqlQueryRequest](docs/SparqlQueryRequest.md)
- [SpatialEntity](docs/SpatialEntity.md)
- [SpatialEntityCommon](docs/SpatialEntityCommon.md)
- [SpatialEntityCreator](docs/SpatialEntityCreator.md)
- [SpatialEntityDimensions](docs/SpatialEntityDimensions.md)
- [SpatialEntityPlacement](docs/SpatialEntityPlacement.md)
- [SpatialObjectReference](docs/SpatialObjectReference.md)
- [SpatialPlacement](docs/SpatialPlacement.md)
- [SpatialPlacementCommon](docs/SpatialPlacementCommon.md)
- [SpatialPlacementRotation](docs/SpatialPlacementRotation.md)
- [SpatialPlacementScaling](docs/SpatialPlacementScaling.md)
- [SpatialPlacementTranslation](docs/SpatialPlacementTranslation.md)
- [SpatialPlacements](docs/SpatialPlacements.md)
- [SpatialSceneNode](docs/SpatialSceneNode.md)
- [SpatialSearch](docs/SpatialSearch.md)
- [TissueBlock](docs/TissueBlock.md)
- [TissueCommon](docs/TissueCommon.md)
- [TissueDataset](docs/TissueDataset.md)
- [TissueDonor](docs/TissueDonor.md)
- [TissueSampleCommon](docs/TissueSampleCommon.md)
- [TissueSection](docs/TissueSection.md)

### Authorization

Endpoints do not require authorization.


## About

This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
and is automatically generated by the
[OpenAPI Generator](https://openapi-generator.tech) project:

- API version: `0.19.0`
- Package version: `0.19.0`
- Generator version: `7.19.0`
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`

The generated npm module supports the following:

- Environments
  * Node.js
  * Webpack
  * Browserify
- Language levels
  * ES5 - you must have a Promises/A+ library installed
  * ES6
- Module systems
  * CommonJS
  * ES6 module system


## Development

### Building

To build the TypeScript source code, you need to have Node.js and npm installed.
After cloning the repository, navigate to the project directory and run:

```bash
npm install
npm run build
```

### Publishing

Once you've built the package, you can publish it to npm:

```bash
npm publish
```

## License

[MIT License](https://spdx.org/licenses/MIT.html)