@keiser/metrics-sdk-admin-typescript 5.0.12

package/dist/apis/MetricsAdminApi.d.ts

@@ -0,0 +1,328 @@
+/**
+ * metrics-sdk-admin
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 5.0.12
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { CacheObjectResponse, FacilityLicenseListResponse, FacilityLicenseResponse, GlobalAccessControlCreationResponse, GlobalAccessControlListResponse, GlobalAccessControlResponse, GlobalAccessControlSecretResponse, ResqueDetailsResponse, StatListResponse, TaskFailedResponse, TaskQueueResponse, UserListResponse, UserResponse, WorkersResponse } from '../models';
+export interface AdminLoginRequest {
+    email: string;
+    password: string;
+    refreshable?: boolean;
+    token?: string;
+    apiVersion?: string;
+}
+export interface AuthExchangeFulfillmentRequest {
+    exchangeToken: string;
+    apiVersion?: string;
+}
+export interface FacilityLicenseCreateRequest {
+    term: number;
+    type: string;
+    accountId?: string;
+    email?: string;
+    name?: string;
+    apiVersion?: string;
+}
+export interface FacilityLicenseDeleteRequest {
+    id: number;
+    apiVersion?: string;
+}
+export interface FacilityLicenseListRequest {
+    accountId?: string;
+    ascending?: boolean;
+    key?: string;
+    limit?: number;
+    name?: string;
+    offset?: number;
+    sort?: string;
+    type?: string;
+    apiVersion?: string;
+}
+export interface GlobalAccessControlCreateRequest {
+    accessControlRights?: string;
+    analyticRights?: string;
+    exerciseRights?: string;
+    facilityRights?: string;
+    licenseRights?: string;
+    mSeriesGuidedSessionRights?: string;
+    resqueRights?: string;
+    userId?: number;
+    userRights?: string;
+    apiVersion?: string;
+}
+export interface GlobalAccessControlDeleteRequest {
+    userId: number;
+    apiVersion?: string;
+}
+export interface GlobalAccessControlListRequest {
+    ascending?: boolean;
+    limit?: number;
+    name?: string;
+    offset?: number;
+    sort?: string;
+    apiVersion?: string;
+}
+export interface GlobalAccessControlRecreateSecretRequest {
+    apiVersion?: string;
+}
+export interface GlobalAccessControlShowRequest {
+    userId?: number;
+    apiVersion?: string;
+}
+export interface GlobalAccessControlUpdateRequest {
+    accessControlRights?: string;
+    analyticRights?: string;
+    exerciseRights?: string;
+    facilityRights?: string;
+    licenseRights?: string;
+    mSeriesGuidedSessionRights?: string;
+    resqueRights?: string;
+    userId?: number;
+    userRights?: string;
+    apiVersion?: string;
+}
+export interface ResqueCacheCreateRequest {
+    key: string;
+    value: string;
+    expireIn?: number;
+    apiVersion?: string;
+}
+export interface ResqueCacheDeleteRequest {
+    key: string;
+    apiVersion?: string;
+}
+export interface ResqueCacheShowRequest {
+    key: string;
+    apiVersion?: string;
+}
+export interface ResqueCacheUpdateRequest {
+    key: string;
+    value: string;
+    expireIn?: number;
+    apiVersion?: string;
+}
+export interface ResqueDetailsRequest {
+    apiVersion?: string;
+}
+export interface ResqueTaskDeleteAllFailedRequest {
+    apiVersion?: string;
+}
+export interface ResqueTaskDeleteFailedRequest {
+    failedTask: string;
+    apiVersion?: string;
+}
+export interface ResqueTaskDeleteTaskRequest {
+    args: string;
+    queue: string;
+    taskName: string;
+    apiVersion?: string;
+}
+export interface ResqueTaskFailuresRequest {
+    limit?: number;
+    offset?: number;
+    apiVersion?: string;
+}
+export interface ResqueTaskQueueRequest {
+    queue: string;
+    limit?: number;
+    offset?: number;
+    apiVersion?: string;
+}
+export interface ResqueTaskRetryAllFailedRequest {
+    apiVersion?: string;
+}
+export interface ResqueTaskRetryFailedRequest {
+    failedTask: string;
+    apiVersion?: string;
+}
+export interface ResqueWorkerListRequest {
+    apiVersion?: string;
+}
+export interface StatsListRequest {
+    ascending?: boolean;
+    from?: Date;
+    limit?: number;
+    offset?: number;
+    sort?: string;
+    to?: Date;
+    apiVersion?: string;
+}
+export interface UserDeleteRequest {
+    userId?: number;
+    apiVersion?: string;
+}
+export interface UserListRequest {
+    ascending?: boolean;
+    email?: string;
+    limit?: number;
+    name?: string;
+    offset?: number;
+    sort?: string;
+    apiVersion?: string;
+}
+export interface UserMergeRequest {
+    fromUserId: number;
+    toUserId: number;
+    apiVersion?: string;
+}
+export interface UserShowRequest {
+    userId?: number;
+    apiVersion?: string;
+}
+/**
+ *
+ */
+export declare class MetricsAdminApi extends runtime.BaseAPI {
+    /**
+     * 1
+     * Login admin user using email, password, and 2FA token
+     */
+    adminLogin(requestParameters: AdminLoginRequest): Promise<UserResponse>;
+    /**
+     * 1
+     * Exchanges an authorization token for access and refresh tokens
+     */
+    authExchangeFulfillment(requestParameters: AuthExchangeFulfillmentRequest): Promise<UserResponse>;
+    /**
+     * 1
+     * Create a facility license
+     */
+    facilityLicenseCreate(requestParameters: FacilityLicenseCreateRequest): Promise<FacilityLicenseResponse>;
+    /**
+     * 1
+     * Delete a facility license
+     */
+    facilityLicenseDelete(requestParameters: FacilityLicenseDeleteRequest): Promise<void>;
+    /**
+     * 1
+     * List facility licenses
+     */
+    facilityLicenseList(requestParameters: FacilityLicenseListRequest): Promise<FacilityLicenseListResponse>;
+    /**
+     * 1
+     * Create a user\'s global access control rights
+     */
+    globalAccessControlCreate(requestParameters: GlobalAccessControlCreateRequest): Promise<GlobalAccessControlCreationResponse>;
+    /**
+     * 1
+     * Delete a user\'s global access control
+     */
+    globalAccessControlDelete(requestParameters: GlobalAccessControlDeleteRequest): Promise<void>;
+    /**
+     * 1
+     * List global access control for users
+     */
+    globalAccessControlList(requestParameters: GlobalAccessControlListRequest): Promise<GlobalAccessControlListResponse>;
+    /**
+     * 1
+     * Recreate a user\'s authenticator secret
+     */
+    globalAccessControlRecreateSecret(requestParameters: GlobalAccessControlRecreateSecretRequest): Promise<GlobalAccessControlSecretResponse>;
+    /**
+     * 1
+     * Show a global access control
+     */
+    globalAccessControlShow(requestParameters: GlobalAccessControlShowRequest): Promise<GlobalAccessControlResponse>;
+    /**
+     * 1
+     * Update a user global access control rights
+     */
+    globalAccessControlUpdate(requestParameters: GlobalAccessControlUpdateRequest): Promise<GlobalAccessControlResponse>;
+    /**
+     * 1
+     * Create cached object
+     */
+    resqueCacheCreate(requestParameters: ResqueCacheCreateRequest): Promise<CacheObjectResponse>;
+    /**
+     * 1
+     * Delete cached object
+     */
+    resqueCacheDelete(requestParameters: ResqueCacheDeleteRequest): Promise<void>;
+    /**
+     * 1
+     * Show cache object
+     */
+    resqueCacheShow(requestParameters: ResqueCacheShowRequest): Promise<CacheObjectResponse>;
+    /**
+     * 1
+     * Update cached object
+     */
+    resqueCacheUpdate(requestParameters: ResqueCacheUpdateRequest): Promise<CacheObjectResponse>;
+    /**
+     * 1
+     * Show wholistic details about resque system
+     */
+    resqueDetails(requestParameters: ResqueDetailsRequest): Promise<ResqueDetailsResponse>;
+    /**
+     * 1
+     * Delete all failed task
+     */
+    resqueTaskDeleteAllFailed(requestParameters: ResqueTaskDeleteAllFailedRequest): Promise<void>;
+    /**
+     * 1
+     * Delete a failed task
+     */
+    resqueTaskDeleteFailed(requestParameters: ResqueTaskDeleteFailedRequest): Promise<void>;
+    /**
+     * 1
+     * Delete a task from the queue
+     */
+    resqueTaskDeleteTask(requestParameters: ResqueTaskDeleteTaskRequest): Promise<void>;
+    /**
+     * 1
+     * Lists failed tasks
+     */
+    resqueTaskFailures(requestParameters: ResqueTaskFailuresRequest): Promise<TaskFailedResponse>;
+    /**
+     * 1
+     * Lists enqueued tasks
+     */
+    resqueTaskQueue(requestParameters: ResqueTaskQueueRequest): Promise<TaskQueueResponse>;
+    /**
+     * 1
+     * Remove and retry all failed task
+     */
+    resqueTaskRetryAllFailed(requestParameters: ResqueTaskRetryAllFailedRequest): Promise<void>;
+    /**
+     * 1
+     * Remove and retry a failed task
+     */
+    resqueTaskRetryFailed(requestParameters: ResqueTaskRetryFailedRequest): Promise<void>;
+    /**
+     * 1
+     * List resque workers
+     */
+    resqueWorkerList(requestParameters: ResqueWorkerListRequest): Promise<WorkersResponse>;
+    /**
+     * 1
+     * Shows stats queries
+     */
+    statsList(requestParameters: StatsListRequest): Promise<StatListResponse>;
+    /**
+     * 1
+     * Delete a user
+     */
+    userDelete(requestParameters: UserDeleteRequest): Promise<void>;
+    /**
+     * 1
+     * List users
+     */
+    userList(requestParameters: UserListRequest): Promise<UserListResponse>;
+    /**
+     * 1
+     * Merge two user together
+     */
+    userMerge(requestParameters: UserMergeRequest): Promise<UserResponse>;
+    /**
+     * 1
+     * Show a user
+     */
+    userShow(requestParameters: UserShowRequest): Promise<UserResponse>;
+}

