@star-insure/sdk 1.1.11 → 1.1.14

package/dist/types/models/claims/ClaimRequest.d.ts

@@ -0,0 +1,287 @@
+import { Condition, Frequency, VehicleType } from "../../api";
+export declare type ClaimRequestStatus = 'new' | 'draft' | 'in-progress' | 'exported';
+export interface ClaimRequest {
+    id: string;
+    reference: string;
+    'status': ClaimRequestStatus;
+    'submitted_at': string;
+    'reminder_sent_at': string;
+    'claim_number': string;
+    'policyholder': string;
+    'policy_number': string;
+    'policy_cover_number': string;
+    'policy_version_number': string;
+    'policy_contact_name': string;
+    'mobile': string;
+    'email': string;
+    'alternative_contact': string;
+    'broker_firm': string;
+    'broker_name': string;
+    'address': string;
+    'terms_accepted_by': string;
+}
+export interface DamageClaimRequest extends ClaimRequest {
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'vehicle_type': VehicleType;
+    'finance_company': string;
+    'finance_phone': string;
+    'driver_name': string;
+    'driver_dob': string;
+    'driver_relationship': string;
+    'driver_licence_number': string;
+    'driver_licence_version': string;
+    'driver_licence_issuer': string;
+    'was_intoxicated': boolean;
+    'intoxicated_details': string;
+    'has_conviction': boolean;
+    'conviction_details': string;
+    'has_recent_claim': boolean;
+    'incident_details': Incident[];
+    'was_disqualified': boolean;
+    'disqualified_details': string;
+    'was_vehicle_used_without_consent': boolean;
+    'vehicle_used_without_consent_details': string;
+    'has_existing_vehicle_damage': boolean;
+    'existing_vehicle_damage_details': string;
+    'was_refused_insurance': boolean;
+    'refused_insurance_details': string;
+    'has_additional_information': boolean;
+    'additional_information_details': string;
+    'accident_location': string;
+    'accident_suburb': string;
+    'accident_happened_at': string;
+    'accident_speed': string;
+    'impact_speed': string;
+    'road_surface': string;
+    'weather_conditions': string;
+    'had_passengers': boolean;
+    'passenger_details': Passenger[];
+    'has_witnesses': boolean;
+    'witness_details': Witness[];
+    'accident_description': string;
+    'is_vehicle_drivable': boolean;
+    'vehicle_drivable_details': string;
+    'was_warning_given': boolean;
+    'warning_given_details': string;
+    'was_third_party_responsible': boolean;
+    'third_party_responsible_details': string;
+    'was_third_party_involved': boolean;
+    'third_party_vehicle_registration': string;
+    'third_party_vehicle_owner': string;
+    'third_party_vehicle_make': string;
+    'third_party_vehicle_model': string;
+    'third_party_vehicle_driver_name': string;
+    'third_party_vehicle_driver_mobile': string;
+    'third_party_vehicle_driver_phone': string;
+    'third_party_vehicle_driver_address': string;
+    'third_party_vehicle_insurance_company': string;
+    'third_party_vehicle_damage': string;
+    'third_party_details_provided': string;
+    'were_police_notified': boolean;
+    'did_police_attend': boolean;
+    'police_officer_name': string;
+    'police_officer_email': string;
+    'police_reference': string;
+    'police_station_address': string;
+    'police_did_test': boolean;
+    'police_issued_notice': boolean;
+    'repairer_name': string;
+    'repairer_phone': string;
+    'repairer_email': string;
+    'is_claiming_protective_gear': boolean;
+    'is_protective_gear_insured_elsewhere': boolean;
+    'protective_gear_details': ClaimItem[];
+    'is_claiming_contents': boolean;
+    'is_contents_insured_elsewhere': boolean;
+    'contents_details': ClaimItem[];
+}
+export interface Incident {
+    'year': string;
+    'month': string;
+    'description': string;
+}
+export interface Passenger {
+    'name': string;
+    'phone'?: string;
+    'email'?: string;
+    'address'?: string;
+}
+export interface Witness {
+    'name': string;
+    'phone'?: string;
+    'email'?: string;
+    'address'?: string;
+}
+export interface ClaimItem {
+    'description': string;
+    'purchased_from'?: string;
+    'age'?: string;
+    'purchase_price'?: string;
+    'replacement_cost'?: string;
+}
+export interface GlassClaimRequest extends ClaimRequest {
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'accident_location': string;
+    'accident_happened_at': string;
+    'accident_description': string;
+    'repairer_name': string;
+    'repairer_phone': string;
+    'repairer_email': string;
+}
+export interface TheftClaimRequest extends ClaimRequest {
+    'is_registered_under_same_name': boolean;
+    'registered_name': string;
+    'registered_address': string;
+    'registered_phone': string;
+    'is_leased': boolean;
+    'lease_name': string;
+    'lease_address': string;
+    'lease_phone': string;
+    'lease_number': string;
+    'lease_payment_amount': string | number;
+    'lease_payment_frequency': Frequency;
+    'has_conviction': boolean;
+    'conviction_details': string;
+    'has_recent_claim': boolean;
+    'incident_details': Incident[];
+    'was_disqualified': boolean;
+    'disqualified_details': string;
+    'was_vehicle_used_without_consent': boolean;
+    'vehicle_used_without_consent_details': string;
+    'has_existing_vehicle_damage': boolean;
+    'existing_vehicle_damage_details': string;
+    'was_refused_insurance': boolean;
+    'refused_insurance_details': string;
+    'has_additional_information': boolean;
+    'additional_information_details': string;
+    'vehicle_registration': string;
+    'vehicle_vin': string;
+    'vehicle_make': string;
+    'vehicle_model': string;
+    'vehicle_year': string | number;
+    'vehicle_type': VehicleType;
+    'finance_company': string;
+    'finance_phone': string;
+    'vehicle_purchased_on': string;
+    'vehicle_purchased_from': string;
+    'vehicle_purchased_price': string | number;
+    'vehicle_value': number;
+    'was_vehicle_for_sale': boolean;
+    'vehicle_first_asking_price': string | number;
+    'vehicle_last_asking_price': string | number;
+    'vehicle_sale_duration': string;
+    'vehicle_purchaser_name': string;
+    'vehicle_purchaser_address': string;
+    'vehicle_purchaser_phone': string;
+    'vehicle_hp_cc_rating': string;
+    'vehicle_transmission': string;
+    'vehicle_engine_number': string;
+    'vehicle_has_air_conditioning': boolean;
+    'vehicle_has_cng': boolean;
+    'vehicle_has_lpg': boolean;
+    'vehicle_colour': string;
+    'vehicle_colour_changes': string;
+    'was_vehicle_repaired': boolean;
+    'vehicle_repaired_damage_details': string;
+    'vehicle_repairer': string;
+    'vehicle_repaired_on': string;
+    'was_vehicle_damaged': boolean;
+    'vehicle_damage_details': string;
+    'vehicle_tyre_condition_front_right': Condition;
+    'vehicle_tyre_condition_front_left': Condition;
+    'vehicle_tyre_condition_rear_right': Condition;
+    'vehicle_tyre_condition_rear_left': Condition;
+    'vehicle_tyre_condition_spare': string;
+    'wheel_assembly_details': string;
+    'vehicle_radio_type': string;
+    'vehicle_radio_make': string;
+    'vehicle_radio_location': string;
+    'vehicle_radio_fixing': string;
+    'vehicle_speaker_make': string;
+    'has_additional_accessories': boolean;
+    'accessory_details': Accessory[];
+    'has_identifiable_contents': boolean;
+    'identifiable_contents_details': Contents[];
+    'vehicle_serviced_by': string;
+    'has_service_invoices': boolean;
+    'vehicle_wof_issued_by': string;
+    'vehicle_wof_issued_on': string;
+    'vehicle_wof_expires_on': string;
+    'vehicle_floor_type': string;
+    'vehicle_interior_details': string;
+    'vehicle_seatbelt_type': string;
+    'vehicle_seatbelt_condition': Condition;
+    'vehicle_engine_condition': Condition;
+    'vehicle_gearbox_condition': Condition;
+    'vehicle_transmission_condition': Condition;
+    'vehicle_suspension_condition': Condition;
+    'vehicle_steering_condition': Condition;
+    'vehicle_seats_condition': Condition;
+    'vehicle_trims_condition': Condition;
+    'vehicle_body_condition': Condition;
+    'vehicle_paint_condition': Condition;
+    'vehicle_dashboard_condition': Condition;
+    'did_engine_use_oil': boolean;
+    'vehicle_engine_oil_per_month': string;
+    'vehicle_ran_well': boolean;
+    'vehicle_ran_poorly_details': string;
+    'theft_details': string;
+    'theft_happened_on': string;
+    'theft_discovered_at': string;
+    'last_seen_at': string;
+    'vehicle_last_used_by': string;
+    'address_stolen_from': string;
+    'were_windows_up': boolean;
+    'windows_down_details': string;
+    'were_doors_locked': boolean;
+    'doors_unlocked_details': string;
+    'has_theft_evidence': boolean;
+    'theft_evidence_details': string;
+    'has_steering_lock': boolean;
+    'was_steering_lock_activated': boolean;
+    'has_alarm': boolean;
+    'was_alarm_active': boolean;
+    'alarm_inactive_details': string;
+    'was_boot_locked': boolean;
+    'boot_unlocked_details': string;
+    'keys_count': string;
+    'key_holder_name': string;
+    'key_holder_phone': string;
+    'key_holder_address': string;
+    'keys_location': string;
+    'policyholder_whereabouts_details': string;
+    'were_police_notified': boolean;
+    'did_police_attend': boolean;
+    'police_officer_name': string;
+    'police_officer_email': string;
+    'police_reference': string;
+    'police_station_address': string;
+    'police_not_notified_details': string;
+    'police_have_suspect': boolean;
+    'police_suspect_details': string;
+    'policyholder_has_suspect': boolean;
+    'policyholder_suspect_details': string;
+    'was_theft_witnessed': boolean;
+    'theft_witnessed_details': string;
+    'has_cctv_footage': boolean;
+    'cctv_footage_details': string;
+    'is_claiming_contents': boolean;
+    'is_contents_insured_elsewhere': boolean;
+    'contents_details': ClaimItem[];
+}
+export interface Accessory {
+    'description': string;
+    'age': string;
+    'condition': string;
+}
+export interface Contents {
+    'description': string;
+}

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

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

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

