@lendi/lead-client - npm Package Compare versions

Comparing version 1.0.0 to 1.0.3

dist/cjs/api.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -34,3 +34,3 @@ *
      */
-    exchangedContract?: BorrowingPowerDataV1ExchangedContractEnum;
+    exchanged_contract?: BorrowingPowerDataV1ExchangedContractEnum;
     /**
@@ -41,3 +41,3 @@ * Describe the person interest in buying the property
      */
-    firstHomeBuyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
+    first_home_buyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
     /**
@@ -48,3 +48,3 @@ * Estimated monthly expenses of the person
      */
-    monthlyExpenses: number;
+    monthly_expenses: number;
     /**
@@ -55,3 +55,3 @@ * Total number of expected borrower for the loan
      */
-    numberOfBorrower: string;
+    number_of_borrower: string;
     /**
@@ -62,3 +62,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: BorrowingPowerDataV1PreApprovedEnum;
+    pre_approved?: BorrowingPowerDataV1PreApprovedEnum;
     /**
@@ -69,3 +69,3 @@ * Estimated yearly income of the person
      */
-    yearlyIncome: string;
+    yearly_income: string;
     /**
@@ -76,3 +76,9 @@ * Describes a person purchasing situation
      */
-    newLoanPurpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+    new_loan_purpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+    /**
+     * Present expected settlement date if any, format as YYYY-MM-DD
+     * @type {string}
+     * @memberof BorrowingPowerDataV1
+     */
+    settlement_date?: string;
 }
@@ -131,3 +137,3 @@ /**
      */
-    contractsExchanged?: boolean;
+    contracts_exchanged?: boolean;
     /**
@@ -138,3 +144,3 @@ * Describe the person interest in buying the property
      */
-    purchaseInterest: BorrowingPowerDataV2PurchaseInterestEnum;
+    purchase_interest: BorrowingPowerDataV2PurchaseInterestEnum;
     /**
@@ -145,3 +151,3 @@ * Estimated monthly expenses of the person
      */
-    monthlyExpenses: number;
+    monthly_expenses: number;
     /**
@@ -152,3 +158,3 @@ * Total number of expected borrower for the loan
      */
-    numberOfBorrowers?: number;
+    number_of_borrowers?: number;
     /**
@@ -159,3 +165,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: boolean;
+    pre_approved?: boolean;
     /**
@@ -166,3 +172,3 @@ * Estimated yearly income of the person
      */
-    yearlyIncome: number;
+    yearly_income: number;
     /**
@@ -173,3 +179,9 @@ * Describes a person purchasing situation
      */
-    purchaseSituation: BorrowingPowerDataV2PurchaseSituationEnum;
+    purchase_situation: BorrowingPowerDataV2PurchaseSituationEnum;
+    /**
+     * Expected settlement date, format as YYYY-MM-DD
+     * @type {string}
+     * @memberof BorrowingPowerDataV2
+     */
+    estimated_settlement_date?: string;
 }
@@ -239,3 +251,3 @@ /**
      */
-    loanPurpose?: string;
+    loan_purpose?: string;
     /**
@@ -246,3 +258,3 @@ * Purpose of looking for new home loan
      */
-    newLoanPurpose?: FunnelDataV1NewLoanPurposeEnum;
+    new_loan_purpose?: FunnelDataV1NewLoanPurposeEnum;
     /**
@@ -253,3 +265,3 @@ * Loan type requested
      */
-    loanType: FunnelDataV1LoanTypeEnum;
+    loan_type: FunnelDataV1LoanTypeEnum;
     /**
@@ -260,3 +272,3 @@ * Current loan value in string
      */
-    loanValue?: string;
+    loan_value?: string;
     /**
@@ -267,3 +279,3 @@ * Property value in string
      */
-    securityValue: string;
+    security_value: string;
     /**
@@ -274,3 +286,3 @@ * Loan deposit amount in string
      */
-    depositAmount?: string;
+    deposit_amount?: string;
     /**
@@ -281,3 +293,3 @@ * Usage of the property
      */
-    propertyUse: FunnelDataV1PropertyUseEnum;
+    property_use: FunnelDataV1PropertyUseEnum;
     /**
@@ -288,3 +300,3 @@ * Loan repayment method
      */
-    repaymentMethod: FunnelDataV1RepaymentMethodEnum;
+    repayment_method: FunnelDataV1RepaymentMethodEnum;
     /**
@@ -295,3 +307,3 @@ * Employment type of the person
      */
-    employmentType: FunnelDataV1EmploymentTypeEnum;
+    employment_type: FunnelDataV1EmploymentTypeEnum;
     /**
@@ -302,3 +314,3 @@ * Indicate if person has self employed proof
      */
-    selfEmployedProof?: FunnelDataV1SelfEmployedProofEnum;
+    self_employed_proof?: FunnelDataV1SelfEmployedProofEnum;
     /**
@@ -309,3 +321,3 @@ * Indicating person\'s credit history
      */
-    creditHistory: FunnelDataV1CreditHistoryEnum;
+    credit_history: FunnelDataV1CreditHistoryEnum;
     /**
@@ -322,3 +334,3 @@ * Indicating desired features
      */
-    totalDebtsConsolidated?: string;
+    total_debts_consolidated?: string;
     /**
@@ -329,3 +341,3 @@ * Total amount to be cash out
      */
-    totalCashoutAmount?: string;
+    total_cashout_amount?: string;
     /**
@@ -336,3 +348,3 @@ * Indicating on the urgency to refinance
      */
-    refinanceUrgency?: FunnelDataV1RefinanceUrgencyEnum;
+    refinance_urgency?: FunnelDataV1RefinanceUrgencyEnum;
     /**
@@ -343,3 +355,3 @@ * Person first name
      */
