@star-insure/sdk 0.1.3 → 0.1.6

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

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './claims';
 export * from './oracle';
+export * from './quotes';

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

@@ -0,0 +1,17 @@
+import { PostalAddress } from "./PostalAddress";
+export interface Lead {
+    id: number;
+    first_name: string;
+    last_name: string;
+    email: string;
+    mobile: string;
+    status: string;
+    source: string;
+    postal_address_id: PostalAddress['id'];
+    current_insurer: string | null;
+    current_insurance_expires_at: string | null;
+    current_insurance_is_monthly: boolean;
+    vehicle_details: string | null;
+    notes: string | null;
+    import_data: string | null;
+}

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

@@ -1,9 +1,11 @@
+import { Product, VehicleType } from "../../api";
 import { Club } from "./Club";
+import { QuoteRequestIncident } from "./QuoteRequestForm";
 import { Lead } from "./Lead";
 import { PostalAddress } from "./PostalAddress";
 import { QuoteRequestDeclaration } from "./QuoteRequestDeclaration";
 import { QuoteRequestLog } from "./QuoteRequestLog";
-import { QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
+import { PaymentFrequency, PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 import { QuoteRequestReferrer } from "./QuoteRequestReferrer";
 import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
 import { QuoteRequestVehicle } from "./QuoteRequestVehicle";
@@ -22,32 +24,32 @@ export interface QuoteRequestUserGroup {
 }
 export interface QuoteRequest {
     id: string;
+    status: QuoteRequestStatus;
+    source: QuoteRequestSource;
     reference: string;
     client_number: string;
-    first_name: string;
-    last_name: string;
-    phone: string;
-    mobile: string;
-    email: string;
-    license: string;
-    license_other: string | null;
-    has_automatch: boolean;
+    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;
-    broker_fee: number;
+    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;
+    dob: string | null;
     sold_at: string | null;
     sent_at: string | null;
     pricing_expires_at: string | null;
     follow_up_at: string | null;
-    status_id: QuoteRequestStatus;
-    source_id: QuoteRequestSource;
     resubmit_id: QuoteRequest['id'] | null;
     referrer_id: QuoteRequestReferrer['id'] | null;
     referrer_category_id: QuoteRequestReferrerCategory['id'] | null;
@@ -58,8 +60,6 @@ export interface QuoteRequest {
     broker_id: QuoteRequestUser['id'] | null;
     club_id: Club['id'] | null;
     lead_id: Lead['id'] | null;
-    status?: QuoteRequestStatus;
-    source?: QuoteRequestSource;
     declaration?: QuoteRequestDeclaration;
     street_address?: StreetAddress;
     postal_address?: PostalAddress;
@@ -77,3 +77,96 @@ 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'];
+    declaration: {
+        id?: number;
+        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;
+    };
+    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/QuoteRequestDeclaration.d.ts

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

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

@@ -0,0 +1,5 @@
+export interface QuoteRequestIncident {
+    year?: string | null;
+    month?: string | null;
+    description?: string | null;
+}

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

@@ -1,20 +1,20 @@
 export interface QuoteRequestPurchaseOption {
     id: number;
     quote_request_id: string;
-    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 | null;
-    sold_at: string | null;
-    is_paid: boolean;
-    payment_frequency: PaymentFrequency;
+    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;
+    is_paid: boolean | null;
+    payment_frequency: PaymentFrequency | null;
 }
 export declare type PremiumType = 'annual' | 'total-due';
 export declare type PaymentFrequency = 'monthly' | 'annually';

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

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

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

@@ -2,19 +2,19 @@ import { Product, VehicleType } from "../../api";
 import { QuoteRequestVehicleDriver } from "./QuoteRequestVehicleDriver";
 export interface QuoteRequestVehicle {
     id: number;
-    vehicle_type: VehicleType;
+    vehicle_type: VehicleType | null;
     registration: string | null;
     make: string | null;
     model: string | null;
     year: string | null;
     usage: string | null;
-    product: Product;
-    has_financially_interested_party: boolean;
+    product: Product | null;
+    has_financially_interested_party: boolean | null;
     financially_interested_party_detail: string | null;
     owned_duration: string | null;
     value: number | null;
     storage_location: string | null;
-    is_heavy: boolean;
+    is_heavy: boolean | null;
     quote_request_id: string;
     drivers?: QuoteRequestVehicleDriver[];
 }

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

@@ -1,7 +1,7 @@
 export interface QuoteRequestVehicleDriver {
     id: number;
-    first_name: string;
-    last_name: string;
+    first_name: string | null;
+    last_name: string | null;
     dob: string | null;
     relationship: string | null;
     licence: string | null;

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

@@ -10,3 +10,4 @@ export * from './Club';
 export * from './Lead';
 export * from './StreetAddress';
 export * from './PostalAddress';
+export * from './QuoteRequestForm';

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

package/src/types/models/index.ts

@@ -1,3 +1,4 @@
 export * from './auth';
 export * from './claims';
 export * from './oracle';
+export * from './quotes';

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

@@ -1,3 +1,5 @@
+import { PostalAddress } from "./PostalAddress";
+
 export interface Lead {
     id: number;
     first_name: string;

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

@@ -1,9 +1,11 @@
+import { Product, VehicleType } from "../../api";
 import { Club } from "./Club";
+import { QuoteRequestIncident } from "./QuoteRequestForm";
 import { Lead } from "./Lead";
 import { PostalAddress } from "./PostalAddress";
 import { QuoteRequestDeclaration } from "./QuoteRequestDeclaration";
 import { QuoteRequestLog } from "./QuoteRequestLog";
-import { QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
+import { PaymentFrequency, PremiumType, QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
 import { QuoteRequestReferrer } from "./QuoteRequestReferrer";
 import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
 import { QuoteRequestVehicle } from "./QuoteRequestVehicle";
@@ -28,36 +30,36 @@ export interface QuoteRequestUserGroup {
 
 export interface QuoteRequest {
     id: string;
+    status: QuoteRequestStatus;
+    source: QuoteRequestSource;
     reference: string;
     client_number: string;
-    first_name: string;
-    last_name: string;
-    phone: string;
-    mobile: string;
-    email: string;
-    license: string;
-    license_other: string | null;
-    has_automatch: boolean;
+    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;
-    broker_fee: number;
+    club_membership_number: string | null;
+    broker_fee: number | null;
     length_of_insurance: string | null;
     theme: string | null;
 
     // Dates
     created_at: string;
     updated_at: string;
-    dob: string;
+    dob: string | null;
     sold_at: string | null;
     sent_at: string | null;
     pricing_expires_at: string | null;
     follow_up_at: string | null;
 
     // Foreign keys
-    status_id: QuoteRequestStatus;
-    source_id: QuoteRequestSource;
     resubmit_id: QuoteRequest['id'] | null;
     referrer_id: QuoteRequestReferrer['id'] | null;
     referrer_category_id: QuoteRequestReferrerCategory['id'] | null;
@@ -70,8 +72,6 @@ export interface QuoteRequest {
     lead_id: Lead['id'] | null;
 
     // Relationships
-    status?: QuoteRequestStatus;
-    source?: QuoteRequestSource;
     declaration?: QuoteRequestDeclaration;
     street_address?: StreetAddress;
     postal_address?: PostalAddress;
@@ -89,3 +89,103 @@ 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'];
+
+    declaration: {
+        id?: number;
+        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;
+    }
+
+    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/QuoteRequestDeclaration.ts

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

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

@@ -0,0 +1,5 @@
+export interface QuoteRequestIncident {
+    year?: string | null;
+    month?: string | null;
+    description?: string | null;
+}

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

@@ -1,20 +1,20 @@
 export interface QuoteRequestPurchaseOption {
     id: number;
     quote_request_id: string;
-    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 | null;
-    sold_at: string | null;
-    is_paid: boolean;
-    payment_frequency: PaymentFrequency;
+    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;
+    is_paid: boolean | null;
+    payment_frequency: PaymentFrequency | null;
 }
 
 export type PremiumType = 'annual' | 'total-due';

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

@@ -1,3 +1,5 @@
+import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
+
 export interface QuoteRequestReferrer {
     id: number;
     name: string;

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

@@ -3,19 +3,19 @@ import { QuoteRequestVehicleDriver } from "./QuoteRequestVehicleDriver";
 
 export interface QuoteRequestVehicle {
     id: number;
-    vehicle_type: VehicleType;
+    vehicle_type: VehicleType | null;
     registration: string | null;
     make: string | null;
     model: string | null;
     year: string | null;
     usage: string | null;
-    product: Product;
-    has_financially_interested_party: boolean;
+    product: Product | null;
+    has_financially_interested_party: boolean | null;
     financially_interested_party_detail: string | null;
     owned_duration: string | null;
     value: number | null;
     storage_location: string | null;
-    is_heavy: boolean;
+    is_heavy: boolean | null;
     quote_request_id: string;
     drivers?: QuoteRequestVehicleDriver[];
 }

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

@@ -1,7 +1,7 @@
 export interface QuoteRequestVehicleDriver {
     id: number;
-    first_name: string;
-    last_name: string;
+    first_name: string | null;
+    last_name: string | null;
     dob: string | null;
     relationship: string | null;
     licence: string | null;

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

@@ -10,3 +10,4 @@ export * from './Club';
 export * from './Lead';
 export * from './StreetAddress';
 export * from './PostalAddress';
+export * from './QuoteRequestForm';