@star-insure/sdk 6.0.3 → 6.0.5

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

@@ -0,0 +1,110 @@
+import { Payment } from '../payments';
+import { BlacklistEntry } from './Blacklist';
+import { Club } from './Club';
+import { InformationRequest } from './InformationRequest';
+import { Lead } from './Lead';
+import { PostalAddress } from './PostalAddress';
+import { QuoteRequestDeclaration } from './QuoteRequestDeclaration';
+import { QuoteRequestLog } from './QuoteRequestLog';
+import { QuoteRequestPurchaseOption } from './QuoteRequestPurchaseOption';
+import { QuoteRequestReferrer } from './QuoteRequestReferrer';
+import { QuoteRequestReferrerCategory } from './QuoteRequestReferrerCategory';
+import { QuoteRequestVehicle } from './QuoteRequestVehicle';
+import { StreetAddress } from './StreetAddress';
+export type QuoteRequestStatus = 'new' | 'draft' | 'in-progress' | 'with-customer' | 'sold' | 'bound' | 'customer-modified' | 'closed';
+export type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'broker' | 'entry-form' | 'bularangi' | 'eric-t';
+export type QuoteRequestAutomatch = 'quote' | 'email' | 'registration' | 'duplicate';
+export interface QuoteRequestUser {
+    id: number;
+    name: string;
+    email: string;
+}
+export interface QuoteRequestUserGroup {
+    id: number;
+    name: string;
+}
+export interface Automatch {
+    client_number: string;
+    id: number;
+    matched_by: QuoteRequestAutomatch;
+    matched_by_value: string;
+    quote_request_id: string;
+}
+export interface QuoteRequest {
+    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_registrations?: string;
+    promo_code?: string;
+    club_membership_number?: string;
+    broker_fee?: number;
+    length_of_insurance?: string;
+    theme?: string;
+    notes?: string;
+    purchase_options_summary?: string;
+    secondary_first_name?: string;
+    secondary_last_name?: string;
+    secondary_licence?: string;
+    secondary_licence_other?: string;
+    created_at?: string;
+    updated_at?: string;
+    dob?: string;
+    secondary_dob?: string;
+    sold_at?: string;
+    sent_at?: string;
+    pricing_expires_at?: string;
+    max_policy_starts_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'];
+    blacklist_entry_id?: BlacklistEntry['id'];
+    declaration?: QuoteRequestDeclaration;
+    street_address?: StreetAddress;
+    postal_address?: PostalAddress;
+    resubmit?: QuoteRequest;
+    referrer?: QuoteRequestReferrer;
+    referrer_category?: QuoteRequestReferrerCategory;
+    staff_member?: QuoteRequestUser;
+    agent?: QuoteRequestUser;
+    agent_firm?: QuoteRequestUserGroup;
+    broker?: QuoteRequestUser;
+    broker_firm?: QuoteRequestUserGroup;
+    dealer?: QuoteRequestUser;
+    dealer_firm?: QuoteRequestUserGroup;
+    club?: Club;
+    lead?: Lead;
+    vehicles?: QuoteRequestVehicle[];
+    purchase_options?: QuoteRequestPurchaseOption[];
+    logs?: QuoteRequestLog[];
+    information_requests?: InformationRequest[];
+    links?: {
+        purchase: string;
+        purchase_preview: string;
+        purchase_options_pdf: string;
+        documentation_pdf: string;
+    };
+    blacklist_entry?: BlacklistEntry;
+    is_follow_up_required: boolean;
+    payments?: Payment[];
+    automatches?: Automatch[];
+}

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

@@ -0,0 +1,22 @@
+import { QuoteRequest } from './QuoteRequest';
+import { QuoteRequestIncident } from './QuoteRequestIncident';
+export interface QuoteRequestDeclaration {
+    id?: number;
+    quote_request_id?: QuoteRequest['id'];
+    had_incident?: boolean;
+    incidents?: QuoteRequestIncident[];
+    has_demerit_points?: boolean;
+    demerit_points?: string;
+    has_lost_licence?: boolean;
+    lost_licence_details?: string;
+    was_refused_insurance?: boolean;
+    refused_insurance_details?: string;
+    has_criminal_conviction?: boolean;
+    criminal_conviction_details?: string;
+    has_vehicle_modifications?: boolean;
+    vehicle_modifications_details?: string;
+    has_previous_insurer?: boolean;
+    previous_insurer_details?: string;
+    previous_insurer_expires_at?: string;
+    additional_details?: string;
+}

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