package/dist/apis/index.d.ts

@@ -0,0 +1 @@
+export * from './MetricsAdminApi';

package/dist/connection.d.ts

@@ -0,0 +1,110 @@
+import { ConnectionOptions, MetricsConnection, HTTPMethod, HTTPHeaders } from './runtime';
+export declare const JWT_TTL_LIMIT = 5000;
+export interface AuthenticatedResponse {
+    accessToken: string;
+    refreshToken?: string;
+}
+export interface SubscriptionResponse extends AuthenticatedResponse {
+    subscriptionKey: string;
+}
+export interface AuthPrefillParams {
+    email: string;
+    returnUrl: string;
+    requiresElevated?: boolean;
+    name?: string;
+    birthday?: string;
+    gender?: string;
+    language?: string;
+    units?: string;
+    metricWeight?: number;
+    bodyFatPercentage?: number;
+    metricHeight?: number;
+}
+export interface AccessTokenChangeEvent {
+    accessToken: string;
+}
+export interface RefreshTokenChangeEvent {
+    refreshToken: string;
+}
+export interface KioskTokenChangeEvent {
+    kioskToken: string;
+}
+export interface StrengthMachineTokenChangeEvent {
+    accessToken: string;
+}
+export interface JWTFacility {
+    id: number;
+    licensedUntil: string;
+}
+export interface JWTToken {
+    iss: string;
+    jti: string;
+    exp: number;
+    type: 'access' | 'refresh' | 'kiosk' | 'machine';
+}
+export interface SessionToken extends JWTToken {
+    user: {
+        id: number;
+    };
+    facility?: {
+        id: number;
+        licencedUntil: string;
+    } | null;
+    facilityRole?: string | null;
+}
+export interface AccessToken extends SessionToken {
+    type: 'access';
+}
+export interface RefreshToken extends SessionToken {
+    type: 'refresh';
+}
+export interface ModelChangeEvent {
+    id: number;
+    name: string;
+    mutation: 'create' | 'update' | 'delete';
+    occurredAt: number;
+}
+export interface ModelSubscribeParameters {
+    model: string;
+    id: number;
+    userId?: number;
+    facilityRelationshipId?: number;
+    actionOverride?: string;
+}
+export interface ListSubscribeParameters {
+    parentModel: string;
+    parentId: number;
+    model: string;
+    actionOverride?: string;
+}
+export declare class AuthenticatedConnection {
+    protected readonly _connection: MetricsConnection;
+    private _keepAlive;
+    private _accessToken;
+    private _refreshToken;
+    private _accessTokenTimeout;
+    private readonly _modelChangeEventHandlerMap;
+    private readonly _onAccessTokenChangeEvent;
+    private readonly _onRefreshTokenChangeEvent;
+    constructor(params: {
+        options?: ConnectionOptions;
+        keepAlive?: boolean;
+        authenticatedResponse?: AuthenticatedResponse;
+    });
+    initializeAuthenticatedSession(refreshToken: string): Promise<AuthenticatedResponse>;
+    private updateTokens;
+    private keepAccessTokenAlive;
+    private handleConnectionEvent;
+    private dispatchPushData;
+    get connection(): MetricsConnection;
+    get keepAlive(): boolean;
+    set keepAlive(value: boolean);
+    get decodedAccessToken(): AccessToken;
+    get accessToken(): string;
+    get refreshToken(): string;
+    get onRefreshTokenChangeEvent(): import("./event").IEvent<RefreshTokenChangeEvent>;
+    get onAccessTokenChangeEvent(): import("./event").IEvent<AccessTokenChangeEvent>;
+    close(): void;
+    authenticatedAction(action: string, route: string, method: HTTPMethod, params: Object, pathParams: Object, headers: HTTPHeaders): Promise<any>;
+    action(action: string, route: string, method: HTTPMethod, params: Object, pathParams: Object, headers: HTTPHeaders): Promise<any>;
+}