@@ -0,0 +1,6 @@
+export * from './auth';
+export * from './claims';
+export * from './oracle';
+export * from './quotes';
+export * from './sms-messages';
+export * from './payments';

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

@@ -0,0 +1,8 @@
+export interface RiskDisplayValue {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    RI_CODE: string;
+    RI_DESCRIPTION?: string;
+    value: string;
+}

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

@@ -0,0 +1,9 @@
+export interface TableDataDisplayValue {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    TBL_TYPE: string;
+    TBL_CODE: string;
+    TBL_FULLNAME?: string;
+    value: string;
+}

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

@@ -0,0 +1,2 @@
+export * from './Risk';
+export * from './TableData';

package/dist/types/models/payments/Gateways.d.ts

@@ -0,0 +1 @@
+export declare type GatewayKey = 'SIS_Windcave_Account2Account' | 'SIS_Windcave_PxPayTradeMe' | 'SIS_Windcave_PxPayMonth' | 'SIS_Windcave_PxPayYear' | 'SIS_Windcave_PxPayStaff' | 'SIS_Windcave_PxPayTradeMeStaff' | 'bind' | 'invoice';

package/dist/types/models/payments/Payment.d.ts

@@ -0,0 +1,35 @@
+import { User } from "../auth";
+import { QuoteRequest } from "../quotes";
+import { GatewayKey } from "./Gateways";
+export declare type PaymentStatus = 'accepted' | 'incomplete' | 'declined';
+export declare type PaymentType = 'quote' | 'account' | 'auction';
+export interface Payment {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    status: PaymentStatus;
+    reference: string | null;
+    client_number: string | null;
+    amount: number;
+    processing_fee: number | null;
+    surcharge_percentage: number | null;
+    name: string | null;
+    email: string | null;
+    phone: string | null;
+    mobile: string | null;
+    gateway_key: GatewayKey;
+    gateway_reference: string;
+    payment_type: PaymentType;
+    quote_request_purchase_option_id: number | null;
+    quote_request_id: string | null;
+    email_sent_at: string | null;
+    cardholder_name: string;
+    card_name: string;
+    card_number: string;
+    card_expires_at: string;
+    card_token: string | null;
+    user_id: User['id'] | null;
+    return_url: string | null;
+    user?: User;
+    quoteRequest?: QuoteRequest;
+}

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