@@ -0,0 +1,113 @@
+import { Product, VehicleType } from '../../api';
+import { Club } from './Club';
+import { QuoteRequestSource, QuoteRequestStatus, QuoteRequestUser, QuoteRequestUserGroup } from './QuoteRequest';
+import { PaymentFrequency, PremiumType } from './QuoteRequestPurchaseOption';
+import { QuoteRequestReferrer } from './QuoteRequestReferrer';
+import { QuoteRequestReferrerCategory } from './QuoteRequestReferrerCategory';
+export interface QuoteRequestForm {
+    id?: string;
+    status?: QuoteRequestStatus;
+    source?: QuoteRequestSource;
+    reference?: string;
+    client_number?: string;
+    first_name?: string;
+    last_name?: string;
+    phone?: string;
+    mobile?: string;
+    email?: string;
+    licence?: string;
+    licence_other?: string;
+    promo_code?: string;
+    club_membership_number?: string;
+    broker_fee?: number;
+    length_of_insurance?: string;
+    theme?: string;
+    notes?: string;
+    dob?: string;
+    sold_at?: string;
+    sent_at?: string;
+    pricing_expires_at?: string;
+    follow_up_at?: string;
+    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'];
+    street_address: {
+        id?: number;
+        address?: string;
+        unit?: string;
+        suburb?: string;
+        city?: string;
+        post_code?: string;
+    };
+    declaration: {
+        id?: number;
+        had_incident?: boolean;
+        incidents: {
+            year?: string;
+            month?: string;
+            description?: string;
+        }[];
+        has_demerit_points?: boolean;
+        demerit_points?: string;
+        has_lost_licence?: boolean;
+        lost_licence_details?: string;
+        was_refused_insurance?: boolean;
+        refused_insurance_details?: string;
+        has_criminal_conviction?: boolean;
+        criminal_conviction_details?: string;
+        has_vehicle_modifications?: boolean;
+        vehicle_modifications_details?: string;
+        has_previous_insurer?: boolean;
+        previous_insurer_details?: string;
+        previous_insurer_expires_at?: string;
+        additional_details?: string;
+    };
+    vehicles: {
+        id?: number;
+        vehicle_type?: VehicleType;
+        registration?: string;
+        make?: string;
+        model?: string;
+        year?: string;
+        usage?: string;
+        product?: Product;
+        has_financially_interested_party?: boolean;
+        financially_interested_party_detail?: string;
+        owned_duration?: string;
+        value?: number;
+        storage_location?: string;
+        is_heavy?: boolean;
+        main_driver?: string;
+        drivers: {
+            id?: number;
+            first_name?: string;
+            last_name?: string;
+            dob?: string;
+            relationship?: string;
+            licence?: string;
+            licence_other?: string;
+        }[];
+    }[];
+    purchase_options: {
+        id?: number;
+        level_of_insurance_id?: number;
+        sort_order?: number;
+        description?: string;
+        base_premium?: number;
+        premium?: number;
+        monthly_premium?: number;
+        show_monthly?: boolean;
+        fsl?: number;
+        gst?: number;
+        premium_type?: PremiumType;
+        policy_starts_at?: string;
+        sold_at?: string;
+        is_paid?: boolean;
+        payment_frequency?: PaymentFrequency;
+    }[];
+}

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

@@ -0,0 +1,6 @@
+export interface QuoteRequestIncident {
+    year?: string;
+    month?: string;
+    description?: string;
+    key?: string;
+}

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

@@ -0,0 +1,11 @@
+import { User } from '../auth';
+export interface QuoteRequestLog {
+    id: number;
+    created_at: string;
+    quote_request_id: string;
+    user_id: number | null;
+    user?: User;
+    activity_type: string;
+    message: string;
+    key?: string;
+}

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

