@star-insure/sdk 0.1.0 → 0.1.3

package/dist/types/api/enums.d.ts

@@ -1,3 +1,4 @@
 export declare type VehicleType = 'car' | 'motorcycle' | 'motorhome';
 export declare type Frequency = 'daily' | 'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'annually';
 export declare type Condition = 'poor' | 'fair' | 'good';
+export declare type Product = 'star-enthusiast-prestige-everyday-plus' | 'star-enthusiast' | 'star-prestige' | 'star-everyday' | 'star-plus' | 'star-motorcycle' | 'star-campercare';

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

@@ -1,5 +1,6 @@
 export * from './auth';
 export * from './enums';
+export * from './responses';
 export interface ApiResponse<T = any> {
     data: T;
     meta: Meta;

package/dist/types/api/responses/claimRequestActions.d.ts

@@ -0,0 +1,12 @@
+export interface OraclePolicyMatch {
+    ply_covernumber: string;
+    ply_verno: string;
+    ply_clientnumber: string;
+    ply_riskcode: string;
+    ply_effdate: string;
+    ply_current: '-1' | '0';
+    client?: {
+        cli_clientnumber: string;
+        cli_emailaddress?: string;
+    };
+}

package/dist/types/api/responses/index.d.ts

@@ -0,0 +1 @@
+export * from './claimRequestActions';

package/dist/types/models/oracle/Risk.d.ts

@@ -3,5 +3,6 @@ export interface RiskDisplayValue {
     created_at: string;
     updated_at: string;
     RI_CODE: string;
+    RI_DESCRIPTION?: string;
     value: string;
 }

package/dist/types/models/oracle/TableData.d.ts

@@ -4,5 +4,6 @@ export interface TableDataDisplayValue {
     updated_at: string;
     tbl_type: string;
     tbl_code: string;
+    tbl_fullname?: string;
     value: string;
 }

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

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

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

@@ -0,0 +1,2 @@
+export interface PolicyEnhancement {
+}

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

@@ -0,0 +1,7 @@
+export interface PostalAddress {
+    id: number;
+    postal_line_1: string | null;
+    postal_line_2: string | null;
+    postal_line_3: string | null;
+    postal_line_4: string | null;
+}

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

@@ -1,3 +1,13 @@
+import { Club } from "./Club";
+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 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;
@@ -63,68 +73,7 @@ export interface QuoteRequest {
     broker_firm?: QuoteRequestUserGroup;
     club?: Club;
     lead?: Lead;
-}
-export interface QuoteRequestReferrer {
-    id: number;
-    name: string;
-    category_id: QuoteRequestReferrerCategory['id'];
-    category?: QuoteRequestReferrerCategory;
-}
-export interface QuoteRequestReferrerCategory {
-    id: number;
-    name: string;
-}
-export interface Club {
-    id: number;
-    name: string;
-}
-export interface StreetAddress {
-    id: number;
-    address: string | null;
-    unit: string | null;
-    suburb: string | null;
-    city: string | null;
-    post_code: string | null;
-}
-export interface PostalAddress {
-    id: number;
-    postal_line_1: string | null;
-    postal_line_2: string | null;
-    postal_line_3: string | null;
-    postal_line_4: string | null;
-}
-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;
-}
-export interface QuoteRequestDeclaration {
-    id: number;
-    quote_request_id: QuoteRequest['id'];
-    had_incident: boolean;
-    has_demerit_points: boolean;
-    demerit_points: string | null;
-    has_lost_license: boolean;
-    lost_license_details: string | null;
-    was_refused_insurance: boolean;
-    refused_insurance_details: string | null;
-    has_criminal_conviction: boolean;
-    criminal_conviction_details: string | null;
-    has_vehicle_modifications: boolean;
-    vehicle_modifications_details: string | null;
-    has_previous_insurer: boolean;
-    previous_insurer_details: string | null;
-    previous_insurer_expires_at: string | null;
-    additional_details: string | null;
+    vehicles?: QuoteRequestVehicle[];
+    purchase_options?: QuoteRequestPurchaseOption[];
+    logs?: QuoteRequestLog[];
 }

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

@@ -0,0 +1,9 @@
+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;
+}

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

@@ -0,0 +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;
+}
+export declare type PremiumType = 'annual' | 'total-due';
+export declare type PaymentFrequency = 'monthly' | 'annually';

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

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

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

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

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

@@ -0,0 +1,10 @@
+export interface QuoteRequestVehicleDriver {
+    id: number;
+    first_name: string;
+    last_name: string;
+    dob: string | null;
+    relationship: string | null;
+    licence: string | null;
+    licence_other: string | null;
+    quote_request_vehicle_id: number;
+}

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

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

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

@@ -1 +1,12 @@
 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';

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

package/src/types/api/enums.ts

@@ -3,3 +3,5 @@ export type VehicleType = 'car' | 'motorcycle' | 'motorhome';
 export type Frequency = 'daily' | 'weekly' | 'fortnightly' | 'monthly' | 'quarterly' | 'annually';
 
 export type Condition = 'poor' | 'fair' | 'good';
+
+export type Product = 'star-enthusiast-prestige-everyday-plus' | 'star-enthusiast' | 'star-prestige' | 'star-everyday' | 'star-plus' | 'star-motorcycle' | 'star-campercare';