@@ -0,0 +1,2 @@
+export * from './Payment';
+export * from './Gateways';

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

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

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

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

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

@@ -0,0 +1,34 @@
+import { User } from "../auth";
+export declare type InformationRequestStatus = 'open' | 'closed';
+export interface InformationRequest {
+    id: string;
+    created_at: string;
+    updated_at: string;
+    user_id: number | null;
+    quote_request_id: string;
+    subject: string;
+    status: InformationRequestStatus;
+    messages?: InformationRequestMessage[];
+    user?: User;
+}
+export interface InformationRequestMessage {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    information_request_id: string;
+    user_id: number | null;
+    content: string;
+    has_been_read_by_customer: boolean;
+    sent_at: string;
+    received_at: string;
+    user?: User;
+    attachments?: InformationRequestAttachment[];
+}
+export interface InformationRequestAttachment {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    information_request_message_id: string;
+    title: string;
+    url: string;
+}

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/MotorwebVehicle.d.ts

@@ -0,0 +1,120 @@
+export interface MotorwebVehicleResponse {
+    id: number;
+    created_at: string;
+    updated_at: string;
+    check_type: 'bvi' | 'motorcheck' | 'valuation';
+    plate_or_vin: string;
+    data: MotorwebVehicle;
+}
+export interface MotorwebVehicle {
+    '@attributes': Attributes;
+    'vehicle': BviCheck | MotorvehicleCheck;
+}
+interface Attributes {
+    'version'?: string;
+}
+interface FirstRegistrationDateOverseas {
+    'month'?: string;
+    'year'?: string;
+    'description'?: string;
+}
+interface Registration {
+    'previous-country-of-registration'?: string;
+    'first-registration-date-in-new-zealand'?: string;
+    'registration-status'?: string;
+    'cause-of-last-registration'?: string;
+    'registered-overseas'?: string;
+    'first-registration-date-overseas'?: FirstRegistrationDateOverseas;
+    'last-registration-date'?: string;
+}
+interface Licence {
+    'expiry-date'?: string;
+    'licence-type'?: string;
+    'issue-date'?: string;
+    'issue-time'?: string;
+    'continuous'?: string;
+}
+interface Wof {
+    'last-inspection-date'?: string;
+    'last-inspection-result'?: string;
+    'expiry-date'?: string;
+    'is-subject-to'?: string;
+}
+interface Cof {
+    'is-subject-to'?: string;
+}
+interface Attributes2 {
+    'data-retrieved'?: string;
+}
+interface Ruc {
+    '@attributes': Attributes2;
+    'is-subject-to'?: string;
+}
+interface Attributes3 {
+    'current'?: string;
+    'past-plate'?: string;
+}
+interface Plate {
+    '@attributes'?: Attributes3;
+    'plate-number'?: string;
+    'plate-type'?: string;
+    'effective-date'?: string;
+}
+interface Attributes4 {
+    'latest'?: string;
+}
+interface OdometerReading {
+    '@attributes'?: Attributes4;
+    'reading'?: string;
+    'reading-date'?: string;
+    'reading-unit'?: string;
+    'source'?: string;
+}
+interface Transmission {
+    'type'?: string;
+}
+interface Attributes5 {
+    'current': string;
+    'owner-number': string;
+    'suppressed-reason': string;
+}
+interface Owner {
+    '@attributes': Attributes5;
+    'ownership-date': string;
+    'owner-status': string;
+}
+interface BviCheck {
+    'registration'?: Registration;
+    'licence'?: Licence;
+    'wof'?: Wof;
+    'cof'?: Cof;
+    'ruc'?: Ruc;
+    'year-of-manufacture'?: string;
+    'make'?: string;
+    'model'?: string;
+    'mvr-model'?: string;
+    'body-style'?: string;
+    'vehicle-type'?: string;
+    'vin'?: string;
+    'chassis'?: string;
+    'engine-number'?: string;
+    'main-colour'?: string;
+    'cc-rating'?: string;
+    'country-of-origin'?: string;
+    'assembly-type'?: string;
+    'gross-vehicle-mass'?: string;
+    'number-of-seats'?: string;
+    'fuel-type'?: string;
+    'vehicle-usage'?: string;
+    'odometer-unit'?: string;
+    'plate'?: Plate;
+    'odometer-reading'?: OdometerReading;
+    'transmission'?: Transmission;
+    'model-code'?: string;
+    'model-variant'?: string;
+}
+interface MotorvehicleCheck extends BviCheck {
+    'number-of-owners'?: string;
+    owner?: Owner;
+}
+export {};

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