-    firstName?: string;
+    first_name?: string;
     /**
@@ -350,3 +362,3 @@ * Indicating purpose for apply loan
      */
-    transactionType?: FunnelDataV1TransactionTypeEnum;
+    transaction_type?: FunnelDataV1TransactionTypeEnum;
     /**
@@ -357,3 +369,3 @@ * Stating factors when selecting a lender. Value is concatenated based from the list of items \"offset\", \"redraw\", \"major lender\", \"mobile app\"
      */
-    factorsInChoosingALender: string;
+    factors_in_choosing_a_lender: string;
     /**
@@ -364,3 +376,3 @@ * Indicating if the person has already been pre-approved
      */
-    preApproved?: FunnelDataV1PreApprovedEnum;
+    pre_approved?: FunnelDataV1PreApprovedEnum;
     /**
@@ -371,3 +383,3 @@ * Indicating if the person has already exchange contract
      */
-    exchangedContract?: FunnelDataV1ExchangedContractEnum;
+    exchanged_contract?: FunnelDataV1ExchangedContractEnum;
     /**
@@ -378,3 +390,3 @@ * Present expected settlement date if any, format as YYYY-MM-DD
      */
-    expectedSettlementDate?: string;
+    expected_settlement_date?: string;
 }
@@ -495,3 +507,3 @@ /**
      */
-    employmentType: FunnelDataV2EmploymentTypeEnum;
+    employment_type: FunnelDataV2EmploymentTypeEnum;
     /**
@@ -502,3 +514,3 @@ * Credit history of a person
      */
-    creditStatus: FunnelDataV2CreditStatusEnum;
+    credit_status: FunnelDataV2CreditStatusEnum;
     /**
@@ -509,3 +521,3 @@ * Indicate if a person has already exchanged contract
      */
-    contractsExchanged?: boolean;
+    contracts_exchanged?: boolean;
     /**
@@ -522,3 +534,3 @@ * Deposit amount
      */
-    desiredFeatures: Array<FunnelDataV2DesiredFeaturesEnum>;
+    desired_features: Array<FunnelDataV2DesiredFeaturesEnum>;
     /**
@@ -529,3 +541,3 @@ * Indicate user has proof of self-employment, if any
      */
-    hasSelfEmploymentProof?: boolean;
+    has_self_employment_proof?: boolean;
     /**
@@ -536,3 +548,3 @@ * Prefered repayment method
      */
-    paymentType: FunnelDataV2PaymentTypeEnum;
+    payment_type: FunnelDataV2PaymentTypeEnum;
     /**
@@ -549,3 +561,3 @@ * Intention for applying a loan
      */
-    purchaseSituation?: FunnelDataV2PurchaseSituationEnum;
+    purchase_situation?: FunnelDataV2PurchaseSituationEnum;
     /**
@@ -556,3 +568,3 @@ * Reasons for refinancing, if any
      */
-    refinancingReasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
+    refinancing_reasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
     /**
@@ -563,3 +575,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: boolean;
+    pre_approved?: boolean;
     /**
@@ -570,3 +582,3 @@ * Stating the usage of property
      */
-    propertyUse: FunnelDataV2PropertyUseEnum;
+    property_use: FunnelDataV2PropertyUseEnum;
     /**
@@ -577,3 +589,3 @@ * Current existing loan value for refinancing
      */
-    loanValue?: number;
+    loan_value?: number;
     /**
@@ -584,3 +596,3 @@ * Expected property price
      */
-    securityValue: number;
+    security_value: number;
     /**
@@ -591,3 +603,3 @@ * Expected cashout amount given if user choose to have cashout as part of the loan
      */
-    totalCashoutAmount?: number;
+    total_cashout_amount?: number;
     /**
@@ -604,3 +616,3 @@ * Indicate urgency of applying and getting a loan
      */
-    estimatedSettlementDate?: string;
+    estimated_settlement_date?: string;
 }
@@ -700,4 +712,10 @@ /**
      */
-    generatedAt: string;
+    generated_at: string;
     /**
+     * Time zone name for identifying customer location when making call(s). Refer to https://www.iana.org/time-zones
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    time_zone: string;
+    /**
      * Prefix with Australia international code, e.g. +61
@@ -707,3 +725,3 @@ * @type {string}
      */
-    mobileNumber: string;
+    mobile_number: string;
     /**
@@ -720,5 +738,5 @@ * Email of the potential customer
      */
-    firstName: string;
+    first_name: string;
     /**
-     *
+     * Representation of funnel origin and indicates roughly the journey of the customer originate from
      * @type {string}
@@ -735,2 +753,20 @@ * @memberof LeadsRecord
     /**
+     * Google Click Identifier used for analytical tracking
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    gcl_id?: string;
+    /**
+     * URL value of the origin from where customer landed in the platform webpage
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    account_origin: string;
+    /**
+     *
+     * @type {UTM}
+     * @memberof LeadsRecord
+     */
+    utm?: UTM;
+    /**
      * Data captured that qualified as a lead
@@ -793,3 +829,3 @@ * @type {FunnelDataV1 | BorrowingPowerDataV2 | StampDutyDataV1 | PropertyReportDataV1}
      */
-    relationshipWithProperty: PropertyReportDataV1RelationshipWithPropertyEnum;
+    relationship_with_property: PropertyReportDataV1RelationshipWithPropertyEnum;
 }
@@ -823,3 +859,3 @@ /**
      */
-    relationshipWithProperty: PropertyReportDataV2RelationshipWithPropertyEnum;
+    relationship_with_property: PropertyReportDataV2RelationshipWithPropertyEnum;
 }
@@ -847,3 +883,3 @@ /**
      */
