Registry / devops / ch-admin-api-client-typescript

ch-admin-api-client-typescript

library5.90.39jsnpmunverified

OpenAPI-generated TypeScript/Axios client for the CloudHospital Admin API. Version 5.90.39, auto-generated from OpenAPI spec with frequent releases. Provides typed API methods and models for administrative operations, leveraging Axios for HTTP requests. Differentiates from generic HTTP clients by offering complete type safety and autocompletion for all admin endpoints. Currently active and regularly updated to match API changes.

devops

npm install ch-admin-api-client-typescript

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CH-ADMIN-API-CLIEN

ch-admin-api-client-typescript

devopsjavascriptv5.90.39

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

AdminApiClient

✓ import { AdminApiClient } from 'ch-admin-api-client-typescript'

✗ const AdminApiClient = require('ch-admin-api-client-typescript').AdminApiClient

The package ships TypeScript types and is ESM-compatible; named import is preferred.

Configuration

✓ import { Configuration } from 'ch-admin-api-client-typescript'

✗ import Configuration from 'ch-admin-api-client-typescript'

Configuration is a named export, not a default export.

AdminApi

✓ import { AdminApi } from 'ch-admin-api-client-typescript'

✗ import { AdminAPI } from 'ch-admin-api-client-typescript'

Watch casing: exported as AdminApi (camelCase), not AdminAPI.

Shows how to create a configured client instance and make a simple GET request to the admin API using the generated TypeScript client.

import { AdminApiClient, Configuration } from 'ch-admin-api-client-typescript'; async function main() { const config = new Configuration({ basePath: 'https://admin.cloudhospital.com/api', apiKey: process.env.ADMIN_API_KEY ?? '', }); const client = new AdminApiClient(config); try { const response = await client.admin.api.v1.adminGet(); console.log(response.data); } catch (error) { console.error('API call failed:', error); } } main();

Debug

Known issues

breakingThe API client is auto-generated; breaking changes may occur without major version bump if the OpenAPI spec changes significantly.

fix

Pin to a specific version and review changelog before upgrading.

affects: all

gotchaDefault export not available; all exports are named.

fix

Use named imports as shown in documentation.

affects: all

deprecatedSome methods may be marked deprecated in newer versions; check generated types for @deprecated JSDoc tags.

fix

Migrate to suggested alternatives as indicated in JSDoc comments.

affects: >=5.0.0

gotchaAxios version compatibility: the generated client requires axios >= 0.21.1; mismatched versions can cause runtime errors.

fix

Ensure axios is installed at a compatible version.

affects: all

Errors

Common errors & fixes

Cannot find module 'ch-admin-api-client-typescript' or its corresponding type declarations.

Package not installed or TypeScript cannot resolve types.

fix

Install package: npm install ch-admin-api-client-typescript. Ensure tsconfig.json includes node_modules types.

TypeError: client.admin.api.v1.adminGet is not a function

Incorrect path or method name after API changes.

fix

Check the generated API methods on the client object; use autocomplete or read the generated Source to confirm method names.

AxiosError: Request failed with status code 401

API key missing or invalid.

fix

Verify ADMIN_API_KEY environment variable is set and valid.

Upgrade

Version history

5.90.39latest on npm

Audit

Dependencies

axiosrequiredHTTP client used for all API requests

Agent activity

7 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/iCloudHospital/ch-admin-api-client-typescript ↗

packagech-admin-api-client-typescript ↗

homepagehttps://github.com/iCloudHospital/ch-admin-api-client-typescript#readme ↗