@star-insure/sdk 0.3.22 → 0.4.0

package/dist/types/models/quotes/QuoteRequest.d.ts

@@ -11,7 +11,7 @@ import { QuoteRequestVehicle } from "./QuoteRequestVehicle";
 import { StreetAddress } from "./StreetAddress";
 export declare type QuoteRequestStatus = 'new' | 'draft' | 'in-progress' | 'with-customer' | 'sold' | 'bound' | 'customer-modified' | 'closed';
 export declare type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'entry-form' | 'bularangi';
-export declare type QuoteRequestAutomatch = 'QUOTE' | 'EMAIL' | 'REGISTRATION' | 'DUPLICATE' | null;
+export declare type QuoteRequestAutomatch = 'QUOTE' | 'EMAIL' | 'REGISTRATION' | 'DUPLICATE';
 export interface QuoteRequestUser {
     id: number;
     name: string;
@@ -22,44 +22,45 @@ export interface QuoteRequestUserGroup {
     name: string;
 }
 export interface QuoteRequest {
-    id: string;
-    status: QuoteRequestStatus;
-    source: QuoteRequestSource;
-    reference: string;
-    client_number: string;
-    policy_number: string | null;
-    first_name: string | null;
-    last_name: string | null;
-    phone: string | null;
-    mobile: string | null;
-    email: string | null;
-    licence: string | null;
-    licence_other: string | null;
-    has_automatch: boolean | null;
-    automatch_by: QuoteRequestAutomatch;
-    automatch_client_id: string | null;
-    promo_code: string | null;
-    club_membership_number: string | null;
-    broker_fee: number | null;
-    length_of_insurance: string | null;
-    theme: string | null;
-    created_at: string;
-    updated_at: string;
-    dob: string | null;
-    sold_at: string | null;
-    sent_at: string | null;
-    pricing_expires_at: string | null;
-    follow_up_at: string | null;
-    resubmit_id: QuoteRequest['id'] | null;
-    referrer_id: QuoteRequestReferrer['id'] | null;
-    referrer_category_id: QuoteRequestReferrerCategory['id'] | null;
-    staff_member_id: QuoteRequestUser['id'] | null;
-    agent_id: QuoteRequestUser['id'] | null;
-    agent_firm_id: QuoteRequestUserGroup['id'] | null;
-    broker_firm_id: QuoteRequestUserGroup['id'] | null;
-    broker_id: QuoteRequestUser['id'] | null;
-    club_id: Club['id'] | null;
-    lead_id: Lead['id'] | null;
+    id?: string;
+    status?: QuoteRequestStatus;
+    source?: QuoteRequestSource;
+    reference?: string;
+    client_number?: string;
+    policy_number?: string;
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+    mobile?: string;
+    email?: string;
+    licence?: string;
+    licence_other?: string;
+    has_automatch?: boolean;
+    automatch_by?: QuoteRequestAutomatch;
+    automatch_client_id?: string;
+    promo_code?: string;
+    club_membership_number?: string;
+    broker_fee?: number;
+    length_of_insurance?: string;
+    theme?: string;
+    notes?: string;
+    created_at?: string;
+    updated_at?: string;
+    dob?: string;
+    sold_at?: string;
+    sent_at?: string;
+    pricing_expires_at?: string;
+    follow_up_at?: string;
+    resubmit_id?: QuoteRequest['id'];
+    referrer_id?: QuoteRequestReferrer['id'];
+    referrer_category_id?: QuoteRequestReferrerCategory['id'];
+    staff_member_id?: QuoteRequestUser['id'];
+    agent_id?: QuoteRequestUser['id'];
+    agent_firm_id?: QuoteRequestUserGroup['id'];
+    broker_firm_id?: QuoteRequestUserGroup['id'];
+    broker_id?: QuoteRequestUser['id'];
+    club_id?: Club['id'];
+    lead_id?: Lead['id'];
     declaration?: QuoteRequestDeclaration;
     street_address?: StreetAddress;
     postal_address?: PostalAddress;

package/dist/types/models/quotes/QuoteRequestForm.d.ts

@@ -22,6 +22,7 @@ export interface QuoteRequestForm {
     broker_fee?: number;
     length_of_insurance?: string;
     theme?: string;
+    notes?: string;
     dob?: string;
     sold_at?: string;
     sent_at?: string;

package/dist/types/models/quotes/RedbookVehicle.d.ts

@@ -21,4 +21,35 @@ export interface RedbookVehicle {
     vin: string | null;
     weight: number | null;
     year: number | null;
+    valuation_details: Valuation[] | null;
+    chassis_number: string | null;
+    fuel_type: string | null;
+    previous_registered_country: string | null;
+    overseas_first_registered_year: number | null;
+    overseas_first_registered_month: number | null;
+}
+export interface Valuation {
+    matchedRedbookVehicle: MatchedRedbookVehicle;
+    valuationDetail: ValuationDetail;
+}
+export interface MatchedRedbookVehicle {
+    make?: string;
+    model?: string;
+    year?: number;
+    description?: string;
+    redbookCode: string;
+}
+export interface ValuationDetail {
+    newRetailValue: number;
+    targetConditionTypeAvailable: boolean;
+    newValueAvailable: boolean;
+    pricingBandAvailable: boolean;
+    retailValueList: RetailValueList[];
+}
+export interface RetailValueList {
+    condition: string;
+    lowerPricingRange: number;
+    upperPricingRange: number;
+    value: number;
+    kilometers: number;
 }

package/package.json

@@ -2,7 +2,7 @@
     "name": "@star-insure/sdk",
     "description": "The SDK for Star Insure client apps with shared helper functions and TypeScript definitions.",
     "author": "alexclark_nz",
-    "version": "0.3.22",
+    "version": "0.4.0",
     "license": "MIT",
     "repository": {
         "type": "git",

package/src/types/models/quotes/QuoteRequest.ts

@@ -14,7 +14,7 @@ export type QuoteRequestStatus = 'new' | 'draft' | 'in-progress' | 'with-custome
 
 export type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'entry-form' | 'bularangi';
 
-export type QuoteRequestAutomatch = 'QUOTE' | 'EMAIL' | 'REGISTRATION' | 'DUPLICATE' | null;
+export type QuoteRequestAutomatch = 'QUOTE' | 'EMAIL' | 'REGISTRATION' | 'DUPLICATE';
 
 export interface QuoteRequestUser {
     id: number;
@@ -28,48 +28,49 @@ export interface QuoteRequestUserGroup {
 }
 
 export interface QuoteRequest {
-    id: string;
-    status: QuoteRequestStatus;
-    source: QuoteRequestSource;
-    reference: string;
-    client_number: string;
-    policy_number: string | null;
-    first_name: string | null;
-    last_name: string | null;
-    phone: string | null;
-    mobile: string | null;
-    email: string | null;
-    licence: string | null;
-    licence_other: string | null;
-    has_automatch: boolean | null;
-    automatch_by: QuoteRequestAutomatch;
-    automatch_client_id: string | null;
-    promo_code: string | null;
-    club_membership_number: string | null;
-    broker_fee: number | null;
-    length_of_insurance: string | null;
-    theme: string | null;
+    id?: string;
+    status?: QuoteRequestStatus;
+    source?: QuoteRequestSource;
+    reference?: string;
+    client_number?: string;
+    policy_number?: string;
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+    mobile?: string;
+    email?: string;
+    licence?: string;
+    licence_other?: string;
+    has_automatch?: boolean;
+    automatch_by?: QuoteRequestAutomatch;
+    automatch_client_id?: string;
+    promo_code?: string;
+    club_membership_number?: string;
+    broker_fee?: number;
+    length_of_insurance?: string;
+    theme?: string;
+    notes?: string;
 
     // Dates
-    created_at: string;
-    updated_at: string;
-    dob: string | null;
-    sold_at: string | null;
-    sent_at: string | null;
-    pricing_expires_at: string | null;
-    follow_up_at: string | null;
+    created_at?: string;
+    updated_at?: string;
+    dob?: string;
+    sold_at?: string;
+    sent_at?: string;
+    pricing_expires_at?: string;
+    follow_up_at?: string;
 
     // Foreign keys
-    resubmit_id: QuoteRequest['id'] | null;
-    referrer_id: QuoteRequestReferrer['id'] | null;
-    referrer_category_id: QuoteRequestReferrerCategory['id'] | null;
-    staff_member_id: QuoteRequestUser['id'] | null;
-    agent_id: QuoteRequestUser['id'] | null;
-    agent_firm_id: QuoteRequestUserGroup['id'] | null;
-    broker_firm_id: QuoteRequestUserGroup['id'] | null;
-    broker_id: QuoteRequestUser['id'] | null;
-    club_id: Club['id'] | null;
-    lead_id: Lead['id'] | null;
+    resubmit_id?: QuoteRequest['id'];
+    referrer_id?: QuoteRequestReferrer['id'];
+    referrer_category_id?: QuoteRequestReferrerCategory['id'];
+    staff_member_id?: QuoteRequestUser['id'];
+    agent_id?: QuoteRequestUser['id'];
+    agent_firm_id?: QuoteRequestUserGroup['id'];
+    broker_firm_id?: QuoteRequestUserGroup['id'];
+    broker_id?: QuoteRequestUser['id'];
+    club_id?: Club['id'];
+    lead_id?: Lead['id'];
 
     // Relationships
     declaration?: QuoteRequestDeclaration;

package/src/types/models/quotes/QuoteRequestForm.ts

@@ -23,6 +23,7 @@ export interface QuoteRequestForm {
     broker_fee?: number;
     length_of_insurance?: string;
     theme?: string;
+    notes?: string;
 
     dob?: string;
     sold_at?: string;

package/src/types/models/quotes/RedbookVehicle.ts

@@ -21,4 +21,39 @@ export interface RedbookVehicle {
     vin: string | null;
     weight: number | null;
     year: number | null;
+    valuation_details: Valuation[] | null;
+    chassis_number: string | null;
+    fuel_type: string | null;
+    previous_registered_country: string | null;
+    overseas_first_registered_year: number | null;
+    overseas_first_registered_month: number | null;
+}
+
+export interface Valuation {
+    matchedRedbookVehicle: MatchedRedbookVehicle;
+    valuationDetail: ValuationDetail;
+};
+
+export interface MatchedRedbookVehicle {
+    make?: string;
+    model?: string;
+    year?: number;
+    description?: string;
+    redbookCode: string;
+}
+
+export interface ValuationDetail {
+    newRetailValue: number;
+    targetConditionTypeAvailable: boolean;
+    newValueAvailable: boolean;
+    pricingBandAvailable: boolean;
+    retailValueList: RetailValueList[];
+}
+
+export interface RetailValueList {
+    condition: string;
+    lowerPricingRange: number;
+    upperPricingRange: number;
+    value: number;
+    kilometers: number;
 }