@star-insure/sdk 0.1.14 → 0.1.17

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

@@ -0,0 +1,4 @@
+export interface PolicyBenefit {
+    id: number;
+    name: string | null;
+}

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

@@ -1,2 +1,13 @@
+import { PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 export interface PolicyEnhancement {
+    id: number;
+    title: string | null;
+    description: string | null;
+    premium: number | null;
+    monthly_premium: number | null;
+    disable_rounding: boolean | null;
+    auto_select: boolean | null;
+    show_monthly: boolean | null;
+    premium_type: PremiumType | null;
+    purchase_option_id: QuoteRequestPurchaseOption['id'] | null;
 }

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

@@ -1,10 +1,9 @@
-import { Product, VehicleType } from "../../api";
 import { Club } from "./Club";
 import { Lead } from "./Lead";
 import { PostalAddress } from "./PostalAddress";
 import { QuoteRequestDeclaration } from "./QuoteRequestDeclaration";
 import { QuoteRequestLog } from "./QuoteRequestLog";
-import { PaymentFrequency, PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
+import { QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 import { QuoteRequestReferrer } from "./QuoteRequestReferrer";
 import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
 import { QuoteRequestVehicle } from "./QuoteRequestVehicle";
@@ -76,108 +75,3 @@ export interface QuoteRequest {
     purchase_options?: QuoteRequestPurchaseOption[];
     logs?: QuoteRequestLog[];
 }
-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;
-    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;
-        drivers: {
-            id?: number;
-            first_name?: string;
-            last_name?: string;
-            dob?: string;
-            relationship?: string;
-            licence?: string;
-            licence_other?: string;
-        }[];
-    }[];
-    purchaseOptions?: {
-        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/QuoteRequestForm.d.ts

@@ -0,0 +1,111 @@
+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;
+    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;
+        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/QuoteRequestPurchaseOption.d.ts

@@ -1,20 +1,31 @@
+import { PolicyBenefit } from "./PolicyBenefit";
+import { PolicyEnhancement } from "./PolicyEnhancement";
 export interface QuoteRequestPurchaseOption {
     id: number;
     quote_request_id: string;
     level_of_insurance_id: number | null;
     sort_order: number | null;
     description: string | null;
-    base_premium: number | null;
     premium: number | null;
     monthly_premium: number | null;
     show_monthly: boolean | null;
     fsl: number | null;
     gst: number | null;
     premium_type: PremiumType | null;
-    policy_starts_at: string | null | null;
-    sold_at: string | null | null;
+    policy_starts_at: string | null;
+    sold_at: string | null;
     is_paid: boolean | null;
     payment_frequency: PaymentFrequency | null;
+    excess_details: string | null;
+    terms: string | null;
+    authorised_drivers: string | null;
+    level_of_insurance?: LevelOfInsurance;
+    enhancements?: PolicyEnhancement[];
+    benefits?: PolicyBenefit[];
 }
 export declare type PremiumType = 'annual' | 'total-due';
 export declare type PaymentFrequency = 'monthly' | 'annually';
+export interface LevelOfInsurance {
+    id: number;
+    name: string;
+}

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

@@ -13,3 +13,6 @@ export * from './PostalAddress';
 export * from './QuoteRequestIncident';
 export * from './QuoteRequestOptions';
 export * from './RedbookVehicle';
+export * from './QuoteRequestForm';
+export * from './QuoteRequestForm';
+export * from './PolicyBenefit';

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.1.14",
+    "version": "0.1.17",
     "license": "MIT",
     "repository": {
         "type": "git",

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

@@ -0,0 +1,4 @@
+export interface PolicyBenefit {
+    id: number;
+    name: string | null;
+}

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

@@ -1,3 +1,14 @@
-export interface PolicyEnhancement {
+import { PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 
+export interface PolicyEnhancement {
+    id: number;
+    title: string | null;
+    description: string | null;
+    premium: number | null;
+    monthly_premium: number | null;
+    disable_rounding: boolean | null;
+    auto_select: boolean | null;
+    show_monthly: boolean | null;
+    premium_type: PremiumType | null;
+    purchase_option_id: QuoteRequestPurchaseOption['id'] | null;
 }

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

@@ -1,10 +1,9 @@
-import { Product, VehicleType } from "../../api";
 import { Club } from "./Club";
 import { Lead } from "./Lead";
 import { PostalAddress } from "./PostalAddress";
 import { QuoteRequestDeclaration } from "./QuoteRequestDeclaration";
 import { QuoteRequestLog } from "./QuoteRequestLog";
-import { PaymentFrequency, PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
+import { QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 import { QuoteRequestReferrer } from "./QuoteRequestReferrer";
 import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
 import { QuoteRequestVehicle } from "./QuoteRequestVehicle";
@@ -88,116 +87,3 @@ export interface QuoteRequest {
     purchase_options?: QuoteRequestPurchaseOption[];
     logs?: QuoteRequestLog[];
 }
-
-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;
-
-    dob?: string;
-    sold_at?: string;
-    sent_at?: string;
-    pricing_expires_at?: string;
-    follow_up_at?: string;
-
-    // Foreign keys
-    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;
-        drivers: {
-            id?: number;
-            first_name?: string;
-            last_name?: string;
-            dob?: string;
-            relationship?: string;
-            licence?: string;
-            licence_other?: string;
-        }[];
-    }[],
-
-    purchaseOptions?: {
-        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/src/types/models/quotes/QuoteRequestForm.ts

@@ -0,0 +1,118 @@
+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;
+
+    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;
+        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/src/types/models/quotes/QuoteRequestPurchaseOption.ts

@@ -1,22 +1,37 @@
+import { PolicyBenefit } from "./PolicyBenefit";
+import { PolicyEnhancement } from "./PolicyEnhancement";
+
 export interface QuoteRequestPurchaseOption {
     id: number;
     quote_request_id: string;
     level_of_insurance_id: number | null;
     sort_order: number | null;
     description: string | null;
-    base_premium: number | null;
     premium: number | null;
     monthly_premium: number | null;
     show_monthly: boolean | null;
     fsl: number | null;
     gst: number | null;
     premium_type: PremiumType | null;
-    policy_starts_at: string | null | null;
-    sold_at: string | null | null;
+    policy_starts_at: string | null;
+    sold_at: string | null;
     is_paid: boolean | null;
     payment_frequency: PaymentFrequency | null;
+    excess_details: string | null;
+    terms: string | null;
+    authorised_drivers: string | null;
+
+    // Relationships
+    level_of_insurance?: LevelOfInsurance;
+    enhancements?: PolicyEnhancement[];
+    benefits?: PolicyBenefit[];
 }
 
 export type PremiumType = 'annual' | 'total-due';
 
 export type PaymentFrequency = 'monthly' | 'annually';
+
+export interface LevelOfInsurance {
+    id: number;
+    name: string;
+}

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

@@ -13,3 +13,6 @@ export * from './PostalAddress';
 export * from './QuoteRequestIncident';
 export * from './QuoteRequestOptions';
 export * from './RedbookVehicle';
+export * from './QuoteRequestForm';
+export * from './QuoteRequestForm';
+export * from './PolicyBenefit';