package/dist/error.d.ts

@@ -0,0 +1,134 @@
+export interface ActionErrorProperties {
+    code?: number;
+    name: string;
+    message: string;
+    explanation?: string;
+    params?: string[];
+}
+export declare class BaseMetricsError extends Error {
+    static readonly code: number;
+    readonly message: string;
+    readonly explanation: string;
+    readonly params: string[];
+    constructor(errorProperties: ActionErrorProperties);
+    toString(): string;
+    get code(): number;
+}
+/** @hidden */
+export declare function GetErrorInstance(errorProperties: ActionErrorProperties): MissingParamsError | UnknownActionError | InvalidCredentialsError | ValidationError | UnknownEntityError | DuplicateEntityError | CSRFError | UnsupportedTypeError | ServerShutdownError | PendingActionOverflowError | DataSizeLimitError | OTPTokenExpiredError | UnauthorizedTokenError | InvalidAuthorizationCodeError | BlacklistTokenError | TokenInvalidError | ParseError | OAuthInvalidLoginError | InvalidExchangeCodeError | UnauthorizedResourceError | OAuthCollisionError | OAuthRequestError | OAuthRefreshTokenError | DuplicateActionError | ActionPreventedError | DemoActionPreventedError | SessionDataMissingError | FacilityLicenseExpiredError | FacilityAccessControlError | UnhealthyNodeError | InvalidReturnUrlError | SubscribePreventedError | DatabaseError | ConnectionError;
+export declare class RequestError extends BaseMetricsError {
+}
+export declare class SessionError extends BaseMetricsError {
+}
+export declare class ServerError extends BaseMetricsError {
+}
+export declare class ConnectionError extends BaseMetricsError {
+    static readonly code = 0;
+}
+export declare class MissingParamsError extends RequestError {
+    static readonly code = 601;
+}
+export declare class UnknownActionError extends RequestError {
+    static readonly code = 602;
+}
+export declare class InvalidCredentialsError extends RequestError {
+    static readonly code = 603;
+}
+export declare class ValidationError extends RequestError {
+    static readonly code = 604;
+}
+export declare class UnknownEntityError extends RequestError {
+    static readonly code = 605;
+}
+export declare class DuplicateEntityError extends RequestError {
+    static readonly code = 606;
+}
+export declare class CSRFError extends SessionError {
+    static readonly code = 607;
+}
+export declare class UnsupportedTypeError extends RequestError {
+    static readonly code = 608;
+}
+export declare class ServerShutdownError extends ServerError {
+    static readonly code = 609;
+}
+export declare class PendingActionOverflowError extends ServerError {
+    static readonly code = 610;
+}
+export declare class DataSizeLimitError extends RequestError {
+    static readonly code = 611;
+}
+export declare class OTPTokenExpiredError extends RequestError {
+    static readonly code = 612;
+}
+export declare class UnauthorizedTokenError extends SessionError {
+    static readonly code = 613;
+}
+export declare class InvalidAuthorizationCodeError extends RequestError {
+    static readonly code = 614;
+}
+export declare class BlacklistTokenError extends SessionError {
+    static readonly code = 615;
+}
+export declare class TokenInvalidError extends SessionError {
+    static readonly code = 616;
+}
+export declare class ParseError extends RequestError {
+    static readonly code = 617;
+}
+export declare class OAuthInvalidLoginError extends RequestError {
+    static readonly code = 618;
+}
+export declare class InvalidExchangeCodeError extends RequestError {
+    static readonly code = 619;
+}
+export declare class UnauthorizedResourceError extends RequestError {
+    static readonly code = 620;
+}
+export declare class OAuthCollisionError extends RequestError {
+    static readonly code = 621;
+}
+export declare class OAuthRequestError extends RequestError {
+    static readonly code = 622;
+}
+export declare class OAuthRefreshTokenError extends SessionError {
+    static readonly code = 623;
+}
+export declare class DuplicateActionError extends RequestError {
+    static readonly code = 624;
+}
+export declare class ActionPreventedError extends RequestError {
+    static readonly code = 625;
+}
+export declare class DemoActionPreventedError extends RequestError {
+    static readonly code = 626;
+}
+export declare class SessionDataMissingError extends SessionError {
+    static readonly code = 627;
+}
+export declare class FacilityLicenseExpiredError extends SessionError {
+    static readonly code = 628;
+}
+export declare class FacilityAccessControlError extends RequestError {
+    static readonly code = 629;
+}
+export declare class UnhealthyNodeError extends ServerError {
+    static readonly code = 630;
+}
+export declare class InvalidReturnUrlError extends RequestError {
+    static readonly code = 631;
+}
+export declare class SubscribePreventedError extends RequestError {
+    static readonly code = 632;
+}
+export declare class DatabaseError extends RequestError {
+    static readonly code = 633;
+}
+export declare class ClientSideActionPrevented extends RequestError {
+    constructor({ explanation }: {
+        explanation?: string;
+    });
+}
+export declare class ConnectionFaultError extends ConnectionError {
+    constructor();
+}