-    depositAmount: string;
+    deposit_amount: string;
     /**
@@ -854,3 +890,3 @@ * Property price
      */
-    securityValue: string;
+    security_value: string;
     /**
@@ -861,3 +897,3 @@ * Status of the person
      */
-    firstHomeBuyer: StampDutyDataV1FirstHomeBuyerEnum;
+    first_home_buyer: StampDutyDataV1FirstHomeBuyerEnum;
     /**
@@ -868,3 +904,3 @@ * State territory
      */
-    propertyState: StampDutyDataV1PropertyStateEnum;
+    property_state: StampDutyDataV1PropertyStateEnum;
     /**
@@ -875,3 +911,3 @@ * Type of property
      */
-    propertyType: StampDutyDataV1PropertyTypeEnum;
+    property_type: StampDutyDataV1PropertyTypeEnum;
     /**
@@ -882,3 +918,3 @@ * Usage of property
      */
-    propertyUse: StampDutyDataV1PropertyUseEnum;
+    property_use: StampDutyDataV1PropertyUseEnum;
 }
@@ -942,3 +978,3 @@ /**
      */
-    securityValue: number;
+    security_value: number;
     /**
@@ -949,3 +985,3 @@ * Status if person is first home buyer
      */
-    isFirstHomeBuyer: boolean;
+    is_first_home_buyer: boolean;
     /**
@@ -956,3 +992,3 @@ * Status if person is a foreign investor
      */
-    isForeignInvestor: boolean;
+    is_foreign_investor: boolean;
     /**
@@ -963,3 +999,3 @@ * State territory
      */
-    propertyState: StampDutyDataV2PropertyStateEnum;
+    property_state: StampDutyDataV2PropertyStateEnum;
     /**
@@ -970,3 +1006,3 @@ * Type of property
      */
-    propertyType: StampDutyDataV2PropertyTypeEnum;
+    property_type: StampDutyDataV2PropertyTypeEnum;
     /**
@@ -977,3 +1013,3 @@ * Usage of property
      */
-    propertyUse: StampDutyDataV2PropertyUseEnum;
+    property_use: StampDutyDataV2PropertyUseEnum;
 }
@@ -1012,2 +1048,39 @@ /**
 /**
+ *
+ * @export
+ * @interface UTM
+ */
+export interface UTM {
+    /**
+     * Identifies the source of where it was being sent from
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_source: string;
+    /**
+     * Identifies the item that was clicked by the user
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_content?: string;
+    /**
+     * Identifies the type of link used, e.g. email, cost per click, etc.
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_medium?: string;
+    /**
+     * Identifies a specific product promotion or strategic campaign
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_campaign?: string;
+    /**
+     * Identifies the search term
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_term?: string;
+}
+/**
  * HealthCheckApi - axios parameter creator
@@ -1014,0 +1087,0 @@ * @export

dist/cjs/api.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -11,0 +11,0 @@ *

dist/cjs/base.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

dist/cjs/base.js

@@ -8,3 +8,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -11,0 +11,0 @@ *

dist/cjs/configuration.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

dist/cjs/configuration.js

@@ -7,3 +7,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -10,0 +10,0 @@ *

dist/cjs/index.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

dist/cjs/index.js

@@ -7,3 +7,3 @@ "use strict";
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -10,0 +10,0 @@ *

dist/types/api.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -34,3 +34,3 @@ *
      */
-    exchangedContract?: BorrowingPowerDataV1ExchangedContractEnum;
+    exchanged_contract?: BorrowingPowerDataV1ExchangedContractEnum;
     /**
@@ -41,3 +41,3 @@ * Describe the person interest in buying the property
      */
-    firstHomeBuyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
+    first_home_buyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
     /**
@@ -48,3 +48,3 @@ * Estimated monthly expenses of the person
      */
-    monthlyExpenses: number;
+    monthly_expenses: number;
     /**
@@ -55,3 +55,3 @@ * Total number of expected borrower for the loan
      */
-    numberOfBorrower: string;
+    number_of_borrower: string;
     /**
@@ -62,3 +62,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: BorrowingPowerDataV1PreApprovedEnum;
+    pre_approved?: BorrowingPowerDataV1PreApprovedEnum;
     /**
@@ -69,3 +69,3 @@ * Estimated yearly income of the person
      */
-    yearlyIncome: string;
+    yearly_income: string;
     /**
@@ -76,3 +76,9 @@ * Describes a person purchasing situation
      */
-    newLoanPurpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+    new_loan_purpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+    /**
+     * Present expected settlement date if any, format as YYYY-MM-DD
+     * @type {string}
+     * @memberof BorrowingPowerDataV1
+     */
+    settlement_date?: string;
 }
@@ -131,3 +137,3 @@ /**
      */
-    contractsExchanged?: boolean;
+    contracts_exchanged?: boolean;
     /**
@@ -138,3 +144,3 @@ * Describe the person interest in buying the property
      */
-    purchaseInterest: BorrowingPowerDataV2PurchaseInterestEnum;
+    purchase_interest: BorrowingPowerDataV2PurchaseInterestEnum;
     /**
@@ -145,3 +151,3 @@ * Estimated monthly expenses of the person
      */
-    monthlyExpenses: number;
+    monthly_expenses: number;
     /**
@@ -152,3 +158,3 @@ * Total number of expected borrower for the loan
      */
-    numberOfBorrowers?: number;
+    number_of_borrowers?: number;
     /**
@@ -159,3 +165,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: boolean;
+    pre_approved?: boolean;
     /**
@@ -166,3 +172,3 @@ * Estimated yearly income of the person
      */
-    yearlyIncome: number;
+    yearly_income: number;
     /**
@@ -173,3 +179,9 @@ * Describes a person purchasing situation
      */
