@keiser/metrics-sdk-admin-typescript

v5.0.34

Published

2 days ago

Keiser Metrics SDK

Downloads

0High
0Medium
0Low

@keiser/[email protected]

Project

This SDK facilitates communication between a client system (ie: phone app, website, server) and Keiser Metrics. The SDK is written in TypeScript and supports both browser and NodeJS platforms.

Installation

Navigate to the folder of your consuming project and install with npm:

npm install @keiser/[email protected] --save

Getting Started

Please follow the installation instruction and execute the following JS code:


import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';

var api = new MetricsAdminApi()

let body:MetricsAdminApiAdminLoginRequest = {
  // string
  email: email_example,
  // string
  password: password_example,
  // boolean (optional)
  refreshable: true,
  // string (optional)
  token: token_example,
  // string (optional)
  apiVersion: apiVersion_example,
};

try {
  const data = await api.adminLogin(body);
  console.log('API called successfully. Returned data: ' + data);
} catch (error) {
  console.error(error);
}

Documentation for API Endpoints

All URIs are relative to https://metrics-api-v3.keiser.com/api

Method | HTTP request | Description ------------- | ------------- | ------------- adminLogin | POST /admin/login | Login admin user using email, password, and 2FA token authExchangeFulfillment | POST /auth/exchange/fulfillment | Exchanges an authorization token for access and refresh tokens facilityLicenseCreate | POST /facility/license | Create a facility license facilityLicenseDelete | DELETE /facility/license/{id} | Delete a facility license facilityLicenseList | GET /facility/license/list | List facility licenses globalAccessControlCreate | POST /global-access-control | Create a user's global access control rights globalAccessControlDelete | DELETE /global-access-control/{userId} | Delete a user's global access control globalAccessControlList | GET /global-access-control/list | List global access control for users globalAccessControlRecreateSecret | POST /global-access-control/recreate-secret | Recreate a user's authenticator secret globalAccessControlShow | GET /global-access-control | Show a global access control globalAccessControlUpdate | PUT /global-access-control | Update a user global access control rights resqueCacheCreate | POST /resque/cache | Create cached object resqueCacheDelete | DELETE /resque/cache/{key} | Delete cached object resqueCacheList | GET /resque/cache/list | List cached objects resqueCacheShow | GET /resque/cache | Show cache object resqueCacheUpdate | PUT /resque/cache/{key} | Update cached object resqueDetails | GET /resque/details | Show wholistic details about resque system resqueTaskDeleteAllFailed | DELETE /resque/task/delete-all-failed | Delete all failed task resqueTaskDeleteFailed | DELETE /resque/task/delete-failed | Delete a failed task resqueTaskDeleteTask | DELETE /resque/task/delete-task | Delete a task from the queue resqueTaskFailures | GET /resque/task/failures | Lists failed tasks resqueTaskQueue | GET /resque/task/queue | Lists enqueued tasks resqueTaskRetryAllFailed | POST /resque/task/retry-all-failed | Remove and retry all failed task resqueTaskRetryFailed | POST /resque/task/retry-failed | Remove and retry a failed task resqueWorkerList | GET /resque/worker | List resque workers statsList | GET /stats | Shows stats queries userDelete | DELETE /user | Delete a user userList | GET /user/list | List users userMerge | PUT /user/merge | Merge two user together userShow | GET /user | Show a user

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (JWT)

Copyright and License

The Keiser Metrics SDK source code and distributed package are made available through the MIT license.

Using any of the APIs made available through the Keiser Metrics SDK to communicate with Keiser Metrics make you subject to the following agreements. Please read all documents in their entirety as they govern your use of the APIs and Keiser Metrics servers.

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme