@telstra/messaging/dist/classes/HealthCheck.d.ts

Telstra SDK Messaging

import { HttpClient, IAuthConfigProps } from '@telstra/core';
import { THealthCheck } from '../types/index.js';
export declare class HealthCheck extends HttpClient {
    authConfig?: IAuthConfigProps | undefined;
    constructor(authConfig?: IAuthConfigProps | undefined);
    /**
       * Determine whether the messaging service is up or down.
       * @link https://dev.telstra.com/docs/messaging-api/apiReference/apiReferenceOverviewEndpoints?version=3.x#HealthCheck
       * @example
          ```typescript
          import { HealthCheck } from '@telstra/messaging'
  
          const healthCheck = new HealthCheck();
  
          healthCheck.get()
          .then(result => {
              console.log(result);
          })
          .catch(error => {
              console.error(error);
          });
          ```
       */
    get(): Promise<THealthCheck>;
}