-    purchaseSituation: BorrowingPowerDataV2PurchaseSituationEnum;
+    purchase_situation: BorrowingPowerDataV2PurchaseSituationEnum;
+    /**
+     * Expected settlement date, format as YYYY-MM-DD
+     * @type {string}
+     * @memberof BorrowingPowerDataV2
+     */
+    estimated_settlement_date?: string;
 }
@@ -239,3 +251,3 @@ /**
      */
-    loanPurpose?: string;
+    loan_purpose?: string;
     /**
@@ -246,3 +258,3 @@ * Purpose of looking for new home loan
      */
-    newLoanPurpose?: FunnelDataV1NewLoanPurposeEnum;
+    new_loan_purpose?: FunnelDataV1NewLoanPurposeEnum;
     /**
@@ -253,3 +265,3 @@ * Loan type requested
      */
-    loanType: FunnelDataV1LoanTypeEnum;
+    loan_type: FunnelDataV1LoanTypeEnum;
     /**
@@ -260,3 +272,3 @@ * Current loan value in string
      */
-    loanValue?: string;
+    loan_value?: string;
     /**
@@ -267,3 +279,3 @@ * Property value in string
      */
-    securityValue: string;
+    security_value: string;
     /**
@@ -274,3 +286,3 @@ * Loan deposit amount in string
      */
-    depositAmount?: string;
+    deposit_amount?: string;
     /**
@@ -281,3 +293,3 @@ * Usage of the property
      */
-    propertyUse: FunnelDataV1PropertyUseEnum;
+    property_use: FunnelDataV1PropertyUseEnum;
     /**
@@ -288,3 +300,3 @@ * Loan repayment method
      */
-    repaymentMethod: FunnelDataV1RepaymentMethodEnum;
+    repayment_method: FunnelDataV1RepaymentMethodEnum;
     /**
@@ -295,3 +307,3 @@ * Employment type of the person
      */
-    employmentType: FunnelDataV1EmploymentTypeEnum;
+    employment_type: FunnelDataV1EmploymentTypeEnum;
     /**
@@ -302,3 +314,3 @@ * Indicate if person has self employed proof
      */
-    selfEmployedProof?: FunnelDataV1SelfEmployedProofEnum;
+    self_employed_proof?: FunnelDataV1SelfEmployedProofEnum;
     /**
@@ -309,3 +321,3 @@ * Indicating person\'s credit history
      */
-    creditHistory: FunnelDataV1CreditHistoryEnum;
+    credit_history: FunnelDataV1CreditHistoryEnum;
     /**
@@ -322,3 +334,3 @@ * Indicating desired features
      */
-    totalDebtsConsolidated?: string;
+    total_debts_consolidated?: string;
     /**
@@ -329,3 +341,3 @@ * Total amount to be cash out
      */
-    totalCashoutAmount?: string;
+    total_cashout_amount?: string;
     /**
@@ -336,3 +348,3 @@ * Indicating on the urgency to refinance
      */
-    refinanceUrgency?: FunnelDataV1RefinanceUrgencyEnum;
+    refinance_urgency?: FunnelDataV1RefinanceUrgencyEnum;
     /**
@@ -343,3 +355,3 @@ * Person first name
      */
-    firstName?: string;
+    first_name?: string;
     /**
@@ -350,3 +362,3 @@ * Indicating purpose for apply loan
      */
-    transactionType?: FunnelDataV1TransactionTypeEnum;
+    transaction_type?: FunnelDataV1TransactionTypeEnum;
     /**
@@ -357,3 +369,3 @@ * Stating factors when selecting a lender. Value is concatenated based from the list of items \"offset\", \"redraw\", \"major lender\", \"mobile app\"
      */
-    factorsInChoosingALender: string;
+    factors_in_choosing_a_lender: string;
     /**
@@ -364,3 +376,3 @@ * Indicating if the person has already been pre-approved
      */
-    preApproved?: FunnelDataV1PreApprovedEnum;
+    pre_approved?: FunnelDataV1PreApprovedEnum;
     /**
@@ -371,3 +383,3 @@ * Indicating if the person has already exchange contract
      */
-    exchangedContract?: FunnelDataV1ExchangedContractEnum;
+    exchanged_contract?: FunnelDataV1ExchangedContractEnum;
     /**
@@ -378,3 +390,3 @@ * Present expected settlement date if any, format as YYYY-MM-DD
      */
-    expectedSettlementDate?: string;
+    expected_settlement_date?: string;
 }
@@ -495,3 +507,3 @@ /**
      */
-    employmentType: FunnelDataV2EmploymentTypeEnum;
+    employment_type: FunnelDataV2EmploymentTypeEnum;
     /**
@@ -502,3 +514,3 @@ * Credit history of a person
      */
-    creditStatus: FunnelDataV2CreditStatusEnum;
+    credit_status: FunnelDataV2CreditStatusEnum;
     /**
@@ -509,3 +521,3 @@ * Indicate if a person has already exchanged contract
      */
-    contractsExchanged?: boolean;
+    contracts_exchanged?: boolean;
     /**
@@ -522,3 +534,3 @@ * Deposit amount
      */
-    desiredFeatures: Array<FunnelDataV2DesiredFeaturesEnum>;
+    desired_features: Array<FunnelDataV2DesiredFeaturesEnum>;
     /**
@@ -529,3 +541,3 @@ * Indicate user has proof of self-employment, if any
      */
-    hasSelfEmploymentProof?: boolean;
+    has_self_employment_proof?: boolean;
     /**
@@ -536,3 +548,3 @@ * Prefered repayment method
      */
-    paymentType: FunnelDataV2PaymentTypeEnum;
+    payment_type: FunnelDataV2PaymentTypeEnum;
     /**
@@ -549,3 +561,3 @@ * Intention for applying a loan
      */
