oro-sdk 2.1.4

package/dist/models/practice.d.ts

@@ -0,0 +1,353 @@
+export declare enum WorkflowType {
+    Onboard = "Onboard",
+    Followup = "Followup",
+    Renew = "Renew",
+    DataRetrieve = "DataRetrieve"
+}
+export declare enum RateDimension {
+    RatioOnTotal = "RatioOnTotal",
+    FixedOnTotal = "FixedOnTotal",
+    RatioPlatformFee = "RatioPlatformFee",
+    FixedPlatformFee = "FixedPlatformFee",
+    RatioOnPlatformFeeTotal = "RatioOnPlatformFeeTotal",
+    FixedOnPlatformFeeTotal = "FixedOnPlatformFeeTotal",
+    RatioOnItem = "RatioOnItem",
+    FixedOnItem = "FixedOnItem"
+}
+export declare enum PlanType {
+    Onboard = "Onboard",
+    Followup = "Followup",
+    Renew = "Renew",
+    DataRetrieve = "DataRetrieve"
+}
+export declare enum PaymentStatus {
+    Pending = "Pending",
+    Success = "Success",
+    Failure = "Failure",
+    Canceled = "Canceled"
+}
+export declare enum PractitionerStatus {
+    Practicing = "Practicing",
+    Retired = "Retired",
+    NotInvolvedAnymore = "NotInvolvedAnymore",
+    Deactivated = "Deactivated",
+    Flagged = "Flagged",
+    InConflict = "InConflict",
+    Delicensed = "Delicensed"
+}
+export declare enum AssignmentStatus {
+    Assigned = "Assigned",
+    Reassigned = "Reassigned",
+    Cancelled = "Cancelled"
+}
+export declare enum PractitionnerRoleType {
+    Doctor = "Doctor",
+    MedicalAssistant = "MedicalAssistant",
+    MedicalSecretary = "MedicalSecretary",
+    Nurse = "Nurse",
+    Specialist = "Specialist",
+    LabAssistant = "LabAssistant",
+    Administrative = "Administrative",
+    ManualDispatcher = "ManualDispatcher",
+    Other = "Other"
+}
+export declare enum OtherRoleType {
+    Patient = "Patient",
+    User = "User",
+    System = "System"
+}
+export declare type AllRoleType = OtherRoleType | PractitionnerRoleType;
+export declare enum LicenseStatus {
+    Valid = "Valid",
+    Invalid = "Invalid",
+    Expired = "Expired",
+    NA = "NA",
+    Removed = "Removed"
+}
+export declare enum PeriodType {
+    PerYear = "PerYear",
+    PerQuarter = "PerQuarter",
+    PerMonth = "PerMonth",
+    PerWeek = "PerWeek",
+    PerBusinessDay = "PerBusinessDay",
+    PerDay = "PerDay",
+    PerHour = "PerHour"
+}
+export declare enum SyncStatus {
+    Requested = "Requested",
+    Started = "Started",
+    Succeeded = "Succeeded",
+    Failed = "Failed",
+    Cancelled = "Cancelled"
+}
+export declare enum PracticeEmailKind {
+    SignedUp = "SignedUp",
+    Onboarded = "Onboarded",
+    OnboardedPractitioner = "OnboardedPractitioner",
+    OnboardedPatient = "OnboardedPatient",
+    Answered = "Answered",
+    ToAnswer = "ToAnswer",
+    FollowedUp = "FollowedUp",
+    Renewed = "Renewed",
+    DataRetrieved = "DataRetrieved"
+}
+export interface PracticeAccount {
+    id?: number;
+    uuidPractice: string;
+    isoLocality?: string;
+    idStripeAccount?: string;
+    emailBillingContact: string;
+    urlSubdomain?: string;
+}
+export declare enum PracticeConfigKind {
+    PractitionerConsultList = "PractitionerConsultList",
+    PractitionerChatbox = "PractitionerChatbox",
+    PracticeTheme = "PracticeTheme",
+    PracticeLocaleSwitcher = "PracticeLocaleSwitcher",
+    PracticeCookieBanner = "PracticeCookieBanner"
+}
+export interface PracticeConfig<K, T> {
+    uuidPractice: string;
+    kind: K;
+    config: T;
+}
+export declare type PracticeConfigPractitionerConsultList = PracticeConfig<PracticeConfigKind.PractitionerConsultList, {
+    hideLocality?: boolean;
+    hideFax?: boolean;
+    hideExpiresAt?: boolean;
+}>;
+export declare type PracticeConfigPracticeLocaleSwitcher = PracticeConfig<PracticeConfigKind.PracticeLocaleSwitcher, {
+    hideLocaleSwitcher?: boolean;
+}>;
+export declare type PracticeConfigPractitionerChatbox = PracticeConfig<PracticeConfigKind.PractitionerChatbox, {
+    planAddedMessage?: {
+        [languageISO639_3: string]: string;
+    };
+    planUpdatedMessage?: {
+        [languageISO639_3: string]: string;
+    };
+}>;
+export declare type PracticeConfigPracticeCookieBanner = PracticeConfig<PracticeConfigKind.PracticeCookieBanner, {
+    showCookieBanner?: boolean;
+    policyLink?: string;
+    useOfCookieLink?: string;
+}>;
+export declare type PracticeConfigPracticeTheme = PracticeConfig<PracticeConfigKind.PracticeTheme, {
+    primaryColor?: string;
+}>;
+export declare type PracticeConfigs = PracticeConfigPractitionerConsultList | PracticeConfigPractitionerChatbox | PracticeConfigPracticeLocaleSwitcher | PracticeConfigPracticeCookieBanner | PracticeConfigPracticeTheme;
+export interface PracticeWorkflow {
+    id?: number;
+    uuidPractice: string;
+    uuidWorkflow: string;
+    typeWorkflow: WorkflowType;
+    tagSpecialty?: string;
+}
+export declare type PracticeWorkflowWithTagSpecialty = PracticeWorkflow & {
+    tagSpecialty: string;
+};
+export interface PracticePlan {
+    id?: number;
+    uuidPractice: string;
+    isoLocality?: string;
+    nameDefault: string;
+    descDefault: string;
+    hoursExpiration: number;
+    active: boolean;
+    namePriceCurrency: string;
+    numPriceAmount: number;
+    numPriceExtDecimal?: number;
+    numPriceExtNegativeExponential?: number;
+    kind: PlanType;
+    idStripeProduct: string;
+    idStripePrice: string;
+    dateCreatedAt: Date;
+    dateUpdateAt: Date;
+    ratePerThousandOverride: number;
+}
+export declare enum StripePriceType {
+    Default = "Default",
+    Discount = "Discount"
+}
+export interface PracticePrice {
+    /**
+     * Unique identifier for the object in Stripe.
+     */
+    idStripePrice: string;
+    /**
+     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+     */
+    currency: string;
+    /**
+     * The unit amount in %s to be charged, represented as a whole integer if possible.
+     */
+    unitAmount: number;
+}
+export interface PracticePlanPrices {
+    idPlan: number;
+    default: PracticePrice;
+    discount?: PracticePrice;
+}
+export interface PracticeRate {
+    id?: number;
+    uuidPractice: string;
+    idPlan: number;
+    isoLocality?: string;
+    dimension: RateDimension;
+    description: string;
+    uidTaxRate: string;
+    idStripeTaxRate: string;
+}
+export interface PracticePlatformFee {
+    uuidPractice: string;
+    idPlan: number;
+    isoLocality?: string;
+    numPlatformFinalFee: number;
+}
+export interface PracticePayment {
+    id?: number;
+    uuidPractice: string;
+    idPlan: number;
+    uuidConsult: string;
+    hoursConsultExpiration: number;
+    idStripeInvoiceOrPaymentIntent: string;
+    status: PaymentStatus;
+    dateCreatedAt: Date;
+    dateUpdateAt: Date;
+}
+export interface PracticePaymentIntent {
+    id?: number;
+    uuidPractice: string;
+    idPlan: number;
+    idPayment: number;
+    hoursPlanExpiration: number;
+    isoLocality?: string;
+    textPaymentMethodOptions: string;
+    nameCurrency: string;
+    numTotalAmount: number;
+    numPlatformFeeAmount: number;
+    idStripeInvoice: string;
+    idStripePaymtIntent: string;
+    stripeClientSecret: string;
+    dateCreatedAt?: Date;
+    dateUpdateAt?: Date;
+}
+export interface Assignment {
+    id?: number;
+    uuidPractice: string;
+    uuidAssignor: string;
+    uuidPractitioner?: string;
+    status?: AssignmentStatus;
+    uuidConsult?: string;
+    tagSpecialty?: string;
+    timeAssigned?: string;
+}
+export interface PractitionerRole {
+    id?: number;
+    uuidPractice: string;
+    uuidPractitioner: string;
+    role: PractitionnerRoleType;
+    dateGiven?: Date;
+}
+export interface PractitionerLicense {
+    id?: number;
+    uuidPractitioner: string;
+    country: string;
+    tagSpecialty: string;
+    isoLocality: string;
+    txtLicenseNumber: string;
+    txtComplementary?: string;
+    dateProvidedAt?: Date;
+    dateObtainedAt?: Date;
+    dateRenewedAt?: Date;
+    status?: LicenseStatus;
+}
+export interface PractitionerPreference {
+    id?: number;
+    uuidPractitioner: string;
+    uuidPractice: string;
+    tagSpecialties: string;
+    isoLocalityConsult?: string;
+    periodQuotaConsult?: PeriodType;
+    quantityQuotaConsult?: number;
+    tagConsultLanguages?: string;
+}
+export interface PractitionerQuota {
+    id?: number;
+    uuidPractitioner: string;
+    uuidPractice: string;
+    tagSpecialty: string;
+    isoLocality: string;
+    quantityLeft?: number;
+    dateRenewal?: Date;
+    dateLastUpdate?: Date;
+}
+export interface Practitioner {
+    uuid: string;
+    uuidPractice: string;
+    txtFirstName: string;
+    txtLastName: string;
+    txtTitle: string;
+    emailAddress: string;
+    tagsSpecialties: string;
+    arrLanguages: string;
+    dateAddedAt?: Date;
+    status?: PractitionerStatus;
+    txtAddressTransmission?: string;
+}
+export interface HydratedPracticeConfigs {
+    [PracticeConfigKind.PractitionerConsultList]?: PracticeConfigPractitionerConsultList;
+    [PracticeConfigKind.PractitionerChatbox]?: PracticeConfigPractitionerChatbox;
+    [PracticeConfigKind.PracticeTheme]?: PracticeConfigPracticeTheme;
+    [PracticeConfigKind.PracticeLocaleSwitcher]?: PracticeConfigPracticeLocaleSwitcher;
+    [PracticeConfigKind.PracticeCookieBanner]?: PracticeConfigPracticeCookieBanner;
+}
+export interface Practice {
+    uuid: string;
+    name: string;
+    countryOperating: string;
+    urlPractice: string;
+    urlLinkedPage?: string;
+    urlTos?: string;
+    urlConfidentiality?: string;
+    uuidAdmin: string;
+    uuidDefaultAssigned: string;
+    uuidDefaultFallback: string;
+    prefDefaultLang: string;
+    keyGoogleTagNonProd: string;
+    keyGoogleTagProd: string;
+    txtAddress?: string;
+    phoneBusiness?: string;
+    urlSupport?: string;
+    emailSupport?: string;
+    phoneSupport?: string;
+    phoneFax?: string;
+    txtTaxID?: string;
+    txtVATID?: string;
+    txtRegistrationID?: string;
+    txtLegalInfos?: string;
+    txtDefaultTransmissionDriver?: string;
+    accounts?: PracticeAccount[];
+    configs?: HydratedPracticeConfigs;
+}
+export interface Sync {
+    id?: number;
+    status?: SyncStatus;
+    descriptionStep: string;
+    dateStarted?: Date;
+    dateFinished?: Date;
+}
+export interface PracticeEmail {
+    id?: number;
+    uuidPractice: string;
+    kind: PracticeEmailKind;
+    idMailgunTemplate: string;
+    isoLanguage: string;
+    tags: string;
+}
+export interface PracticeSubscription {
+    id?: number;
+    uuidPractice: string;
+    idMailChimpAudience: string;
+    isoLanguage: string;
+}

