Interface InsuranceService

interface InsuranceService {
    cancelPolicies(
        insurancePolicyIds: string[],
        booking: BaseBooking,
    ): Promise<void>;
    cancelPolicy(
        insurancePolicyId: string,
        booking: BaseBooking,
    ): Promise<void>;
    createInsurancePlans(coverages: InsuranceCoverage[]): Promise<string[]>;
    deletePolicies(insurancePolicyIds: string[]): Promise<void>;
    generateManifest(
        request: InsuranceManifestGenerateRequest,
        userId: string,
        jobId: string,
    ): Promise<SavedReport>;
    getClaimsUrl(): string;
    getPoliciesUrl(): string;
    getQuote(quoteRequest: InsuranceQuoteRequest): Promise<InsuranceQuote>;
    getUpdatedQuote(
        insurancePolicyId: string,
        updateRequest: InsuranceUpdateQuoteRequest,
    ): Promise<InsuranceUpdatedQuote>;
    ingestManifest(manifest: Readable): Promise<InsuranceManifestIngestResult>;
    logCreatedPolicies(insurancePolicyIds: string[]): Promise<void>;
    purchasePolicy(
        purchaseRequest: InsurancePurchaseRequest,
    ): Promise<SavedInsurancePolicy>;
    updatePoliciesWithBooking(
        insurancePolicyIds: string[],
        bookingId: string,
    ): Promise<void>;
    updatePolicy(
        insurancePolicyId: string,
        updateRequest: InsuranceUpdateRequest,
    ): Promise<SavedInsurancePolicy>;
    validateQuote(
        quoteRequest: InsuranceQuoteRequest,
        quotedPrice: number,
    ): Promise<void>;
}

Index

Methods

cancelPolicies cancelPolicy createInsurancePlans deletePolicies generateManifest getClaimsUrl getPoliciesUrl getQuote getUpdatedQuote ingestManifest logCreatedPolicies purchasePolicy updatePoliciesWithBooking updatePolicy validateQuote

Methods

cancelPolicies

cancelPolicies(
insurancePolicyIds: string[],
booking: BaseBooking,
): Promise<void>
Mark the given InsurancePolicys as cancelled
Parameters
- insurancePolicyIds: string[]
- booking: BaseBooking
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:65

cancelPolicy

cancelPolicy(insurancePolicyId: string, booking: BaseBooking): Promise<void>
Mark the given InsurancePolicy as cancelled
Parameters
- insurancePolicyId: string
- booking: BaseBooking
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:75

createInsurancePlans

createInsurancePlans(coverages: InsuranceCoverage[]): Promise<string[]>
Creates an InsurancePlan for each the given coverages
Parameters
- coverages: InsuranceCoverage[]
Returns Promise<string[]>
The IDs of the created InsurancePlans
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:110

deletePolicies

deletePolicies(insurancePolicyIds: string[]): Promise<void>
Mark the given InsurancePolicys as deleted. This should not be used to cancel policies.
Parameters
- insurancePolicyIds: string[]
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:81

generateManifest

generateManifest(
    request: InsuranceManifestGenerateRequest,
    userId: string,
    jobId: string,
): Promise<SavedReport>
Generates a request manifest CSV file for Travel Insured with the pending InsurancePolicys in the given date range
Parameters
- request: InsuranceManifestGenerateRequest
  The manifest request parameters
- userId: string
  The ID of the user requesting the manifest
- jobId: string
  The job ID
Returns Promise<SavedReport>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:125

getClaimsUrl

getClaimsUrl(): string
Get the URL for the claims page

Returns string
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:139

getPoliciesUrl

getPoliciesUrl(): string
Get the URL for the policies page

Returns string
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:134

getQuote

getQuote(quoteRequest: InsuranceQuoteRequest): Promise<InsuranceQuote>
Get a quote for an InsurancePolicy
Parameters
- quoteRequest: InsuranceQuoteRequest
  The requested policy to quote
Returns Promise<InsuranceQuote>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:24

getUpdatedQuote

getUpdatedQuote(
insurancePolicyId: string,
updateRequest: InsuranceUpdateQuoteRequest,
): Promise<InsuranceUpdatedQuote>
Quote an update to an InsurancePolicy that has already been purchased (for when add-on is added/removed)
Parameters
- insurancePolicyId: string
  The existing InsurancePolicy ID
- updateRequest: InsuranceUpdateQuoteRequest
  The requested updates to the policy
Returns Promise<InsuranceUpdatedQuote>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:89

ingestManifest

ingestManifest(manifest: Readable): Promise<InsuranceManifestIngestResult>
Ingests a response manifest CSV file from Travel Insured
Parameters
- manifest: Readable
  The response manifest CSV file to ingest
Returns Promise<InsuranceManifestIngestResult>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:116

logCreatedPolicies

logCreatedPolicies(insurancePolicyIds: string[]): Promise<void>
Log the given InsurancePolicys as created
Parameters
- insurancePolicyIds: string[]
  The InsurancePolicys IDs
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:48

purchasePolicy

purchasePolicy(
purchaseRequest: InsurancePurchaseRequest,
): Promise<SavedInsurancePolicy>
Purchase an InsurancePolicy
Parameters
- purchaseRequest: InsurancePurchaseRequest
  The requested policy to purchase
Returns Promise<SavedInsurancePolicy>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:40

updatePoliciesWithBooking

updatePoliciesWithBooking(
insurancePolicyIds: string[],
bookingId: string,
): Promise<void>
Updates the given InsurancePolicys with the $Booking ID
Parameters
- insurancePolicyIds: string[]
- bookingId: string
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:55

updatePolicy

updatePolicy(
insurancePolicyId: string,
updateRequest: InsuranceUpdateRequest,
): Promise<SavedInsurancePolicy>
Purchase an update an InsurancePolicy that has already been purchased (for when add-ons are added/removed)
Parameters
- insurancePolicyId: string
  The existing InsurancePolicy ID
- updateRequest: InsuranceUpdateRequest
  The requested updates to the policy
Returns Promise<SavedInsurancePolicy>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:100

validateQuote

validateQuote(
quoteRequest: InsuranceQuoteRequest,
quotedPrice: number,
): Promise<void>
Validate a previously quoted price for an InsurancePolicy
Parameters
- quoteRequest: InsuranceQuoteRequest
  The requested policy to quote
- quotedPrice: number
  The price that was quoted
Returns Promise<void>
- Defined in packages/services/src/services/Insurance/InsuranceService.ts:31

Interface InsuranceService

Index

Methods

Methods

cancelPolicies

Parameters

Returns Promise<void>

cancelPolicy

Parameters

Returns Promise<void>

createInsurancePlans

Parameters

Returns Promise<string[]>

deletePolicies

Parameters

Returns Promise<void>

generateManifest

Parameters

Returns Promise<SavedReport>

getClaimsUrl

Returns string

getPoliciesUrl

Returns string

getQuote

Parameters

Returns Promise<InsuranceQuote>

getUpdatedQuote

Parameters

Returns Promise<InsuranceUpdatedQuote>

ingestManifest

Parameters

Returns Promise<InsuranceManifestIngestResult>

logCreatedPolicies

Parameters

Returns Promise<void>

purchasePolicy

Parameters

Returns Promise<SavedInsurancePolicy>

updatePoliciesWithBooking

Parameters

Returns Promise<void>

updatePolicy

Parameters

Returns Promise<SavedInsurancePolicy>

validateQuote

Parameters

Returns Promise<void>

Settings

On This Page