@royalinvest/dto 0.64.2 → 0.66.1

package/dist/credit-check/creditCheck.d.ts

@@ -0,0 +1,277 @@
+import { IAddress } from "../address";
+import { IAnsweredQuestionnaire } from "./screeningQuestionnaireAnswered";
+import { LocaleType } from "../types";
+export type TBureau = "transunion" | "equifax";
+export type TCreditCheckStatus = "pass" | "fail" | "review" | "not_found";
+export type TCreditScoreTier = "a_plus" | "a" | "b_plus" | "b" | "c_plus" | "c" | "d" | "f";
+export type TCreditCheckRequestStatus = "draft" | "pending" | "completed" | "failed" | "expired" | "cancelled";
+export type TCreditCheckInitiated = "tenant_initiated" | "landlord_initiated";
+export type TConsentAuditAction = "sent" | "resent" | "viewed" | "confirmed" | "failed";
+export type TConsentStatus = "none" | "pending" | "confirmed" | "expired" | "cancelled";
+export type IConsentMethod = "checkbox" | "uploaded_file";
+export type TReason = {
+    code: string;
+    message: string;
+    delta: number;
+};
+export interface ICreateDraftCreditCheckRequest {
+    request_type: TCreditCheckInitiated;
+    bureau: TBureau;
+    screening_questionnaire_id?: string;
+}
+export interface ICreateDraftCreditCheckResponse {
+    request_id: string;
+    subject_id: string;
+    consent_id: string;
+    status: TCreditCheckRequestStatus;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface ICreditCheckRequest {
+    id: string;
+    user_id: string;
+    request_type: TCreditCheckInitiated;
+    status: TCreditCheckRequestStatus;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface ICreditCheckRequestResponse {
+    id: string;
+    rental_unit_id: string;
+    request_type: TCreditCheckInitiated;
+    status: TCreditCheckRequestStatus;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface ISubject {
+    id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    consent?: ISubjectConsent;
+}
+export interface ISubjectExtended {
+    id: string;
+    first_name: string;
+    middle_name: string;
+    last_name: string;
+    email: string;
+    phone?: string;
+    dob: Date;
+    ssn?: string;
+    addresses?: ISubjectAddress[];
+    consent?: ISubjectConsent;
+    errors?: ICreditCheckError;
+}
+export interface ISubjectConsent {
+    id: string;
+    status: TConsentStatus;
+    consent_confirmed_at?: Date;
+    audits?: ICreditCheckConsentAuditResponse[];
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface ICreditCheckRentalQueryUnit {
+    unit_number?: string;
+    property: IAddress;
+}
+export interface ICreditCheckRequestQueryList {
+    id: string;
+    request_type: TCreditCheckInitiated;
+    status: TCreditCheckRequestStatus;
+    subjects: ISubject[];
+    rental_unit: ICreditCheckRentalQueryUnit;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface ICreditCheckRequestList {
+    id: string;
+    request_type: TCreditCheckInitiated;
+    status: TCreditCheckRequestStatus;
+    rental_unit_id: string;
+    subjects: ISubjectExtended[];
+    rental_address: IAddress;
+    created_at?: Date;
+    updated_at?: Date;
+}
+export interface ISubjectAddress extends IAddress {
+    isCurrent: boolean;
+    order: number;
+}
+export interface ICreditCheckSubjectRequest {
+    id: string;
+    credit_check_request_id: string;
+    bureau: TBureau;
+    first_name: string;
+    last_name: string;
+    middle_name?: string;
+    dob: Date | null;
+    email?: string;
+    phone?: string;
+    ssn?: string;
+    addresses?: ISubjectAddress[];
+    credit_type?: string;
+    credit_number?: string;
+    addons?: string[];
+}
+export interface ICreditCheckConsentRequest {
+    credit_check_subject_id: string;
+    consent_confirmed: boolean;
+    consent_confirmed_at: Date;
+    consent_method: IConsentMethod;
+    consent_uploaded_file_url?: string;
+    ip_address?: string;
+    user_agent?: string;
+}
+export interface ICreditCheckConsentResponse {
+    id: string;
+    consent_confirmed: boolean;
+    consent_confirmed_at: Date;
+    consent_method: IConsentMethod;
+    consent_uploaded_file_url?: string;
+    ip_address?: string;
+    user_agent?: string;
+}
+export interface ICreditCheckSubjectResponse {
+    id: string;
+    credit_check_request_id: string;
+    bureau: TBureau;
+    first_name: string;
+    last_name: string;
+    middle_name?: string;
+    date_of_birth?: Date | string | null;
+    email?: string;
+    phone?: string;
+    ssn?: string;
+    credit_type?: string;
+    credit_number?: string;
+    addresses: ISubjectAddress[];
+    created_at: Date;
+    updated_at: Date;
+}
+export interface ICreditCheckResult {
+    id: string;
+    subject_id: string;
+    status: TCreditCheckStatus;
+    score: number;
+    tier?: TCreditScoreTier;
+    risk_index?: number;
+    bankruptcies?: number;
+    collections?: number;
+    inquiries: number;
+    trades: number;
+    flags: string[];
+    created_at: Date;
+    reason_codes?: TReason[];
+}
+export interface ICreditCheckReportFile {
+    id: string;
+    subject_id: string;
+    file_url: string;
+    created_at: Date;
+    expires_at: Date;
+}
+export interface ICreditCheckInviteLinkRequest {
+    credit_check_subject_id: string;
+    tenant_email: string;
+    tenant_first_name: string;
+    tenant_last_name: string;
+    rental_address: IAddress;
+}
+export interface ICreditCheckConsentInviteLinkRequest {
+    credit_check_subject_id: string;
+}
+export interface ICreditCheckConsentCancelRequest {
+    credit_check_consent_id: string;
+}
+export interface ICreditCheckInviteLinkResponse {
+    id: string;
+    credit_check_subject_id: string;
+    token: string;
+    expires_at: Date;
+}
+export interface ICreditCheckRequested {
+    credit_check_subject_id: string;
+    bureau: TBureau;
+    document_language: LocaleType;
+    property_address: string;
+    first_name: string;
+    last_name: string;
+    dob: Date;
+    addresses?: ISubjectAddress[];
+    middle_name?: string;
+    ssn?: string;
+    phone?: string;
+    email?: string;
+    credit_card_number?: string;
+    credit_card_type?: string;
+    addons?: string[];
+    request_tty?: boolean;
+    questionnaire?: IAnsweredQuestionnaire;
+}
+export interface ICreditCheckFailed {
+    credit_check_subject_id: string;
+    error_code: string;
+    error_message: string;
+    bureau_reference_id: string;
+}
+export interface ICreditCheckForDashboard {
+    credit_check_subject_id: string;
+    bureau_reference_id: string;
+    status: TCreditCheckStatus;
+    score: number;
+    tier?: TCreditScoreTier;
+    risk_index?: number;
+    bankruptcies: number;
+    collections: number;
+    inquiries: number;
+    trades: number;
+    flags?: string[];
+    report_json_url?: string;
+    raw_xml_url?: string;
+    reason_codes?: TReason[];
+}
+export interface ICreditCheckConsentAuditResponse {
+    id: string;
+    ip_address: string;
+    action: TConsentAuditAction;
+    status: TConsentStatus;
+    created_at: Date;
+}
+export interface ICreditCheckConsentExtendedResponse {
+    id: string;
+    first_name: string;
+    last_name: string;
+    email: string;
+    status: TConsentStatus;
+    confirmed: boolean;
+    confirmed_at: Date;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface ICreditCheckConsentTenantInfoResponse {
+    id: string;
+    consent_id: string;
+    tenant_first_name: string;
+    tenant_last_name: string;
+    sender_first_name: string;
+    sender_last_name: string;
+    sender_email: string;
+    screening_questionnaire_id?: string;
+    rental_address: IAddress;
+    tenant_email: string;
+    user_id?: string;
+}
+export interface ICreditCheckReportFileDownload {
+    id: string;
+    file_base64: string;
+    file_type: string;
+    file_name: string;
+}
+export interface ICreditCheckError {
+    id: string;
+    subject_id: string;
+    error_code: string;
+    error_message: string;
+    bureau_reference_id?: string;
+}

package/dist/{messageNotification.js → credit-check/creditCheck.js}

@@ -1,2 +1,3 @@
 "use strict";
+// Credit Check
 Object.defineProperty(exports, "__esModule", { value: true });

package/dist/credit-check/index.d.ts

@@ -1,267 +1,3 @@
-import { IAddress } from "../address";
-import { LocaleType } from "../types";
-export type TBureau = "transunion" | "equifax";
-export type TCreditCheckStatus = "pass" | "fail" | "review" | "not_found";
-export type TCreditScoreTier = "a_plus" | "a" | "b_plus" | "b" | "c_plus" | "c" | "d" | "f";
-export type TCreditCheckRequestStatus = "draft" | "pending" | "completed" | "failed" | "expired" | "cancelled";
-export type TCreditCheckInitiated = "tenant_initiated" | "landlord_initiated";
-export type TConsentAuditAction = "sent" | "resent" | "viewed" | "confirmed" | "failed";
-export type TConsentStatus = "none" | "pending" | "confirmed" | "expired" | "cancelled";
-export type IConsentMethod = "checkbox" | "uploaded_file";
-export type TReason = {
-    code: string;
-    message: string;
-    delta: number;
-};
-export interface ICreateDraftCreditCheckRequest {
-    request_type: TCreditCheckInitiated;
-    bureau: TBureau;
-    screening_questionnaire_id?: string;
-}
-export interface ICreateDraftCreditCheckResponse {
-    request_id: string;
-    subject_id: string;
-    consent_id: string;
-    status: TCreditCheckRequestStatus;
-    created_at: Date;
-    updated_at: Date;
-}
-export interface ICreditCheckRequest {
-    id: string;
-    user_id: string;
-    request_type: TCreditCheckInitiated;
-    status: TCreditCheckRequestStatus;
-    created_at?: Date;
-    updated_at?: Date;
-}
-export interface ICreditCheckRequestResponse {
-    id: string;
-    rental_unit_id: string;
-    request_type: TCreditCheckInitiated;
-    status: TCreditCheckRequestStatus;
-    created_at?: Date;
-    updated_at?: Date;
-}
-export interface ISubject {
-    id: string;
-    first_name: string;
-    last_name: string;
-    email: string;
-    consent?: ISubjectConsent;
-}
-export interface ISubjectExtended {
-    id: string;
-    first_name: string;
-    middle_name: string;
-    last_name: string;
-    email: string;
-    phone?: string;
-    dob: Date;
-    ssn?: string;
-    addresses?: ISubjectAddress[];
-    consent?: ISubjectConsent;
-}
-export interface ISubjectConsent {
-    id: string;
-    status: TConsentStatus;
-    consent_confirmed_at?: Date;
-    audits?: ICreditCheckConsentAuditResponse[];
-    created_at?: Date;
-    updated_at?: Date;
-}
-export interface ICreditCheckRentalQueryUnit {
-    unit_number?: string;
-    property: IAddress;
-}
-export interface ICreditCheckRequestQueryList {
-    id: string;
-    request_type: TCreditCheckInitiated;
-    status: TCreditCheckRequestStatus;
-    subjects: ISubject[];
-    rental_unit: ICreditCheckRentalQueryUnit;
-    created_at?: Date;
-    updated_at?: Date;
-}
-export interface ICreditCheckRequestList {
-    id: string;
-    request_type: TCreditCheckInitiated;
-    status: TCreditCheckRequestStatus;
-    rental_unit_id: string;
-    subjects: ISubjectExtended[];
-    rental_address: IAddress;
-    created_at?: Date;
-    updated_at?: Date;
-}
-export interface ISubjectAddress extends IAddress {
-    isCurrent: boolean;
-    order: number;
-}
-export interface ICreditCheckSubjectRequest {
-    id: string;
-    credit_check_request_id: string;
-    bureau: TBureau;
-    first_name: string;
-    last_name: string;
-    middle_name?: string;
-    dob: Date | null;
-    email?: string;
-    phone?: string;
-    ssn?: string;
-    addresses?: ISubjectAddress[];
-    credit_type?: string;
-    credit_number?: string;
-    addons?: string[];
-}
-export interface ICreditCheckConsentRequest {
-    credit_check_subject_id: string;
-    consent_confirmed: boolean;
-    consent_confirmed_at: Date;
-    consent_method: IConsentMethod;
-    consent_uploaded_file_url?: string;
-    ip_address?: string;
-    user_agent?: string;
-}
-export interface ICreditCheckConsentResponse {
-    id: string;
-    consent_confirmed: boolean;
-    consent_confirmed_at: Date;
-    consent_method: IConsentMethod;
-    consent_uploaded_file_url?: string;
-    ip_address?: string;
-    user_agent?: string;
-}
-export interface ICreditCheckSubjectResponse {
-    id: string;
-    credit_check_request_id: string;
-    bureau: TBureau;
-    first_name: string;
-    last_name: string;
-    middle_name?: string;
-    date_of_birth?: Date | string | null;
-    email?: string;
-    phone?: string;
-    ssn?: string;
-    credit_type?: string;
-    credit_number?: string;
-    addresses: ISubjectAddress[];
-    created_at: Date;
-    updated_at: Date;
-}
-export interface ICreditCheckResult {
-    id: string;
-    subject_id: string;
-    status: TCreditCheckStatus;
-    score: number;
-    tier?: TCreditScoreTier;
-    risk_index?: number;
-    bankruptcies?: number;
-    collections?: number;
-    inquiries: number;
-    trades: number;
-    flags: string[];
-    created_at: Date;
-    reason_codes?: TReason[];
-}
-export interface ICreditCheckReportFile {
-    id: string;
-    subject_id: string;
-    file_url: string;
-    created_at: Date;
-    expires_at: Date;
-}
-export interface ICreditCheckInviteLinkRequest {
-    credit_check_subject_id: string;
-    tenant_email: string;
-    tenant_first_name: string;
-    tenant_last_name: string;
-    rental_address: IAddress;
-}
-export interface ICreditCheckConsentInviteLinkRequest {
-    credit_check_subject_id: string;
-}
-export interface ICreditCheckConsentCancelRequest {
-    credit_check_consent_id: string;
-}
-export interface ICreditCheckInviteLinkResponse {
-    id: string;
-    credit_check_subject_id: string;
-    token: string;
-    expires_at: Date;
-}
-export interface ICreditCheckRequested {
-    credit_check_subject_id: string;
-    bureau: TBureau;
-    document_language: LocaleType;
-    property_address: string;
-    first_name: string;
-    last_name: string;
-    dob: Date;
-    addresses?: ISubjectAddress[];
-    middle_name?: string;
-    ssn?: string;
-    phone?: string;
-    email?: string;
-    credit_card_number?: string;
-    credit_card_type?: string;
-    addons?: string[];
-    request_tty?: boolean;
-}
-export interface ICreditCheckFailed {
-    credit_check_subject_id: string;
-    error_code: string;
-    error_message: string;
-    bureau_reference_id: string;
-}
-export interface ICreditCheckForDashboard {
-    credit_check_subject_id: string;
-    bureau_reference_id: string;
-    status: TCreditCheckStatus;
-    score: number;
-    tier?: TCreditScoreTier;
-    risk_index?: number;
-    bankruptcies: number;
-    collections: number;
-    inquiries: number;
-    trades: number;
-    flags?: string[];
-    report_json_url?: string;
-    raw_xml_url?: string;
-    reason_codes?: TReason[];
-}
-export interface ICreditCheckConsentAuditResponse {
-    id: string;
-    ip_address: string;
-    action: TConsentAuditAction;
-    status: TConsentStatus;
-    created_at: Date;
-}
-export interface ICreditCheckConsentExtendedResponse {
-    id: string;
-    first_name: string;
-    last_name: string;
-    email: string;
-    status: TConsentStatus;
-    confirmed: boolean;
-    confirmed_at: Date;
-    created_at: Date;
-    updated_at: Date;
-}
-export interface ICreditCheckConsentTenantInfoResponse {
-    id: string;
-    consent_id: string;
-    tenant_first_name: string;
-    tenant_last_name: string;
-    sender_first_name: string;
-    sender_last_name: string;
-    sender_email: string;
-    screening_questionnaire_id?: string;
-    rental_address: IAddress;
-    tenant_email: string;
-    user_id?: string;
-}
-export interface ICreditCheckReportFileDownload {
-    id: string;
-    file_base64: string;
-    file_type: string;
-    file_name: string;
-}
+export * from "./creditCheck";
+export * from "./screeningQuestionnaire";
+export * from "./screeningQuestionnaireAnswered";

package/dist/credit-check/index.js

@@ -1,3 +1,19 @@
 "use strict";
-// Credit Check
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./creditCheck"), exports);
+__exportStar(require("./screeningQuestionnaire"), exports);
+__exportStar(require("./screeningQuestionnaireAnswered"), exports);

package/dist/credit-check/screeningQuestionnaire.d.ts

@@ -0,0 +1 @@
+export type QuestionOptionType = "text" | "multiple_choice" | "dual_choice" | "date" | "file";

package/dist/credit-check/screeningQuestionnaireAnswered.d.ts

@@ -0,0 +1,24 @@
+import { QuestionOptionType } from "./screeningQuestionnaire";
+export interface IAnsweredQuestionnaire {
+    sections: IAnsweredQuestionnaireSection[];
+}
+export interface IAnsweredQuestionnaireSection {
+    section_title_key: string;
+    questions: IAnsweredQuestionnaireQuestion[];
+}
+export interface IAnsweredQuestionnaireQuestion {
+    id: string;
+    question_key: string;
+    type: QuestionOptionType;
+    answer: IAnsweredQuestionnaireAnswer;
+}
+export type IAnsweredQuestionnaireAnswer = IAnsweredQuestionnaireTextAnswer | IAnsweredQuestionnaireOptionAnswer | IAnsweredQuestionnaireFileAnswer;
+export interface IAnsweredQuestionnaireTextAnswer {
+    answer_text: string;
+}
+export interface IAnsweredQuestionnaireOptionAnswer {
+    option_keys: string[];
+}
+export interface IAnsweredQuestionnaireFileAnswer {
+    file_paths: string[];
+}

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from "./contractAttachment";
 export * from "./contractParty";
 export * from "./contractUsage";
 export * from "./country";
+export * from "./credit-check";
 export * from "./creditCheckReport";
 export * from "./documentDrawingInstructions";
 export * from "./emailMessage";
@@ -70,7 +71,6 @@ export * from "./tableData";
 export * from "./template-variant";
 export * from "./template";
 export * from "./types";
+export * from "./usa";
 export * from "./user";
 export * from "./yes-no";
-export * from "./usa";
-export * from "./credit-check";

package/dist/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./contractAttachment"), exports);
 __exportStar(require("./contractParty"), exports);
 __exportStar(require("./contractUsage"), exports);
 __exportStar(require("./country"), exports);
+__exportStar(require("./credit-check"), exports);
 __exportStar(require("./creditCheckReport"), exports);
 __exportStar(require("./documentDrawingInstructions"), exports);
 __exportStar(require("./emailMessage"), exports);
@@ -86,7 +87,6 @@ __exportStar(require("./tableData"), exports);
 __exportStar(require("./template-variant"), exports);
 __exportStar(require("./template"), exports);
 __exportStar(require("./types"), exports);
+__exportStar(require("./usa"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./yes-no"), exports);
-__exportStar(require("./usa"), exports);
-__exportStar(require("./credit-check"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@royalinvest/dto",
-  "version": "0.64.2",
+  "version": "0.66.1",
   "description": "Data Transfer Objects (DTOs) to carry data between frontend and backend processes.",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",

package/dist/messageBrokerEvent.d.ts

@@ -1,5 +0,0 @@
-export interface IMessageBrokerEvent<TPayload> {
-    http_request_id: string;
-    user_id: string;
-    payload: TPayload;
-}

package/dist/messageGenerate.d.ts

@@ -1,57 +0,0 @@
-import { LeaseTypeEnum } from "./enum";
-import { ICertificateFormData } from "./certificateFormData";
-import { IContractParty } from "./contractParty";
-import { IDocumentDrawingInstructions } from "./documentDrawingInstructions";
-import { IFileMetadata } from "./fileMetadata";
-import { ISignaturePartySigned } from "./signaturePartySigned";
-import { IInvoiceRenderData } from "./invoiceRenderData";
-import { ICreditCheckReportData } from "./creditCheckReport";
-export interface IMessageGenerate {
-    contract_id: string;
-    details: JSON;
-    user_id: string;
-    template_variant_file_name: string;
-    template_variant_name: string;
-    template_variant_language: string;
-    template_variant_mime_type: string;
-    template_variant_id: string;
-    template_name: LeaseTypeEnum;
-    file_id?: string;
-    isEdit?: boolean;
-    contract_parties?: IContractParty[];
-    drawing_instructions?: IDocumentDrawingInstructions;
-    metadata?: IFileMetadata;
-}
-export interface IMessageGenerateSigned {
-    party: ISignaturePartySigned;
-    generate_hash?: boolean;
-}
-export interface IMessageGenerateVoided {
-    user_id: string;
-    contract_id: string;
-    file_id: string;
-    file_name: string;
-    notify_party_email: boolean;
-    generate_hash?: boolean;
-}
-export interface IMessageGenerateCertificate {
-    file_id: string;
-    blob_path: string;
-    form_data: ICertificateFormData;
-    form_instructions: JSON;
-    language: string;
-}
-export interface IMessageGenerateInvoice {
-    user_id: string;
-    billing_id: string;
-    blob_path: string;
-    invoice_number: string;
-    language: string;
-    data: IInvoiceRenderData;
-}
-export interface IMessageGenerateCreditCheckReport {
-    report_data: ICreditCheckReportData;
-    subject_id: string;
-    blob_path: string;
-    language: string;
-}

package/dist/messageNotification.d.ts

@@ -1,45 +0,0 @@
-import { IPhysicalFileDetails } from "./physicalFileDetails";
-import { IPlaceholderCollection } from "./placeholderCollection";
-import { ISignaturePartyBasic } from "./signaturePartyBasic";
-export interface IGeneratedNotification {
-    contract_id: string;
-    user_id: string;
-    file_name: string;
-    file_language: string;
-    mime_type: string;
-    template_name: string;
-    template_variant_id: string;
-    file_id?: string;
-    isEdit?: boolean;
-    generated_placeholders?: IPlaceholderCollection;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface ISignedNotification {
-    file_id: string;
-    party: ISignaturePartyBasic;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface IVoidedNotification {
-    user_id: string;
-    file_id: string;
-    contract_id: string;
-    notify_party_email: boolean;
-    generated_file_details?: IPhysicalFileDetails;
-}
-export interface IGeneratedCertificateNotification {
-    file_id: string;
-    blob_path: string;
-}
-export interface IGeneratedInvoiceNotification {
-    user_id: string;
-    billing_id: string;
-    blob_path: string;
-    invoice_number: string;
-    language: string;
-}
-export interface IGeneratedCreditCheckReportNotification {
-    subject_id: string;
-    blob_path: string;
-    hash: string;
-    language: string;
-}