package/dist/models/shared.d.ts

@@ -0,0 +1,8 @@
+export declare type Uuid = string;
+export declare type Url = string;
+export declare type Base64String = string;
+export declare type Metadata = {
+    [val: string]: any;
+};
+export declare type TokenData = Metadata;
+export declare type RFC3339Date = string;

package/dist/models/vault.d.ts

@@ -0,0 +1,124 @@
+import { Uuid, Base64String, Metadata } from './shared';
+import { MetadataCategory } from './workflow';
+export interface LockboxCreateResponse {
+    lockboxUuid: Uuid;
+}
+export interface SharedSecretResponse {
+    sharedSecret: Base64String;
+}
+export interface LockboxGrantRequest {
+    granteeUuid: Uuid;
+    encryptedSecret: Base64String;
+}
+export interface LockboxDataRequest {
+    publicMetadata?: Metadata;
+    privateMetadata?: Base64String;
+    data: Base64String;
+}
+export declare type LockboxManifest = ManifestEntry[];
+export interface ManifestEntry {
+    dataUuid: Uuid;
+    metadata: Metadata;
+}
+export interface GrantedLockboxes {
+    grants: Grant[];
+}
+export interface Grant {
+    lockboxOwnerUuid?: Uuid;
+    encryptedLockbox?: Base64String;
+    lockboxUuid?: Uuid;
+}
+export interface DataCreateResponse {
+    dataUuid: Uuid;
+}
+export interface DataResponse {
+    data: Base64String;
+}
+export interface IndexEntry {
+    uuid?: Uuid;
+    uniqueHash?: Base64String;
+    timestamp?: Date;
+}
+export interface IndexConsultLockbox extends IndexEntry {
+    consultationId: Uuid;
+    grant: Grant;
+}
+export interface VaultIndex extends IndexEntry {
+    [IndexKey.ConsultationLockbox]?: IndexConsultLockbox[];
+    [IndexKey.Consultation]?: IndexConsultLockbox[];
+}
+export interface EncryptedVaultIndex {
+    [IndexKey.Consultation]?: EncryptedIndexEntry[];
+    [IndexKey.ConsultationLockbox]?: EncryptedIndexEntry[];
+    [IndexKey.IndexSnapshot]?: EncryptedIndexEntry[];
+}
+export interface EncryptedIndexEntry extends IndexEntry {
+    encryptedIndexEntry: Base64String;
+}
+export declare enum IndexKey {
+    Consultation = "Consultation",
+    IndexSnapshot = "IndexSnapshot",
+    ConsultationLockbox = "ConsultationLockbox"
+}
+export interface Document extends ManifestEntry {
+    lockboxOwnerUuid?: Uuid;
+    lockboxUuid: Uuid;
+}
+export interface Meta {
+    documentType?: DocumentType;
+    category: MetadataCategory;
+    contentType?: string;
+}
+export interface PreferenceMeta extends Meta {
+    category: MetadataCategory.Preference;
+    contentType: 'application/json';
+}
+export interface RecoveryMeta extends Meta {
+    category: MetadataCategory.Recovery;
+    contentType: 'application/json';
+}
+export interface RawConsultationMeta extends Meta {
+    category: MetadataCategory.Raw;
+    contentType: 'application/json';
+    consultationId?: Uuid;
+}
+export interface ConsultationMeta extends Meta {
+    documentType: DocumentType;
+    category: MetadataCategory.Consultation;
+    consultationId?: Uuid;
+}
+export interface ConsultationImageMeta extends ConsultationMeta {
+    idbId: Uuid;
+}
+export interface MedicalMeta extends Meta {
+    documentType: DocumentType.PopulatedWorkflowData | DocumentType.Result | DocumentType.Prescription | DocumentType.DoctorsNote;
+    category: MetadataCategory.Medical;
+    consultationIds?: Uuid[];
+}
+export interface PersonalMeta {
+    documentType: DocumentType.PopulatedWorkflowData | DocumentType.Note;
+    category: MetadataCategory.Personal | MetadataCategory.ChildPersonal | MetadataCategory.OtherPersonal;
+    consultationIds?: Uuid[];
+}
+export declare enum DocumentType {
+    Message = "Message",
+    Note = "Note",
+    DoctorsNote = "DoctorsNote",
+    Prescription = "Prescription",
+    ExamRequest = "ExamRequest",
+    Result = "Result",
+    Attachment = "Attachment",
+    BigFile = "BigFile",
+    MeetingRequest = "MeetingRequest",
+    AudioNote = "AudioNote",
+    VideoNote = "VideoNote",
+    PopulatedWorkflowData = "PopulatedWorkflowData",
+    TreatmentPlan = "TreatmentPlan",
+    ImageAlias = "ImageAlias"
+}
+export interface LocalizedData<T = any> {
+    lockboxOwnerUuid?: string;
+    lockboxUuid: string;
+    dataUuid: string;
+    data: T;
+}

