@careevolution/mydatahelps-js 2.3.2 → 3.2.0

package/types.d.ts

@@ -0,0 +1,328 @@
+export declare type SurveyTaskStatus = "incomplete" | "closed" | "complete";
+export declare type SortOrder = "descending" | "ascending";
+export declare type EventName = "applicationDidBecomeVisible" | "surveyDidFinish" | "externalAccountSyncComplete" | "tokenWillExpire";
+export declare type DeviceDataNamespace = "Project" | "Fitbit" | "AppleHealth" | "GoogleFit" | "AirNowApi" | "WeatherBit";
+export declare type ExternalAccountStatus = "unauthorized" | "fetchComplete" | "error" | "fetchingData";
+export declare type NotificationType = "Sms" | "Push" | "Email";
+export declare type NotificationStatusCode = "Succeeded" | "Unsubscribed" | "MissingContactInfo" | "NoRegisteredMobileDevice" | "NoAssociatedUser" | "ServiceError";
+export declare type StatusBarStyle = "lightContent" | "darkContent" | "default";
+export interface Guid extends String {
+}
+export interface QueryParameters {
+    limit?: number;
+    pageID?: Guid;
+}
+export interface ExternalAccount {
+    id: number;
+    provider: ExternalAccountProvider;
+    status: ExternalAccountStatus;
+    lastRefreshDate: string;
+}
+export interface ExternalAccountProvider {
+    id: number;
+    name: string;
+    category: string;
+    logoUrl: string;
+}
+export interface ExternalAccountProvidersPage {
+    externalAccountProviders: ExternalAccountProvider[];
+    totalExternalAccountProviders: number;
+}
+export interface ProjectInfo {
+    id: Guid;
+    name: string;
+    description: string;
+    code: string;
+    type: string;
+    organization: {
+        id: Guid;
+        name: string;
+        description: string;
+        logoUrl: string;
+        color: string;
+    };
+    supportEmail: string;
+    supportPhone: string;
+    learnMoreLink: string;
+    learnMoreTitle: string;
+}
+export interface DeviceInfo {
+    identifier: Guid;
+    platform: string;
+    properties: {
+        [key: string]: string;
+    };
+}
+export interface ParticipantInfo {
+    participantID: Guid;
+    participantIdentifier: string;
+    secondaryIdentifier: string;
+    linkIdentifier: string;
+    demographics: ParticipantDemographics;
+    customFields: {
+        [key: string]: string;
+    };
+    enrollmentDate: string;
+    projectID: string;
+}
+export interface ParticipantDemographics extends Record<string, string> {
+    email: string;
+    mobilePhone: string;
+    firstName: string;
+    middleName: string;
+    lastName: string;
+    dateOfBirth: string;
+    gender: string;
+    preferredLanguage: string;
+    street1: string;
+    street2: string;
+    city: string;
+    state: string;
+    postalCode: string;
+    utcOffset: string;
+    unsubscribedFromEmails: string;
+    timeZone: string;
+    unsubscribedFromSms: string;
+}
+export interface NotificationQueryParameters extends QueryParameters {
+    sentBefore?: string;
+    sentAfter?: string;
+    identifier?: string;
+    type?: NotificationType;
+    statusCode?: NotificationStatusCode;
+}
+export interface NotificationsPage {
+    notifications: Notification[];
+    nextPageID?: Guid;
+}
+export interface Notification {
+    id: Guid;
+    identifier: string;
+    contentVersion?: number;
+    sentDate: string;
+    statusCode: NotificationStatusCode;
+    type: NotificationType;
+    recipients: string[];
+    content?: {
+        body?: string;
+        title?: string;
+        subject?: string;
+    };
+}
+export interface SurveyTaskQueryParameters extends QueryParameters {
+    status?: SurveyTaskStatus;
+    surveyID?: Guid;
+    surveyName?: string | string[];
+    linkIdentifier?: string;
+    sortOrder?: SortOrder;
+}
+export interface SurveyTasksPage {
+    surveyTasks: SurveyTask[];
+    nextPageID?: Guid;
+}
+export interface SurveyTask {
+    id: Guid;
+    linkIdentifier: string;
+    surveyID: Guid;
+    surveyName: string;
+    surveyDisplayName?: string;
+    surveyDescription?: string;
+    startDate?: string;
+    endDate?: string;
+    status: SurveyTaskStatus;
+    hasSavedProgress: boolean;
+    dueDate: string;
+    insertedDate: string;
+    modifiedDate: string;
+}
+export interface CustomEventInfo {
+    eventType: string;
+    properties: {
+        [key: string]: object;
+    };
+}
+export interface DeviceDataPointsPage {
+    deviceDataPoints: DeviceDataPoint[];
+    nextPageID?: Guid;
+}
+export interface PersistableDeviceDataPoint {
+    identifier: string;
+    type: string;
+    value: string;
+    units?: string;
+    properties?: {
+        [key: string]: any;
+    };
+    source?: {
+        identifier: string;
+        properties?: {
+            [key: string]: any;
+        };
+    };
+    startDate?: string;
+    observationDate?: string;
+}
+export interface DeviceDataPoint extends PersistableDeviceDataPoint {
+    id: Guid;
+    namespace: DeviceDataNamespace;
+    limit?: number;
+    deviceDataContextID?: string;
+    insertedDate: string;
+    modifiedDate: string;
+}
+export interface DeviceDataPointQuery extends QueryParameters {
+    namespace: DeviceDataNamespace;
+    type?: string | string[];
+    observedBefore?: string;
+    observedAfter?: string;
+    modifiedBefore?: string;
+    modifiedAfter?: string;
+}
+export interface SurveyAnswersQuery extends QueryParameters {
+    surveyResultID?: string;
+    surveyID?: string;
+    surveyName?: string | string[];
+    after?: string;
+    before?: string;
+    stepIdentifier?: string | string[];
+    resultIdentifier?: string | string[];
+    answer?: string | string[];
+    insertedAfter?: string;
+    insertedBefore?: string;
+}
+export interface SurveyAnswersPage {
+    surveyAnswers: SurveyAnswer[];
+    nextPageID?: Guid;
+}
+export interface SurveyAnswer {
+    id: Guid;
+    surveyResultID: Guid;
+    surveyID: Guid;
+    surveyVersion: number;
+    taskID?: Guid;
+    surveyName: string;
+    surveyDisplayName: string;
+    date: string;
+    stepIdentifier: string;
+    resultIdentifier: string;
+    answers: string[];
+    insertedDate: string;
+}
+export interface FitbitQuery {
+    providerID?: number;
+    pageID?: Guid;
+    pageSize?: number;
+    startDate?: string;
+    endDate?: string;
+}
+export interface FitbitDailySummariesPage {
+    results: FitbitDailySummary[];
+    nextPageID?: Guid;
+}
+export interface FitbitDailySummary {
+    date: string;
+    activityCalories: number;
+    bodyBMI: number;
+    bodyFat: number;
+    bodyWeight: number;
+    calories: number;
+    caloriesBMR: number;
+    distance: number;
+    elevation: number;
+    foodCaloriesIn: number;
+    floors: number;
+    heartRateZones: FitbitHeartRateZones;
+    minutesFairlyActive: number;
+    minutesLightlyActive: number;
+    minutesSedentary: number;
+    minutesVeryActive: number;
+    steps: number;
+    tracker: FitbitTracker;
+    water: number;
+    modifiedDate: string;
+    restingHeartRate: number;
+}
+export interface FitbitHeartRateZones {
+    fatBurn: FitbitHeartRateZone;
+    cardio: FitbitHeartRateZone;
+    peak: FitbitHeartRateZone;
+    outOfRange: FitbitHeartRateZone;
+}
+export interface FitbitHeartRateZone {
+    caloriesOut: number;
+    min: number;
+    max: number;
+    minutes: number;
+}
+export interface FitbitTracker {
+    activityCalories: number;
+    calories: number;
+    distance: number;
+    elevation: number;
+    floors: number;
+    minutesFairlyActive: number;
+    minutesLightlyActive: number;
+    minutesSedentary: number;
+    minutesVeryActive: number;
+    steps: number;
+}
+export interface FitbitSleepLogsPage {
+    results: FitbitSleepLogs[];
+    nextPageID?: Guid;
+}
+export interface FitbitSleepLogs {
+    startTimestamp: string;
+    endTimestamp: string;
+    duration: number;
+    efficiency: number;
+    timeInBed: number;
+    infoCode: string;
+    type: string;
+    minutesAfterWakeup: number;
+    minutesAsleep: number;
+    minutesAwake: number;
+    minutesToFallAsleep: number;
+    sleepLevelAwake: number;
+    sleepLevelAsleep: number;
+    sleepLevelRestless: number;
+    sleepLevelDeep: number;
+    sleepLevelLight: number;
+    sleepLevelRem: number;
+    sleepLevelWake: number;
+}
+export interface EventData {
+    type: string;
+    messageID?: number;
+}
+export interface Token {
+    expires_in: number;
+    access_token: string;
+    token_type: string;
+}
+export interface OpenApplicationOptions {
+    modal: boolean;
+}
+export interface ShowDashboardOptions {
+    modal: boolean;
+    title?: string;
+}
+export interface ShowWebVisualizationOptions {
+    modal: boolean;
+    title?: string;
+}
+export interface ShowWebVisualizationPdfOptions {
+    landscape: boolean;
+    htmlViewerZoom: number;
+}
+export interface DataCollectionSettings {
+    fitbitEnabled: boolean;
+    ehrEnabled: boolean;
+    airQualityEnabled: boolean;
+    weatherEnabled: boolean;
+    queryableDeviceDataTypes: QueryableDeviceDataType[];
+    sensorDataCollectionEndDate: string;
+}
+export interface QueryableDeviceDataType {
+    namespace: DeviceDataNamespace;
+    type: string;
+}