-    purchaseSituation?: FunnelDataV2PurchaseSituationEnum;
+    purchase_situation?: FunnelDataV2PurchaseSituationEnum;
     /**
@@ -556,3 +568,3 @@ * Reasons for refinancing, if any
      */
-    refinancingReasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
+    refinancing_reasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
     /**
@@ -563,3 +575,3 @@ * Indicate if the person has already been pre-approved
      */
-    preApproved?: boolean;
+    pre_approved?: boolean;
     /**
@@ -570,3 +582,3 @@ * Stating the usage of property
      */
-    propertyUse: FunnelDataV2PropertyUseEnum;
+    property_use: FunnelDataV2PropertyUseEnum;
     /**
@@ -577,3 +589,3 @@ * Current existing loan value for refinancing
      */
-    loanValue?: number;
+    loan_value?: number;
     /**
@@ -584,3 +596,3 @@ * Expected property price
      */
-    securityValue: number;
+    security_value: number;
     /**
@@ -591,3 +603,3 @@ * Expected cashout amount given if user choose to have cashout as part of the loan
      */
-    totalCashoutAmount?: number;
+    total_cashout_amount?: number;
     /**
@@ -604,3 +616,3 @@ * Indicate urgency of applying and getting a loan
      */
-    estimatedSettlementDate?: string;
+    estimated_settlement_date?: string;
 }
@@ -700,4 +712,10 @@ /**
      */
-    generatedAt: string;
+    generated_at: string;
     /**
+     * Time zone name for identifying customer location when making call(s). Refer to https://www.iana.org/time-zones
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    time_zone: string;
+    /**
      * Prefix with Australia international code, e.g. +61
@@ -707,3 +725,3 @@ * @type {string}
      */
-    mobileNumber: string;
+    mobile_number: string;
     /**
@@ -720,5 +738,5 @@ * Email of the potential customer
      */
-    firstName: string;
+    first_name: string;
     /**
-     *
+     * Representation of funnel origin and indicates roughly the journey of the customer originate from
      * @type {string}
@@ -735,2 +753,20 @@ * @memberof LeadsRecord
     /**
+     * Google Click Identifier used for analytical tracking
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    gcl_id?: string;
+    /**
+     * URL value of the origin from where customer landed in the platform webpage
+     * @type {string}
+     * @memberof LeadsRecord
+     */
+    account_origin: string;
+    /**
+     *
+     * @type {UTM}
+     * @memberof LeadsRecord
+     */
+    utm?: UTM;
+    /**
      * Data captured that qualified as a lead
@@ -793,3 +829,3 @@ * @type {FunnelDataV1 | BorrowingPowerDataV2 | StampDutyDataV1 | PropertyReportDataV1}
      */
-    relationshipWithProperty: PropertyReportDataV1RelationshipWithPropertyEnum;
+    relationship_with_property: PropertyReportDataV1RelationshipWithPropertyEnum;
 }
@@ -823,3 +859,3 @@ /**
      */
-    relationshipWithProperty: PropertyReportDataV2RelationshipWithPropertyEnum;
+    relationship_with_property: PropertyReportDataV2RelationshipWithPropertyEnum;
 }
@@ -847,3 +883,3 @@ /**
      */
-    depositAmount: string;
+    deposit_amount: string;
     /**
@@ -854,3 +890,3 @@ * Property price
      */
-    securityValue: string;
+    security_value: string;
     /**
@@ -861,3 +897,3 @@ * Status of the person
      */
-    firstHomeBuyer: StampDutyDataV1FirstHomeBuyerEnum;
+    first_home_buyer: StampDutyDataV1FirstHomeBuyerEnum;
     /**
@@ -868,3 +904,3 @@ * State territory
      */
-    propertyState: StampDutyDataV1PropertyStateEnum;
+    property_state: StampDutyDataV1PropertyStateEnum;
     /**
@@ -875,3 +911,3 @@ * Type of property
      */
-    propertyType: StampDutyDataV1PropertyTypeEnum;
+    property_type: StampDutyDataV1PropertyTypeEnum;
     /**
@@ -882,3 +918,3 @@ * Usage of property
      */
-    propertyUse: StampDutyDataV1PropertyUseEnum;
+    property_use: StampDutyDataV1PropertyUseEnum;
 }
@@ -942,3 +978,3 @@ /**
      */
-    securityValue: number;
+    security_value: number;
     /**
@@ -949,3 +985,3 @@ * Status if person is first home buyer
      */
-    isFirstHomeBuyer: boolean;
+    is_first_home_buyer: boolean;
     /**
@@ -956,3 +992,3 @@ * Status if person is a foreign investor
      */
-    isForeignInvestor: boolean;
+    is_foreign_investor: boolean;
     /**
@@ -963,3 +999,3 @@ * State territory
      */
-    propertyState: StampDutyDataV2PropertyStateEnum;
+    property_state: StampDutyDataV2PropertyStateEnum;
     /**
@@ -970,3 +1006,3 @@ * Type of property
      */
-    propertyType: StampDutyDataV2PropertyTypeEnum;
+    property_type: StampDutyDataV2PropertyTypeEnum;
     /**
@@ -977,3 +1013,3 @@ * Usage of property
      */
-    propertyUse: StampDutyDataV2PropertyUseEnum;
+    property_use: StampDutyDataV2PropertyUseEnum;
 }
