@hra-api/ts-client

v0.19.0

Published

25 days ago

OpenAPI client for @hra-api/ts-client

Downloads

125

0High
0Medium
0Low

bherr2

@hra-api/[email protected]

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

Usage

First, install the SDK from npm.

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

Next, try it out.

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 | GET /ds-graph/atlas-d2k | Get Atlas D2K Dataset Graph DsGraphApi | gtex | GET /ds-graph/gtex | Get GTEx Dataset Graph DsGraphApi | hubmap | GET /ds-graph/hubmap | Get HuBMAP Dataset Graph DsGraphApi | sennet | GET /ds-graph/sennet | Get SenNet Dataset Graph HraKgApi | asctbTermOccurences | GET /kg/asctb-term-occurences | Get number of ASCT+B term occurrences for a search HraKgApi | digitalObjects | GET /kg/digital-objects | List all digital objects in the HRA KG HraKgApi | doSearch | GET /kg/do-search | Search for Digital Object PURLs HraPopApi | cellSummaryReport | 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 | 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 | GET /hra-pop/supported-organs | Get all organs supported by HRApop HraPopApi | supportedReferenceOrgans | GET /hra-pop/supported-reference-organs | Get all reference organs supported by HRApop HraPopApi | supportedTools | GET /hra-pop/supported-tools | Get all tools supported by HRApop V1Api | aggregateResults | GET /v1/aggregate-results | Get aggregate results / statistics V1Api | anatomicalSystemsTreeModel | GET /v1/anatomical-systems-tree-model | Get anatomical systems partonomy tree nodes V1Api | asctbOmapSheetConfig | GET /v1/asctb-omap-sheet-config | Get OMAP sheet config data for the ASCT+B Reporter V1Api | asctbSheetConfig | GET /v1/asctb-sheet-config | Get sheet config data for the ASCT+B Reporter V1Api | biomarkerTermOccurences | GET /v1/biomarker-term-occurences | Get number of biomarker type term occurrences for a search V1Api | biomarkerTreeModel | GET /v1/biomarker-tree-model | Get biomarker tree nodes V1Api | cellTypeTermOccurences | GET /v1/cell-type-term-occurences | Get number of cell type term occurrences for a search V1Api | cellTypeTreeModel | GET /v1/cell-type-tree-model | Get cell type tree nodes V1Api | collisions | POST /v1/collisions | Given an extraction site, get mesh-based collisions with the reference organ. V1Api | consortiumNames | GET /v1/consortium-names | Get consortium names (for filtering) V1Api | corridor | POST /v1/corridor | Given an extraction site, generate a corridor with the reference organ. V1Api | dbStatus | GET /v1/db-status | Get current status of database V1Api | dsGraph | GET /v1/ds-graph | Get dataset graph V1Api | extractionSite | GET /v1/extraction-site | Lookup Extraction Site V1Api | ftuIllustrations | GET /v1/ftu-illustrations | Get 2D FTU Illustration data V1Api | getSpatialPlacement | 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 | GET /v1/gtex/rui_locations.jsonld | Get all GTEx rui locations (if enabled) V1Api | hubmapRuiLocations | GET /v1/hubmap/rui_locations.jsonld | Get all hubmap rui locations (if enabled) V1Api | mesh3dCellPopulation | 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 | GET /v1/ontology-term-occurences | Get number of ontology term occurrences for a search V1Api | ontologyTreeModel | GET /v1/ontology-tree-model | Get ontology term tree nodes V1Api | providerNames | GET /v1/provider-names | Get tissue provider names (for filtering) V1Api | referenceOrganScene | GET /v1/reference-organ-scene | Get all nodes to form the 3D scene for an organ V1Api | referenceOrgans | GET /v1/reference-organs | Get all reference organs V1Api | ruiReferenceData | GET /v1/rui-reference-data | Get reference data for the RUI tool V1Api | scene | GET /v1/scene | Get all nodes to form the 3D scene of reference body, organs, and tissues V1Api | sennetRuiLocations | GET /v1/sennet/rui_locations.jsonld | Get all sennet rui locations (if enabled) V1Api | sessionToken | POST /v1/session-token | Get a session token V1Api | sparql | GET /v1/sparql | Run a SPARQL query V1Api | sparqlPost | POST /v1/sparql | Run a SPARQL query (POST) V1Api | technologyNames | GET /v1/technology-names | Get technology names (for filtering) V1Api | tissueBlocks | GET /v1/tissue-blocks | Get Tissue Block Results

Models

Authorization

Endpoints do not require authorization.

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator 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:

npm install
npm run build

Publishing

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

npm publish

License

MIT License