@@ -0,0 +1,62 @@
+import { VehicleType } from '../../api';
+export interface QuoteRequestOptions {
+    club_options: SimpleOption[];
+    driver_licence_options: SimpleOption[];
+    incident_options: SimpleOption[];
+    insurance_companies: SimpleOption[];
+    level_of_insurance_options: SimpleOption[];
+    policy_description_options: SimpleOption[];
+    referrer_category_options: (SimpleOption & {
+        is_public: boolean;
+    })[];
+    relationship_options: SimpleOption[];
+    storage_location_options: SimpleOption[];
+    vehicle_usage_options: {
+        id: number;
+        name: string;
+        vehicle_type: VehicleType;
+    }[];
+    policy_benefit_template_options: SimpleOption[];
+    referrer_options: {
+        id: number;
+        name: string;
+        category_id: number;
+        is_public: boolean;
+    }[];
+    policy_benefit_options: {
+        id: number;
+        name: string;
+        description: string;
+        auto_select: boolean;
+        template_id: number;
+        sort_order: number;
+    }[];
+    policy_enhancement_options: {
+        id: number;
+        name: string;
+        description: string;
+        premium: number;
+        disable_rounding: boolean;
+        auto_select: boolean;
+    }[];
+    authorised_drivers_options: {
+        id: number;
+        name: string;
+        description: string;
+    }[];
+    terms_options: {
+        id: number;
+        name: string;
+        description: string;
+    }[];
+    excess_options: {
+        id: number;
+        name: string;
+        description: string;
+    }[];
+}
+interface SimpleOption {
+    id: number;
+    name: string;
+}
+export {};

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

@@ -0,0 +1,38 @@
+import { PolicyBenefit, PolicyBenefitTemplate } from './PolicyBenefit';
+import { PolicyEnhancement } from './PolicyEnhancement';
+export interface QuoteRequestPurchaseOption {
+    id?: number;
+    quote_request_id?: string;
+    level_of_insurance_id?: number;
+    policy_number?: string;
+    sort_order?: number;
+    description?: string;
+    premium?: number;
+    monthly_premium?: number;
+    purchased_total?: number;
+    show_monthly?: boolean;
+    fsl?: number;
+    gst?: number;
+    premium_type?: PremiumType;
+    policy_starts_at?: string;
+    sold_at?: string;
+    is_paid?: boolean;
+    payment_frequency?: PaymentFrequency;
+    excess_details?: string;
+    terms?: string;
+    authorised_drivers?: string;
+    is_draft?: boolean;
+    is_direct_debit?: boolean;
+    benefit_template_id?: number;
+    level_of_insurance?: LevelOfInsurance;
+    enhancements?: PolicyEnhancement[];
+    benefits?: PolicyBenefit[];
+    benefit_template?: PolicyBenefitTemplate;
+    key?: string;
+}
+export type PremiumType = 'annual' | 'total-due';
+export type PaymentFrequency = 'monthly' | 'annually';
+export interface LevelOfInsurance {
+    id: number;
+    name: string;
+}

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

@@ -0,0 +1,9 @@
+import { QuoteRequestReferrerCategory } from './QuoteRequestReferrerCategory';
+export interface QuoteRequestReferrer {
+    id: number;
+    name: string;
+    category_id: QuoteRequestReferrerCategory['id'];
+    category?: QuoteRequestReferrerCategory;
+    key?: string;
+    is_public: boolean;
+}

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

@@ -0,0 +1,6 @@
+export interface QuoteRequestReferrerCategory {
+    id: number;
+    name: string;
+    key?: string;
+    is_public: boolean;
+}

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

@@ -0,0 +1,23 @@
+import { Product, VehicleType } from '../../api';
+import { QuoteRequestVehicleDriver } from './QuoteRequestVehicleDriver';
+export interface QuoteRequestVehicle {
+    id?: number;
+    vehicle_type?: VehicleType;
+    registration?: string;
+    make?: string;
+    model?: string;
+    year?: string;
+    usage?: string;
+    product?: Product;
+    has_financially_interested_party?: boolean;
+    financially_interested_party_detail?: string;
+    owned_duration?: string;
+    value?: number;
+    storage_location?: string;
+    storage_location_other?: string;
+    is_heavy?: boolean;
+    quote_request_id?: string;
+    drivers?: QuoteRequestVehicleDriver[];
+    key?: string;
+    main_driver?: string;
+}

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

@@ -0,0 +1,11 @@
+export interface QuoteRequestVehicleDriver {
+    id?: number;
+    first_name?: string;
+    last_name?: string;
+    dob?: string;
+    relationship?: string;
+    licence?: string;
+    licence_other?: string;
+    quote_request_vehicle_id?: number;
+    key?: string;
+}

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