@@ -1012,2 +1048,39 @@ /**
 /**
+ *
+ * @export
+ * @interface UTM
+ */
+export interface UTM {
+    /**
+     * Identifies the source of where it was being sent from
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_source: string;
+    /**
+     * Identifies the item that was clicked by the user
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_content?: string;
+    /**
+     * Identifies the type of link used, e.g. email, cost per click, etc.
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_medium?: string;
+    /**
+     * Identifies a specific product promotion or strategic campaign
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_campaign?: string;
+    /**
+     * Identifies the search term
+     * @type {string}
+     * @memberof UTM
+     */
+    utm_term?: string;
+}
+/**
  * HealthCheckApi - axios parameter creator
@@ -1014,0 +1087,0 @@ * @export

dist/types/base.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

dist/types/configuration.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

dist/types/index.d.ts

@@ -5,3 +5,3 @@ /**
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -8,0 +8,0 @@ *

package.json

 {
   "name": "@lendi/lead-client",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "description": "Lendi lead client",
@@ -13,3 +13,3 @@ "main": "dist/cjs/index.js",
     "build": "yarn run build:types && yarn run build:cjs && yarn run build:esm",
-    "generate": "openapi-generator generate -g typescript-axios -i openapi.yaml -o src --additional-properties=supportsES6=true"
+    "generate": "openapi-generator generate -g typescript-axios -i openapi.yaml -o src --additional-properties=supportsES6=true,modelPropertyNaming=snake_case"
   },
@@ -16,0 +16,0 @@ "devDependencies": {

src/api.ts

@@ -7,3 +7,3 @@ // tslint:disable
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -38,3 +38,3 @@ *
    */
-  exchangedContract?: BorrowingPowerDataV1ExchangedContractEnum;
+  exchanged_contract?: BorrowingPowerDataV1ExchangedContractEnum;
   /**
@@ -45,3 +45,3 @@ * Describe the person interest in buying the property
    */
-  firstHomeBuyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
+  first_home_buyer: BorrowingPowerDataV1FirstHomeBuyerEnum;
   /**
@@ -52,3 +52,3 @@ * Estimated monthly expenses of the person
    */
-  monthlyExpenses: number;
+  monthly_expenses: number;
   /**
@@ -59,3 +59,3 @@ * Total number of expected borrower for the loan
    */
-  numberOfBorrower: string;
+  number_of_borrower: string;
   /**
@@ -66,3 +66,3 @@ * Indicate if the person has already been pre-approved
    */
-  preApproved?: BorrowingPowerDataV1PreApprovedEnum;
+  pre_approved?: BorrowingPowerDataV1PreApprovedEnum;
   /**
@@ -73,3 +73,3 @@ * Estimated yearly income of the person
    */
-  yearlyIncome: string;
+  yearly_income: string;
   /**
@@ -80,3 +80,9 @@ * Describes a person purchasing situation
    */
-  newLoanPurpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+  new_loan_purpose: BorrowingPowerDataV1NewLoanPurposeEnum;
+  /**
+   * Present expected settlement date if any, format as YYYY-MM-DD
+   * @type {string}
+   * @memberof BorrowingPowerDataV1
+   */
+  settlement_date?: string;
 }
@@ -137,3 +143,3 @@
    */
-  contractsExchanged?: boolean;
+  contracts_exchanged?: boolean;
   /**
@@ -144,3 +150,3 @@ * Describe the person interest in buying the property
    */
-  purchaseInterest: BorrowingPowerDataV2PurchaseInterestEnum;
+  purchase_interest: BorrowingPowerDataV2PurchaseInterestEnum;
   /**
@@ -151,3 +157,3 @@ * Estimated monthly expenses of the person
    */
-  monthlyExpenses: number;
+  monthly_expenses: number;
   /**
@@ -158,3 +164,3 @@ * Total number of expected borrower for the loan
    */
-  numberOfBorrowers?: number;
+  number_of_borrowers?: number;
   /**
@@ -165,3 +171,3 @@ * Indicate if the person has already been pre-approved
    */
-  preApproved?: boolean;
+  pre_approved?: boolean;
   /**
@@ -172,3 +178,3 @@ * Estimated yearly income of the person
    */
-  yearlyIncome: number;
+  yearly_income: number;
   /**
@@ -179,3 +185,9 @@ * Describes a person purchasing situation
    */
-  purchaseSituation: BorrowingPowerDataV2PurchaseSituationEnum;
+  purchase_situation: BorrowingPowerDataV2PurchaseSituationEnum;
+  /**
+   * Expected settlement date, format as YYYY-MM-DD
+   * @type {string}
+   * @memberof BorrowingPowerDataV2
+   */
+  estimated_settlement_date?: string;
 }
@@ -246,3 +258,3 @@
    */
-  loanPurpose?: string;
+  loan_purpose?: string;
   /**
@@ -253,3 +265,3 @@ * Purpose of looking for new home loan
    */
-  newLoanPurpose?: FunnelDataV1NewLoanPurposeEnum;
+  new_loan_purpose?: FunnelDataV1NewLoanPurposeEnum;
   /**
@@ -260,3 +272,3 @@ * Loan type requested
    */
-  loanType: FunnelDataV1LoanTypeEnum;
+  loan_type: FunnelDataV1LoanTypeEnum;
   /**
@@ -267,3 +279,3 @@ * Current loan value in string
    */
-  loanValue?: string;
+  loan_value?: string;
   /**
@@ -274,3 +286,3 @@ * Property value in string
    */
-  securityValue: string;
+  security_value: string;
   /**
@@ -281,3 +293,3 @@ * Loan deposit amount in string
    */
-  depositAmount?: string;
+  deposit_amount?: string;
   /**
@@ -288,3 +300,3 @@ * Usage of the property
    */
-  propertyUse: FunnelDataV1PropertyUseEnum;
+  property_use: FunnelDataV1PropertyUseEnum;
   /**
@@ -295,3 +307,3 @@ * Loan repayment method
    */