package/src/types/api/index.ts

@@ -1,5 +1,6 @@
 export * from './auth';
 export * from './enums';
+export * from './responses';
 
 export interface ApiResponse<T = any> {
     data: T;

package/src/types/api/responses/claimRequestActions.ts

@@ -0,0 +1,12 @@
+export interface OraclePolicyMatch {
+    ply_covernumber: string;
+    ply_verno: string;
+    ply_clientnumber: string;
+    ply_riskcode: string;
+    ply_effdate: string; // YYYY-MM-DD
+    ply_current: '-1' | '0'; // '-1' = yes, '0' = no
+    client?: {
+        cli_clientnumber: string;
+        cli_emailaddress?: string;
+    }
+}

package/src/types/api/responses/index.ts

@@ -0,0 +1 @@
+export * from './claimRequestActions';

package/src/types/models/oracle/Risk.ts

@@ -3,5 +3,6 @@ export interface RiskDisplayValue {
     created_at: string;
     updated_at: string;
     RI_CODE: string;
+    RI_DESCRIPTION?: string;
     value: string;
 }

package/src/types/models/oracle/TableData.ts

@@ -4,5 +4,6 @@ export interface TableDataDisplayValue {
     updated_at: string;
     tbl_type: string;
     tbl_code: string;
+    tbl_fullname?: string;
     value: string;
 }

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

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

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

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

@@ -0,0 +1,3 @@
+export interface PolicyEnhancement {
+
+}

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

@@ -0,0 +1,7 @@
+export interface PostalAddress {
+    id: number;
+    postal_line_1: string | null;
+    postal_line_2: string | null;
+    postal_line_3: string | null;
+    postal_line_4: string | null;
+}

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

@@ -1,3 +1,14 @@
+import { Club } from "./Club";
+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' | 'entry-form' | 'bularangi';
@@ -74,75 +85,7 @@ export interface QuoteRequest {
     broker_firm?: QuoteRequestUserGroup;
     club?: Club;
     lead?: Lead;
-}
-
-export interface QuoteRequestReferrer {
-    id: number;
-    name: string;
-    category_id: QuoteRequestReferrerCategory['id'];
-    category?: QuoteRequestReferrerCategory;
-}
-
-export interface QuoteRequestReferrerCategory {
-    id: number;
-    name: string;
-}
-
-export interface Club {
-    id: number;
-    name: string;
-}
-
-export interface StreetAddress {
-    id: number;
-    address: string | null;
-    unit: string | null;
-    suburb: string | null;
-    city: string | null;
-    post_code: string | null;
-}
-
-export interface PostalAddress {
-    id: number;
-    postal_line_1: string | null;
-    postal_line_2: string | null;
-    postal_line_3: string | null;
-    postal_line_4: string | null;
-}
-
-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;
-}
-
-export interface QuoteRequestDeclaration {
-    id: number;
-    quote_request_id: QuoteRequest['id'];
-    had_incident: boolean;
-    has_demerit_points: boolean;
-    demerit_points: string | null;
-    has_lost_license: boolean;
-    lost_license_details: string | null;
-    was_refused_insurance: boolean;
-    refused_insurance_details: string | null;
-    has_criminal_conviction: boolean;
-    criminal_conviction_details: string | null;
-    has_vehicle_modifications: boolean;
-    vehicle_modifications_details: string | null;
-    has_previous_insurer: boolean;
-    previous_insurer_details: string | null;
-    previous_insurer_expires_at: string | null;
-    additional_details: string | null;
+    vehicles?: QuoteRequestVehicle[];
+    purchase_options?: QuoteRequestPurchaseOption[];
+    logs?: QuoteRequestLog[];
 }

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

@@ -0,0 +1,19 @@
+export interface QuoteRequestDeclaration {
+    id: number;
+    quote_request_id: QuoteRequest['id'];
+    had_incident: boolean;
+    has_demerit_points: boolean;
+    demerit_points: string | null;
+    has_lost_license: boolean;
+    lost_license_details: string | null;
+    was_refused_insurance: boolean;
+    refused_insurance_details: string | null;
+    has_criminal_conviction: boolean;
+    criminal_conviction_details: string | null;
+    has_vehicle_modifications: boolean;
+    vehicle_modifications_details: string | null;
+    has_previous_insurer: boolean;
+    previous_insurer_details: string | null;
+    previous_insurer_expires_at: string | null;
+    additional_details: string | null;
+}

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

@@ -0,0 +1,10 @@
+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;
+}

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

@@ -0,0 +1,22 @@
+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;
+}
+
+export type PremiumType = 'annual' | 'total-due';
+
+export type PaymentFrequency = 'monthly' | 'annually';

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

@@ -0,0 +1,6 @@
+export interface QuoteRequestReferrer {
+    id: number;
+    name: string;
+    category_id: QuoteRequestReferrerCategory['id'];
+    category?: QuoteRequestReferrerCategory;
+}

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

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

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

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

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

@@ -0,0 +1,10 @@
+export interface QuoteRequestVehicleDriver {
+    id: number;
+    first_name: string;
+    last_name: string;
+    dob: string | null;
+    relationship: string | null;
+    licence: string | null;
+    licence_other: string | null;
+    quote_request_vehicle_id: number;
+}

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

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

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

@@ -1 +1,12 @@
 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';