package/dist/event.d.ts

@@ -0,0 +1,51 @@
+interface IEventManagement {
+    unsubscribe: () => void;
+    stopPropagation: () => void;
+}
+interface ISubscribable<TypedEventHandler> {
+    readonly count: number;
+    subscribe: (handler: TypedEventHandler) => () => void;
+    unsubscribe: (handler: TypedEventHandler) => void;
+    one: (handler: TypedEventHandler) => () => void;
+    has: (handler: TypedEventHandler) => boolean;
+    clear: () => void;
+}
+interface ISubscription<TypedEventHandler> {
+    readonly isExecuted: boolean;
+    readonly isOnce: boolean;
+    readonly handler: TypedEventHandler;
+}
+type IEventHandler<TypedEventArgument> = (argument: TypedEventArgument, eventManager: IEventManagement) => void;
+type TypedEventArgument = any;
+type TypedEventHandler = IEventHandler<TypedEventArgument>;
+interface IPropagationStatus {
+    readonly propagationStopped: boolean;
+}
+export type IEvent<TypedEventArgument> = ISubscribable<IEventHandler<TypedEventArgument>>;
+declare class BaseEventDispatcher<TypedEventArgument> implements IEvent<TypedEventArgument> {
+    private _asEventWrapper?;
+    protected _subscriptions: ISubscription<TypedEventHandler>[];
+    get count(): number;
+    subscribe(handler: TypedEventHandler): () => void;
+    one(handler: TypedEventHandler): () => void;
+    has(handler: TypedEventHandler): boolean;
+    unsubscribe(handler: TypedEventHandler): void;
+    protected _dispatch(executeAsync: boolean, scope: any, argument: any): IPropagationStatus | null;
+    protected createSubscription(handler: TypedEventHandler, isOnce: boolean): ISubscription<TypedEventHandler>;
+    protected cleanup(subscription: ISubscription<TypedEventHandler>): void;
+    clear(): void;
+    dispatch(argument: TypedEventArgument): IPropagationStatus;
+    dispatchAsync(argument: TypedEventArgument): void;
+    asEvent(): IEvent<TypedEventArgument>;
+}
+export declare class EventDispatcher<TypedEventArgument> extends BaseEventDispatcher<TypedEventArgument> {
+    private readonly _onSubscriptionCountChangeEvent;
+    get onSubscriptionCountChangeEvent(): IEvent<{
+        count: number;
+    }>;
+    subscribe(handler: TypedEventHandler): () => void;
+    one(handler: TypedEventHandler): () => void;
+    unsubscribe(handler: TypedEventHandler): void;
+    clear(): void;
+}
+export {};

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from './runtime';
+export * from './apis';
+export * from './models';
+export * from './error';
+export * from './event';
+export * from './connection';
+export * from './jwt';