-  repaymentMethod: FunnelDataV1RepaymentMethodEnum;
+  repayment_method: FunnelDataV1RepaymentMethodEnum;
   /**
@@ -302,3 +314,3 @@ * Employment type of the person
    */
-  employmentType: FunnelDataV1EmploymentTypeEnum;
+  employment_type: FunnelDataV1EmploymentTypeEnum;
   /**
@@ -309,3 +321,3 @@ * Indicate if person has self employed proof
    */
-  selfEmployedProof?: FunnelDataV1SelfEmployedProofEnum;
+  self_employed_proof?: FunnelDataV1SelfEmployedProofEnum;
   /**
@@ -316,3 +328,3 @@ * Indicating person\'s credit history
    */
-  creditHistory: FunnelDataV1CreditHistoryEnum;
+  credit_history: FunnelDataV1CreditHistoryEnum;
   /**
@@ -329,3 +341,3 @@ * Indicating desired features
    */
-  totalDebtsConsolidated?: string;
+  total_debts_consolidated?: string;
   /**
@@ -336,3 +348,3 @@ * Total amount to be cash out
    */
-  totalCashoutAmount?: string;
+  total_cashout_amount?: string;
   /**
@@ -343,3 +355,3 @@ * Indicating on the urgency to refinance
    */
-  refinanceUrgency?: FunnelDataV1RefinanceUrgencyEnum;
+  refinance_urgency?: FunnelDataV1RefinanceUrgencyEnum;
   /**
@@ -350,3 +362,3 @@ * Person first name
    */
-  firstName?: string;
+  first_name?: string;
   /**
@@ -357,3 +369,3 @@ * Indicating purpose for apply loan
    */
-  transactionType?: FunnelDataV1TransactionTypeEnum;
+  transaction_type?: FunnelDataV1TransactionTypeEnum;
   /**
@@ -364,3 +376,3 @@ * Stating factors when selecting a lender. Value is concatenated based from the list of items \"offset\", \"redraw\", \"major lender\", \"mobile app\"
    */
-  factorsInChoosingALender: string;
+  factors_in_choosing_a_lender: string;
   /**
@@ -371,3 +383,3 @@ * Indicating if the person has already been pre-approved
    */
-  preApproved?: FunnelDataV1PreApprovedEnum;
+  pre_approved?: FunnelDataV1PreApprovedEnum;
   /**
@@ -378,3 +390,3 @@ * Indicating if the person has already exchange contract
    */
-  exchangedContract?: FunnelDataV1ExchangedContractEnum;
+  exchanged_contract?: FunnelDataV1ExchangedContractEnum;
   /**
@@ -385,3 +397,3 @@ * Present expected settlement date if any, format as YYYY-MM-DD
    */
-  expectedSettlementDate?: string;
+  expected_settlement_date?: string;
 }
@@ -504,3 +516,3 @@
    */
-  employmentType: FunnelDataV2EmploymentTypeEnum;
+  employment_type: FunnelDataV2EmploymentTypeEnum;
   /**
@@ -511,3 +523,3 @@ * Credit history of a person
    */
-  creditStatus: FunnelDataV2CreditStatusEnum;
+  credit_status: FunnelDataV2CreditStatusEnum;
   /**
@@ -518,3 +530,3 @@ * Indicate if a person has already exchanged contract
    */
-  contractsExchanged?: boolean;
+  contracts_exchanged?: boolean;
   /**
@@ -531,3 +543,3 @@ * Deposit amount
    */
-  desiredFeatures: Array<FunnelDataV2DesiredFeaturesEnum>;
+  desired_features: Array<FunnelDataV2DesiredFeaturesEnum>;
   /**
@@ -538,3 +550,3 @@ * Indicate user has proof of self-employment, if any
    */
-  hasSelfEmploymentProof?: boolean;
+  has_self_employment_proof?: boolean;
   /**
@@ -545,3 +557,3 @@ * Prefered repayment method
    */
-  paymentType: FunnelDataV2PaymentTypeEnum;
+  payment_type: FunnelDataV2PaymentTypeEnum;
   /**
@@ -558,3 +570,3 @@ * Intention for applying a loan
    */
-  purchaseSituation?: FunnelDataV2PurchaseSituationEnum;
+  purchase_situation?: FunnelDataV2PurchaseSituationEnum;
   /**
@@ -565,3 +577,3 @@ * Reasons for refinancing, if any
    */
-  refinancingReasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
+  refinancing_reasons?: Array<FunnelDataV2RefinancingReasonsEnum>;
   /**
@@ -572,3 +584,3 @@ * Indicate if the person has already been pre-approved
    */
-  preApproved?: boolean;
+  pre_approved?: boolean;
   /**
@@ -579,3 +591,3 @@ * Stating the usage of property
    */
-  propertyUse: FunnelDataV2PropertyUseEnum;
+  property_use: FunnelDataV2PropertyUseEnum;
   /**
@@ -586,3 +598,3 @@ * Current existing loan value for refinancing
    */
-  loanValue?: number;
+  loan_value?: number;
   /**
@@ -593,3 +605,3 @@ * Expected property price
    */
-  securityValue: number;
+  security_value: number;
   /**
@@ -600,3 +612,3 @@ * Expected cashout amount given if user choose to have cashout as part of the loan
    */
-  totalCashoutAmount?: number;
+  total_cashout_amount?: number;
   /**
@@ -613,3 +625,3 @@ * Indicate urgency of applying and getting a loan
    */
-  estimatedSettlementDate?: string;
+  estimated_settlement_date?: string;
 }
@@ -711,4 +723,10 @@
    */
-  generatedAt: string;
+  generated_at: string;
   /**
+   * Time zone name for identifying customer location when making call(s). Refer to https://www.iana.org/time-zones
+   * @type {string}
+   * @memberof LeadsRecord
+   */
+  time_zone: string;
+  /**
    * Prefix with Australia international code, e.g. +61
@@ -718,3 +736,3 @@ * @type {string}
    */