@@ -0,0 +1,16 @@
+export interface PolicyBenefit {
+    id?: number;
+    name?: string;
+    description?: string;
+    sort_order?: number;
+    icon?: string;
+    auto_select?: boolean;
+    template_id?: PolicyBenefitTemplate['id'];
+}
+export interface PolicyBenefitTemplate {
+    id?: number;
+    created_at?: string;
+    updated_at?: string;
+    name?: string;
+    sort_order?: number;
+}

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

@@ -0,0 +1,11 @@
+import { QuoteRequestPurchaseOption } from "./QuoteRequestPurchaseOption";
+export interface PolicyEnhancement {
+    id?: number;
+    name?: string;
+    description?: string;
+    premium?: number;
+    disable_rounding?: boolean;
+    auto_select?: boolean;
+    sold_at?: string;
+    purchase_option_id?: QuoteRequestPurchaseOption['id'];
+}

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

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

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

@@ -0,0 +1,18 @@
+import { Group, User } from "../auth";
+import { QuoteRequestReferrer } from "./QuoteRequestReferrer";
+import { QuoteRequestReferrerCategory } from "./QuoteRequestReferrerCategory";
+export interface PromoCode {
+    id?: number;
+    created_at?: string;
+    updated_at?: string;
+    code?: string;
+    user_id?: number;
+    group_id?: number;
+    referrer_id?: number;
+    referrer_category_id?: number;
+    advisor_type?: 'agent' | 'broker';
+    user?: User;
+    group?: Group;
+    referrer?: QuoteRequestReferrer;
+    category?: QuoteRequestReferrerCategory;
+}