package/dist/models/workflow.d.ts

@@ -0,0 +1,106 @@
+export interface IndexedData<T> {
+    [key: string]: T;
+}
+export declare type SelectedAnswerData = string | string[];
+export declare type SelectedAnswersData = IndexedData<SelectedAnswerData>[];
+export interface ChoiceInputData {
+    text: string;
+    className?: string;
+    order?: number;
+}
+export interface RadioInputIconOptionsData {
+    variant: 'icon';
+    icon: string;
+}
+export interface RadioInputData extends ChoiceInputData {
+    options?: RadioInputIconOptionsData;
+}
+export interface RadioCardInputData extends RadioInputData {
+    bodyText: string;
+}
+export interface EntryData {
+    id?: number;
+    label?: string;
+    summaryLabel?: string;
+    summaryHidden?: boolean;
+    className?: string;
+    triggers?: string[];
+}
+export declare enum MetadataCategory {
+    ChildPersonal = "ChildPersonal",
+    Consultation = "Consultation",
+    DataRetrieval = "DataRetrieval",
+    Followup = "Followup",
+    Recovery = "Recovery",
+    Medical = "Medical",
+    OtherPersonal = "OtherPersonal",
+    Personal = "Personal",
+    Preference = "Preference",
+    Prescription = "Prescription",
+    Raw = "Raw"
+}
+export interface GenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends EntryData {
+    kind: T;
+    metaCategory: MetadataCategory;
+    answers?: A;
+    formValidation?: any[];
+    placeholder?: string;
+    defaultValue?: any;
+    value?: string;
+}
+export interface GroupedGenericQuestionData<T, A = IndexedData<ChoiceInputData>> extends GenericQuestionData<T, A> {
+    inline?: boolean;
+    inlineLabel?: boolean;
+    order?: number;
+}
+export declare type QuestionData = GenericQuestionData<'title' | 'paragraph' | 'checkbox', void> | GenericQuestionData<'text' | 'date' | 'number' | 'images' | 'images-alias' | 'body-parts' | 'pharmacy-picker' | 'place-address'> | GenericQuestionData<'checkbox-group' | 'select' | 'multiple', IndexedData<ChoiceInputData>> | GroupedGenericQuestionData<'radio', IndexedData<RadioInputData>> | GroupedGenericQuestionData<'radio-card', IndexedData<RadioCardInputData>>;
+export interface FieldData {
+    type: 'field';
+    className?: string;
+    id: string;
+}
+export interface FieldGroupData {
+    type: 'field-group';
+    className?: string;
+    fieldsAndGroups: (FieldData | FieldGroupData)[];
+    name?: string;
+    inline?: boolean;
+    fullWidth?: boolean;
+}
+export interface WorkflowPageData {
+    className?: string;
+    groups?: FieldGroupData[];
+    highlightMsg?: string;
+    questions: IndexedData<QuestionData>;
+    title?: string;
+    triggers?: string[];
+}
+export interface WorkflowData {
+    createdAt: string;
+    culDeSacs: EntryData[];
+    id: string;
+    locale?: string;
+    pages: WorkflowPageData[];
+    summaryImageFieldName?: string;
+    summarySymptomsFieldName?: string;
+    selectedAnswers?: SelectedAnswersData;
+}
+/**
+ * This interface describes a workflow prepared and ready to be sent to vault
+ */
+export interface WorkflowUploadedImage {
+    idbId?: string;
+    name: string;
+    imageData?: string;
+}
+export interface PopulatedWorkflowField {
+    answer: SelectedAnswerData | WorkflowUploadedImage[];
+    displayedAnswer?: any;
+    kind: string;
+}
+export interface PopulatedWorkflowData {
+    workflowId: string;
+    workflowCreatedAt: string;
+    locale?: string;
+    fields: Record<string, PopulatedWorkflowField>;
+}