-  mobileNumber: string;
+  mobile_number: string;
   /**
@@ -731,5 +749,5 @@ * Email of the potential customer
    */
-  firstName: string;
+  first_name: string;
   /**
-   *
+   * Representation of funnel origin and indicates roughly the journey of the customer originate from
    * @type {string}
@@ -746,2 +764,20 @@ * @memberof LeadsRecord
   /**
+   * Google Click Identifier used for analytical tracking
+   * @type {string}
+   * @memberof LeadsRecord
+   */
+  gcl_id?: string;
+  /**
+   * URL value of the origin from where customer landed in the platform webpage
+   * @type {string}
+   * @memberof LeadsRecord
+   */
+  account_origin: string;
+  /**
+   *
+   * @type {UTM}
+   * @memberof LeadsRecord
+   */
+  utm?: UTM;
+  /**
    * Data captured that qualified as a lead
@@ -806,3 +842,3 @@ * @type {FunnelDataV1 | BorrowingPowerDataV2 | StampDutyDataV1 | PropertyReportDataV1}
    */
-  relationshipWithProperty: PropertyReportDataV1RelationshipWithPropertyEnum;
+  relationship_with_property: PropertyReportDataV1RelationshipWithPropertyEnum;
 }
@@ -838,3 +874,3 @@
    */
-  relationshipWithProperty: PropertyReportDataV2RelationshipWithPropertyEnum;
+  relationship_with_property: PropertyReportDataV2RelationshipWithPropertyEnum;
 }
@@ -864,3 +900,3 @@
    */
-  depositAmount: string;
+  deposit_amount: string;
   /**
@@ -871,3 +907,3 @@ * Property price
    */
-  securityValue: string;
+  security_value: string;
   /**
@@ -878,3 +914,3 @@ * Status of the person
    */
-  firstHomeBuyer: StampDutyDataV1FirstHomeBuyerEnum;
+  first_home_buyer: StampDutyDataV1FirstHomeBuyerEnum;
   /**
@@ -885,3 +921,3 @@ * State territory
    */
-  propertyState: StampDutyDataV1PropertyStateEnum;
+  property_state: StampDutyDataV1PropertyStateEnum;
   /**
@@ -892,3 +928,3 @@ * Type of property
    */
-  propertyType: StampDutyDataV1PropertyTypeEnum;
+  property_type: StampDutyDataV1PropertyTypeEnum;
   /**
@@ -899,3 +935,3 @@ * Usage of property
    */
-  propertyUse: StampDutyDataV1PropertyUseEnum;
+  property_use: StampDutyDataV1PropertyUseEnum;
 }
@@ -961,3 +997,3 @@
    */
-  securityValue: number;
+  security_value: number;
   /**
@@ -968,3 +1004,3 @@ * Status if person is first home buyer
    */
-  isFirstHomeBuyer: boolean;
+  is_first_home_buyer: boolean;
   /**
@@ -975,3 +1011,3 @@ * Status if person is a foreign investor
    */
-  isForeignInvestor: boolean;
+  is_foreign_investor: boolean;
   /**
@@ -982,3 +1018,3 @@ * State territory
    */
-  propertyState: StampDutyDataV2PropertyStateEnum;
+  property_state: StampDutyDataV2PropertyStateEnum;
   /**
@@ -989,3 +1025,3 @@ * Type of property
    */
-  propertyType: StampDutyDataV2PropertyTypeEnum;
+  property_type: StampDutyDataV2PropertyTypeEnum;
   /**
@@ -996,3 +1032,3 @@ * Usage of property
    */
-  propertyUse: StampDutyDataV2PropertyUseEnum;
+  property_use: StampDutyDataV2PropertyUseEnum;
 }
@@ -1033,2 +1069,40 @@
 /**
+ *
+ * @export
+ * @interface UTM
+ */
+export interface UTM {
+  /**
+   * Identifies the source of where it was being sent from
+   * @type {string}
+   * @memberof UTM
+   */
+  utm_source: string;
+  /**
+   * Identifies the item that was clicked by the user
+   * @type {string}
+   * @memberof UTM
+   */
+  utm_content?: string;
+  /**
+   * Identifies the type of link used, e.g. email, cost per click, etc.
+   * @type {string}
+   * @memberof UTM
+   */
+  utm_medium?: string;
+  /**
+   * Identifies a specific product promotion or strategic campaign
+   * @type {string}
+   * @memberof UTM
+   */
+  utm_campaign?: string;
+  /**
+   * Identifies the search term
+   * @type {string}
+   * @memberof UTM
+   */
+  utm_term?: string;
+}
+
+/**
  * HealthCheckApi - axios parameter creator
@@ -1035,0 +1109,0 @@ * @export

src/base.ts

@@ -7,3 +7,3 @@ // tslint:disable
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -10,0 +10,0 @@ *

src/configuration.ts

@@ -6,3 +6,3 @@ // tslint:disable
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -9,0 +9,0 @@ *

src/index.ts

@@ -6,3 +6,3 @@ // tslint:disable
  *
- * The version of the OpenAPI document: 1.0.0
+ * The version of the OpenAPI document: 1.1.0
  *
@@ -9,0 +9,0 @@ *

tsconfig.json

@@ -12,3 +12,3 @@ {
     "allowSyntheticDefaultImports": true,
-    "declaration": false
+    "declaration": true
   },
@@ -15,0 +15,0 @@ "include": ["src/*.ts", "src/**/*.ts, src/**/*.tsx"],

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

174118

increased by4.49%

Lines of code

4881

increased by4.7%

No dependency changes