@@ -0,0 +1,55 @@
+export interface RedbookVehicle {
+    id: number;
+    body_type: string | null;
+    colour: string | null;
+    condition: string | null;
+    created_at: string | null;
+    description: string | null;
+    engine_number: string | null;
+    imported: boolean | null;
+    make: string | null;
+    model: string | null;
+    odometer_read_at: string | null;
+    odometer_reading: string | null;
+    odometer_reading_source: string | null;
+    redbook_code: string | null;
+    registration: string | null;
+    sub_model: string | null;
+    updated_at: string | null;
+    value: number | null;
+    vehicle_type: string | null;
+    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/dist/types/models/quotes/StreetAddress.d.ts

@@ -0,0 +1,8 @@
+export interface StreetAddress {
+    id?: number;
+    address?: string;
+    unit?: string;
+    suburb?: string;
+    city?: string;
+    post_code?: string;
+}

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

@@ -0,0 +1,23 @@
+export * from './QuoteRequest';
+export * from './QuoteRequestDeclaration';
+export * from './QuoteRequestVehicle';
+export * from './QuoteRequestVehicleDriver';
+export * from './QuoteRequestPurchaseOption';
+export * from './PolicyEnhancement';
+export * from './QuoteRequestReferrerCategory';
+export * from './QuoteRequestReferrer';
+export * from './Club';
+export * from './Lead';
+export * from './StreetAddress';
+export * from './PostalAddress';
+export * from './QuoteRequestIncident';
+export * from './QuoteRequestOptions';
+export * from './RedbookVehicle';
+export * from './QuoteRequestForm';
+export * from './QuoteRequestForm';
+export * from './PolicyBenefit';
+export * from './InformationRequest';
+export * from './EmailContentOption';
+export * from './MotorwebVehicle';
+export * from './PromoCode';
+export * from './Blacklist';

package/dist/types/models/sms-messages/SmsContentOption.d.ts

@@ -0,0 +1,7 @@
+export interface SmsContentOption {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    name: string;
+    content: string;
+}

package/dist/types/models/sms-messages/SmsMessage.d.ts

@@ -0,0 +1,18 @@
+import { User } from '../auth';
+import { QuoteRequest } from '../quotes';
+import { SmsMessageReply } from './SmsMessageReply';
+export interface SmsMessage {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    content: string;
+    recipients: string;
+    reference: string | null;
+    reply_to: string | null;
+    user_id: number | null;
+    quote_request_id: string | null;
+    is_archived: boolean;
+    replies?: SmsMessageReply[];
+    quote_request?: QuoteRequest;
+    user?: User;
+}

package/dist/types/models/sms-messages/SmsMessageReply.d.ts

@@ -0,0 +1,10 @@
+import { SmsMessage } from './SmsMessage';
+export interface SmsMessageReply {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    content: string;
+    phone_number: string;
+    sms_message_id: number;
+    message?: SmsMessage;
+}

package/dist/types/models/sms-messages/index.d.ts

@@ -0,0 +1,3 @@
+export * from './SmsMessage';
+export * from './SmsMessageReply';
+export * from './SmsContentOption';

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": "6.0.3",
+    "version": "6.0.5",
     "license": "MIT",
     "repository": {
         "type": "git",

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

@@ -14,9 +14,9 @@ import { StreetAddress } from "./StreetAddress";
 
 export type QuoteRequestStatus = 'new' | 'draft' | 'in-progress' | 'with-customer' | 'sold' | 'bound' | 'customer-modified' | 'closed';
 
-export type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'broker' |  'entry-form' | 'bularangi' | 'eric-t';
+export type QuoteRequestSource = 'web' | 'phone' | 'show' | 'existing-customer' | 'mighway' | 'agent' | 'broker' |  'entry-form' | 'bularangi' | 'eric-t' | 'referrer';
 
-export type QuoteRequestAutomatch = 'quote' | 'email' | 'registration' | 'duplicate';
+export type QuoteRequestAutomatch = 'quote' | 'email' | 'registration' | 'duplicate' | 'name-dob' | 'phone';
 
 export interface QuoteRequestUser {
     id: number;