From d542c5c9c29db766f71b3def8e5a7209527eaddd Mon Sep 17 00:00:00 2001 From: ballerina-bot Date: Wed, 9 Apr 2025 02:57:59 +0000 Subject: [PATCH 1/6] [AUTOMATED] Regenerate the OpenAPI Connector --- ballerina/client.bal | 390 ++- ballerina/types.bal | 2872 +++++++++---------- ballerina/utils.bal | 42 +- docs/spec/openapi.yml | 6241 ++++++++++++++++++++++++----------------- gradle.properties | 2 +- 5 files changed, 5330 insertions(+), 4217 deletions(-) diff --git a/ballerina/client.bal b/ballerina/client.bal index 0664062..5fc9f35 100644 --- a/ballerina/client.bal +++ b/ballerina/client.bal @@ -28,356 +28,324 @@ public isolated client class Client { # + serviceUrl - URL of the target service # + return - An error if connector initialization failed public isolated function init(ConnectionConfig config, string serviceUrl) returns error? { - http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, timeout: config.timeout, forwarded: config.forwarded, poolConfig: config.poolConfig, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, validation: config.validation}; - do { - if config.http1Settings is ClientHttp1Settings { - ClientHttp1Settings settings = check config.http1Settings.ensureType(ClientHttp1Settings); - httpClientConfig.http1Settings = {...settings}; - } - if config.http2Settings is http:ClientHttp2Settings { - httpClientConfig.http2Settings = check config.http2Settings.ensureType(http:ClientHttp2Settings); - } - if config.cache is http:CacheConfig { - httpClientConfig.cache = check config.cache.ensureType(http:CacheConfig); - } - if config.responseLimits is http:ResponseLimitConfigs { - httpClientConfig.responseLimits = check config.responseLimits.ensureType(http:ResponseLimitConfigs); - } - if config.secureSocket is http:ClientSecureSocket { - httpClientConfig.secureSocket = check config.secureSocket.ensureType(http:ClientSecureSocket); - } - if config.proxy is http:ProxyConfig { - httpClientConfig.proxy = check config.proxy.ensureType(http:ProxyConfig); - } - } - http:Client httpEp = check new (serviceUrl, httpClientConfig); - self.clientEp = httpEp; - return; + http:ClientConfiguration httpClientConfig = {auth: config.auth, httpVersion: config.httpVersion, http1Settings: config.http1Settings, http2Settings: config.http2Settings, timeout: config.timeout, forwarded: config.forwarded, followRedirects: config.followRedirects, poolConfig: config.poolConfig, cache: config.cache, compression: config.compression, circuitBreaker: config.circuitBreaker, retryConfig: config.retryConfig, cookieConfig: config.cookieConfig, responseLimits: config.responseLimits, secureSocket: config.secureSocket, proxy: config.proxy, socketConfig: config.socketConfig, validation: config.validation, laxDataBinding: config.laxDataBinding}; + self.clientEp = check new (serviceUrl, httpClientConfig); } + # Returns a list of supported countries. # - # + sortType - Indicates the method used to sort the results by name. - # + return - Successful response. - resource isolated function get addresses/countries("asc"|"desc" sortType = "asc") returns ListCountry|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get addresses/countries(map headers = {}, *GetSupportedCountriesQueries queries) returns ListCountry|error { string resourcePath = string `/addresses/countries`; - map queryParam = {"sortType": sortType}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - ListCountry response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Returns the AddressCountryTemplate bean for the given IsoCd (e.g. US). # - # + isoCd - ISO Country code. - # + return - Successful response. - resource isolated function get addresses/countries/[string isoCd]() returns AddressCountryTemplate|error { + # + isoCd - ISO Country code + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get addresses/countries/[string isoCd](map headers = {}) returns AddressCountryTemplate|error { string resourcePath = string `/addresses/countries/${getEncodedUri(isoCd)}`; - AddressCountryTemplate response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Fills an address from a Google Places search. Using the placeId from a Google Places search, an address will be returned that has all of the address components filled. If the placeId is not known, Google Places will be called to search and fill the address components. # - # + addressLine - The address line to have Google Places search and fill the address components. - # + placeId - Place Id from the Google Places search. - # + return - Successful response. - resource isolated function get addresses/googlePlacesFill(string? addressLine = (), string? placeId = ()) returns Address|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get addresses/googlePlacesFill(map headers = {}, *FillAddressFromGooglePlacesQueries queries) returns Address|error { string resourcePath = string `/addresses/googlePlacesFill`; - map queryParam = {"addressLine": addressLine, "placeId": placeId}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - Address response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Indicates whether a given address is already verified. # - # + return - Successful response. - resource isolated function post addresses/isVerifiedRequest(Address payload) returns http:Response|error { + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post addresses/isVerifiedRequest(Address payload, map headers = {}) returns error? { string resourcePath = string `/addresses/isVerifiedRequest`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Normalizes, verifies, and provides a more complete address. The verified address may include additional address properties. The response either returns one or more addresses that match the given address, or it will return an error if the address cannot be verified. If more than one address is returned, select an address and then resubmit the API request to perform address verification on the selected address. # - # + addressType - Indicates the requested format of the address after verification. Uncombined returns the street address in components. The default is Combined. - # + return - Successful response. - resource isolated function post addresses/verificationRequest(ListAddress payload, "Combined"|"Uncombined" addressType = "Combined") returns http:Response|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function post addresses/verificationRequest(ListAddress payload, map headers = {}, *VerifyAddressQueries queries) returns error? { string resourcePath = string `/addresses/verificationRequest`; - map queryParam = {"addressType": addressType}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); + resourcePath = resourcePath + check getPathForQueryParam(queries); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Returns a list of quotes or applications. # - # + applicationOrQuoteNumber - Application or quote number. - # + continuationId - Indicates the starting offset for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, the limit on your first API call was 100 and the results populated a list on the page. To request the next page of 100 results, call the API again with continuationId=101 and limit=100. - # + createdSinceDate - Select applications where application creation date is equal to or greater than the provided createdSinceDate. - # + customerId - Customer ID number. - # + includeClosed - Includes closed applications. If true, results will include "Closed" applications. If false (or not provided), results will not include "Closed" applications. - # + includeDeleted - Includes deleted applications. If true, results will include "Deleted" applications. If false (or not provided), results will not include "Deleted" applications. - # + 'limit - The maximum number of results to return. - # + optionalFields - Comma-delimited list of optional fields to be included. Currently supports customer and product. - # + policyId - Policy ID. - # + providerId - Provider code number. - # + recentlyViewed - Finds applications recently viewed by the caller/user. If true, results will be restricted to applications recently viewed by the caller/user. If false (or not provided), results will not be restricted to applications recently viewed by the caller/user. - # + status - Application status (e.g. In Process). - # + transactionCd - Transaction code (e.g. New Business) Use where a specific transactionCd(s) is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup contains a value. - # + transactionCdGroup - Find applications by transactionCdGroup. Use when a specific transactionCd(s) is not known. Accepts a comma-separated list of values. Valid values are Quote, Cancellation, Renewal, or Other. - # + 'type - Application type. Valid values are Application, QuickQuote, or Quote. - # + return - Successful response. - resource isolated function get applications(string? applicationOrQuoteNumber = (), string? continuationId = (), string? createdSinceDate = (), string? customerId = (), boolean? includeClosed = (), boolean? includeDeleted = (), string? 'limit = (), string? optionalFields = (), string? policyId = (), string? providerId = (), boolean? recentlyViewed = (), string? status = (), string? transactionCd = (), string? transactionCdGroup = (), string? 'type = ()) returns ListApplication|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get applications(map headers = {}, *GetQuotesQueries queries) returns ListApplication|error { string resourcePath = string `/applications`; - map queryParam = {"applicationOrQuoteNumber": applicationOrQuoteNumber, "continuationId": continuationId, "createdSinceDate": createdSinceDate, "customerId": customerId, "includeClosed": includeClosed, "includeDeleted": includeDeleted, "limit": 'limit, "optionalFields": optionalFields, "policyId": policyId, "providerId": providerId, "recentlyViewed": recentlyViewed, "status": status, "transactionCd": transactionCd, "transactionCdGroup": transactionCdGroup, "type": 'type}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - ListApplication response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Starts a new QuickQuote or Quote. To create a QuickQuote, basicPolicy productVersionIdRef (e.g. Homeowners-1.00.00), providerRef (e.g. 19), and effectiveDt strings are required. To create a Quote, basicPolicy productVersionIdRef, providerRef, and effectiveDt strings, plus one piece of insured information to create a customer, are required. # - # + requestedTypeCd - Starts a quote of the specified type. Valid values are QuickQuote or Quote. If a type is not specified, a QuickQuote will be created if the selected product supports quick quotes and you can perform quick quotes; otherwise, a Quote will be created. If QuickQuote is specified but the selected product does not support quick quotes or you cannot perform quick quotes, then either a 400 or 403 response code will be returned. - # + return - Successful response. - resource isolated function post applications(Quote payload, string? requestedTypeCd = ()) returns http:Response|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function post applications(Quote payload, map headers = {}, *CreateQuoteQueries queries) returns error? { string resourcePath = string `/applications`; - map queryParam = {"requestedTypeCd": requestedTypeCd}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); + resourcePath = resourcePath + check getPathForQueryParam(queries); http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Delete the quote or application. # - # + systemId - System identifier of the quote or application. - # + return - Successful response. - resource isolated function delete applications/[string systemId]() returns http:Response|error { + # + systemId - System identifier of the quote or application + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function delete applications/[string systemId](map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}`; - http:Response response = check self.clientEp->delete(resourcePath); - return response; + return self.clientEp->delete(resourcePath, headers = headers); } + # Converts a quote to an application. # - # + systemId - System identifier of the quote. - # + return - Successful response. - resource isolated function post applications/[string systemId]/bindRequest() returns http:Response|error { + # + systemId - System identifier of the quote + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post applications/[string systemId]/bindRequest(map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/bindRequest`; http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Converts a QuickQuote to a Quote. # - # + systemId - System identifier of the quote. - # + return - Successful response. - resource isolated function post applications/[string systemId]/convertToQuoteRequest() returns http:Response|error { + # + systemId - System identifier of the quote + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post applications/[string systemId]/convertToQuoteRequest(map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/convertToQuoteRequest`; http:Request request = new; - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Returns a list of documents for a quote or application. # - # + systemId - System identifier of the application. - # + return - Successful response. - resource isolated function get applications/[string systemId]/documents() returns ListDocument|error { + # + systemId - System identifier of the application + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get applications/[string systemId]/documents(map headers = {}) returns ListDocument|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/documents`; - ListDocument response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Adds an attachment to a quote or application. # - # + systemId - System identifier of the application. - # + return - Successful response. - resource isolated function post applications/[string systemId]/documents(Attachment payload) returns http:Response|error { + # + systemId - System identifier of the application + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post applications/[string systemId]/documents(Attachment payload, map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/documents`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Deletes an attachment associated with a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540"). # - # + systemId - System identifier of the application. - # + documentId - The identifier of the document. - # + return - Successful response. - resource isolated function delete applications/[string systemId]/documents/[string documentId]() returns http:Response|error { + # + systemId - System identifier of the application + # + documentId - The identifier of the document + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function delete applications/[string systemId]/documents/[string documentId](map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/documents/${getEncodedUri(documentId)}`; - http:Response response = check self.clientEp->delete(resourcePath); - return response; + return self.clientEp->delete(resourcePath, headers = headers); } + # Downloads a document for a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540"). # - # + systemId - System identifier of the application. - # + documentId - The identifier of the document. - # + return - Successful response. - resource isolated function get applications/[string systemId]/documents/[string documentId]/content() returns byte[]|error { + # + systemId - System identifier of the application + # + documentId - The identifier of the document + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get applications/[string systemId]/documents/[string documentId]/content(map headers = {}) returns byte[]|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/documents/${getEncodedUri(documentId)}/content`; - byte[] response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Returns a list of the drivers or non-drivers of a quote or application. # - # + systemId - System identifier of the quote or application. - # + continuationId - Indicates the starting offset for the API results when you want to return a specific portion of the full results. - # + includeDeleted - Includes deleted drivers/non-drivers. If true, results will include "Deleted" drivers/non-drivers. If false (or not provided), results will not include "Deleted" drivers/non-drivers. - # + 'limit - For pagination -- the maximum number of results to return. - # + typeCd - Filter by type of driver. - # + return - Successful response. - resource isolated function get applications/[string systemId]/drivers(string? continuationId = (), boolean? includeDeleted = (), string? 'limit = (), "Driver"|"NonDriver"? typeCd = ()) returns ListDriver|error { + # + systemId - System identifier of the quote or application + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get applications/[string systemId]/drivers(map headers = {}, *GetDriversQueries queries) returns ListDriver|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers`; - map queryParam = {"continuationId": continuationId, "includeDeleted": includeDeleted, "limit": 'limit, "typeCd": typeCd}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - ListDriver response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Creates a new driver or non-driver. You must include a partyTypeCd (DriverParty or NonDriverParty). Other details may be required depending on the insurance product being quoted. # - # + systemId - System identifier of the quote or application. - # + return - Successful response. - resource isolated function post applications/[string systemId]/drivers(Driver payload) returns http:Response|error { + # + systemId - System identifier of the quote or application + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post applications/[string systemId]/drivers(Driver payload, map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Returns details about a driver or non-driver. # - # + systemId - System identifier of the quote or application. - # + driverNumber - Driver/non-driver number. - # + return - Successful response. - resource isolated function get applications/[string systemId]/drivers/[int:Signed32 driverNumber]() returns Driver|error { + # + systemId - System identifier of the quote or application + # + driverNumber - Driver/non-driver number + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get applications/[string systemId]/drivers/[int:Signed32 driverNumber](map headers = {}) returns Driver|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers/${getEncodedUri(driverNumber)}`; - Driver response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Replaces the details about a driver or non-driver. # - # + systemId - System identifier of the quote or application. - # + driverNumber - Driver/non-driver number. - # + return - Successful response. - resource isolated function put applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload) returns Driver|error { + # + systemId - System identifier of the quote or application + # + driverNumber - Driver/non-driver number + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function put applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload, map headers = {}) returns Driver|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers/${getEncodedUri(driverNumber)}`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Driver response = check self.clientEp->put(resourcePath, request); - return response; + return self.clientEp->put(resourcePath, request, headers); } + # Deletes a driver/non-driver. # - # + systemId - System identifier of the quote or application. - # + driverNumber - Driver/non-driver number. - # + return - Successful response. - resource isolated function delete applications/[string systemId]/drivers/[int:Signed32 driverNumber]() returns http:Response|error { + # + systemId - System identifier of the quote or application + # + driverNumber - Driver/non-driver number + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function delete applications/[string systemId]/drivers/[int:Signed32 driverNumber](map headers = {}) returns error? { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers/${getEncodedUri(driverNumber)}`; - http:Response response = check self.clientEp->delete(resourcePath); - return response; + return self.clientEp->delete(resourcePath, headers = headers); } + # Makes changes to details about a driver/non-driver. # - # + systemId - System identifier of the quote or application. - # + driverNumber - Driver/non-driver number. - # + return - Successful response. - resource isolated function patch applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload) returns Driver|error { + # + systemId - System identifier of the quote or application + # + driverNumber - Driver/non-driver number + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function patch applications/[string systemId]/drivers/[int:Signed32 driverNumber](Driver payload, map headers = {}) returns Driver|error { string resourcePath = string `/applications/${getEncodedUri(systemId)}/drivers/${getEncodedUri(driverNumber)}`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - Driver response = check self.clientEp->patch(resourcePath, request); - return response; + return self.clientEp->patch(resourcePath, request, headers); } + # Returns the list of documents attached to a claim. # - # + systemId - System identifier of the claim. - # + return - Successful response. - resource isolated function get claims/[string systemId]/documents() returns ListDocument|error { + # + systemId - System identifier of the claim + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get claims/[string systemId]/documents(map headers = {}) returns ListDocument|error { string resourcePath = string `/claims/${getEncodedUri(systemId)}/documents`; - ListDocument response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Adds an attachment to a claim. # - # + systemId - System identifier of the claim. - # + return - Successful response. - resource isolated function post claims/[string systemId]/documents(DocumentDetail payload) returns http:Response|error { + # + systemId - System identifier of the claim + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post claims/[string systemId]/documents(DocumentDetail payload, map headers = {}) returns error? { string resourcePath = string `/claims/${getEncodedUri(systemId)}/documents`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Returns a list of notes for a claim. # - # + systemId - System identifier of the claim. - # + return - Successful response. - resource isolated function get claims/[string systemId]/notes() returns ListNote|error { + # + systemId - System identifier of the claim + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function get claims/[string systemId]/notes(map headers = {}) returns ListNote|error { string resourcePath = string `/claims/${getEncodedUri(systemId)}/notes`; - ListNote response = check self.clientEp->get(resourcePath); - return response; + return self.clientEp->get(resourcePath, headers); } + # Adds a note to a claim. # - # + systemId - System identifier of the claim. - # + return - Successful response. - resource isolated function post claims/[string systemId]/notes(NoteDetail payload) returns http:Response|error { + # + systemId - System identifier of the claim + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function post claims/[string systemId]/notes(NoteDetail payload, map headers = {}) returns error? { string resourcePath = string `/claims/${getEncodedUri(systemId)}/notes`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - http:Response response = check self.clientEp->post(resourcePath, request); - return response; + return self.clientEp->post(resourcePath, request, headers); } + # Returns a list of policies. # - # + continuationId - Indicates the starting list value for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, if the limit on your first API call was 10 and the results populated a list on the page. To request the next page of 10 results, call the API again with continuationId=11 and limit=10. - # + createdSinceDate - Selects policies where policy creation date is equal to or greater than the provided createdSinceDate (e.g. 2020-01-01). - # + customerId - Finds policies by customer id (e.g. 212). - # + expiredDateAfter - Selects policies where policy expiration date is equal to or lesser than the provided expirationDateBefore (e.g. 2020-01-01). - # + includePriorTerms - Includes prior terms.If true, results will include prior terms. If false (or not provided), results will not include prior terms. - # + 'limit - Indicates how many results to return. - # + optionalFields - Comma-delimited list of optional fields to be included. Currently supports customer and product. - # + policyNumber - Finds policies by policyNumber (e.g. HO00000058). - # + providerRef - Filters policies by provider identifier (e.g. 28). - # + recentlyViewed - Limits policies to those recently viewed by the caller or user. If true, results will be restricted to policies recently viewed by the caller or user. If false (or not provided), results will not be restricted to policies recently viewed by the caller or user. - # + status - Finds policies by policy status (e.g Active). - # + return - Successful response. - resource isolated function get policies(string? continuationId = (), string? createdSinceDate = (), string? customerId = (), string? expiredDateAfter = (), boolean? includePriorTerms = (), string? 'limit = (), string? optionalFields = (), string? policyNumber = (), string? providerRef = (), boolean? recentlyViewed = (), string? status = ()) returns ListPolicy|error { + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get policies(map headers = {}, *GetPoliciesQueries queries) returns ListPolicy|error { string resourcePath = string `/policies`; - map queryParam = {"continuationId": continuationId, "createdSinceDate": createdSinceDate, "customerId": customerId, "expiredDateAfter": expiredDateAfter, "includePriorTerms": includePriorTerms, "limit": 'limit, "optionalFields": optionalFields, "policyNumber": policyNumber, "providerRef": providerRef, "recentlyViewed": recentlyViewed, "status": status}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - ListPolicy response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Returns the full details of a policy. # - # + systemId - System identifier of the policy. - # + asOfDate - Returns the policy details from a specified date (e.g. 2021-01-01). If not provided, the current date will be used. - # + return - Successful response. - resource isolated function get policies/[string systemId](string? asOfDate = ()) returns PolicyDetails|error { + # + systemId - System identifier of the policy + # + headers - Headers to be sent with the request + # + queries - Queries to be sent with the request + # + return - Successful response + resource isolated function get policies/[string systemId](map headers = {}, *GetPolicyQueries queries) returns PolicyDetails|error { string resourcePath = string `/policies/${getEncodedUri(systemId)}`; - map queryParam = {"asOfDate": asOfDate}; - resourcePath = resourcePath + check getPathForQueryParam(queryParam); - PolicyDetails response = check self.clientEp->get(resourcePath); - return response; + resourcePath = resourcePath + check getPathForQueryParam(queries); + return self.clientEp->get(resourcePath, headers); } + # Updates the preferred delivery method and insured email address of the policy. Requires the systemId. # - # + systemId - System identifier of the policy. - # + return - Successful response. - resource isolated function patch policies/[string systemId](PolicyDetails payload) returns PolicyDetails|error { + # + systemId - System identifier of the policy + # + headers - Headers to be sent with the request + # + return - Successful response + resource isolated function patch policies/[string systemId](PolicyDetails payload, map headers = {}) returns PolicyDetails|error { string resourcePath = string `/policies/${getEncodedUri(systemId)}`; http:Request request = new; json jsonBody = payload.toJson(); request.setPayload(jsonBody, "application/json"); - PolicyDetails response = check self.clientEp->patch(resourcePath, request); - return response; + return self.clientEp->patch(resourcePath, request, headers); } } diff --git a/ballerina/types.bal b/ballerina/types.bal index 34d4cce..3d3d93f 100644 --- a/ballerina/types.bal +++ b/ballerina/types.bal @@ -17,1854 +17,1900 @@ // specific language governing permissions and limitations // under the License. +import ballerina/data.jsondata; import ballerina/http; -# Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. -@display {label: "Connection Config"} -public type ConnectionConfig record {| - # Configurations related to client authentication - http:BearerTokenConfig|http:CredentialsConfig auth; - # The HTTP version understood by the client - http:HttpVersion httpVersion = http:HTTP_2_0; - # Configurations related to HTTP/1.x protocol - ClientHttp1Settings http1Settings?; - # Configurations related to HTTP/2 protocol - http:ClientHttp2Settings http2Settings?; - # The maximum time to wait (in seconds) for a response before closing the connection - decimal timeout = 60; - # The choice of setting `forwarded`/`x-forwarded` header - string forwarded = "disable"; - # Configurations associated with request pooling - http:PoolConfiguration poolConfig?; - # HTTP caching related configurations - http:CacheConfig cache?; - # Specifies the way of handling compression (`accept-encoding`) header - http:Compression compression = http:COMPRESSION_AUTO; - # Configurations associated with the behaviour of the Circuit Breaker - http:CircuitBreakerConfig circuitBreaker?; - # Configurations associated with retrying - http:RetryConfig retryConfig?; - # Configurations associated with inbound response size limits - http:ResponseLimitConfigs responseLimits?; - # SSL/TLS-related options - http:ClientSecureSocket secureSocket?; - # Proxy server related options - http:ProxyConfig proxy?; - # Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default - boolean validation = true; -|}; - -# Provides settings related to HTTP/1.x protocol. -public type ClientHttp1Settings record {| - # Specifies whether to reuse a connection for multiple requests - http:KeepAlive keepAlive = http:KEEPALIVE_AUTO; - # The chunking behaviour of the request - http:Chunking chunking = http:CHUNKING_AUTO; - # Proxy server related options - ProxyConfig proxy?; -|}; - -# Proxy server configurations to be used with the HTTP client endpoint. -public type ProxyConfig record {| - # Host name of the proxy server - string host = ""; - # Proxy server port - int port = 0; - # Proxy server username - string userName = ""; - # Proxy server password - @display {label: "", kind: "password"} - string password = ""; -|}; - -# Represents a comprehensive view of an insurance policy, including customer details, policy specifics, associated contacts, and system references. It's designed to encapsulate all relevant information about a policy, facilitating easy access and management within the system. +# Represents a comprehensive view of an insurance policy, including customer details, policy specifics, associated contacts, and system references. It's designed to encapsulate all relevant information about a policy, facilitating easy access and management within the system public type Policy record { - # Hypermedia links associated with the policy item, providing navigational URLs to related resources. - Link[] _links?; - # Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system. - CustomerInfo customerInfo?; - # Provides a condensed overview of policy information, including key attributes and links for deeper exploration. PolicyMini policyMini?; - # Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization. - ProductInfo productInfo?; - # A general reference identifier for the policy item, usable for cross-referencing or linkage. + # A general reference identifier for the policy item, usable for cross-referencing or linkage string ref?; + # Hypermedia links associated with the policy item, providing navigational URLs to related resources + @jsondata:Name {value: "_links"} + Link[] links?; + CustomerInfo customerInfo?; + ProductInfo productInfo?; }; -# Defines an issue related to an entity within the system, capturing details such as the type of issue, associated attributes, and descriptive messages to aid in identification and resolution. -public type Issue record { - # A collection of references to attributes associated with the issue, providing context and details that may aid in issue analysis and resolution. - AttributeRef[] attributeRefs?; - # A unique identifier for the issue, enabling tracking and management within the system. - string id?; - # A descriptive message or summary of the issue, offering insight into the nature and potential impact of the problem. - string msg?; - # A code further categorizing the issue within its broader type, allowing for more granular classification and handling. - string subTypeCd?; - # The primary classification code of the issue, indicating its general category and facilitating appropriate routing and response strategies. - string typeCd?; -}; - -# Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services. +# Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services public type PersonInfo record { - # The current age of the individual, crucial for assessing eligibility and risk factors for certain insurance products. - int age?; - # The age at which the individual was first licensed to drive, providing insight into driving experience and proficiency. - int ageLicensed?; - # Preferred time for contacting the individual, ensuring communications are made at convenient times, enhancing customer service. + # The total number of years the individual has been licensed to drive, a direct measure of driving experience + int yearsLicensed?; + # The individual’s date of birth, in a standard format such as ISO 8601, foundational for many aspects of insurance processing and decision-making + string birthDt?; + # The professional title or role of the individual within their place of employment, relevant for understanding socioeconomic factors and occupational risks + string positionTitle?; + # Preferred time for contacting the individual, ensuring communications are made at convenient times, enhancing customer service string bestTimeToContact?; - # Preferred method of contact (e.g., email, phone, text), allowing for personalized communication strategies. + # The age at which the individual was first licensed to drive, providing insight into driving experience and proficiency + int ageLicensed?; + # A code indicating the marital status of the individual, which can be a factor in policy rates and coverage options + string maritalStatusCd?; + # Preferred method of contact (e.g., email, phone, text), allowing for personalized communication strategies string bestWayToContact?; - # The individual’s date of birth, in a standard format such as ISO 8601, foundational for many aspects of insurance processing and decision-making. - string birthDt?; - # A code representing the highest level of education attained by the individual, which may influence insurance rates or eligibility for certain benefits. - string educationCd?; - # A code identifying the individual’s employer, useful in policies where employment status or employer partnerships affect coverage options. - string employerCd?; - # The individual's gender as officially recorded, relevant in contexts where gender may impact insurance analytics or product offerings. + # The individual's gender as officially recorded, relevant in contexts where gender may impact insurance analytics or product offerings string genderCd?; - # A unique identifier for the person's information record, ensuring accurate tracking and updating of personal details within the system. + # A code identifying the individual’s employer, useful in policies where employment status or employer partnerships affect coverage options + string employerCd?; + # A code representing the highest level of education attained by the individual, which may influence insurance rates or eligibility for certain benefits + string educationCd?; + # Indicates the context or category of personal information provided, with 'ContactPersonal' denoting a direct, personal contact type + string personTypeCd = "ContactPersonal"; + # A unique identifier for the person's information record, ensuring accurate tracking and updating of personal details within the system string id?; - # A code indicating the marital status of the individual, which can be a factor in policy rates and coverage options. - string maritalStatusCd?; - # A code that classifies the individual's occupation, providing risk assessment data and potential eligibility for occupation-based discounts. + # The current age of the individual, crucial for assessing eligibility and risk factors for certain insurance products + int age?; + # A code that classifies the individual's occupation, providing risk assessment data and potential eligibility for occupation-based discounts string occupationCd?; - # Further classification of the individual’s occupation, offering nuanced insight into professional risks and coverage needs. + # Further classification of the individual’s occupation, offering nuanced insight into professional risks and coverage needs string occupationClassCd?; - # Indicates the context or category of personal information provided, with 'ContactPersonal' denoting a direct, personal contact type. - string personTypeCd?; - # The professional title or role of the individual within their place of employment, relevant for understanding socioeconomic factors and occupational risks. - string positionTitle?; - # The total number of years the individual has been licensed to drive, a direct measure of driving experience. - int yearsLicensed?; }; -# Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts. +# Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts public type BusinessInfo record { - # The total amount of payroll paid annually by the business, a factor in workers' compensation and liability coverages. + # The total number of years the business has been operational, indicating stability and experience in its field + string yearsInBusiness?; + # A code indicating the type of business, such as corporation, sole proprietorship, or partnership, relevant for underwriting and policy customization + string businessTypeCd?; + # A code describing the nature of the business, used for classification and risk assessment purposes + string natureBusinessCd?; + # The number of employees working for the business, impacting liability exposures and coverage requirements + string numberEmployees?; + # The total amount of payroll paid annually by the business, a factor in workers' compensation and liability coverages string annualPayrollAmt?; - # The total annual sales or revenue generated by the business, influencing coverage needs and premium calculations. + # The total annual sales or revenue generated by the business, influencing coverage needs and premium calculations string annualSalesAmt?; - # A code categorizing the business information record for internal tracking and management. + # A code categorizing the business information record for internal tracking and management string businessInfoCd?; - # A code indicating the type of business, such as corporation, sole proprietorship, or partnership, relevant for underwriting and policy customization. - string businessTypeCd?; - # A unique identifier for the business information record within the system, facilitating accurate reference and management. + # A unique identifier for the business information record within the system, facilitating accurate reference and management string id?; - # A code describing the nature of the business, used for classification and risk assessment purposes. - string natureBusinessCd?; - # A textual description of the business's primary operations, providing context for underwriting and coverage considerations. + # A textual description of the business's primary operations, providing context for underwriting and coverage considerations string natureOfBusiness?; - # The number of employees working for the business, impacting liability exposures and coverage requirements. - string numberEmployees?; - # The total number of years the business has been operational, indicating stability and experience in its field. - string yearsInBusiness?; }; -# Provides a condensed overview of policy information, including key attributes and links for deeper exploration. +# Defines an issue related to an entity within the system, capturing details such as the type of issue, associated attributes, and descriptive messages to aid in identification and resolution +public type Issue record { + # A descriptive message or summary of the issue, offering insight into the nature and potential impact of the problem + string msg?; + # A collection of references to attributes associated with the issue, providing context and details that may aid in issue analysis and resolution + AttributeRef[] attributeRefs?; + # The primary classification code of the issue, indicating its general category and facilitating appropriate routing and response strategies + string typeCd?; + # A code further categorizing the issue within its broader type, allowing for more granular classification and handling + string subTypeCd?; + # A unique identifier for the issue, enabling tracking and management within the system + string id?; +}; + +# Provides a condensed overview of policy information, including key attributes and links for deeper exploration public type PolicyMini record { - # A collection of hypermedia links to related resources, facilitating navigation and further actions. - Link[] _links?; - # Reference identifier to the account associated with this policy, linking to account-specific details. - string accountRef?; - # Reference to the audit account, if applicable, providing a connection to audit-related information and actions. - string auditAccountRef?; - # Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan. - BasicPolicy basicPolicy?; - # An array of contacts related to the policy, detailing individuals or entities associated in various capacities. - Contact[] contacts?; - # A reference to the customer associated with the policy, enabling linkage to detailed customer information. - string customerRef?; - # Indicator for the association of the policy with an external system, highlighting integrations or external dependencies. + # System identifier that manages or tracks the policy, indicating the source or platform of policy management + string systemId?; + # Indicator for the association of the policy with an external system, highlighting integrations or external dependencies string externalSystemInd?; - # Result or status from an IVANS insurance verification process, reflecting verification outcomes. - string iVANSCheck?; - # Unique identifier for the policy, facilitating identification and retrieval within the system. - string id?; - # Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information. Insured insured?; - # Reference to the statement account related to the policy, used for financial transactions and billing. + # Reference to the statement account related to the policy, used for financial transactions and billing string statementAccountRef?; - # System identifier that manages or tracks the policy, indicating the source or platform of policy management. - string systemId?; - # Version identifier for the policy information, denoting the format or structure level of the policy data. + # A collection of hypermedia links to related resources, facilitating navigation and further actions + @jsondata:Name {value: "_links"} + Link[] links?; + # Version identifier for the policy information, denoting the format or structure level of the policy data string version?; - # Indicates the VIP level of the policy or associated customer, used for service prioritization or benefits. + # Indicates the VIP level of the policy or associated customer, used for service prioritization or benefits string vipLevel?; + BasicPolicy basicPolicy?; + # A reference to the customer associated with the policy, enabling linkage to detailed customer information + string customerRef?; + # Reference identifier to the account associated with this policy, linking to account-specific details + string accountRef?; + # Unique identifier for the policy, facilitating identification and retrieval within the system + string id?; + # Reference to the audit account, if applicable, providing a connection to audit-related information and actions + string auditAccountRef?; + # Result or status from an IVANS insurance verification process, reflecting verification outcomes + string iVANSCheck?; + # An array of contacts related to the policy, detailing individuals or entities associated in various capacities + Contact[] contacts?; }; -# Comprehensive details about an address, encapsulating both the physical location attributes and metadata for validation, geocoding, and postal delivery optimization. +# Comprehensive details about an address, encapsulating both the physical location attributes and metadata for validation, geocoding, and postal delivery optimization public type Address record { - # Additional detail to further specify the location within complex addresses, such as unit or apartment number. + # A cryptographic hash value generated from the address details. This hash is used to ensure the integrity of the address data and to verify that no changes have occurred since the last validation + string verificationHash; + # Directional indicator for the range, providing spatial orientation in rural addressing schemes + string rangeDir?; + # A directional suffix in an address, specifying the compass point after the street name, for geographical clarity + string postDirectional?; + # A legal narrative description of the property associated with the address, used in formal documentation and contracts + string legalDesc?; + # Specifies the primary meridian reference, important in certain legal and surveying contexts + string primaryMeridian?; + # The ZIP or postal code, crucial for mail sorting, delivery, and regional identification + string postalCode?; + # The county in which the address resides, providing an additional layer of geographic specificity + string county?; + # Designates a specific section within the Public Land Survey System (PLSS) or a similar land division system, providing additional precision to rural and agricultural property locations + string section?; + # A suffix indicating the type or category of the street or thoroughfare, such as Road, Avenue, Circle, etc., providing additional context to the street name + string suffix?; + # A numerical score representing the accuracy of the address verification, where higher scores indicate higher confidence levels + string score?; + # The block number or identifier, relevant in urban planning and real estate contexts + string block?; + # A unique identifier for the address within the system, used for tracking and reference + string id; + # Additional detail to further specify the location within complex addresses, such as unit or apartment number string addition?; - # Any legal descriptors that provide further detail to the address, often used in legal contexts or when precise property identification is necessary. - string additionalLegal?; - # The primary address line, typically containing the street number and name. - string addr1; - # Secondary address line, used for additional location information, such as building or suite number. - string addr2?; - # Tertiary address line for further detail, less commonly used. - string addr3?; - # Quaternary address line, utilized in complex addressing scenarios where multiple lines are needed for clarity. - string addr4?; - # A code indicating the type of address, such as 'ContactAddr' for a primary contact address. - string addrTypeCd; - # A unique hash value representing the address, used for identifying and detecting changes to address data. - string addressHash?; - # Designates a specific individual or department at the address for targeted delivery. - string attention?; - # Numeric representation of the postal barcode associated with the address, used for mail sorting and delivery. + # The longitude coordinate of the address, resulting from geocoding processes + string longitude?; + # The specific number or identifier of the unit within a larger building, essential for accurate mail delivery to multi-unit locations + string secondaryNumber?; + # Numeric representation of the postal barcode associated with the address, used for mail sorting and delivery string barcodeDigits?; - # The block number or identifier, relevant in urban planning and real estate contexts. - string block?; - # A postal service designation indicating the specific route for mail delivery, comprising a type and code. - string carrierRoute?; - # The city or town associated with the address. - string city; - # Identifies the congressional district in which the address is located, relevant for political and demographic purposes. - string congressCode?; - # The county in which the address resides, providing an additional layer of geographic specificity. - string county?; - # A specific code assigned to the county, used for administrative and geographic classification. - string countyCode?; - # Delivery Point Validation code, indicating the deliverability status of the address as per postal service validation. - string dpv?; - # A textual description of the Delivery Point Validation code, offering insights into mail delivery capabilities. + # Indicates the precision of geocoding for the address, such as 'street' or 'postal code' level + string geocodeLevel?; + # The number assigned to the building or property within the street, fundamental for address identification + string primaryNumber?; + # The full name of the country or major administrative region for the address + string regionCd; + # A code indicating the type of address, such as 'ContactAddr' for a primary contact address + string addrTypeCd = "ContactAddr"; + # Directional indicator associated with the township, aiding in the geographical orientation and precise location of properties within larger rural or unincorporated areas + string townshipDir?; + # A textual description of the Delivery Point Validation code, offering insights into mail delivery capabilities string dpvDesc?; - # Additional notes from the Delivery Point Validation process, highlighting specific issues or considerations. - string dpvNotes?; - # Descriptive elaboration on the DPV notes, providing context and explanations for validation outcomes. + # Any legal descriptors that provide further detail to the address, often used in legal contexts or when precise property identification is necessary + string additionalLegal?; + # A unique hash value representing the address, used for identifying and detecting changes to address data + string addressHash?; + # Descriptive elaboration on the DPV notes, providing context and explanations for validation outcomes string dpvNotesDesc?; - # Indicates the precision of geocoding for the address, such as 'street' or 'postal code' level. - string geocodeLevel?; - # Narrative description of the geocode level, explaining the extent of location accuracy achieved. - string geocodeLevelDescription?; - # A unique identifier for the address within the system, used for tracking and reference. - string id; - # The latitude coordinate of the address, resulting from geocoding processes. + # Identifies the congressional district in which the address is located, relevant for political and demographic purposes + string congressCode?; + # The city or town associated with the address + string city; + # The latitude coordinate of the address, resulting from geocoding processes string latitude?; - # A legal narrative description of the property associated with the address, used in formal documentation and contracts. - string legalDesc?; - # The longitude coordinate of the address, resulting from geocoding processes. - string longitude?; - # Identifies the specific lot within a subdivision or development, relevant in property identification. - string lot?; - # Refers to the principal meridian used in surveying and legal descriptions within the region of the address. - string meridian?; - # Indicates the Public Land Survey System (PLSS) county code, relevant in the United States for land division and legal descriptions. - string plssCounty?; - # A directional suffix in an address, specifying the compass point after the street name, for geographical clarity. - string postDirectional?; - # The ZIP or postal code, crucial for mail sorting, delivery, and regional identification. - string postalCode?; - # A directional prefix in an address, specifying the compass point before the street name, enhancing locational accuracy. - string preDirectional?; - # Specifies the primary meridian reference, important in certain legal and surveying contexts. - string primaryMeridian?; - # The number assigned to the building or property within the street, fundamental for address identification. - string primaryNumber?; - # A suffix to the primary number, providing additional specificity, such as indicating a range of units. + # A suffix to the primary number, providing additional specificity, such as indicating a range of units string primaryNumberSuffix?; - # Specifies the range for rural or agricultural properties, often used in conjunction with township and section. + # A postal service designation indicating the specific route for mail delivery, comprising a type and code + string carrierRoute?; + # Specifies the range for rural or agricultural properties, often used in conjunction with township and section string range?; - # Directional indicator for the range, providing spatial orientation in rural addressing schemes. - string rangeDir?; - # The full name of the country or major administrative region for the address. - string regionCd; - # The ISO Alpha-2 country code, standardizing country identification across international systems. - string regionISOCd; - # A numerical score representing the accuracy of the address verification, where higher scores indicate higher confidence levels. - string score?; - # Indicates a specific unit or sub-location within a larger complex or building, such as 'Apt' or 'Suite'. + # A message summarizing the outcome of the latest address verification attempt, providing insights into any discrepancies, issues, or confirmation of address accuracy + string verificationMsg?; + # Indicates a specific unit or sub-location within a larger complex or building, such as 'Apt' or 'Suite' string secondaryDesignator?; - # The specific number or identifier of the unit within a larger building, essential for accurate mail delivery to multi-unit locations. - string secondaryNumber?; - # Designates a specific section within the Public Land Survey System (PLSS) or a similar land division system, providing additional precision to rural and agricultural property locations. - string section?; - # The code representing the state or province of the address. This may be an abbreviation or a full name, depending on local conventions and requirements. - string stateProvCd; - # The name of the street or thoroughfare, excluding numerical or directional prefixes and suffixes, essential for identifying the location within a city or region. + # Identifies the specific lot within a subdivision or development, relevant in property identification + string lot?; + # The name of the street or thoroughfare, excluding numerical or directional prefixes and suffixes, essential for identifying the location within a city or region string streetName?; - # A suffix indicating the type or category of the street or thoroughfare, such as Road, Avenue, Circle, etc., providing additional context to the street name. - string suffix?; - # Identifies the township or equivalent jurisdictional division, used primarily in rural addressing to specify location within larger, often unincorporated, areas. - string township?; - # Directional indicator associated with the township, aiding in the geographical orientation and precise location of properties within larger rural or unincorporated areas. - string townshipDir?; - # Indicates the validation status of the address, particularly the accuracy of the township, section, and range components, confirming the address has been verified against official records or databases. + # Indicates the validation status of the address, particularly the accuracy of the township, section, and range components, confirming the address has been verified against official records or databases string validated?; - # A cryptographic hash value generated from the address details. This hash is used to ensure the integrity of the address data and to verify that no changes have occurred since the last validation. - string verificationHash; - # A message summarizing the outcome of the latest address verification attempt, providing insights into any discrepancies, issues, or confirmation of address accuracy. - string verificationMsg?; + # The code representing the state or province of the address. This may be an abbreviation or a full name, depending on local conventions and requirements + string stateProvCd; + # A directional prefix in an address, specifying the compass point before the street name, enhancing locational accuracy + string preDirectional?; + # The ISO Alpha-2 country code, standardizing country identification across international systems + string regionISOCd; + # Secondary address line, used for additional location information, such as building or suite number + string addr2?; + # The primary address line, typically containing the street number and name + string addr1; + # Quaternary address line, utilized in complex addressing scenarios where multiple lines are needed for clarity + string addr4?; + # Tertiary address line for further detail, less commonly used + string addr3?; + # Delivery Point Validation code, indicating the deliverability status of the address as per postal service validation + string dpv?; + # Narrative description of the geocode level, explaining the extent of location accuracy achieved + string geocodeLevelDescription?; + # A specific code assigned to the county, used for administrative and geographic classification + string countyCode?; + # Refers to the principal meridian used in surveying and legal descriptions within the region of the address + string meridian?; + # Designates a specific individual or department at the address for targeted delivery + string attention?; + # Additional notes from the Delivery Point Validation process, highlighting specific issues or considerations + string dpvNotes?; + # Indicates the Public Land Survey System (PLSS) county code, relevant in the United States for land division and legal descriptions + string plssCounty?; + # Identifies the township or equivalent jurisdictional division, used primarily in rural addressing to specify location within larger, often unincorporated, areas + string township?; }; -# Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information. +# Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information public type AuditPayPlan record { - # A code representing the specific payment plan determined as a result of the audit, which may differ from the initial payment plan based on actual policy performance or other factors. - string auditPayPlanCd?; - # Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods. ElectronicPaymentSource electronicPaymentSource?; - # A unique identifier for the audit pay plan record, ensuring the ability to reference and apply the specific plan adjustments post-audit. + # Indicates the adjusted day of the month for payment due dates under the audited payment plan, which may have been modified from the original schedule + string paymentDay?; + # A code representing the specific payment plan determined as a result of the audit, which may differ from the initial payment plan based on actual policy performance or other factors + string auditPayPlanCd?; + # A unique identifier for the audit pay plan record, ensuring the ability to reference and apply the specific plan adjustments post-audit string id?; - # References the template from which the audited payment plan was derived, indicating the base plan prior to any adjustments. + # References the template from which the audited payment plan was derived, indicating the base plan prior to any adjustments string payPlanTemplateIdRef?; - # Indicates the adjusted day of the month for payment due dates under the audited payment plan, which may have been modified from the original schedule. - string paymentDay?; }; -# Encapsulates details about an attachment, including files, metadata, and policies related to the retention and deletion of the attachment. +# Encapsulates details about an attachment, including files, metadata, and policies related to the retention and deletion of the attachment public type Attachment record { - # An array of file identifiers that are to be combined into this single composite attachment, facilitating document management and access. - CompositeFile[] compositeFile?; - # A user or system-provided description of the attachment, often detailing its content, purpose, or any relevant context. - string description?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. - EraseInfo eraseInfo?; - # The storage path and unique filename under which the attachment is saved on the server, crucial for retrieval and management. + # The storage path and unique filename under which the attachment is saved on the server, crucial for retrieval and management string filename?; - # A unique identifier for the attachment, facilitating tracking, reference, and operations like update or deletion. + EraseInfo eraseInfo?; + # A user or system-provided description of the attachment, often detailing its content, purpose, or any relevant context + string description?; + # Optional user-entered notes or commentary about the attachment, which can include usage notes, revision information, or any other pertinent details + string memo?; + # An array of file identifiers that are to be combined into this single composite attachment, facilitating document management and access + CompositeFile[] compositeFile?; + # A unique identifier for the attachment, facilitating tracking, reference, and operations like update or deletion string id?; - # An array of identifiers for other resources or entities within the system that this attachment is linked to, enhancing data connectivity and context. + # An array of identifiers for other resources or entities within the system that this attachment is linked to, enhancing data connectivity and context LinkReference[] linkReferences?; - # Optional user-entered notes or commentary about the attachment, which can include usage notes, revision information, or any other pertinent details. - string memo?; - # Contains details regarding the policies and processes for purging the attachment from the system, including timelines, methods, and compliance requirements. + # Contains details regarding the policies and processes for purging the attachment from the system, including timelines, methods, and compliance requirements record {} purgeInfo?; - # A collection of tags associated with the attachment, serving as metadata for categorization, searchability, and organization. - Tag[] tags?; - # Identifies the template from which the attachment was created, if any, linking it to standardized document formats or predefined content structures. + # Identifies the template from which the attachment was created, if any, linking it to standardized document formats or predefined content structures string templateId?; + # A collection of tags associated with the attachment, serving as metadata for categorization, searchability, and organization + Tag[] tags?; }; -# Details an individual's or entity's phone contact information, including type and preference, to support effective and preferred modes of communication. +# Details an individual's or entity's phone contact information, including type and preference, to support effective and preferred modes of communication public type PhoneInfo record { - # A unique identifier for the phone information record, allowing for efficient tracking and management within the system. + # A code that categorizes the type of phone number (e.g., mobile, home, work), aiding in its appropriate use and prioritization + string phoneTypeCd = "ContactPhone"; + # The actual phone number, formatted according to local or international standards, facilitating contact + string phoneNumber?; + # A unique identifier for the phone information record, allowing for efficient tracking and management within the system string id?; - # A label or name associated with the phone number, such as 'Home' or 'Work', to identify the phone number's context or usage. + # A label or name associated with the phone number, such as 'Home' or 'Work', to identify the phone number's context or usage string phoneName?; - # The actual phone number, formatted according to local or international standards, facilitating contact. - string phoneNumber?; - # A code that categorizes the type of phone number (e.g., mobile, home, work), aiding in its appropriate use and prioritization. - string phoneTypeCd?; - # Indicates whether this phone number is the preferred method of contact, prioritizing it among multiple contact options. - boolean preferredInd?; + # Indicates whether this phone number is the preferred method of contact, prioritizing it among multiple contact options + boolean preferredInd = true; }; -# Detailed metadata and properties associated with a specific document, including access permissions, document type, and identifiers. +# Detailed metadata and properties associated with a specific document, including access permissions, document type, and identifiers public type Document record { - # Hypermedia links related to the document, providing navigational paths to related data and actions available for the document. - Link[] _links?; - # The date the document was added to the system, typically in ISO 8601 format. - string addDt?; - # The time the document was added to the system, often complementing the addition date for precise tracking. - string addTm?; - # Identifier of the user who added the document, useful for audit trails and permissions management. + # Hypermedia links related to the document, providing navigational paths to related data and actions available for the document + @jsondata:Name {value: "_links"} + Link[] links?; + # Identifier of the user who added the document, useful for audit trails and permissions management string addUser?; - # Indicator of whether the document can be deleted, based on current user permissions and document status. - boolean canDeleteInd?; - # Indicator of whether the current user has permissions to view the document, ensuring compliance with access control policies. - boolean canViewInd?; - # Code representing the delivery method or status of the document, such as electronic, mailed, or pending. + # A unique identifier for the transaction that resulted in the document's creation or modification, essential for traceability + string transactionNumber?; + # Code representing the delivery method or status of the document, such as electronic, mailed, or pending string deliveryCd?; - # A brief description or summary of the document's content or purpose, aiding in identification and categorization. + # A brief description or summary of the document's content or purpose, aiding in identification and categorization string description?; - # A code categorizing the document by type, such as policy, claim, or identification, for systematic organization. + # Indicator of whether the current user has permissions to view the document, ensuring compliance with access control policies + boolean canViewInd?; + # General categorization of the document, possibly overlapping with documentTypeCd but allowing for broader classification + string 'type?; + # A code categorizing the document by type, such as policy, claim, or identification, for systematic organization string documentTypeCd?; - # The name of the file as stored within the system, including file extension, facilitating file retrieval and management. - string filename?; - # A code identifying the form associated with the document, relevant in contexts where documents are generated from standardized forms. - string formCd?; - # Detailed description of the item or content covered by the document, providing additional context beyond the basic description. - string itemDescription?; - # The name or title of the item or subject matter the document pertains to, offering a quick reference to the document's focus. + # The name or title of the item or subject matter the document pertains to, offering a quick reference to the document's focus string itemName?; - # The title or name of the document, used as a primary identifier in listings and searches. - string name?; - # A unique number or identifier generated during the document's output or creation process, useful for tracking and reference. - string outputNumber?; - # A general reference field that could be used to link the document to other entities or identifiers within the system. + # A general reference field that could be used to link the document to other entities or identifiers within the system string ref?; - # Reference to the template used for generating the document, linking the document to its source for replication or audit purposes. + # The name of the file as stored within the system, including file extension, facilitating file retrieval and management + string filename?; + # The date the document was added to the system, typically in ISO 8601 format + string addDt?; + # A unique number or identifier generated during the document's output or creation process, useful for tracking and reference + string outputNumber?; + # The title or name of the document, used as a primary identifier in listings and searches + string name?; + # Reference to the template used for generating the document, linking the document to its source for replication or audit purposes string templateIdRef?; - # A unique identifier for the transaction that resulted in the document's creation or modification, essential for traceability. - string transactionNumber?; - # General categorization of the document, possibly overlapping with documentTypeCd but allowing for broader classification. - string 'type?; + # A code identifying the form associated with the document, relevant in contexts where documents are generated from standardized forms + string formCd?; + # Detailed description of the item or content covered by the document, providing additional context beyond the basic description + string itemDescription?; + # Indicator of whether the document can be deleted, based on current user permissions and document status + boolean canDeleteInd?; + # The time the document was added to the system, often complementing the addition date for precise tracking + string addTm?; +}; + +# Represents the Queries record for the operation: getDrivers +public type GetDriversQueries record { + # Filter by type of driver + "Driver"|"NonDriver" typeCd?; + # Indicates the starting offset for the API results when you want to return a specific portion of the full results + string continuationId?; + # For pagination -- the maximum number of results to return + string 'limit?; + # Includes deleted drivers/non-drivers. If true, results will include "Deleted" drivers/non-drivers. If false (or not provided), results will not include "Deleted" drivers/non-drivers + boolean includeDeleted?; +}; + +# Represents the Queries record for the operation: getPolicies +public type GetPoliciesQueries record { + # Limits policies to those recently viewed by the caller or user. If true, results will be restricted to policies recently viewed by the caller or user. If false (or not provided), results will not be restricted to policies recently viewed by the caller or user + boolean recentlyViewed?; + # Filters policies by provider identifier (e.g. 28) + string providerRef?; + # Selects policies where policy creation date is equal to or greater than the provided createdSinceDate (e.g. 2020-01-01) + string createdSinceDate?; + # Indicates the starting list value for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, if the limit on your first API call was 10 and the results populated a list on the page. To request the next page of 10 results, call the API again with continuationId=11 and limit=10 + string continuationId?; + # Finds policies by customer id (e.g. 212) + string customerId?; + # Indicates how many results to return + string 'limit?; + # Finds policies by policyNumber (e.g. HO00000058) + string policyNumber?; + # Selects policies where policy expiration date is equal to or lesser than the provided expirationDateBefore (e.g. 2020-01-01) + string expiredDateAfter?; + # Includes prior terms.If true, results will include prior terms. If false (or not provided), results will not include prior terms + boolean includePriorTerms?; + # Comma-delimited list of optional fields to be included. Currently supports customer and product + string optionalFields?; + # Finds policies by policy status (e.g Active) + string status?; +}; + +# Represents the Queries record for the operation: getSupportedCountries +public type GetSupportedCountriesQueries record { + # Indicates the method used to sort the results by name + "asc"|"desc" sortType = "asc"; }; -# Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting. +# Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting public type TaxInfo record { - # The Federal Employer Identification Number (FEIN) for the entity, used in tax filings and other legal documents as a unique identifier. - string fein?; - # A unique identifier for the tax information record, facilitating accurate tracking and association with parties or accounts. - string id?; - # A code indicating the legal entity type, such as corporation, partnership, or sole proprietor, relevant for tax classification and compliance. - string legalEntityCd?; - # Indicates whether the party has received a Form 1099, used for reporting income from sources other than wages, salaries, and tips. + # A code describing the tax classification of the party, such as 'Individual', 'Corporation', or 'Partnership', impacting tax treatment and obligations + string taxTypeCd?; + # Indicates whether the party is exempt from tax withholding, relevant for processing payments and tax reporting + boolean withholdingExemptInd?; + # Indicates whether the party has received a Form 1099, used for reporting income from sources other than wages, salaries, and tips boolean received1099Ind?; - # Indicates whether a Form W-9 has been received from the party, used to request the taxpayer identification number and certification. + # A code that specifies the type of tax identification number provided, such as SSN or FEIN, indicating the format and nature of the ID + string taxIdTypeCd?; + # Indicates whether a Form W-9 has been received from the party, used to request the taxpayer identification number and certification boolean receivedW9Ind?; - # Specifies if the issuance of a Form 1099 is required for the party, based on the nature of payments or income received. + # Specifies if the issuance of a Form 1099 is required for the party, based on the nature of payments or income received boolean required1099Ind?; - # The Social Security Number (SSN) for individuals, serving as a primary identification number for tax and other legal purposes. + # The Federal Employer Identification Number (FEIN) for the entity, used in tax filings and other legal documents as a unique identifier + string fein?; + # A unique identifier for the tax information record, facilitating accurate tracking and association with parties or accounts + string id?; + # A code indicating the legal entity type, such as corporation, partnership, or sole proprietor, relevant for tax classification and compliance + string legalEntityCd?; + # The Social Security Number (SSN) for individuals, serving as a primary identification number for tax and other legal purposes string ssn?; - # A code that specifies the type of tax identification number provided, such as SSN or FEIN, indicating the format and nature of the ID. - string taxIdTypeCd?; - # A code describing the tax classification of the party, such as 'Individual', 'Corporation', or 'Partnership', impacting tax treatment and obligations. - string taxTypeCd?; - # Indicates whether the party is exempt from tax withholding, relevant for processing payments and tax reporting. - boolean withholdingExemptInd?; }; -# Reasons for the closure of a transaction. +# Reasons for the closure of a transaction public type TransactionCloseReasons record { - # Comment associated with transaction closure. - string closeComment?; - # Code indicating the reason for transaction closure. + # Code indicating the reason for transaction closure string closeReasonCd?; - # Code indicating the sub-reason for transaction closure. - string closeSubReasonCd?; - # Label associated with the sub-reason for transaction closure. + # Label associated with the sub-reason for transaction closure string closeSubReasonLabel?; - # Unique identifier for the transaction close reasons. + # Unique identifier for the transaction close reasons string id?; + # Comment associated with transaction closure + string closeComment?; + # Code indicating the sub-reason for transaction closure + string closeSubReasonCd?; }; -# Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes. +# Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes public type EmailInfo record { - # The email address itself, providing a means of electronic communication. + # The email address itself, providing a means of electronic communication string emailAddr?; - # A code identifying the type of email address provided (e.g., personal, work), aiding in its appropriate use and categorization. - string emailTypeCd?; - # A unique identifier for the email information record, allowing for reference and management within the system. + # A code identifying the type of email address provided (e.g., personal, work), aiding in its appropriate use and categorization + string emailTypeCd = "ContactEmail"; + # A unique identifier for the email information record, allowing for reference and management within the system string id?; - # Indicates whether this email address is the preferred contact method for the individual, prioritizing it among multiple contact options. - boolean preferredInd?; + # Indicates whether this email address is the preferred contact method for the individual, prioritizing it among multiple contact options + boolean preferredInd = false; }; -# Encapsulates detailed information about an individual policy, including identification, related entities, and status indicators. This schema serves as a comprehensive model for policy information, integrating with both internal and external systems for full lifecycle management. +# Encapsulates detailed information about an individual policy, including identification, related entities, and status indicators. This schema serves as a comprehensive model for policy information, integrating with both internal and external systems for full lifecycle management public type PolicyDetails record { - # Hypermedia links associated with the policy item, providing navigational URLs to related resources. - Link[] _links?; - # The revision identifier of the policy, used for tracking changes and ensuring data consistency. - string _revision?; - # A reference identifier linking the policy to a specific account in the system. - string accountRef?; - # Reference identifier for the account associated with any audits related to the policy. - string auditAccountRef?; - # Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan. - BasicPolicy basicPolicy?; - # A collection of contacts related to the policy, including individuals and entities with various roles. - Contact[] contacts?; - # A reference identifier for the customer associated with the policy. - string customerRef?; - # Indicator flag signifying if the policy is synchronized with an external system. + # An identifier for the policy within the internal or external systems, facilitating cross-reference + string systemId?; + # List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage + WCAdditionalInsured[] wcAdditionalInsureds?; + # The revision identifier of the policy, used for tracking changes and ensuring data consistency + @jsondata:Name {value: "_revision"} + string revision?; + # A counter indicating the number of times the policy has been updated + int updateCount?; + # Indicator flag signifying if the policy is synchronized with an external system string externalSystemInd?; - # Status of the IVANS check for the policy, indicating connectivity and data exchange success with the IVANS network. - string iVANSCheck?; - # The unique identifier of the policy within the system. - string id?; - # Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information. Insured insured?; - # Reference identifier for the account associated with billing statements for the policy. + # Reference identifier for the account associated with billing statements for the policy string statementAccountRef?; - # An identifier for the policy within the internal or external systems, facilitating cross-reference. - string systemId?; - # A counter indicating the number of times the policy has been updated. - int updateCount?; - # The timestamp of the last update made to the policy, formatted in ISO 8601. - string updateTimestamp?; - # Identifier of the user who last updated the policy, used for audit trails and accountability. + # Hypermedia links associated with the policy item, providing navigational URLs to related resources + @jsondata:Name {value: "_links"} + Link[] links?; + # A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance + WCCoveredState[] wcCoveredStates?; + # Identifier of the user who last updated the policy, used for audit trails and accountability string updateUser?; - # The version number of the policy, used for version control and history tracking. + # The version number of the policy, used for version control and history tracking string version?; - # The VIP level assigned to the policy or policyholder, indicating priority or special handling requirements. + # The timestamp of the last update made to the policy, formatted in ISO 8601 + string updateTimestamp?; + # The VIP level assigned to the policy or policyholder, indicating priority or special handling requirements string vipLevel?; - # List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage. - WCAdditionalInsured[] wcAdditionalInsureds?; - # A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance. - WCCoveredState[] wcCoveredStates?; + BasicPolicy basicPolicy?; + # A reference identifier for the customer associated with the policy + string customerRef?; + # A reference identifier linking the policy to a specific account in the system + string accountRef?; + # The unique identifier of the policy within the system + string id?; + # Reference identifier for the account associated with any audits related to the policy + string auditAccountRef?; + # Status of the IVANS check for the policy, indicating connectivity and data exchange success with the IVANS network + string iVANSCheck?; + # A collection of contacts related to the policy, including individuals and entities with various roles + Contact[] contacts?; }; -# Provides details about an insurance score, including the score itself, reasons for the score, and related metadata, which is used in the underwriting and risk assessment processes. +# Provides details about an insurance score, including the score itself, reasons for the score, and related metadata, which is used in the underwriting and risk assessment processes public type InsuranceScore record { - # A unique identifier for the insurance score record, facilitating tracking and management within the system. - string id?; - # The insurance score, typically a numerical value or rating, derived from various factors and used to assess the risk associated with an insured or applicant. - string insuranceScore?; - # A list of reasons contributing to the insurance score, providing insight into factors influencing the score. - InsuranceScoreReason[] insuranceScoreReasons?; - # A code categorizing the type of insurance score, such as credit-based or claims history, indicating the basis for the scoring. - string insuranceScoreTypeCd?; - # If applicable, the insurance score that overrides the original score, typically resulting from manual review or additional information. + # If applicable, the insurance score that overrides the original score, typically resulting from manual review or additional information string overriddenInsuranceScore?; - # A code indicating the source of the insurance score, such as an external credit bureau or an internal scoring system. + # A code categorizing the type of insurance score, such as credit-based or claims history, indicating the basis for the scoring + string insuranceScoreTypeCd?; + # The insurance score, typically a numerical value or rating, derived from various factors and used to assess the risk associated with an insured or applicant + string insuranceScore?; + # A code indicating the source of the insurance score, such as an external credit bureau or an internal scoring system string sourceCd?; - # A reference to the specific source record or identifier for the insurance score, linking to detailed source information. - string sourceIdRef?; - # The current status of the insurance score, such as 'Active' or 'Reviewed', indicating its state within the underwriting process. + # The current status of the insurance score, such as 'Active' or 'Reviewed', indicating its state within the underwriting process string statusCd?; + # A unique identifier for the insurance score record, facilitating tracking and management within the system + string id?; + # A list of reasons contributing to the insurance score, providing insight into factors influencing the score + InsuranceScoreReason[] insuranceScoreReasons?; + # A reference to the specific source record or identifier for the insurance score, linking to detailed source information + string sourceIdRef?; }; -# Encapsulates issues identified by the submitter during the insurance application or quote submission process, including categorization and descriptive messaging. +# Encapsulates issues identified by the submitter during the insurance application or quote submission process, including categorization and descriptive messaging public type SubmitterIssue record { - # A unique identifier for the submitter issue, facilitating tracking and resolution efforts within the system. - string id?; - # A descriptive message detailing the nature of the issue, providing insight into potential concerns or required actions. + # A descriptive message detailing the nature of the issue, providing insight into potential concerns or required actions string msg?; - # A code further specifying the subtype of the issue, offering additional granularity beyond the primary type for more precise categorization. - string subTypeCd?; - # The primary classification code for the issue, indicating its general category and aiding in prioritization and resolution strategies. + # The primary classification code for the issue, indicating its general category and aiding in prioritization and resolution strategies string typeCd?; + # A code further specifying the subtype of the issue, offering additional granularity beyond the primary type for more precise categorization + string subTypeCd?; + # A unique identifier for the submitter issue, facilitating tracking and resolution efforts within the system + string id?; }; -# Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes. +# Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint. +@display {label: "Connection Config"} +public type ConnectionConfig record {| + # Configurations related to client authentication + http:BearerTokenConfig|http:CredentialsConfig auth; + # The HTTP version understood by the client + http:HttpVersion httpVersion = http:HTTP_2_0; + # Configurations related to HTTP/1.x protocol + http:ClientHttp1Settings http1Settings = {}; + # Configurations related to HTTP/2 protocol + http:ClientHttp2Settings http2Settings = {}; + # The maximum time to wait (in seconds) for a response before closing the connection + decimal timeout = 30; + # The choice of setting `forwarded`/`x-forwarded` header + string forwarded = "disable"; + # Configurations associated with Redirection + http:FollowRedirects followRedirects?; + # Configurations associated with request pooling + http:PoolConfiguration poolConfig?; + # HTTP caching related configurations + http:CacheConfig cache = {}; + # Specifies the way of handling compression (`accept-encoding`) header + http:Compression compression = http:COMPRESSION_AUTO; + # Configurations associated with the behaviour of the Circuit Breaker + http:CircuitBreakerConfig circuitBreaker?; + # Configurations associated with retrying + http:RetryConfig retryConfig?; + # Configurations associated with cookies + http:CookieConfig cookieConfig?; + # Configurations associated with inbound response size limits + http:ResponseLimitConfigs responseLimits = {}; + # SSL/TLS-related options + http:ClientSecureSocket secureSocket?; + # Proxy server related options + http:ProxyConfig proxy?; + # Provides settings related to client socket configuration + http:ClientSocketConfig socketConfig = {}; + # Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default + boolean validation = true; + # Enables relaxed data binding on the client side. When enabled, `nil` values are treated as optional, + # and absent fields are handled as `nilable` types. Enabled by default. + boolean laxDataBinding = true; +|}; + +# Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes public type ApplicationMini record { - # A collection of hypermedia links to related resources, enabling easy navigation to detailed views of the application, policy information, and other associated resources. - Link[] _links?; - # Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions. - ApplicationInfo applicationInfo?; - # The unique identifier assigned to the application, serving as a primary reference for tracking and management throughout the application process. + # A collection of hypermedia links to related resources, enabling easy navigation to detailed views of the application, policy information, and other associated resources + @jsondata:Name {value: "_links"} + Link[] links?; + # The unique identifier assigned to the application, serving as a primary reference for tracking and management throughout the application process string applicationNumber?; - # A reference identifier linking the application to its associated audit account, facilitating financial tracking and audit processes. - string auditAccountRef?; - # Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan. BasicPolicy basicPolicy?; + ApplicationInfo applicationInfo?; + # A reference identifier linking the application to its associated audit account, facilitating financial tracking and audit processes + string auditAccountRef?; }; -# Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods. +# Represents the Queries record for the operation: verifyAddress +public type VerifyAddressQueries record { + # Indicates the requested format of the address after verification. Uncombined returns the street address in components. The default is Combined + "Combined"|"Uncombined" addressType = "Combined"; +}; + +# Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods public type ElectronicPaymentSource record { - # The bank account number for ACH payments, essential for direct bank transfers. + # Message providing additional details regarding credit card authorization status or any associated messages + string creditCardAuthorizationMessage?; + EraseInfo eraseInfo?; + # Indicates whether the payment source is an agent's trust account, differentiating it from customer-owned accounts + boolean agentTrustInd?; + # The bank account number for ACH payments, essential for direct bank transfers string achBankAccountNumber?; - # A code identifying the type of bank account (e.g., checking, savings) used for ACH payments. + # A date indicating when a payment reminder should be sent, aiding in timely payment collection and customer notification + string reminderDt?; + # An account identifier used by the payment service provider, linking the payment transaction to external payment processing systems + string paymentServiceAccountId?; + # Code indicating the status of credit card authorization, such as approved or declined + string creditCardAuthorizationCd?; + # A code identifying the type of bank account (e.g., checking, savings) used for ACH payments string achBankAccountTypeCd?; - # The name of the bank where the ACH account is held, providing necessary details for payment processing. - string achBankName?; - # Message detailing any exceptions or issues encountered during the ACH payment process, useful for troubleshooting and record-keeping. - string achExceptionMsg?; - # The name associated with the ACH account, typically the account holder's name as it appears on bank records. - string achName?; - # The routing number for the bank account, a critical component for directing ACH payments to the correct financial institution. - string achRoutingNumber?; - # A code that categorizes the type of ACH transaction, conforming to standard entry class specifications for payment processing. - string achStandardEntryClassCd?; - # Indicates whether the payment source is an agent's trust account, differentiating it from customer-owned accounts. - boolean agentTrustInd?; - # Carrier code associated with the payment, identifying the insurance carrier in cases of payments facilitated by or through carriers. - string carrierCd?; - # The number of the credit card used for payments, sensitive data that must be handled according to PCI compliance standards. - string creditCardNumber?; - # A code indicating the type of credit card (e.g., Visa, MasterCard) used for the payment. - string creditCardTypeCd?; - # An identifier for the customer's payment profile, allowing for the reuse of stored payment information in a secure manner. - string customerPaymentProfileId?; - # An identifier linking the electronic payment source to a customer profile, facilitating comprehensive customer payment management. - string customerProfileId?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. - EraseInfo eraseInfo?; - # A unique identifier for the electronic payment source record within the system. - string id?; - # A code that specifies the payment method (e.g., ACH, credit card), important for directing the payment process accordingly. - string methodCd?; - # An identifier used in MIDAS (Money Inflow/Disbursement Administration System) or similar systems for tracking financial transactions. + # An identifier used in MIDAS (Money Inflow/Disbursement Administration System) or similar systems for tracking financial transactions string midasId?; - # Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication. - PartyInfo partyInfo?; - # An account identifier used by the payment service provider, linking the payment transaction to external payment processing systems. - string paymentServiceAccountId?; - # A date indicating when a payment reminder should be sent, aiding in timely payment collection and customer notification. - string reminderDt?; - # The name of the payment source, providing a human-readable identifier for the payment method or account. - string sourceName?; - # A code identifying the category of payment source (e.g., internal, external, third-party), useful for payment routing and management. - string sourceTypeCd?; - # A code indicating the current status of the payment source, such as active, inactive, or under review, guiding its availability for use. - string statusCd?; - # Placeholder for any action related to the payment source, such as update or deletion. + # Placeholder for any action related to the payment source, such as update or deletion string action?; - # Code indicating the status of credit card authorization, such as approved or declined. - string creditCardAuthorizationCd?; - # Message providing additional details regarding credit card authorization status or any associated messages. - string creditCardAuthorizationMessage?; - # The expiration month of the credit card. + # A unique identifier for the electronic payment source record within the system + string id?; + # A code indicating the type of credit card (e.g., Visa, MasterCard) used for the payment + string creditCardTypeCd?; + # The expiration month of the credit card string creditCardExpirationMonth?; - # The expiration year of the credit card. - string creditCardExpirationYr?; - # The name of the credit card holder as it appears on the card. + # The name of the credit card holder as it appears on the card string creditCardHolderName?; - # The security code associated with the credit card, typically found on the back of the card. + # Message detailing any exceptions or issues encountered during the ACH payment process, useful for troubleshooting and record-keeping + string achExceptionMsg?; + # A code identifying the category of payment source (e.g., internal, external, third-party), useful for payment routing and management + string sourceTypeCd?; + # A code indicating the current status of the payment source, such as active, inactive, or under review, guiding its availability for use + string statusCd?; + # The name of the bank where the ACH account is held, providing necessary details for payment processing + string achBankName?; + # The security code associated with the credit card, typically found on the back of the card string creditCardSecurityCd?; + # An identifier for the customer's payment profile, allowing for the reuse of stored payment information in a secure manner + string customerPaymentProfileId?; + PartyInfo partyInfo?; + # An identifier linking the electronic payment source to a customer profile, facilitating comprehensive customer payment management + string customerProfileId?; + # The expiration year of the credit card + string creditCardExpirationYr?; + # Carrier code associated with the payment, identifying the insurance carrier in cases of payments facilitated by or through carriers + string carrierCd?; + # The number of the credit card used for payments, sensitive data that must be handled according to PCI compliance standards + string creditCardNumber?; + # A code that specifies the payment method (e.g., ACH, credit card), important for directing the payment process accordingly + string methodCd?; + # The name associated with the ACH account, typically the account holder's name as it appears on bank records + string achName?; + # The name of the payment source, providing a human-readable identifier for the payment method or account + string sourceName?; + # A code that categorizes the type of ACH transaction, conforming to standard entry class specifications for payment processing + string achStandardEntryClassCd?; + # The routing number for the bank account, a critical component for directing ACH payments to the correct financial institution + string achRoutingNumber?; }; -# Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information. +# Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information public type Insured record { - # A code that identifies the nature of the insured entity, such as 'Individual', 'Corporation', or 'Partnership', reflecting the structure and legal status of the insured. - string entityTypeCd?; - # A unique identifier assigned to the insured within the system, facilitating tracking, policy association, and risk assessment. - string id?; - # A standardized name used for indexing and search purposes, often formatted to meet specific regulatory or operational requirements. + # The North American Industry Classification System (NAICS) code applicable to the insured's business, used for statistical and risk assessment purposes + string wcNAICS?; + # A standardized name used for indexing and search purposes, often formatted to meet specific regulatory or operational requirements string indexName?; - # A list of PartyInfo objects associated with the insured, detailing multiple roles, relationships, or contact points as needed. - PartyInfo[] partyInfo?; - # The preferred method of communication or document delivery for the insured, aligning with their convenience and regulatory preferences. - string preferredDeliveryMethod?; - # An identifier used by rating bureaus to classify or rate the insured, relevant in jurisdictions or lines of business where bureau ratings are applicable. + # The official website address for the insured or their business, offering an additional contact point and information source + string websiteAddress?; + # An identifier used by rating bureaus to classify or rate the insured, relevant in jurisdictions or lines of business where bureau ratings are applicable string ratingBureauID?; - # Indicates whether the insured operates under a self-insurance model, relevant for certain types of coverage and risk management strategies. + # Indicates whether the insured operates under a self-insurance model, relevant for certain types of coverage and risk management strategies boolean selfInsured?; - # A flag that indicates a temporary override of the insured's standard address, useful for short-term billing or communication needs. - boolean temporaryAddressOverrideInd?; - # The North American Industry Classification System (NAICS) code applicable to the insured's business, used for statistical and risk assessment purposes. - string wcNAICS?; - # A risk identification number assigned by the National Council on Compensation Insurance (NCCI), relevant for workers' compensation insurance. + # A risk identification number assigned by the National Council on Compensation Insurance (NCCI), relevant for workers' compensation insurance string wcNCCIRiskIdNumber?; - # The Standard Industrial Classification (SIC) code for the insured's business, providing an industry-based risk indicator. - string wcSIC?; - # The official website address for the insured or their business, offering an additional contact point and information source. - string websiteAddress?; - # The total number of years the insured has been in operation, reflecting business stability and experience for underwriting and risk assessment. + # The total number of years the insured has been in operation, reflecting business stability and experience for underwriting and risk assessment int yearsInBusiness?; + # A list of PartyInfo objects associated with the insured, detailing multiple roles, relationships, or contact points as needed + PartyInfo[] partyInfo?; + # The preferred method of communication or document delivery for the insured, aligning with their convenience and regulatory preferences + string preferredDeliveryMethod?; + # The Standard Industrial Classification (SIC) code for the insured's business, providing an industry-based risk indicator + string wcSIC?; + # A unique identifier assigned to the insured within the system, facilitating tracking, policy association, and risk assessment + string id?; + # A flag that indicates a temporary override of the insured's standard address, useful for short-term billing or communication needs + boolean temporaryAddressOverrideInd?; + # A code that identifies the nature of the insured entity, such as 'Individual', 'Corporation', or 'Partnership', reflecting the structure and legal status of the insured + string entityTypeCd?; }; -# Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior. +# Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior public type DriverInfo record { - # The date the driver completed an accredited accident prevention course, potentially qualifying for insurance discounts. - string accidentPreventionCourseCompletionDt?; - # Indicates whether the driver has successfully completed an accident prevention course. - boolean accidentPreventionCourseInd?; - # The number of vehicles officially assigned to the driver within the policy, indicating responsibility and primary usage. - int assignedVehicle?; - # Reference identifier for the vehicle(s) associated with the driver, linking driver information to specific vehicles covered under the policy. + # Reference identifier for the vehicle(s) associated with the driver, linking driver information to specific vehicles covered under the policy string attachedVehicleRef?; - # The date the driver was hired for employment, applicable when driving is a part of professional duties. - string dateofHire?; - # The start date from which defensive driving course benefits apply, reflecting eligibility for associated discounts. + # The start date from which defensive driving course benefits apply, reflecting eligibility for associated discounts string defensiveDriverEffectiveDt?; - # The expiration date for defensive driving course benefits, after which renewal may be required to maintain discounts. - string defensiveDriverExpirationDt?; - # Indicates whether the driver has completed a defensive driving course, affecting insurance premiums and coverage options. - boolean defensiveDriverInd?; - # A code categorizing the type of driver information record, useful for system processing and classification. - string driverInfoCd?; - # A list of points accrued by the driver for traffic violations or other infractions, impacting risk assessment and premium calculation. - DriverPoint[] driverPoints?; - # The date the driver began driving, relevant for calculating driving experience and insurance eligibility. - string driverStartDt?; - # A code indicating the current status of the driver, such as active or suspended, which may influence policy terms and pricing. - string driverStatusCd?; - # The date on which the driver completed a formal driver training program, potentially affecting policy discounts. - string driverTrainingCompletionDt?; - # Indicates completion of a formal driver training program, qualifying the driver for potential insurance benefits. - boolean driverTrainingInd?; - # Categorizes the driver by type, such as 'Primary' or 'Occasional', affecting policy coverage and premiums. - string driverTypeCd?; - # Specifies whether the driver is excluded from certain coverages within the policy, based on risk assessments or other factors. - string excludeDriverInd?; - # Indicates eligibility for a good driver discount, based on a history of safe driving practices. - boolean goodDriverDiscountInd?; - # Affirms the driver's qualification as a good driver, impacting insurance rates and coverage eligibility. + # Affirms the driver's qualification as a good driver, impacting insurance rates and coverage eligibility boolean goodDriverInd?; - # A unique identifier for the driver information record, ensuring distinct management within the insurance system. - string id?; - # The total number of years the individual has been driving, crucial for evaluating driving experience and risk. - int lengthTimeDriving?; - # The date on which the driver's license was issued, foundational for legal driving status and insurance underwriting. + # Indicates eligibility for a good driver discount, based on a history of safe driving practices + boolean goodDriverDiscountInd?; + # The date the driver qualified for a discount based on scholastic achievements, relevant for young or student drivers + string scholasticCertificationDt?; + # The total number of years the driver has held a license, serving as an indicator of experience and driving history + int yearsExperience?; + # The date of the last update to the driver's MVR status, important for maintaining current and accurate risk assessments + string mvrStatusDt?; + # The date on which the driver completed a formal driver training program, potentially affecting policy discounts + string driverTrainingCompletionDt?; + # The date the driver began driving, relevant for calculating driving experience and insurance eligibility + string driverStartDt?; + # The date on which the driver's license was issued, foundational for legal driving status and insurance underwriting string licenseDt?; - # The official number associated with the driver's license, essential for identification and record-keeping. - string licenseNumber?; - # The current status of the driver's license, such as valid, suspended, or expired, directly affecting insurance eligibility. - string licenseStatus?; - # The code for the state or province that issued the driver's license, indicating jurisdiction and legal authority. - string licensedStateProvCd?; - # Indicates recognition of the driver as a mature driver, possibly affecting insurance premiums and coverage options. - boolean matureDriverInd?; - # Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a key component in risk assessment and policy pricing. + # A code indicating the current status of the driver, such as active or suspended, which may influence policy terms and pricing + string driverStatusCd?; + # Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a key component in risk assessment and policy pricing boolean mvrRequestInd?; - # The status of the driver's MVR, providing insights into driving history, violations, and overall risk profile. + # The expiration date for defensive driving course benefits, after which renewal may be required to maintain discounts + string defensiveDriverExpirationDt?; + # The year in which the driver was first licensed, offering a measure of driving experience and proficiency + string yearLicensed?; + # The official number associated with the driver's license, essential for identification and record-keeping + string licenseNumber?; + # A unique identifier for the driver information record, ensuring distinct management within the insurance system + string id?; + # The date the driver completed an accredited accident prevention course, potentially qualifying for insurance discounts + string accidentPreventionCourseCompletionDt?; + # The status of the driver's MVR, providing insights into driving history, violations, and overall risk profile string mvrStatus?; - # The date of the last update to the driver's MVR status, important for maintaining current and accurate risk assessments. - string mvrStatusDt?; - # Specifies whether the driver holds a permanent driving license, as opposed to a provisional or temporary license. + # Specifies whether the driver holds a permanent driving license, as opposed to a provisional or temporary license boolean permanentLicenseInd?; - # Describes the driver's relationship to the insured entity or individual, such as family member or employee, impacting coverage details. - string relationshipToInsuredCd?; - # Indicates whether the driver is required to provide proof of insurance, typically for legal or regulatory compliance. + # The number of vehicles officially assigned to the driver within the policy, indicating responsibility and primary usage + int assignedVehicle?; + # The total number of years the individual has been driving, crucial for evaluating driving experience and risk + int lengthTimeDriving?; + # A code categorizing the type of driver information record, useful for system processing and classification + string driverInfoCd?; + # Indicates completion of a formal driver training program, qualifying the driver for potential insurance benefits + boolean driverTrainingInd?; + # Specifies whether the driver is excluded from certain coverages within the policy, based on risk assessments or other factors + string excludeDriverInd?; + # Indicates whether the driver is required to provide proof of insurance, typically for legal or regulatory compliance boolean requiredProofOfInsuranceInd?; - # The date the driver qualified for a discount based on scholastic achievements, relevant for young or student drivers. - string scholasticCertificationDt?; - # Indicates eligibility for a discount based on scholastic performance, encouraging responsible behavior among student drivers. + # The code for the state or province that issued the driver's license, indicating jurisdiction and legal authority + string licensedStateProvCd?; + # Indicates eligibility for a discount based on scholastic performance, encouraging responsible behavior among student drivers boolean scholasticDiscountInd?; - # Comments related to the driver's status, providing additional context or explanations for status assignments or changes. + # Comments related to the driver's status, providing additional context or explanations for status assignments or changes string statusComments?; - # The year in which the driver was first licensed, offering a measure of driving experience and proficiency. - string yearLicensed?; - # The total number of years the driver has held a license, serving as an indicator of experience and driving history. - int yearsExperience?; + # The current status of the driver's license, such as valid, suspended, or expired, directly affecting insurance eligibility + string licenseStatus?; + # Indicates recognition of the driver as a mature driver, possibly affecting insurance premiums and coverage options + boolean matureDriverInd?; + # Indicates whether the driver has successfully completed an accident prevention course + boolean accidentPreventionCourseInd?; + # Categorizes the driver by type, such as 'Primary' or 'Occasional', affecting policy coverage and premiums + string driverTypeCd?; + # Describes the driver's relationship to the insured entity or individual, such as family member or employee, impacting coverage details + string relationshipToInsuredCd?; + # The date the driver was hired for employment, applicable when driving is a part of professional duties + string dateofHire?; + # A list of points accrued by the driver for traffic violations or other infractions, impacting risk assessment and premium calculation + DriverPoint[] driverPoints?; + # Indicates whether the driver has completed a defensive driving course, affecting insurance premiums and coverage options + boolean defensiveDriverInd?; }; -# Encapsulates a response that includes a list of insurance applications, potentially spanning multiple pages, along with pagination control via a continuation identifier. +# Encapsulates a response that includes a list of insurance applications, potentially spanning multiple pages, along with pagination control via a continuation identifier public type ListApplication record { - # An array of Application objects, each representing an individual insurance application with summary and detailed data. - Application[] applicationListItems?; - # A pagination control identifier that specifies the starting point for the next set of results, used when additional results are available beyond the current response. + # A pagination control identifier that specifies the starting point for the next set of results, used when additional results are available beyond the current response string continuationId?; + # An array of Application objects, each representing an individual insurance application with summary and detailed data + Application[] applicationListItems?; }; -# Represents the details of a composite file, which is typically created by combining multiple files or parts of files into a single file attachment. This schema facilitates the management and assembly of such files. -public type CompositeFile record { - # Specifies the storage path and the unique filename under which the component file is saved on the server. These files are intended to be combined to form a composite attachment. - string fileName?; - # A unique identifier for the composite file component, allowing for precise reference and manipulation within the system. - string id?; -}; - -# Details specific workers' compensation coverage options and conditions for a given state, including discounts, deductibles, experience modifications, and other factors influencing the policy's terms and premium calculations. +# Details specific workers' compensation coverage options and conditions for a given state, including discounts, deductibles, experience modifications, and other factors influencing the policy's terms and premium calculations public type WCCoveredState record { - # Indicates whether the Alternate Risk Distribution (ARD) rule is enabled for this state, affecting risk assessment and premium distribution. - boolean aRDRuleEnabled?; - # Indicates eligibility for a credit based on participation in alcohol and drug-free workplace programs. - boolean alcoholDrugFreeCreditInd?; - # The percentage credit applied for participation in certified safety and health programs, encouraging workplace safety initiatives. - string certifiedSafetyHealthProgPct?; - # Indicates the presence of a coinsurance arrangement for the covered state, impacting the distribution of risk between insurer and insured. + # Indicates whether Employers' Liability Voluntary Compensation is included, extending coverage beyond statutory workers' compensation requirements + boolean eLVoluntaryCompensationInd?; + # Indicates the presence of a coinsurance arrangement for the covered state, impacting the distribution of risk between insurer and insured boolean coinsuranceInd?; - # The percentage credit applied based on adjustments to the contractor classification premium, reflecting specific risk profiles and experience. - string contrClassPremAdjCreditPct?; - # The amount of deductible applied to the policy for the covered state, influencing out-of-pocket costs before insurance coverage begins. + # The amount of deductible applied to the policy for the covered state, influencing out-of-pocket costs before insurance coverage begins string deductibleAmt?; - # Specifies the type of deductible, such as 'per claim' or 'aggregate', defining how the deductible applies within the policy terms. + # Specifies the type of deductible, such as 'per claim' or 'aggregate', defining how the deductible applies within the policy terms string deductibleType?; - # Indicates whether Employers' Liability Voluntary Compensation is included, extending coverage beyond statutory workers' compensation requirements. - boolean eLVoluntaryCompensationInd?; - # A factor reflecting the insured's historical claims experience relative to the industry average, affecting premium calculations. + # The unemployment insurance number for the insured within the covered state, relevant for businesses and compliance reporting + string unemploymentNumber?; + # Indicates the status of regulatory or internal rules applied to the coverage, such as 'active', 'pending', or 'expired' + string ruleStatus?; + # The total premium calculated based on manual rates before application of experience modifications or other adjustments + string totalManualPremiumAmt?; + # The number of weeks covered under a workfare program, applicable for policies including workfare participants + string workfareProgramWeeksNum?; + # Indicates the application of a credit for participation in managed care programs, reflecting cost savings from efficient care management + boolean managedCareCreditInd?; + # Reference to the product version associated with this coverage, linking state-specific terms to overall policy structure and offerings + string productVersionIdRef?; + # Indicates whether the Alternate Risk Distribution (ARD) rule is enabled for this state, affecting risk assessment and premium distribution + boolean aRDRuleEnabled?; + # The portion of the premium subject to adjustments and modifications, based on covered payroll, classification rates, and experience factors + string totalSubjectPremiumAmt?; + # Details about any work-study programs affecting coverage or premium calculations, relevant for educational institutions or employers + string workStudyProgram?; + # A unique identifier for the workers' compensation coverage record within the specified state + string id?; + # The total premium amount after applying discounts, reflecting cost adjustments based on risk management practices or other criteria + string totalDiscountedPremiumAmt?; + # Indicates whether a flat waiver of subrogation applies, limiting the insurer's right to recover from third parties causing loss + boolean waiverOfSubrogationFlatInd?; + # An estimate of the total premium for the covered state, considering specific state rates, classifications, and coverage requirements + string totalStateEstimatedPremium?; + # A factor reflecting the insured's historical claims experience relative to the industry average, affecting premium calculations string experienceModificationFactor?; - # Status of the experience modification, such as 'applied' or 'pending', indicating the current application of the experience factor. - string experienceModificationStatus?; - # A code representing the insured's experience rating, categorizing the risk level based on past claims history. - string experienceRatingCd?; - # Scheduled premium modification for General Liability, affecting the overall premium calculation based on specific risk adjustments. + # Scheduled premium modification for General Liability, affecting the overall premium calculation based on specific risk adjustments string gLScheduledPremiumMod?; - # A unique identifier for the workers' compensation coverage record within the specified state. - string id?; - # A numerical index used for ordering or categorization within the system, facilitating data organization and retrieval. - int index?; - # A factor applied in cases of large deductibles, influencing the premium calculation by accounting for the increased self-assumed risk. - string largeDeductibleFactor?; - # Indicates the application of a credit for participation in managed care programs, reflecting cost savings from efficient care management. - boolean managedCareCreditInd?; - # The number of contracts under which a waiver of subrogation applies, affecting the rights of the insurer to pursue recovery from third parties. - string noOfContractsForWaiverOfSubrogation?; - # The amount charged for noncompliance with specified conditions or requirements, serving as a penalty or incentive for adherence to policy terms. + # Specifies the order in which this state's coverage details are presented or processed, indicating sequencing within multi-state policies + int 'order?; + # The amount charged for noncompliance with specified conditions or requirements, serving as a penalty or incentive for adherence to policy terms string noncomplianceChargeAmt?; - # The number of claims filed under the policy for the covered state, providing a measure of risk and loss history. + # The number of contracts under which a waiver of subrogation applies, affecting the rights of the insurer to pursue recovery from third parties + string noOfContractsForWaiverOfSubrogation?; + # A factor applied in cases of large deductibles, influencing the premium calculation by accounting for the increased self-assumed risk + string largeDeductibleFactor?; + # A numerical index used for ordering or categorization within the system, facilitating data organization and retrieval + int index?; + # The number of claims filed under the policy for the covered state, providing a measure of risk and loss history string numberOfClaims?; - # Specifies the order in which this state's coverage details are presented or processed, indicating sequencing within multi-state policies. - int 'order?; - # Indicates whether package factors, combining multiple coverages or policies, are applied in premium calculations for the state. - boolean packageFactorInd?; - # Designates the state as the primary state of coverage, relevant for policies covering multiple jurisdictions. - boolean primaryInd?; - # Reference to the product version associated with this coverage, linking state-specific terms to overall policy structure and offerings. - string productVersionIdRef?; - # The effective date of the rating and pricing structure applied to the covered state, marking the beginning of the applicable terms. + # The effective date of the rating and pricing structure applied to the covered state, marking the beginning of the applicable terms string ratingEffectiveDt?; - # Indicates the status of regulatory or internal rules applied to the coverage, such as 'active', 'pending', or 'expired'. - string ruleStatus?; - # The code representing the state for which the coverage details apply, identifying the jurisdiction covered by the policy terms. + # The standard premium amount prior to any discounts or modifications, serving as a baseline for subsequent premium calculations + string totalStandardPremiumAmt?; + # The percentage credit applied for participation in certified safety and health programs, encouraging workplace safety initiatives + string certifiedSafetyHealthProgPct?; + # Indicates whether package factors, combining multiple coverages or policies, are applied in premium calculations for the state + boolean packageFactorInd?; + # Indicates eligibility for a credit based on participation in alcohol and drug-free workplace programs + boolean alcoholDrugFreeCreditInd?; + # A code representing the insured's experience rating, categorizing the risk level based on past claims history + string experienceRatingCd?; + # The code representing the state for which the coverage details apply, identifying the jurisdiction covered by the policy terms string stateCd?; - # The current status of the coverage for the specified state, indicating active, inactive, or pending states of the coverage terms. + # Status of the experience modification, such as 'applied' or 'pending', indicating the current application of the experience factor + string experienceModificationStatus?; + # The percentage credit applied based on adjustments to the contractor classification premium, reflecting specific risk profiles and experience + string contrClassPremAdjCreditPct?; + # Designates the state as the primary state of coverage, relevant for policies covering multiple jurisdictions + boolean primaryInd?; + # The current status of the coverage for the specified state, indicating active, inactive, or pending states of the coverage terms string status?; - # The total premium amount after applying discounts, reflecting cost adjustments based on risk management practices or other criteria. - string totalDiscountedPremiumAmt?; - # The total premium calculated based on manual rates before application of experience modifications or other adjustments. - string totalManualPremiumAmt?; - # The standard premium amount prior to any discounts or modifications, serving as a baseline for subsequent premium calculations. - string totalStandardPremiumAmt?; - # An estimate of the total premium for the covered state, considering specific state rates, classifications, and coverage requirements. - string totalStateEstimatedPremium?; - # The portion of the premium subject to adjustments and modifications, based on covered payroll, classification rates, and experience factors. - string totalSubjectPremiumAmt?; - # The unemployment insurance number for the insured within the covered state, relevant for businesses and compliance reporting. - string unemploymentNumber?; - # Indicates whether a flat waiver of subrogation applies, limiting the insurer's right to recover from third parties causing loss. - boolean waiverOfSubrogationFlatInd?; - # Details about any work-study programs affecting coverage or premium calculations, relevant for educational institutions or employers. - string workStudyProgram?; - # The number of weeks covered under a workfare program, applicable for policies including workfare participants. - string workfareProgramWeeksNum?; }; -# Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. +# Represents the details of a composite file, which is typically created by combining multiple files or parts of files into a single file attachment. This schema facilitates the management and assembly of such files +public type CompositeFile record { + # Specifies the storage path and the unique filename under which the component file is saved on the server. These files are intended to be combined to form a composite attachment + string fileName?; + # A unique identifier for the composite file component, allowing for precise reference and manipulation within the system + string id?; +}; + +# Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations public type EraseInfo record { - # Identifier of the user or system process that performed the erasure, providing an audit trail for compliance and review. + # The specific time at which the data was erased, complementing the date information for precise record-keeping + string erasedTm?; + # Identifier of the user or system process that performed the erasure, providing an audit trail for compliance and review string erasedBy?; - # The date on which the data was erased, recorded in a standard format such as ISO 8601 for consistency and clarity. + # The date on which the data was erased, recorded in a standard format such as ISO 8601 for consistency and clarity string erasedDt?; - # A boolean indicator that confirms whether the data has been successfully erased, providing a clear status update. - boolean erasedInd?; - # The specific time at which the data was erased, complementing the date information for precise record-keeping. - string erasedTm?; - # A unique identifier for the erase information record, facilitating tracking and management of erasure actions within the system. + # A unique identifier for the erase information record, facilitating tracking and management of erasure actions within the system string id?; + # A boolean indicator that confirms whether the data has been successfully erased, providing a clear status update + boolean erasedInd?; }; -# Represents a detailed record of a note, capturing contextual comments, priority, and administrative metadata, aiding in communication and documentation processes. +# Represents a detailed record of a note, capturing contextual comments, priority, and administrative metadata, aiding in communication and documentation processes public type Note record { - # The date when the note was initially added to the system, providing a temporal context for the information. + # A reference identifier linking the note to related records or entities, enhancing data connectivity and retrieval + string ref?; + # Additional comments associated with the note, offering further clarification, instructions, or context + string comments?; + # The date when the note was initially added to the system, providing a temporal context for the information string addDt?; - # The precise time of day when the note was added, complementing the date for accurate chronological tracking. - string addTm?; - # The identifier of the user who created the note, linking the note to its author for reference or follow-up. + # A code indicating the note's priority, such as 'High', 'Medium', or 'Low', affecting its visibility and urgency + string priorityCd?; + # The identifier of the user who created the note, linking the note to its author for reference or follow-up string addUser?; - # Additional comments associated with the note, offering further clarification, instructions, or context. - string comments?; - # A brief description or summary of the note's content, providing an at-a-glance understanding of its purpose or subject matter. + # A boolean indicator specifying whether the note is marked as 'sticky' or particularly important, ensuring prominence in listings or displays + boolean stickyInd?; + # A brief description or summary of the note's content, providing an at-a-glance understanding of its purpose or subject matter string description?; - # A detailed memorandum contained within the note, elaborating on the topic, decision-making process, or action items. + # A detailed memorandum contained within the note, elaborating on the topic, decision-making process, or action items string memo?; - # A code indicating the note's priority, such as 'High', 'Medium', or 'Low', affecting its visibility and urgency. - string priorityCd?; - # A reference identifier linking the note to related records or entities, enhancing data connectivity and retrieval. - string ref?; - # The current status of the note, such as 'Active', 'Completed', or 'Cancelled', reflecting its relevance and actionability. - string status?; - # A boolean indicator specifying whether the note is marked as 'sticky' or particularly important, ensuring prominence in listings or displays. - boolean stickyInd?; - # An identifier for a note template that was used as a basis for this note, standardizing the format and content for specific types of annotations. + # An identifier for a note template that was used as a basis for this note, standardizing the format and content for specific types of annotations string templateId?; + # The precise time of day when the note was added, complementing the date for accurate chronological tracking + string addTm?; + # The current status of the note, such as 'Active', 'Completed', or 'Cancelled', reflecting its relevance and actionability + string status?; }; -# Encapsulates a response structure for API calls that return multiple documents, facilitating easy access to and manipulation of a collection of documents within the system. +# Encapsulates a response structure for API calls that return multiple documents, facilitating easy access to and manipulation of a collection of documents within the system public type ListDocument record { - # An array of Document objects, each representing detailed information about a specific document within the system. + # An array of Document objects, each representing detailed information about a specific document within the system Document[] documentListItems?; }; -# Contains detailed information about a single country, including its ISO code and the full country name. This schema is crucial for ensuring accurate country representation and selection across the application. +# Contains detailed information about a single country, including its ISO code and the full country name. This schema is crucial for ensuring accurate country representation and selection across the application public type Country record { - # The ISO 3166-1 alpha-2 code of the country, providing a two-letter code that is universally recognized for representing country names. - string isoCd?; - # The official name of the country as recognized internationally. This name is used for display purposes and in user interfaces. + # The official name of the country as recognized internationally. This name is used for display purposes and in user interfaces string name?; + # The ISO 3166-1 alpha-2 code of the country, providing a two-letter code that is universally recognized for representing country names + string isoCd?; }; -# Provides an in-depth view of a note, including its content, priority, and associated metadata, facilitating detailed documentation and tracking within the system. +# Provides an in-depth view of a note, including its content, priority, and associated metadata, facilitating detailed documentation and tracking within the system public type NoteDetail record { - # A brief overview or summary of the note's content, providing insight into its purpose and significance. - string description?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. EraseInfo eraseInfo?; - # A unique identifier assigned to the note, enabling distinct tracking and retrieval within the system. + # A code indicating the note's priority level, such as 'High', 'Medium', or 'Low', guiding attention and response urgency + string priorityCd?; + # Specifies whether the note is marked as 'sticky' or important, warranting prominent display or special attention + boolean stickyInd?; + # A brief overview or summary of the note's content, providing insight into its purpose and significance + string description?; + # An extended memo or detailed commentary associated with the note, providing additional context, explanations, or action items + string memo?; + # A unique identifier assigned to the note, enabling distinct tracking and retrieval within the system string id?; - # A collection of references linking the note to other related records or documents, enhancing contextual understanding and data integration. + # A collection of references linking the note to other related records or documents, enhancing contextual understanding and data integration LinkReference[] linkReferences?; - # An extended memo or detailed commentary associated with the note, providing additional context, explanations, or action items. - string memo?; - # A code indicating the note's priority level, such as 'High', 'Medium', or 'Low', guiding attention and response urgency. - string priorityCd?; - # Details regarding the conditions and policies for purging the note from the system, ensuring data management compliance. + # Details regarding the conditions and policies for purging the note from the system, ensuring data management compliance record {} purgeInfo?; - # Indicates whether the note should be visible across all producer containers, ensuring broad visibility when necessary. + # Identifier for the template used in creating the note, standardizing format and content for specific types of notes + string templateId?; + # Indicates whether the note should be visible across all producer containers, ensuring broad visibility when necessary boolean showOnAllProducerContainersInd?; - # Specifies whether the note is marked as 'sticky' or important, warranting prominent display or special attention. - boolean stickyInd?; - # A set of tags categorizing or highlighting aspects of the note, facilitating organization and thematic grouping. + # A set of tags categorizing or highlighting aspects of the note, facilitating organization and thematic grouping Tag[] tags?; - # Identifier for the template used in creating the note, standardizing format and content for specific types of notes. - string templateId?; }; -# Provides a paginated structure for listing policies, facilitating the retrieval of policy information in a segmented manner. This schema supports operations that require the listing of multiple policies, including search results and batch processing views. +# Provides a paginated structure for listing policies, facilitating the retrieval of policy information in a segmented manner. This schema supports operations that require the listing of multiple policies, including search results and batch processing views public type ListPolicy record { # If more results are available, the ContinuationId should be the row index of the next row string continuationId?; - # An array of policy items, each containing detailed information about individual policies. + # An array of policy items, each containing detailed information about individual policies Policy[] policyListItems?; }; -# Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system. +# Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system public type CustomerInfo record { - # A unique identifier or number assigned to the customer, serving as a primary reference for account management, policy administration, and customer service activities. - string customerNumber?; - # A reference string or identifier that links the customer to external systems, records, or databases, enhancing interoperability and data cohesion. + # A reference string or identifier that links the customer to external systems, records, or databases, enhancing interoperability and data cohesion string customerRef?; - # The system-generated unique identifier for the customer's record, ensuring the ability to uniquely identify, track, and manage customer information within the system. - string id?; - # The full name of the customer as registered or recognized within the system, facilitating personalization, correspondence, and customer engagement. + # The full name of the customer as registered or recognized within the system, facilitating personalization, correspondence, and customer engagement string name?; + # The system-generated unique identifier for the customer's record, ensuring the ability to uniquely identify, track, and manage customer information within the system + string id?; + # A unique identifier or number assigned to the customer, serving as a primary reference for account management, policy administration, and customer service activities + string customerNumber?; }; -# Detailed representation of an insurance application, including its status, ownership, associated customer and product information, and permissions regarding user actions. +# Detailed representation of an insurance application, including its status, ownership, associated customer and product information, and permissions regarding user actions public type Application record { - # Hypermedia links related to the application, facilitating navigation to related resources and actions such as editing or inquiry. - Link[] _links?; - # Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes. ApplicationMini applicationMini?; - # Indicates whether the current user has permissions to edit the application, reflecting access control based on user roles and application status. - boolean canEdit?; - # Indicates whether the current user is permitted to make inquiries regarding the application, typically used for customer service and support roles. + # A unique reference identifier for the application, used within the system for tracking, management, and retrieval purposes + string ref?; + # Hypermedia links related to the application, facilitating navigation to related resources and actions such as editing or inquiry + @jsondata:Name {value: "_links"} + Link[] links?; + # Indicates whether the current user is permitted to make inquiries regarding the application, typically used for customer service and support roles boolean canInquiry?; - # Identifies the current owner or responsible party for the application, which may be an individual agent or a team within the insurance organization. + # Indicates whether the current user has permissions to edit the application, reflecting access control based on user roles and application status + boolean canEdit?; + # Identifies the current owner or responsible party for the application, which may be an individual agent or a team within the insurance organization string currentOwner?; - # Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system. CustomerInfo customerInfo?; - # Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization. ProductInfo productInfo?; - # A unique reference identifier for the application, used within the system for tracking, management, and retrieval purposes. - string ref?; }; -# Represents a hypermedia link, providing navigational capabilities between related resources within the API, akin to links in web pages. +# Represents a hypermedia link, providing navigational capabilities between related resources within the API, akin to links in web pages public type Link record { - # The absolute or relative URL pointing to the linked resource, which can be used to directly access or query the target resource. - string href?; - # A descriptor that indicates the relationship of the linked resource to the current context, such as 'self', 'next', or specific action-related terms. + # A descriptor that indicates the relationship of the linked resource to the current context, such as 'self', 'next', or specific action-related terms string rel?; + # The absolute or relative URL pointing to the linked resource, which can be used to directly access or query the target resource + string href?; }; -# Encapsulates a reference to a specific attribute within the system, linking issues or other entities to detailed attribute information for clarity and context. +# Encapsulates a reference to a specific attribute within the system, linking issues or other entities to detailed attribute information for clarity and context public type AttributeRef record { - # The unique identifier of the attribute to which this reference points, establishing a direct link for data retrieval and analysis. + # The unique identifier of the attribute to which this reference points, establishing a direct link for data retrieval and analysis string attributeId?; - # A unique identifier for the attribute reference itself, ensuring the ability to track and manage these references independently within the system. + # A unique identifier for the attribute reference itself, ensuring the ability to track and manage these references independently within the system string id?; }; -# Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions. +# Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions public type ApplicationInfo record { - # The date when the application was initially added to the system, marking the start of its lifecycle. - string addDt?; - # The precise time of day when the application was added to the system, complementing the add date for accurate tracking. - string addTm?; - # The identifier (e.g., username) of the user who added the application, providing an audit trail for creation actions. + # The identifier (e.g., username) of the user who added the application, providing an audit trail for creation actions string addUser?; - # Any comments or notes regarding the reasons or circumstances surrounding the application's closure. - string closeComment?; - # The date when the application was officially closed, terminating its active processing or consideration within the system. + # Indicates if the application is currently on hold, pending release for further processing or decision-making + boolean pendForReleaseInd?; + # The date when the application was officially closed, terminating its active processing or consideration within the system string closeDt?; - # A code that categorizes the reason for the application's closure, such as 'withdrawn' or 'issued'. - string closeReasonCd?; - # A more specific code that provides additional detail on the reason for application closure, used for finer categorization. + # A more specific code that provides additional detail on the reason for application closure, used for finer categorization string closeSubReasonCd?; - # The textual description corresponding to the close sub-reason code, offering human-readable insight into the closure reason. - string closeSubReasonLabel?; - # The exact time of day when the application was closed, providing precise timing alongside the closure date. - string closeTm?; - # The identifier of the user who performed the closure action, contributing to the audit trail. + # For renewal applications, this field links to the transaction number of the previous application or policy being renewed + int renewalApplyOfTransactionNumber?; + # A reference to the master quote associated with this application, linking application data to quoting details + string masterQuoteRef?; + # The date when the application was initially added to the system, marking the start of its lifecycle + string addDt?; + # A code that categorizes the reason for the application's closure, such as 'withdrawn' or 'issued' + string closeReasonCd?; + # A unique identifier for the application information record, ensuring distinct and retrievable records within the system + string id?; + # The identifier of the user who performed the closure action, contributing to the audit trail string closeUser?; - # If the application was corrected by a subsequent transaction, this is the number of that correcting transaction. + # Flags whether the application is marked for renewal, indicating an ongoing relationship or coverage continuation + boolean renewalApplyInd?; + # The most recent date on which the application or related documents were mailed out, indicating the latest communication attempt + string lastMailedDt?; + # For applications that are reinstatements, this is the original transaction number of the application that is being reinstated + int reinstatementOfTransactionNumber?; + # The textual description corresponding to the close sub-reason code, offering human-readable insight into the closure reason + string closeSubReasonLabel?; + # If the application was corrected by a subsequent transaction, this is the number of that correcting transaction int correctedByTransactionNumber?; - # If this application serves as a correction, this is the original transaction number that it corrects. - int correctionOfTransactionNumber?; - # The date when the application or associated documents were first mailed to the customer or relevant party. - string firstMailedDt?; - # A unique identifier for the application information record, ensuring distinct and retrievable records within the system. - string id?; - # A description or identifier for the particular iteration or version of the application, useful in tracking changes over time. + # The identifier of the user who made the most recent update to the application, part of the comprehensive audit trail + string updateUser?; + # A description or identifier for the particular iteration or version of the application, useful in tracking changes over time string iterationDescription?; - # The most recent date on which the application or related documents were mailed out, indicating the latest communication attempt. - string lastMailedDt?; - # A reference to the master quote associated with this application, linking application data to quoting details. - string masterQuoteRef?; - # The date by which the application processing needs to be completed, often tied to coverage start dates or customer requirements. - string needByDt?; - # Indicates if the application is currently on hold, pending release for further processing or decision-making. - boolean pendForReleaseInd?; - # Identifies the transaction number that led to the reinstatement of this application, if it was previously closed or withdrawn. + # If this application serves as a correction, this is the original transaction number that it corrects + int correctionOfTransactionNumber?; + # Identifies the transaction number that led to the reinstatement of this application, if it was previously closed or withdrawn int reinstatedByTransactionNumber?; - # For applications that are reinstatements, this is the original transaction number of the application that is being reinstated. - int reinstatementOfTransactionNumber?; - # Flags whether the application is marked for renewal, indicating an ongoing relationship or coverage continuation. - boolean renewalApplyInd?; - # For renewal applications, this field links to the transaction number of the previous application or policy being renewed. - int renewalApplyOfTransactionNumber?; - # The date when the application was formally submitted for review or processing, moving it forward in the underwriting or issuance pipeline. - string submittedDt?; - # The date of the last update made to the application, reflecting the most recent changes or progress. + # The date by which the application processing needs to be completed, often tied to coverage start dates or customer requirements + string needByDt?; + # The date of the last update made to the application, reflecting the most recent changes or progress string updateDt?; - # The time at which the last update to the application was made, providing time-specific tracking of modifications. + # The exact time of day when the application was closed, providing precise timing alongside the closure date + string closeTm?; + # The time at which the last update to the application was made, providing time-specific tracking of modifications string updateTm?; - # The identifier of the user who made the most recent update to the application, part of the comprehensive audit trail. - string updateUser?; + # The date when the application or associated documents were first mailed to the customer or relevant party + string firstMailedDt?; + # The date when the application was formally submitted for review or processing, moving it forward in the underwriting or issuance pipeline + string submittedDt?; + # Any comments or notes regarding the reasons or circumstances surrounding the application's closure + string closeComment?; + # The precise time of day when the application was added to the system, complementing the add date for accurate tracking + string addTm?; +}; + +# Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format +public type QuestionReplies record { + # Metadata or identifier indicating the source or context of the questions, such as a specific underwriting guideline or claim process step + string questionSourceMDA?; + # A unique identifier for the collection of question and replies, facilitating organization and retrieval + string id?; + # An array of responses to specific questions, each containing the question's details and the provided reply, structured according to the QuestionReply schema + QuestionReply[] questionReply?; }; -# Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies. +# Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies public type Driver record { - # A collection of hypermedia links related to the driver, providing quick access to related resources and actions such as fetching detailed information or initiating workflows. - Link[] _links?; - # A versioning identifier used to manage concurrent updates to the driver resource, ensuring data integrity through optimistic locking mechanisms. - string _revision?; - # An array of Address objects that detail the driver's associated addresses, including home, mailing, and potentially other types of addresses. + # An array of Address objects that detail the driver's associated addresses, including home, mailing, and potentially other types of addresses Address[] addresses?; - # Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed. - DriverPersonalInfo driverInfo?; - # Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes. - EmailInfo emailInfo?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. + # A versioning identifier used to manage concurrent updates to the driver resource, ensuring data integrity through optimistic locking mechanisms + @jsondata:Name {value: "_revision"} + string revision?; + # A collection of hypermedia links related to the driver, providing quick access to related resources and actions such as fetching detailed information or initiating workflows + @jsondata:Name {value: "_links"} + Link[] links?; EraseInfo eraseInfo?; - # A code indicating the anticipated future status of the driver with respect to the policy, such as pending renewal or cancellation. - string futureStatusCd?; - # A unique identifier for the driver, used to reference and manage driver information within the system. - string id?; - # A list of issues or points of concern related to the driver, such as incidents or violations, that may affect insurance considerations. - Issue[] issues?; - # A reference to the geographical location or area associated with the driver, potentially relevant for policies with geographical considerations such as Personal Umbrella policies. - string locationIdRef?; - # Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions. NameInfo nameInfo?; - # A categorization field that identifies the nature of the party's relationship to the policy or entity, with 'ContactParty' denoting direct contact or relation. - string partyTypeCd?; - # Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services. + # A categorization field that identifies the nature of the party's relationship to the policy or entity, with 'ContactParty' denoting direct contact or relation + string partyTypeCd = "ContactParty"; + # A list of issues or points of concern related to the driver, such as incidents or violations, that may affect insurance considerations + Issue[] issues?; PersonInfo personInfo?; - # An array detailing the phone contact information associated with the driver, facilitating various forms of communication. + # A reference to the geographical location or area associated with the driver, potentially relevant for policies with geographical considerations such as Personal Umbrella policies + string locationIdRef?; + DriverPersonalInfo driverInfo?; + # Represents the number of years the driver has been associated with the insurance provider or specific policy, possibly impacting considerations such as loyalty discounts or risk assessments + int yearsOfService?; + EmailInfo emailInfo?; + # An array detailing the phone contact information associated with the driver, facilitating various forms of communication PhoneInfo[] phoneInfo?; - # Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format. + # A code indicating the anticipated future status of the driver with respect to the policy, such as pending renewal or cancellation + string futureStatusCd?; + # A unique identifier for the driver, used to reference and manage driver information within the system + string id?; QuestionReplies questionReplies?; - # Current status of the driver, indicating their active involvement or any flags such as 'Deleted' for removed records. - string status?; - # References detailed party information, linking the driver to additional contextual data or policy-related entities. - string underLyingPartyInfoIdRef?; - # A reference to the specific insurance policy ID that this driver is associated with, highlighting the connection to policy structures and coverages. + # A reference to the specific insurance policy ID that this driver is associated with, highlighting the connection to policy structures and coverages string underLyingPolicyIdRef?; - # Represents the number of years the driver has been associated with the insurance provider or specific policy, possibly impacting considerations such as loyalty discounts or risk assessments. - int yearsOfService?; -}; - -# Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format. -public type QuestionReplies record { - # A unique identifier for the collection of question and replies, facilitating organization and retrieval. - string id?; - # An array of responses to specific questions, each containing the question's details and the provided reply, structured according to the QuestionReply schema. - QuestionReply[] questionReply?; - # Metadata or identifier indicating the source or context of the questions, such as a specific underwriting guideline or claim process step. - string questionSourceMDA?; + # References detailed party information, linking the driver to additional contextual data or policy-related entities + string underLyingPartyInfoIdRef?; + # Current status of the driver, indicating their active involvement or any flags such as 'Deleted' for removed records + string status?; }; -# A structured response payload containing an array of addresses. This schema facilitates the return of multiple address records in a single API response, typically used in search or list endpoints where multiple addresses need to be communicated. +# A structured response payload containing an array of addresses. This schema facilitates the return of multiple address records in a single API response, typically used in search or list endpoints where multiple addresses need to be communicated public type ListAddress record { - # An array of Address objects, each representing detailed information about a specific address. The structure of each Address object is defined by the Address schema. + # An array of Address objects, each representing detailed information about a specific address. The structure of each Address object is defined by the Address schema Address[] addresses?; }; -# Defines the structure for transaction text within the system, including its ID, textual content, associated code, and transaction text type. +# Defines the structure for transaction text within the system, including its ID, textual content, associated code, and transaction text type public type TransactionText record { - # Unique identifier for the transaction text. + # Code indicating the type of transaction text + string transactionTextTypeCd?; + # Code associated with the text + string textCd?; + # Unique identifier for the transaction text string id?; - # Text associated with the transaction. + # Text associated with the transaction string text?; - # Code associated with the text. - string textCd?; - # Code indicating the type of transaction text. - string transactionTextTypeCd?; }; -# Defines the attributes of a state or province, providing key identifiers and names for use in addressing and location services within the insurance application. +# Defines the attributes of a state or province, providing key identifiers and names for use in addressing and location services within the insurance application public type StateProvinces record { - # The unique identifier or code for the state or province, often used as a standard abbreviation or code in address formats. + # The unique identifier or code for the state or province, often used as a standard abbreviation or code in address formats string id?; - # The full name of the state or province, providing a clear and unambiguous reference for users and systems interacting with address information. + # The full name of the state or province, providing a clear and unambiguous reference for users and systems interacting with address information string stateProvName?; }; -# Encapsulates a reference to a linked resource within the system, providing context and navigational properties to enhance connectivity between different entities or data models. +# Encapsulates a reference to a linked resource within the system, providing context and navigational properties to enhance connectivity between different entities or data models public type LinkReference record { - # Descriptive text for the link, typically generated based on templates, that explains the nature or purpose of the link in user-readable terms. + # The name of the model or entity type that is being linked to, providing clarity on the kind of resource the link references + string modelName?; + # The system-wide unique database identifier for the target item of this link reference, used in scenarios where objects from different containers or databases are interconnected + string systemIdRef?; + # Descriptive text for the link, typically generated based on templates, that explains the nature or purpose of the link in user-readable terms string description?; - # A unique identifier for the link reference, facilitating tracking and management of links within the application. + # A unique identifier for the link reference, facilitating tracking and management of links within the application string id?; - # The reference ID of the target model to which this link points, establishing a clear connection between the link and its associated entity. + # The reference ID of the target model to which this link points, establishing a clear connection between the link and its associated entity string idRef?; - # The name of the model or entity type that is being linked to, providing clarity on the kind of resource the link references. - string modelName?; - # Indicates the current status of the link, such as 'Active' or 'Deleted', reflecting the link's operational state within the system. + # Indicates the current status of the link, such as 'Active' or 'Deleted', reflecting the link's operational state within the system string status?; - # The system-wide unique database identifier for the target item of this link reference, used in scenarios where objects from different containers or databases are interconnected. - string systemIdRef?; }; -# Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others. +# Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others public type TransactionInfo record { - # Transaction number of a previous transaction that this transaction cancels or nullifies. + # The amount of payment made or processed in this transaction, relevant for transactions involving financial exchanges + string paymentAmt?; + # A brief summary of the transaction, useful for quick reference and overview in listings or summaries + string transactionShortDescription?; + # The effective date of the transaction, indicating when the changes or actions associated with the transaction take effect + string transactionEffectiveDt?; + # The expiration date of the policy resulting from this transaction, indicating the end of the current policy term + string newPolicyExpirationDt?; + # Code that identifies the source of the transaction, such as an online portal, agent submission, or system-generated adjustment + string sourceCd?; + # The effective date of the policy resulting from this transaction, marking the start of the new or adjusted policy term + string newPolicyEffectiveDt?; + # Transaction number of a renewal application associated with this transaction, indicating continuity in the policy lifecycle + int renewalApplyOfTransactionNumber?; + # Transaction number of a previous transaction that this transaction cancels or nullifies int cancelOfTransactionNumber?; - # Code identifying who requested the cancellation, providing insight into the source of the transaction. - string cancelRequestedByCd?; - # Code categorizing the type of cancellation, aiding in the processing and reporting of cancellations. + # A list of output suppression settings to be reapplied as a result of this transaction, affecting document generation and communication preferences + ReapplyOutputSuppression[] reapplyOutputSuppressions?; + # The precise time at which the transaction becomes effective, providing additional specificity beyond the effective date + string transactionEffectiveTm?; + # The reason provided for releasing any holds associated with this transaction, facilitating administrative processing and documentation + string releaseHoldReason?; + # Code categorizing the type of cancellation, aiding in the processing and reporting of cancellations string cancelTypeCd?; - # Transaction number of a subsequent transaction that cancels this one, indicating a linkage between transactions within the policy history. - int cancelledByTransactionNumber?; - # Indicator of whether a reinstatement fee is charged for this transaction, typically associated with policy reinstatements. + # Specifies the type of hold placed on a transaction, impacting how the transaction is processed and when it becomes effective + string holdType?; + # A unique identifier for the transaction information record, ensuring distinct management and tracking within the system + string id?; + # Code identifying the sub-producer or agent responsible for the renewal, part of the distribution and sales tracking + string renewalSubProducerCd?; + # Indicator of whether a reinstatement fee is charged for this transaction, typically associated with policy reinstatements boolean chargeReinstatementFeeInd?; - # The number of the check used for payment in this transaction, applicable for transactions involving check payments. + # For workers' compensation policies, a code that indicates the conditions or reasons for reinstatement following cancellation or lapse + string wcReinstatementCd?; + # The number of the check used for payment in this transaction, applicable for transactions involving check payments string checkNumber?; - # Transaction number of a subsequent transaction that corrects this one, facilitating tracking of corrections through transaction chains. + # Transaction number of a previous transaction that this one reinstates, creating a connection within the reinstatement process + int reinstatementOfTransactionNumber?; + # Transaction number of a subsequent transaction that corrects this one, facilitating tracking of corrections through transaction chains int correctedByTransactionNumber?; - # Transaction number of a previous transaction that this one corrects, establishing a correction relationship within the transaction history. - int correctionOfTransactionNumber?; - # Indicator that the generation of an invoice for this transaction should be delayed, according to specific processing rules or conditions. - boolean delayInvoiceInd?; - # Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods. - ElectronicPaymentSource electronicPaymentSource?; - # Specifies the type of hold placed on a transaction, impacting how the transaction is processed and when it becomes effective. - string holdType?; - # A unique identifier for the transaction information record, ensuring distinct management and tracking within the system. - string id?; - # The effective date of the policy resulting from this transaction, marking the start of the new or adjusted policy term. - string newPolicyEffectiveDt?; - # The expiration date of the policy resulting from this transaction, indicating the end of the current policy term. - string newPolicyExpirationDt?; - # Code that identifies the type of output or document generation triggered by this transaction, such as policy declarations or billing statements. + # A system-assigned sequential number for the transaction, serving as a unique identifier within the policy's transaction history + int transactionNumber?; + # A code categorizing the transaction type, facilitating processing, reporting, and historical tracking of policy transactions + string transactionCd?; + # Indicates whether the audit requirement at cancellation has been waived for a workers' compensation policy, affecting end-of-term processing + boolean wcWaiveCancellationAuditInd?; + # Code that identifies the type of output or document generation triggered by this transaction, such as policy declarations or billing statements string outputTypeCd?; - # The amount of payment made or processed in this transaction, relevant for transactions involving financial exchanges. - string paymentAmt?; - # Code that classifies the type of payment made, such as premium payment, reinstatement fee, or other transaction-related payment. + # Code that classifies the type of payment made, such as premium payment, reinstatement fee, or other transaction-related payment string paymentTypeCd?; - # A list of output suppression settings to be reapplied as a result of this transaction, affecting document generation and communication preferences. - ReapplyOutputSuppression[] reapplyOutputSuppressions?; - # Transaction number of a subsequent transaction that reinstates this one, linking transactions within the context of policy reinstatements. - int reinstatedByTransactionNumber?; - # Transaction number of a previous transaction that this one reinstates, creating a connection within the reinstatement process. - int reinstatementOfTransactionNumber?; - # The reason provided for releasing any holds associated with this transaction, facilitating administrative processing and documentation. - string releaseHoldReason?; - # Transaction number of a renewal application associated with this transaction, indicating continuity in the policy lifecycle. - int renewalApplyOfTransactionNumber?; - # Reference identifier for the renewal provider or system associated with this transaction, linking to external systems managing renewals. + # Reference identifier for the renewal provider or system associated with this transaction, linking to external systems managing renewals string renewalProviderRef?; - # Code identifying the sub-producer or agent responsible for the renewal, part of the distribution and sales tracking. - string renewalSubProducerCd?; - # Specifies the product version to which the policy is being rewritten as a result of this transaction, indicating product updates or changes. - string rewriteToProductVersion?; - # Code that identifies the source of the transaction, such as an online portal, agent submission, or system-generated adjustment. - string sourceCd?; - # A code categorizing the transaction type, facilitating processing, reporting, and historical tracking of policy transactions. - string transactionCd?; - # The effective date of the transaction, indicating when the changes or actions associated with the transaction take effect. - string transactionEffectiveDt?; - # The precise time at which the transaction becomes effective, providing additional specificity beyond the effective date. - string transactionEffectiveTm?; - # A detailed description of the transaction, offering insights into its purpose, scope, and impact on the policy or customer. + # Transaction number of a previous transaction that this one corrects, establishing a correction relationship within the transaction history + int correctionOfTransactionNumber?; + # Transaction number of a subsequent transaction that reinstates this one, linking transactions within the context of policy reinstatements + int reinstatedByTransactionNumber?; + # A detailed description of the transaction, offering insights into its purpose, scope, and impact on the policy or customer string transactionLongDescription?; - # A system-assigned sequential number for the transaction, serving as a unique identifier within the policy's transaction history. - int transactionNumber?; - # A brief summary of the transaction, useful for quick reference and overview in listings or summaries. - string transactionShortDescription?; - # For workers' compensation policies, a code that indicates the conditions or reasons for reinstatement following cancellation or lapse. - string wcReinstatementCd?; - # In workers' compensation policies, the total premium amount for manually rated locations, reflecting specific risk assessments. + ElectronicPaymentSource electronicPaymentSource?; + # Code identifying who requested the cancellation, providing insight into the source of the transaction + string cancelRequestedByCd?; + # In workers' compensation policies, the total premium amount for manually rated locations, reflecting specific risk assessments string wcTotalNetLocationsManualPremiumAmt?; - # Indicates whether the audit requirement at cancellation has been waived for a workers' compensation policy, affecting end-of-term processing. - boolean wcWaiveCancellationAuditInd?; + # Specifies the product version to which the policy is being rewritten as a result of this transaction, indicating product updates or changes + string rewriteToProductVersion?; + # Transaction number of a subsequent transaction that cancels this one, indicating a linkage between transactions within the policy history + int cancelledByTransactionNumber?; + # Indicator that the generation of an invoice for this transaction should be delayed, according to specific processing rules or conditions + boolean delayInvoiceInd?; }; -# Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification. +# Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification public type ESignatureInfo record { - # A code that identifies the type of electronic signature process or technology used, such as digital signatures or clickwrap agreements. + # Describes the method by which the electronic signature is captured or verified, providing details on the procedural aspects of the signing process + string signingType?; + # A code that identifies the type of electronic signature process or technology used, such as digital signatures or clickwrap agreements string eSignatureTypeCd?; - # A unique identifier for the electronic signature information record, enabling distinct management and tracking within the system. - string id?; - # A code categorizing the recipient of the document requiring an electronic signature, such as 'Insured', 'Agent', or 'Third Party'. + # A code categorizing the recipient of the document requiring an electronic signature, such as 'Insured', 'Agent', or 'Third Party' string recipientCd?; - # Describes the method by which the electronic signature is captured or verified, providing details on the procedural aspects of the signing process. - string signingType?; + # A unique identifier for the electronic signature information record, enabling distinct management and tracking within the system + string id?; }; -# Encapsulates a paginated response structure that contains a list of drivers, including relevant metadata to handle continuation of listing if more drivers exist beyond the current response set. +# Encapsulates a paginated response structure that contains a list of drivers, including relevant metadata to handle continuation of listing if more drivers exist beyond the current response set public type ListDriver record { - # A unique identifier that can be used to request subsequent pages of drivers. This value represents the row index from which the next set of results should start, facilitating pagination in client applications. + # A unique identifier that can be used to request subsequent pages of drivers. This value represents the row index from which the next set of results should start, facilitating pagination in client applications string continuationId?; - # Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies. Driver drivers?; }; -# Encapsulates a response that includes a list of notes associated with a specific entity, such as a policy or claim, providing a structured overview of textual annotations or reminders. +# Encapsulates a response that includes a list of notes associated with a specific entity, such as a policy or claim, providing a structured overview of textual annotations or reminders public type ListNote record { - # An array of Note objects, each representing an individual note with details such as content, priority, and status. + # An array of Note objects, each representing an individual note with details such as content, priority, and status Note[] noteListItems?; }; -# Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan. +# Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan public type BasicPolicy record { - # The code representing the affinity group associated with the policy, which may qualify the policyholder for certain benefits or discounts. - string affinityGroupCd?; - # Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information. - AuditPayPlan auditPayPlan?; - # Indicator of whether data prefilling is enabled for automatic data capture and form completion. - boolean autoDataPrefillInd?; - # The branch or division of the insurance provider issuing the policy. - string branch?; - # The code indicating the source of business, such as direct, broker, or agent. + # The effective date of the policy, indicating when coverage begins + string effectiveDt?; + # The code identifying the payment plan associated with the policy, dictating the schedule and method of premium payments + string payPlanCd?; + # The code indicating the source of business, such as direct, broker, or agent string businessSourceCd?; - # Indicator of whether commercial auto line coverage is selected in the policy. - boolean cALineSelectedInd?; - # The type of commercial auto policy, detailing specific coverage options selected. - string cAPolicyType?; - # Indicator of whether commercial property coverage is selected. - boolean cCLineSelectedInd?; - # The type of commercial property policy, detailing the specific coverage options selected. - string cCPolicyType?; - # Subline code for commercial coverage, providing additional detail on the specific nature of the coverage. - string cCSubline?; - # Indicator of whether general liability coverage is selected. - boolean cGLineSelectedInd?; - # Indicator of whether commercial inland marine coverage is selected. - boolean cILineSelectedInd?; - # Indicator of whether commercial lines coverage is selected, encompassing a range of commercial policies. - boolean cLLineSelectedInd?; - # Indicator of whether commercial package policy coverage is selected. - boolean cPLineSelectedInd?; - # The type of commercial package policy, detailing the specific coverage options selected. - string cPPolicyType?; - # The code representing the insurance carrier providing the policy. - string carrierCd?; - # The code representing the group of insurance carriers, if applicable, under which the policy is issued. - string carrierGroupCd?; - # Indicator of whether a commercial CLUE (Comprehensive Loss Underwriting Exchange) report has been requested for underwriting purposes. - boolean commCLUERequestInd?; - # Free-form comments or notes associated with the policy. - string comments?; - # The product code of the company, identifying the specific insurance product offered. - string companyProductCd?; - # The code of the state that has jurisdiction over the policy, particularly important for multi-state operations. + # The branch or division of the insurance provider issuing the policy + string branch?; + # Indicator of whether employment practices liability coverage is selected + boolean employmentAndPracticeLineSelectedInd?; + # The code representing the term for the policy renewal, dictating the duration and conditions for the renewed coverage period + string renewalTermCd?; + # The code of the state that has jurisdiction over the policy, particularly important for multi-state operations string controllingStateCd?; - # Indicator of whether dwelling property coverage is selected. - boolean dPLineSelectedInd?; - # A brief description of the policy, summarizing the key coverage and policy details. - string description?; - # Indicator of whether Directors and Officers (D&O) liability coverage is selected. - boolean directorsAndOfficersLineSelectedInd?; - # A description of the policy designed for display purposes, often used in customer-facing documents. - string displayDescription?; - # The effective date of the policy, indicating when coverage begins. - string effectiveDt?; - # The effective time of the policy, providing precise coverage start time. + # A reference to the version ID of the insurance product, ensuring that the policy aligns with the correct product specifications and terms + string productVersionIdRef?; + # The effective time of the policy, providing precise coverage start time string effectiveTm?; - # Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods. - ElectronicPaymentSource electronicPaymentSource?; - # Indicator of whether employment practices liability coverage is selected. - boolean employmentAndPracticeLineSelectedInd?; - # Indicator of whether Errors and Omissions (E&O) coverage is selected. + # Indicator of whether Errors and Omissions (E&O) coverage is selected boolean errorsAndOmissionLineSelectedInd?; - # The expiration date of the policy, indicating when coverage ends. - string expirationDt?; - # Indicator of whether the policy includes extended coverage beyond standard terms. - boolean extendedCoverageInd?; - # An external identifier for the policy, used for integration with external systems or databases. - string externalId?; - # Indicator of whether the policy includes coverage for fire and lightning damage. - boolean fireLightningInd?; - # Indicator of whether general liability coverage is selected. + # The code identifying the sub-producer or agent responsible for the policy, part of the distribution and sales network + string subProducerCd?; + # Specifies the day of the month on which recurring payments are due for the policy + string paymentDay?; + # A URL or identifier linking to the session or transaction where the policy was created or modified, for audit and tracking purposes + string sessionLink?; + # A legacy sub-type code for the policy, maintained for historical or compatibility purposes + string oldSubTypeCd?; + # Indicator of whether the policy includes coverage for vandalism and malicious mischief, protecting against specific types of property damage + boolean vandalismMaliciousMischiefInd?; + # Indicator of whether data prefilling is enabled for automatic data capture and form completion + boolean autoDataPrefillInd?; + # Indicator of whether general liability coverage is selected boolean gLLineSelectedInd?; - # The unique identifier for the policy within the system. + # The unique identifier for the policy within the system string id?; - # The inception date of the policy, marking the beginning of coverage, distinct from the effective date in some cases. - string inceptionDt?; - # The inception time of the policy, providing precise start time of coverage. - string inceptionTm?; - # A policy number from a legacy system, maintained for historical or cross-reference purposes. - string legacyPolicyNumber?; - # The date on which the covered property was transferred to an LLC, if applicable. - string llcOwnedDt?; - # The type of loss settlement provided by the policy, such as actual cash value or replacement cost. - string lossSettlementType?; - # Indicator of whether the billing for the policy is manually split among multiple entities. - boolean manualBillingEntitySplitInd?; - # Indicator of whether the policy has been manually reinstated after cancellation or lapse. - boolean manualReinstateInd?; - # The reason for manually reinstating the policy, providing context for the action. - string manualReinstateReason?; - # Indicator of whether the policy is manually renewed, as opposed to automatically renewed. - boolean manualRenewalInd?; - # The reason for manually renewing the policy, providing context for the renewal decision. - string manualRenewalReason?; - # Indicator of whether the policy includes coverage for named non-owned vehicles or properties. - boolean namedNonOwnedInd?; - # A legacy sub-type code for the policy, maintained for historical or compatibility purposes. - string oldSubTypeCd?; - # Indicator of whether personal lines coverage is selected, identifying if the policy includes insurance products designed for individuals and families, such as personal auto, homeowners, or personal umbrella coverage. + # Subline code for commercial coverage, providing additional detail on the specific nature of the coverage + string cCSubline?; + # Indicator of whether personal lines coverage is selected, identifying if the policy includes insurance products designed for individuals and families, such as personal auto, homeowners, or personal umbrella coverage boolean pLLineSelectedInd?; - # The code identifying the payment plan associated with the policy, dictating the schedule and method of premium payments. - string payPlanCd?; - # Specifies the day of the month on which recurring payments are due for the policy. - string paymentDay?; - # Identifies the origin of the policy, such as an online application, agent submission, or broker referral. + # A description of the policy designed for display purposes, often used in customer-facing documents + string displayDescription?; + # The code representing the specific insurance product type, facilitating product management and policy administration + string productTypeCd?; + # The policy number of the policyholder's previous insurance policy, used for reference and transferring information + string previousPolicyNumber?; + # The inception time of the policy, providing precise start time of coverage + string inceptionTm?; + # Identifies the origin of the policy, such as an online application, agent submission, or broker referral string policySource?; - # Defines the type of insurance policy, such as auto, homeowners, commercial, etc., categorizing the policy for administrative and product-specific purposes. - string policyType?; - # The code of the insurance carrier that issued the previous policy, used for history tracking and risk assessment. - string previousCarrierCd?; - # The expiration date of the policyholder's previous insurance policy, important for underwriting and continuity of coverage considerations. + # A reference identifier for the provider managing the renewal of the policy, which may differ from the original issuing provider + string renewalProviderRef?; + # Indicator of whether commercial lines coverage is selected, encompassing a range of commercial policies + boolean cLLineSelectedInd?; + # Indicator of whether Directors and Officers (D&O) liability coverage is selected + boolean directorsAndOfficersLineSelectedInd?; + # The code representing the insurance carrier providing the policy + string carrierCd?; + # The type of commercial property policy, detailing the specific coverage options selected + string cCPolicyType?; + # The code for the type of premium discount table applied to the workers' compensation policy, affecting discounts for larger premium volumes + string wcPremiumDiscountTableTypeCd?; + # Indicator of whether commercial property coverage is selected + boolean cCLineSelectedInd?; + # Detailed information on the previous transactions in this policy + TransactionDetails[] transactionHistory?; + # The type of commercial package policy, detailing the specific coverage options selected + string cPPolicyType?; + # Indicator of whether the policy is manually renewed, as opposed to automatically renewed + boolean manualRenewalInd?; + # The code identifying the insurance program under which the policy is issued, often related to specialized markets or groupings of policies + string programCd?; + # The day on which the workers' compensation policy's rating and premium are reassessed annually, important for policy management and pricing + string wcAnniversaryRatingDay?; + # Indicator of whether the policy includes extended coverage beyond standard terms + boolean extendedCoverageInd?; + # The expiration date of the policyholder's previous insurance policy, important for underwriting and continuity of coverage considerations string previousExpirationDt?; - # The policy number of the policyholder's previous insurance policy, used for reference and transferring information. - string previousPolicyNumber?; - # The premium amount paid for the previous policy period, used for underwriting and pricing analysis. + # The premium amount paid for the previous policy period, used for underwriting and pricing analysis string previousPremium?; - # The code representing the specific insurance product type, facilitating product management and policy administration. - string productTypeCd?; - # A reference to the version ID of the insurance product, ensuring that the policy aligns with the correct product specifications and terms. - string productVersionIdRef?; - # The code identifying the insurance program under which the policy is issued, often related to specialized markets or groupings of policies. - string programCd?; - # The code for any promotional offers or discounts applied to the policy, used for marketing and billing purposes. - string promotionCd?; - # A reference identifier for the provider or originator of the policy, such as an agent, broker, or direct application system. - string providerRef?; - # A reference identifier for the provider managing the renewal of the policy, which may differ from the original issuing provider. - string renewalProviderRef?; - # The code for the sub-producer responsible for the renewal of the policy, part of the distribution channel management. + # Indicator of whether a commercial CLUE (Comprehensive Loss Underwriting Exchange) report has been requested for underwriting purposes + boolean commCLUERequestInd?; + # A brief description of the policy, summarizing the key coverage and policy details + string description?; + # Indicator of whether the workers' compensation Average Rate Differential (ARD) rule is enabled, affecting premium calculations + boolean wcARDRuleEnabled?; + # The code representing the group of insurance carriers, if applicable, under which the policy is issued + string carrierGroupCd?; + UmbrellaPolicyInfo umbrellaPolicyInfo?; + # Indicator of whether commercial auto line coverage is selected in the policy + boolean cALineSelectedInd?; + # Indicator of whether the policy includes coverage for named non-owned vehicles or properties + boolean namedNonOwnedInd?; + # Indicator of whether dwelling property coverage is selected + boolean dPLineSelectedInd?; + # The code of the insurance carrier that issued the previous policy, used for history tracking and risk assessment + string previousCarrierCd?; + # The code for the sub-producer responsible for the renewal of the policy, part of the distribution channel management string renewalSubProducerCd?; - # The code representing the term for the policy renewal, dictating the duration and conditions for the renewed coverage period. - string renewalTermCd?; - # A URL or identifier linking to the session or transaction where the policy was created or modified, for audit and tracking purposes. - string sessionLink?; - # The Standard Industrial Classification (SIC) code associated with the policyholder's primary business activity, used for underwriting and risk assessment. - string sicCode?; - # The code identifying the sub-producer or agent responsible for the policy, part of the distribution and sales network. - string subProducerCd?; - # A more specific classification within the overall policy type, providing further detail on the coverage or policy structure. + # Indicator of whether the policy includes coverage for fire and lightning damage + boolean fireLightningInd?; + # The inception date of the policy, marking the beginning of coverage, distinct from the effective date in some cases + string inceptionDt?; + # The reason for manually renewing the policy, providing context for the renewal decision + string manualRenewalReason?; + # Indicator of whether commercial inland marine coverage is selected + boolean cILineSelectedInd?; + # Free-form comments or notes associated with the policy + string comments?; + # The code representing the affinity group associated with the policy, which may qualify the policyholder for certain benefits or discounts + string affinityGroupCd?; + # A more specific classification within the overall policy type, providing further detail on the coverage or policy structure string subTypeCd?; - # The code representing the type of transaction (e.g., new business, renewal, endorsement) that the policy record is associated with. - string transactionCd?; - # A unique identifier for the transaction involving the policy, used for tracking and auditing purposes. - int transactionNumber?; - # Indicates the current status of the policy transaction, such as pending, completed, or canceled. + # Indicates the current status of the policy transaction, such as pending, completed, or canceled string transactionStatus?; - # Detailed information on the previous transactions in this policy. - TransactionDetails[] transactionHistory?; - # Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies. - UmbrellaPolicyInfo umbrellaPolicyInfo?; - # The code identifying the underwriter responsible for the policy, critical for risk management and policy approval processes. - string underwriterCd?; - # Indicator of whether the policy is currently on hold due to underwriting review, awaiting additional information or decision. + # The reason for manually reinstating the policy, providing context for the action + string manualReinstateReason?; + # A unique identifier for the transaction involving the policy, used for tracking and auditing purposes + int transactionNumber?; + # The code representing the type of transaction (e.g., new business, renewal, endorsement) that the policy record is associated with + string transactionCd?; + # An external identifier for the policy, used for integration with external systems or databases + string externalId?; + # The product code of the company, identifying the specific insurance product offered + string companyProductCd?; + AuditPayPlan auditPayPlan?; + # Indicator of whether commercial package policy coverage is selected + boolean cPLineSelectedInd?; + # A policy number from a legacy system, maintained for historical or cross-reference purposes + string legacyPolicyNumber?; + # Indicator of whether the billing for the policy is manually split among multiple entities + boolean manualBillingEntitySplitInd?; + # The expiration date of the policy, indicating when coverage ends + string expirationDt?; + # The type of loss settlement provided by the policy, such as actual cash value or replacement cost + string lossSettlementType?; + # A reference identifier for the provider or originator of the policy, such as an agent, broker, or direct application system + string providerRef?; + ElectronicPaymentSource electronicPaymentSource?; + # The code for any promotional offers or discounts applied to the policy, used for marketing and billing purposes + string promotionCd?; + # Indicator of whether the policy has been manually reinstated after cancellation or lapse + boolean manualReinstateInd?; + # The Standard Industrial Classification (SIC) code associated with the policyholder's primary business activity, used for underwriting and risk assessment + string sicCode?; + # Defines the type of insurance policy, such as auto, homeowners, commercial, etc., categorizing the policy for administrative and product-specific purposes + string policyType?; + # Indicator of whether the policy is currently on hold due to underwriting review, awaiting additional information or decision boolean underwritingHoldInd?; - # Indicator of whether the policy includes coverage for vandalism and malicious mischief, protecting against specific types of property damage. - boolean vandalismMaliciousMischiefInd?; - # Indicator of whether the workers' compensation Average Rate Differential (ARD) rule is enabled, affecting premium calculations. - boolean wcARDRuleEnabled?; - # The day on which the workers' compensation policy's rating and premium are reassessed annually, important for policy management and pricing. - string wcAnniversaryRatingDay?; - # The code for the type of premium discount table applied to the workers' compensation policy, affecting discounts for larger premium volumes. - string wcPremiumDiscountTableTypeCd?; + # The type of commercial auto policy, detailing specific coverage options selected + string cAPolicyType?; + # The date on which the covered property was transferred to an LLC, if applicable + string llcOwnedDt?; + # Indicator of whether general liability coverage is selected + boolean cGLineSelectedInd?; + # The code identifying the underwriter responsible for the policy, critical for risk management and policy approval processes + string underwriterCd?; }; -# Details the points associated with a driver, typically as a result of traffic violations or incidents. These points can impact insurance premiums and coverage. +# Represents the Queries record for the operation: getQuotes +public type GetQuotesQueries record { + # Select applications where application creation date is equal to or greater than the provided createdSinceDate + string createdSinceDate?; + # Application or quote number + string applicationOrQuoteNumber?; + # Transaction code (e.g. New Business) Use where a specific transactionCd(s) is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup contains a value + string transactionCd?; + # Includes deleted applications. If true, results will include "Deleted" applications. If false (or not provided), results will not include "Deleted" applications + boolean includeDeleted?; + # Application type. Valid values are Application, QuickQuote, or Quote + string 'type?; + # Finds applications recently viewed by the caller/user. If true, results will be restricted to applications recently viewed by the caller/user. If false (or not provided), results will not be restricted to applications recently viewed by the caller/user + boolean recentlyViewed?; + # Policy ID + string policyId?; + # Provider code number + string providerId?; + # Indicates the starting offset for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, the limit on your first API call was 100 and the results populated a list on the page. To request the next page of 100 results, call the API again with continuationId=101 and limit=100 + string continuationId?; + # Find applications by transactionCdGroup. Use when a specific transactionCd(s) is not known. Accepts a comma-separated list of values. Valid values are Quote, Cancellation, Renewal, or Other + string transactionCdGroup?; + # Customer ID number + string customerId?; + # Includes closed applications. If true, results will include "Closed" applications. If false (or not provided), results will not include "Closed" applications + boolean includeClosed?; + # The maximum number of results to return + string 'limit?; + # Comma-delimited list of optional fields to be included. Currently supports customer and product + string optionalFields?; + # Application status (e.g. In Process) + string status?; +}; + +# Details the points associated with a driver, typically as a result of traffic violations or incidents. These points can impact insurance premiums and coverage public type DriverPoint record { - # Additional remarks or explanations regarding the specific points or the incident leading to the points. - string comments?; - # The date on which the conviction was registered, leading to points being added to the driver's record. - string convictionDt?; - # A unique identifier for the incident as recorded in the direct portal, linking the points to specific events or violations. - string directPortalIncidentId?; - # The total number of points assigned to the driver as a result of the recorded incident or conviction. - int driverPointsNumber?; - # The date when the points are set to expire or be removed from the driver's record, following applicable laws or regulations. - string expirationDt?; - # A unique identifier for the driver point record, allowing for tracking and management within the system. - string id?; - # Indicator of whether these points should be ignored or not considered in the driver's risk assessment, possibly due to mitigating circumstances. - boolean ignoreInd?; - # A code representing the specific infraction or violation that resulted in the points being assigned to the driver. - string infractionCd?; - # The date on which the infraction occurred, crucial for determining the relevance and impact of the points over time. - string infractionDt?; - # The number of points that are chargeable against the driver, directly affecting insurance assessments and premiums. + # The number of points that are chargeable against the driver, directly affecting insurance assessments and premiums int pointsChargeable?; - # The actual number of points charged to the driver after considerations such as mitigating factors or legal adjustments. + # Additional remarks or explanations regarding the specific points or the incident leading to the points + string comments?; + # The actual number of points charged to the driver after considerations such as mitigating factors or legal adjustments int pointsCharged?; - # The source code identifying where the point data originated from, such as a state DMV or court system, ensuring traceability. + # The source code identifying where the point data originated from, such as a state DMV or court system, ensuring traceability string sourceCd?; - # The current status of the points, such as 'Active', 'Expired', or 'Removed', reflecting the driver's current standing. - string status?; - # Reference to a template used for documenting or processing driver points, facilitating standardized record-keeping. + # The total number of points assigned to the driver as a result of the recorded incident or conviction + int driverPointsNumber?; + # Reference to a template used for documenting or processing driver points, facilitating standardized record-keeping string templateId?; - # A categorization code that classifies the type of points or the nature of the infractions, aiding in analysis and reporting. + # A code representing the specific infraction or violation that resulted in the points being assigned to the driver + string infractionCd?; + # The date on which the infraction occurred, crucial for determining the relevance and impact of the points over time + string infractionDt?; + # A unique identifier for the incident as recorded in the direct portal, linking the points to specific events or violations + string directPortalIncidentId?; + # The date when the points are set to expire or be removed from the driver's record, following applicable laws or regulations + string expirationDt?; + # A categorization code that classifies the type of points or the nature of the infractions, aiding in analysis and reporting string typeCd?; + # The date on which the conviction was registered, leading to points being added to the driver's record + string convictionDt?; + # Indicator of whether these points should be ignored or not considered in the driver's risk assessment, possibly due to mitigating circumstances + boolean ignoreInd = true; + # A unique identifier for the driver point record, allowing for tracking and management within the system + string id?; + # The current status of the points, such as 'Active', 'Expired', or 'Removed', reflecting the driver's current standing + string status?; }; -# Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization. +# Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization public type ProductInfo record { - # A unique identifier for the insurance product, enabling precise reference and retrieval within the system. - string id?; - # The descriptive name of the product as defined in the Product Master, providing a human-readable identifier that may correspond to marketing or regulatory naming conventions. + # The descriptive name of the product as defined in the Product Master, providing a human-readable identifier that may correspond to marketing or regulatory naming conventions string name?; + # A unique identifier for the insurance product, enabling precise reference and retrieval within the system + string id?; }; -# A structured response that enumerates all countries supported by the system. This can be used to populate selection lists or validate country data in user inputs. +# A structured response that enumerates all countries supported by the system. This can be used to populate selection lists or validate country data in user inputs public type ListCountry record { - # An array of country objects, each representing a country supported by the system. This list includes both the ISO code and the name of each country. + # An array of country objects, each representing a country supported by the system. This list includes both the ISO code and the name of each country Country[] countries; }; -# Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed. +# Represents the Queries record for the operation: createQuote +public type CreateQuoteQueries record { + # Starts a quote of the specified type. Valid values are QuickQuote or Quote. If a type is not specified, a QuickQuote will be created if the selected product supports quick quotes and you can perform quick quotes; otherwise, a Quote will be created. If QuickQuote is specified but the selected product does not support quick quotes or you cannot perform quick quotes, then either a 400 or 403 response code will be returned + string requestedTypeCd?; +}; + +# Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed public type DriverPersonalInfo record { - # The date the driver completed an accident prevention course, potentially qualifying them for insurance discounts. - string accidentPreventionCourseCompletionDt?; - # Indicates whether the driver has completed an accredited accident prevention course. - boolean accidentPreventionCourseInd?; - # The total number of vehicles assigned to the driver within the policy, illustrating the extent of the driver's responsibility. - int assignedVehicle?; - # Reference ID of the vehicle(s) attached to the driver within the policy, establishing a direct association between the driver and specific vehicles. + # Reference ID of the vehicle(s) attached to the driver within the policy, establishing a direct association between the driver and specific vehicles string attachedVehicleRef?; - # The date on which the driver was officially hired or employed, relevant in contexts where driving is a professional activity. - string dateofHire?; - # The start date from which the benefits of completing a defensive driving course take effect, often related to policy discounts. + # The start date from which the benefits of completing a defensive driving course take effect, often related to policy discounts string defensiveDriverEffectiveDt?; - # The expiration date of the defensive driving course benefits, after which renewal may be necessary to maintain associated discounts. - string defensiveDriverExpirationDt?; - # Indicates successful completion of a defensive driving course by the driver, which may affect insurance premiums or eligibility for certain coverage options. - boolean defensiveDriverInd?; - # A code that categorizes the driver within the system, often used for internal classification and processing. - string driverInfoCd?; - # A unique sequence number assigned to the driver, used for identification and tracking within the insurance policy. + # Indicates recognition of the driver as a 'good driver', potentially affecting policy rates and eligibility for specific benefits + boolean goodDriverInd = true; + # Signals that the driver qualifies for a good driver discount, based on a history of safe driving and adherence to traffic laws + boolean goodDriverDiscountInd = true; + # The date on which the driver qualified for a scholastic achievement discount, typically based on academic performance + string scholasticCertificationDt?; + # The total number of years the driver has held a valid driving license, serving as an indicator of experience and proficiency + string yearsExperience?; + # The date on which the MVR status was last updated, important for maintaining current and accurate driver records + string mvrStatusDt?; + # The date the driver completed a formal training program, which may qualify them for additional benefits or discounts within their insurance policy + string driverTrainingCompletionDt?; + # A unique sequence number assigned to the driver, used for identification and tracking within the insurance policy int driverNumber?; - # A detailed record of points accumulated by the driver, reflecting violations, infractions, or other factors that may impact insurance rates or coverage. - DriverPoint[] driverPoints?; - # The effective date when the driver was added to the policy, used for calculating the duration of coverage and experience. + # The effective date when the driver was added to the policy, used for calculating the duration of coverage and experience string driverStartDt?; - # The current status of the driver, such as 'Occasional' or 'Principal', indicating their primary role or frequency of vehicle use within the policy. + # The date on which the driver's license was issued, critical for verifying legal driving status and calculating experience + string licenseDt?; + # The current status of the driver, such as 'Occasional' or 'Principal', indicating their primary role or frequency of vehicle use within the policy string driverStatusCd?; - # The date the driver completed a formal training program, which may qualify them for additional benefits or discounts within their insurance policy. - string driverTrainingCompletionDt?; - # A flag indicating whether the driver has undergone formal driving training, potentially influencing risk assessments and policy pricing. - boolean driverTrainingInd?; - # Classifies the driver by type, such as 'Excluded' or 'Underaged', affecting policy terms and coverage limits. - string driverTypeCd?; - # Indicates whether the driver is excluded from certain policy coverages or rating considerations, based on underwriting decisions or policy options. - string excludeDriverInd?; - # Signals that the driver qualifies for a good driver discount, based on a history of safe driving and adherence to traffic laws. - boolean goodDriverDiscountInd?; - # Indicates recognition of the driver as a 'good driver', potentially affecting policy rates and eligibility for specific benefits. - boolean goodDriverInd?; - # A unique identifier for the driver's personal information record within the system. + # Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a critical step in assessing driving history and risk + boolean mvrRequestInd = true; + # The expiration date of the defensive driving course benefits, after which renewal may be necessary to maintain associated discounts + string defensiveDriverExpirationDt?; + # The year in which the driver was first licensed, offering a measure of driving experience and history + string yearLicensed?; + # The official number associated with the driver's license, essential for identity verification and records management + string licenseNumber?; + # A unique identifier for the driver's personal information record within the system string id?; - # The total number of years the driver has been actively driving, reflecting experience and potentially influencing risk profiles. + # The date the driver completed an accident prevention course, potentially qualifying them for insurance discounts + string accidentPreventionCourseCompletionDt?; + # The status of the MVR data report, providing insights into the driver's history and any potential issues or endorsements + string mvrStatus?; + # Indicates whether the driver possesses a permanent driving license, as opposed to a provisional or temporary license + boolean permanentLicenseInd = true; + # The total number of vehicles assigned to the driver within the policy, illustrating the extent of the driver's responsibility + int assignedVehicle?; + # The total number of years the driver has been actively driving, reflecting experience and potentially influencing risk profiles int lengthTimeDriving?; - # The date on which the driver's license was issued, critical for verifying legal driving status and calculating experience. - string licenseDt?; - # The official number associated with the driver's license, essential for identity verification and records management. - string licenseNumber?; - # Current status of the driver's license, such as 'Valid', 'Suspended', or 'Expired', impacting eligibility for insurance. - string licenseStatus?; - # The code of the state or province that issued the driver's license, indicating the jurisdiction under which the license is valid. + # A code that categorizes the driver within the system, often used for internal classification and processing + string driverInfoCd = "ContactDriver"; + # A flag indicating whether the driver has undergone formal driving training, potentially influencing risk assessments and policy pricing + boolean driverTrainingInd?; + # Indicates whether the driver is excluded from certain policy coverages or rating considerations, based on underwriting decisions or policy options + string excludeDriverInd?; + # Signals the requirement for the driver to provide proof of insurance to the state or regulatory body, often linked to vehicle registration processes + boolean requiredProofOfInsuranceInd = true; + # The code of the state or province that issued the driver's license, indicating the jurisdiction under which the license is valid string licensedStateProvCd?; - # Designates the driver as a 'mature driver', possibly qualifying for specific discounts based on age and experience. - boolean matureDriverInd?; - # Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a critical step in assessing driving history and risk. - boolean mvrRequestInd?; - # The status of the MVR data report, providing insights into the driver's history and any potential issues or endorsements. - string mvrStatus?; - # The date on which the MVR status was last updated, important for maintaining current and accurate driver records. - string mvrStatusDt?; - # Indicates whether the driver possesses a permanent driving license, as opposed to a provisional or temporary license. - boolean permanentLicenseInd?; - # Specifies the driver's relationship to the insured party, such as 'Husband', 'Wife', 'Son', 'Daughter', affecting policy structure and coverages. - string relationshipToInsuredCd?; - # Signals the requirement for the driver to provide proof of insurance to the state or regulatory body, often linked to vehicle registration processes. - boolean requiredProofOfInsuranceInd?; - # The date on which the driver qualified for a scholastic achievement discount, typically based on academic performance. - string scholasticCertificationDt?; - # Indicates eligibility for a discount based on scholastic achievement, aimed at student drivers who maintain high academic standards. - boolean scholasticDiscountInd?; - # Free-form comments that provide additional context or explanations for the driver's status, changes, or specific conditions noted in the record. + # Indicates eligibility for a discount based on scholastic achievement, aimed at student drivers who maintain high academic standards + boolean scholasticDiscountInd = true; + # Free-form comments that provide additional context or explanations for the driver's status, changes, or specific conditions noted in the record string statusComments?; - # The year in which the driver was first licensed, offering a measure of driving experience and history. - string yearLicensed?; - # The total number of years the driver has held a valid driving license, serving as an indicator of experience and proficiency. - string yearsExperience?; + # Current status of the driver's license, such as 'Valid', 'Suspended', or 'Expired', impacting eligibility for insurance + string licenseStatus?; + # Designates the driver as a 'mature driver', possibly qualifying for specific discounts based on age and experience + boolean matureDriverInd = true; + # Indicates whether the driver has completed an accredited accident prevention course + boolean accidentPreventionCourseInd = true; + # Classifies the driver by type, such as 'Excluded' or 'Underaged', affecting policy terms and coverage limits + string driverTypeCd?; + # Specifies the driver's relationship to the insured party, such as 'Husband', 'Wife', 'Son', 'Daughter', affecting policy structure and coverages + string relationshipToInsuredCd?; + # The date on which the driver was officially hired or employed, relevant in contexts where driving is a professional activity + string dateofHire?; + # A detailed record of points accumulated by the driver, reflecting violations, infractions, or other factors that may impact insurance rates or coverage + DriverPoint[] driverPoints?; + # Indicates successful completion of a defensive driving course by the driver, which may affect insurance premiums or eligibility for certain coverage options + boolean defensiveDriverInd = true; }; -# Detailed information about an error. -public type Error record { - # The HTTP status code. - int code; - # A brief description of the error. - string message; - # Information about the error stack trace. - string stackTrace?; +# Represents the Queries record for the operation: fillAddressFromGooglePlaces +public type FillAddressFromGooglePlacesQueries record { + # Place Id from the Google Places search + string placeId?; + # The address line to have Google Places search and fill the address components + string addressLine?; }; -# Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations. +# Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations public type AddressStateProvinceTemplates record { - # A collection of state or province entities, each conforming to the defined StateProvinces schema, allowing for detailed representation of geographic administrative divisions. + # A collection of state or province entities, each conforming to the defined StateProvinces schema, allowing for detailed representation of geographic administrative divisions StateProvinces[] stateProvinces?; }; -# Defines the details of a transaction within the system. +# Defines the details of a transaction within the system public type TransactionDetails record { - # Reference to the application. - string applicationRef?; - # Date when the transaction was booked. - string bookDt?; - # Transaction number associated with the cancellation. - int cancelOfTransactionNumber?; - # Code indicating who requested the cancellation. - string cancelRequestedByCd?; - # Code indicating the type of cancellation. - string cancelTypeCd?; - # Transaction number associated with the cancellation. - int cancelledByTransactionNumber?; - # Indicates whether a reinstatement fee was charged. - boolean chargeReinstatementFeeInd?; - # Number associated with the check. - string checkNumber?; - # Group associated with conversion. - string conversionGroup?; - # Reference to the conversion job. + # User associated with the transaction + string transactionUser?; + # Transaction number associated with replacement + int replacementOfTransactionNumber?; + # Transaction number associated with un-application + int unAppliedByTransactionNumber?; + # Reason for releasing hold + string releaseHoldReason?; + # Reference to the conversion job string conversionJobRef?; - # Reference to the conversion template ID. - string conversionTemplateIdRef?; - # Transaction number associated with correction. - int correctedByTransactionNumber?; - # Transaction number associated with correction. - int correctionOfTransactionNumber?; - # Indicates whether invoice is delayed. - boolean delayInvoiceInd?; - # Type of hold. - string holdType?; - # Unique identifier for the transaction. + # Transaction number associated with replacement + int replacedByTransactionNumber?; + # Amount of change in premium for written policy + string writtenChangePremiumAmt?; + # Unique identifier for the transaction string id?; - # Amount of change in premium for in-force policy. - string inforceChangePremiumAmt?; - # Amount of in-force premium. + # Number associated with the check + string checkNumber?; + # Transaction number associated with reinstatement + int reinstatementOfTransactionNumber?; + # Amount of in-force premium string inforcePremiumAmt?; - # Master transaction number. - int masterTransactionNumber?; - # Effective date of the new policy. - string newPolicyEffectiveDt?; - # Expiration date of the new policy. - string newPolicyExpirationDt?; - # Code indicating the type of output. + # Code indicating the type of output string outputTypeCd?; - # Amount of payment. - string paymentAmt?; - # Code indicating the type of payment. + # Code indicating the type of payment string paymentTypeCd?; - # Transaction number associated with reinstatement. - int reinstatedByTransactionNumber?; - # Transaction number associated with reinstatement. - int reinstatementOfTransactionNumber?; - # Reason for releasing hold. - string releaseHoldReason?; - # Transaction number associated with renewal application. - int renewalApplyOfTransactionNumber?; - # Reference to renewal provider. + # Reference to renewal provider string renewalProviderRef?; - # Code indicating the sub-producer of renewal. - string renewalSubProducerCd?; - # Transaction number associated with replacement. - int replacedByTransactionNumber?; - # Transaction number associated with replacement. - int replacementOfTransactionNumber?; - # Version of the product for rewrite. - string rewriteToProductVersion?; - # Code indicating the source of transaction. - string sourceCd?; - # Submission number. - int submissionNumber?; - # Code indicating the type of transaction. - string transactionCd?; - # Reasons for the closure of a transaction. + # Transaction number associated with correction + int correctionOfTransactionNumber?; + # Long description of the transaction + string transactionLongDescription?; TransactionCloseReasons transactionCloseReasons?; - # Date of the transaction. + # Total net locations manual premium amount for workers compensation + string wcTotalNetLocationsManualPremiumAmt?; + # Version of the product for rewrite + string rewriteToProductVersion?; + # Date of the transaction string transactionDt?; - # Effective date of the transaction. + # Amount of payment + string paymentAmt?; + # Submission number + int submissionNumber?; + # Time of the transaction + string transactionTm?; + # Short description of the transaction + string transactionShortDescription?; + # Source of un-application + string unapplySource?; + # Effective date of the transaction string transactionEffectiveDt?; - # Time when the transaction became effective. + # Expiration date of the new policy + string newPolicyExpirationDt?; + # Fee amount for written policy + string writtenFeeAmt?; + # Code indicating the source of transaction + string sourceCd?; + # Effective date of the new policy + string newPolicyEffectiveDt?; + # Reference to the conversion template ID + string conversionTemplateIdRef?; + # Transaction number associated with renewal application + int renewalApplyOfTransactionNumber?; + # Date when the transaction was booked + string bookDt?; + # Transaction number associated with the cancellation + int cancelOfTransactionNumber?; + # Time when the transaction became effective string transactionEffectiveTm?; - # Long description of the transaction. - string transactionLongDescription?; - # Transaction number. - int transactionNumber?; - # Reasons associated with the transaction. - TransactionReason[] transactionReasons?; - # Short description of the transaction. - string transactionShortDescription?; - # Text associated with the transaction. - TransactionText[] transactionText?; - # Time of the transaction. - string transactionTm?; - # User associated with the transaction. - string transactionUser?; - # Transaction number associated with un-application. - int unAppliedByTransactionNumber?; - # Transaction number associated with un-application. + # Premium amount for written policy + string writtenPremiumAmt?; + # Transaction number associated with un-application int unApplyOfTransactionNumber?; - # Source of un-application. - string unapplySource?; - # Code indicating the reinstatement of workers compensation. + # Code indicating the type of cancellation + string cancelTypeCd?; + # Type of hold + string holdType?; + # Code indicating the sub-producer of renewal + string renewalSubProducerCd?; + # Indicates whether a reinstatement fee was charged + boolean chargeReinstatementFeeInd?; + # Code indicating the reinstatement of workers compensation string wcReinstatementCd?; - # Total net locations manual premium amount for workers compensation. - string wcTotalNetLocationsManualPremiumAmt?; - # Indicates whether cancellation audit for workers compensation is waived. + # Reference to the application + string applicationRef?; + # Transaction number associated with correction + int correctedByTransactionNumber?; + # Transaction number + int transactionNumber?; + # Amount of change in premium for in-force policy + string inforceChangePremiumAmt?; + # Code indicating the type of transaction + string transactionCd?; + # Reasons associated with the transaction + TransactionReason[] transactionReasons?; + # Indicates whether cancellation audit for workers compensation is waived boolean wcWaiveCancellationAuditInd?; - # Amount of change in premium for written policy. - string writtenChangePremiumAmt?; - # Fee amount for written policy. - string writtenFeeAmt?; - # Premium amount for written policy. - string writtenPremiumAmt?; + # Group associated with conversion + string conversionGroup?; + # Transaction number associated with reinstatement + int reinstatedByTransactionNumber?; + # Master transaction number + int masterTransactionNumber?; + # Text associated with the transaction + TransactionText[] transactionText?; + # Code indicating who requested the cancellation + string cancelRequestedByCd?; + # Transaction number associated with the cancellation + int cancelledByTransactionNumber?; + # Indicates whether invoice is delayed + boolean delayInvoiceInd?; }; -# Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication. +# Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication public type PartyInfo record { - # A list of addresses associated with the party, detailing physical locations for billing, correspondence, or property coverage. + # A list of addresses associated with the party, detailing physical locations for billing, correspondence, or property coverage Address[] addresses?; - # Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts. - BusinessInfo businessInfo?; - # Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior. - DriverInfo driverInfo?; - # Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification. - ESignatureInfo eSignatureInfo?; - # Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes. - EmailInfo emailInfo?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. EraseInfo eraseInfo?; - # A unique identifier for the party record within the system, ensuring accurate reference and integration across processes. - string id?; - # Reference to a specific location associated with the party, often used for underwriting or claims purposes. - string locationIdRef?; - # Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions. NameInfo nameInfo?; - # A code indicating the type of party (e.g., individual, corporation), aiding in classification and process differentiation. + # A code indicating the type of party (e.g., individual, corporation), aiding in classification and process differentiation string partyTypeCd?; - # Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services. PersonInfo personInfo?; - # A collection of phone numbers for the party, covering different types, purposes, and preferences. + BusinessInfo businessInfo?; + # Reference to a specific location associated with the party, often used for underwriting or claims purposes + string locationIdRef?; + TaxInfo taxInfo?; + DriverInfo driverInfo?; + ESignatureInfo eSignatureInfo?; + # The number of years the party has been associated with services or policies within the system, indicating tenure or loyalty + int yearsOfService?; + EmailInfo emailInfo?; + # A collection of phone numbers for the party, covering different types, purposes, and preferences PhoneInfo[] phoneInfo?; - # Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format. + # A unique identifier for the party record within the system, ensuring accurate reference and integration across processes + string id?; QuestionReplies questionReplies?; - # The current status of the party within the system, reflecting activity, eligibility, or compliance states. - string status?; - # Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting. - TaxInfo taxInfo?; - # A reference to underlying party information, linking related records or entities within the system. - string underLyingPartyInfoIdRef?; - # A reference to an underlying policy associated with the party, establishing connections for coverage, claims, or account management. + # A reference to an underlying policy associated with the party, establishing connections for coverage, claims, or account management string underLyingPolicyIdRef?; - # The number of years the party has been associated with services or policies within the system, indicating tenure or loyalty. - int yearsOfService?; + # A reference to underlying party information, linking related records or entities within the system + string underLyingPartyInfoIdRef?; + # The current status of the party within the system, reflecting activity, eligibility, or compliance states + string status?; }; -# Details a contact entity, capturing essential identification, type, and communication preferences, facilitating targeted and effective interactions. +# Details a contact entity, capturing essential identification, type, and communication preferences, facilitating targeted and effective interactions public type Contact record { - # A code that categorizes the contact by their relationship or role, such as 'Agent', 'Insured', or 'Claimant', aiding in context-specific communication and processes. + # A code that categorizes the contact by their relationship or role, such as 'Agent', 'Insured', or 'Claimant', aiding in context-specific communication and processes string contactTypeCd?; - # A unique identifier for the contact within the system, enabling precise reference and management. - string id?; - # Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication. PartyInfo partyInfo?; - # Specifies the contact's preferred method for receiving communications, such as 'Email', 'Paper Mail', or 'SMS', ensuring compliance with their preferences. + # Specifies the contact's preferred method for receiving communications, such as 'Email', 'Paper Mail', or 'SMS', ensuring compliance with their preferences string preferredDeliveryMethod?; - # Indicates the current status of the contact within the system, such as 'Active' or 'Inactive', reflecting their availability for communication and transactions. + # A unique identifier for the contact within the system, enabling precise reference and management + string id?; + # Indicates the current status of the contact within the system, such as 'Active' or 'Inactive', reflecting their availability for communication and transactions string status?; }; -# Encapsulates comprehensive details about a quotation for insurance coverage, including linked resources, policy information, and the status of the quote. -public type Quote record { - # A collection of hypermedia links to related resources and actions available for the quote, facilitating easy navigation and interaction within the API ecosystem. - Link[] _links?; - # A system-generated version identifier for the quote, used to manage updates and ensure data integrity through optimistic concurrency control. - string _revision?; - # Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions. - ApplicationInfo applicationInfo?; - # Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan. - BasicPolicy basicPolicy?; - # A list of contacts associated with the quote, including individuals or entities involved in the policy as insureds, beneficiaries, or other roles. - Contact[] contacts?; - # A reference identifier linking the quote to a customer record, enabling correlation between customer details and quotation data. - string customerRef?; - # A brief description or summary of the quote, providing insights into the coverage scope, purpose, or specific considerations. +# Describes a specific reason contributing to an insurance score, offering explanations for adjustments or factors affecting the score +public type InsuranceScoreReason record { + # A textual description of the reason, explaining its impact or relevance to the insurance score string description?; - # External system data related to the quote, potentially including state-specific requirements, third-party data, or external identifiers. - string externalStateData?; - # The unique identifier for the quote, facilitating tracking, management, and retrieval within the system. + # A unique identifier for the insurance score reason, enabling distinct management and reference string id?; - # Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information. + # A code representing the specific reason affecting the insurance score, used for categorization and analysis + string reasonCd?; +}; + +# Encapsulates comprehensive details about a quotation for insurance coverage, including linked resources, policy information, and the status of the quote +public type Quote record { + # List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage + WCAdditionalInsured[] wcAdditionalInsureds?; + # A system-generated version identifier for the quote, used to manage updates and ensure data integrity through optimistic concurrency control + @jsondata:Name {value: "_revision"} + string revision?; Insured insured?; - # An identifier for a system task or process that has locked the quote for exclusive access, preventing concurrent modifications. - string lockTaskId?; - # A reference identifier linking the quote to a specific policy or policy proposal, establishing a connection between quoting and policy issuance. - string policyRef?; - # A reference to the statement account associated with this quote, used for billing and financial transactions related to the policy. + # A reference to the statement account associated with this quote, used for billing and financial transactions related to the policy string statementAccountRef?; - # The current status of the quote, indicating its progression through the quoting process, approval state, or any conditions affecting its validity. - string status?; - # A list of issues or concerns raised by the submitter or system during the quoting process, requiring attention or resolution before proceeding. + # A collection of hypermedia links to related resources and actions available for the quote, facilitating easy navigation and interaction within the API ecosystem + @jsondata:Name {value: "_links"} + Link[] links?; + # A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance + WCCoveredState[] wcCoveredStates?; + # A brief description or summary of the quote, providing insights into the coverage scope, purpose, or specific considerations + string description?; + # External system data related to the quote, potentially including state-specific requirements, third-party data, or external identifiers + string externalStateData?; + # A list of issues or concerns raised by the submitter or system during the quoting process, requiring attention or resolution before proceeding SubmitterIssue[] submitterIssues?; - # Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others. + # A reference identifier linking the quote to a specific policy or policy proposal, establishing a connection between quoting and policy issuance + string policyRef?; TransactionInfo transactionInfo?; - # Indicates the VIP level or priority of the quote, which may affect processing speed, service levels, or access to special pricing. + # An identifier for a system task or process that has locked the quote for exclusive access, preventing concurrent modifications + string lockTaskId?; + # Indicates the VIP level or priority of the quote, which may affect processing speed, service levels, or access to special pricing string vipLevel?; - # List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage. - WCAdditionalInsured[] wcAdditionalInsureds?; - # A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance. - WCCoveredState[] wcCoveredStates?; -}; - -# Describes a specific reason contributing to an insurance score, offering explanations for adjustments or factors affecting the score. -public type InsuranceScoreReason record { - # A textual description of the reason, explaining its impact or relevance to the insurance score. - string description?; - # A unique identifier for the insurance score reason, enabling distinct management and reference. + BasicPolicy basicPolicy?; + # A reference identifier linking the quote to a customer record, enabling correlation between customer details and quotation data + string customerRef?; + # The unique identifier for the quote, facilitating tracking, management, and retrieval within the system string id?; - # A code representing the specific reason affecting the insurance score, used for categorization and analysis. - string reasonCd?; + ApplicationInfo applicationInfo?; + # A list of contacts associated with the quote, including individuals or entities involved in the policy as insureds, beneficiaries, or other roles + Contact[] contacts?; + # The current status of the quote, indicating its progression through the quoting process, approval state, or any conditions affecting its validity + string status?; }; -# Details an additional insured entity or individual on a workers' compensation policy, providing key identification and insurance-related information. +# Details an additional insured entity or individual on a workers' compensation policy, providing key identification and insurance-related information public type WCAdditionalInsured record { - # A code indicating the type of entity the additional insured represents, such as 'Additional Named Insured', categorizing their role within the policy context. - string entityTypeCd?; - # A unique identifier for the additional insured record, facilitating distinct management and reference within the system. - string id?; - # A standardized name used for indexing and searching purposes, often formatted to meet specific operational or regulatory requirements. - string indexName?; - # An array of InsuranceScore objects that provide scoring or rating information related to the additional insured, used in underwriting and risk assessment. - InsuranceScore[] insuranceScore?; - # A numerical identifier assigned to the additional insured, useful for tracking and differentiation from other insured entities on the policy. - int insuredNumber?; - # A collection of references linking the additional insured to related records or external entities, enhancing data connectivity and context. - LinkReference[] linkReference?; - # Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication. PartyInfo partyInfo?; - # Indicates the preferred method for delivering communications or documents to the additional insured, aligning with their convenience and regulatory preferences. + # An array of InsuranceScore objects that provide scoring or rating information related to the additional insured, used in underwriting and risk assessment + InsuranceScore[] insuranceScore?; + # A standardized name used for indexing and searching purposes, often formatted to meet specific operational or regulatory requirements + string indexName?; + # Indicates the preferred method for delivering communications or documents to the additional insured, aligning with their convenience and regulatory preferences string preferredDeliveryMethod?; - # The current status of the additional insured within the policy, such as 'Active' or 'Inactive', reflecting their involvement and coverage status. + # A collection of references linking the additional insured to related records or external entities, enhancing data connectivity and context + LinkReference[] linkReference?; + # A unique identifier for the additional insured record, facilitating distinct management and reference within the system + string id?; + # A code indicating the type of entity the additional insured represents, such as 'Additional Named Insured', categorizing their role within the policy context + string entityTypeCd?; + # A numerical identifier assigned to the additional insured, useful for tracking and differentiation from other insured entities on the policy + int insuredNumber?; + # The current status of the additional insured within the policy, such as 'Active' or 'Inactive', reflecting their involvement and coverage status string status?; }; -# Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions. +# Reason associated with a transaction +public type TransactionReason record { + # Unique identifier for the transaction reason + string id?; + # Code indicating the reason for the transaction + string reasonCd?; +}; + +# Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions public type NameInfo record { - # The official commercial name of an entity, used in business contexts and legal documents. - string commercialName?; - # An additional commercial name field, allowing for legal aliases or alternative business names. - string commercialName2?; - # Index name under which the business is filed 'Doing Business As' (DBA), facilitating accurate identification and indexing. - string dbaIndexName?; - # The 'Doing Business As' (DBA) name, representing the trading name under which the business or entity operates publicly, distinct from the legal business name. - string dbaName?; - # An extended version of the name that may include additional identifiers or descriptive information, enhancing clarity and specificity. + # A code that categorizes the type of name record, such as 'ContactName', indicating the context or application of the name information + string nameTypeCd = "ContactName"; + # A prefix code indicating titles or honorifics preceding the name, such as 'Mr.', 'Dr.', or 'Ms.', contributing to respectful and accurate address + string prefixCd?; + # An extended version of the name that may include additional identifiers or descriptive information, enhancing clarity and specificity string extendedName?; - # The individual's first name or given name, used in personal identification. - string givenName?; - # A unique identifier for the name information record, ensuring trackability and distinct management within the system. - string id?; - # A standardized name format used for indexing, typically following conventions to facilitate sorting and retrieval. + # A standardized name format used for indexing, typically following conventions to facilitate sorting and retrieval string indexName?; - # A code that categorizes the type of name record, such as 'ContactName', indicating the context or application of the name information. - string nameTypeCd?; - # An additional or middle given name of the individual, providing completeness to personal identification. - string otherGivenName?; - # A code representing the individual's position or title within an organization, if applicable, contributing to formal identification and correspondence. - string positionCd?; - # A prefix code indicating titles or honorifics preceding the name, such as 'Mr.', 'Dr.', or 'Ms.', contributing to respectful and accurate address. - string prefixCd?; - # A shortened or informal version of the name, used for ease of communication or in less formal contexts. - string shortName?; - # A suffix code indicating qualifiers or titles following the name, such as 'Jr.', 'Sr.', or academic credentials, adding to the formal identification of the individual. + # The individual's first name or given name, used in personal identification + string givenName?; + # Index name under which the business is filed 'Doing Business As' (DBA), facilitating accurate identification and indexing + string dbaIndexName?; + # The 'Doing Business As' (DBA) name, representing the trading name under which the business or entity operates publicly, distinct from the legal business name + string dbaName?; + # An additional commercial name field, allowing for legal aliases or alternative business names + string commercialName2?; + # A suffix code indicating qualifiers or titles following the name, such as 'Jr.', 'Sr.', or academic credentials, adding to the formal identification of the individual string suffixCd?; - # The individual's last name or family name, essential for personal identification and official documentation. + # The individual's last name or family name, essential for personal identification and official documentation string surname?; + # A code representing the individual's position or title within an organization, if applicable, contributing to formal identification and correspondence + string positionCd?; + # A unique identifier for the name information record, ensuring trackability and distinct management within the system + string id?; + # A shortened or informal version of the name, used for ease of communication or in less formal contexts + string shortName?; + # An additional or middle given name of the individual, providing completeness to personal identification + string otherGivenName?; + # The official commercial name of an entity, used in business contexts and legal documents + string commercialName?; }; -# Encapsulates both a specific question posed within the system and the corresponding reply, facilitating the structured collection of information for processes such as underwriting or claim assessment. +# Encapsulates both a specific question posed within the system and the corresponding reply, facilitating the structured collection of information for processes such as underwriting or claim assessment public type QuestionReply record { - # A descriptive label or prompt for the question, intended to be displayed as part of the question when presented to the user. + # Indicates whether the question is currently set to be visible to the user, allowing for conditional display based on context or previous answers + boolean visibleInd = true; + # A descriptive label or prompt for the question, intended to be displayed as part of the question when presented to the user string displayDesc?; - # A unique identifier for the question and reply instance, allowing for tracking and referencing within the system. - string id?; - # The name or key identifying the question, which may be used to map the reply to specific processes or data fields. + # The name or key identifying the question, which may be used to map the reply to specific processes or data fields string name?; - # The full text of the question as presented to the user, detailing what information or response is being requested. + # A unique identifier for the question and reply instance, allowing for tracking and referencing within the system + string id?; + # The full text of the question as presented to the user, detailing what information or response is being requested string text?; - # The reply or response provided to the question, stored as a string regardless of the original format or type of the input. + # The reply or response provided to the question, stored as a string regardless of the original format or type of the input string value?; - # Indicates whether the question is currently set to be visible to the user, allowing for conditional display based on context or previous answers. - boolean visibleInd?; -}; - -# Reason associated with a transaction. -public type TransactionReason record { - # Unique identifier for the transaction reason. - string id?; - # Code indicating the reason for the transaction. - string reasonCd?; }; -# Outlines detailed information about a document, including its description, associated files, and metadata, supporting comprehensive document management and access. +# Outlines detailed information about a document, including its description, associated files, and metadata, supporting comprehensive document management and access public type DocumentDetail record { - # A collection of files that comprise the document, accommodating multi-part documents or attachments. - CompositeFile[] compositeFile?; - # A textual summary of the document's content or purpose, aiding in identification and categorization. - string description?; - # Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations. - EraseInfo eraseInfo?; - # The name of the file as stored within the system, including extension, facilitating file identification and access. + # The name of the file as stored within the system, including extension, facilitating file identification and access string filename?; - # A unique identifier for the document, ensuring unambiguous reference across the system. + EraseInfo eraseInfo?; + # A textual summary of the document's content or purpose, aiding in identification and categorization + string description?; + # An accompanying memo providing further detail or context about the document, enhancing understanding or guiding action + string memo?; + # A collection of files that comprise the document, accommodating multi-part documents or attachments + CompositeFile[] compositeFile?; + # A unique identifier for the document, ensuring unambiguous reference across the system string id?; - # Links connecting the document to related entities or records, promoting interconnectedness and contextual awareness. + # Links connecting the document to related entities or records, promoting interconnectedness and contextual awareness LinkReference[] linkReferences?; - # An accompanying memo providing further detail or context about the document, enhancing understanding or guiding action. - string memo?; - # Details the criteria and processes for purging the document from the system, aligning with data governance practices. + # Details the criteria and processes for purging the document from the system, aligning with data governance practices record {} purgeInfo?; - # Tags applied to the document for categorization, searchability, and thematic association. - Tag[] tags?; - # The identifier of the template utilized for the document, indicating conformity to specific formats or standards. + # The identifier of the template utilized for the document, indicating conformity to specific formats or standards string templateId?; + # Tags applied to the document for categorization, searchability, and thematic association + Tag[] tags?; }; -# Encapsulates metadata in the form of a tag, allowing for the categorization, organization, and easy retrieval of various entities within the system. Tags can be applied to documents, contacts, claims, and more, facilitating efficient data management and searchability. +# Encapsulates metadata in the form of a tag, allowing for the categorization, organization, and easy retrieval of various entities within the system. Tags can be applied to documents, contacts, claims, and more, facilitating efficient data management and searchability public type Tag record { - # A unique identifier for the tag, ensuring distinctness across the system and enabling precise reference and operations on the tag. - string id?; - # The human-readable name of the tag, which succinctly describes the attribute, category, or keyword associated with the tag. This name is used for displaying, searching, and organizing entities tagged with this label. + # The human-readable name of the tag, which succinctly describes the attribute, category, or keyword associated with the tag. This name is used for displaying, searching, and organizing entities tagged with this label string name?; - # The reference ID to a predefined tag template from which this tag was created, if applicable. Tag templates facilitate the standardization of tags across the system, ensuring consistency in tagging conventions and metadata application. + # The reference ID to a predefined tag template from which this tag was created, if applicable. Tag templates facilitate the standardization of tags across the system, ensuring consistency in tagging conventions and metadata application string tagTemplateIdRef?; + # A unique identifier for the tag, ensuring distinctness across the system and enabling precise reference and operations on the tag + string id?; }; -# Defines the template for constructing and validating addresses within a specific country. This schema includes details like the required fields, address format, and labels for various address components, tailored to the country's postal system. +# Defines the template for constructing and validating addresses within a specific country. This schema includes details like the required fields, address format, and labels for various address components, tailored to the country's postal system public type AddressCountryTemplate record { - # Indicates the number of address lines that are supported or required by the address format of this country. - string addressLines?; - # Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations. AddressStateProvinceTemplates addressStateProvinceTemplates?; - # The label used for the city field in address forms, which may vary based on the country's addressing system. + # A regular expression pattern used to validate the format of postal or zip codes for addresses in this country, ensuring data accuracy and compliance with local postal standards + string postalCodeRegex?; + # The label used for the city field in address forms, which may vary based on the country's addressing system string cityLabel?; - # The full name of the country to which this address template applies, ensuring clarity and consistency in international addressing. - string countryName?; - # Specifies the format used for addresses in this country, including the order of address components and the separators used between them. + # The label for the state or province field in address forms, accommodating the terminology used in the country's addressing system + string stateProvLabel?; + # A comma-separated list of address fields that are mandatory for this country, allowing for dynamic form validation that adapts to different countries' addressing requirements + string requiredFields?; + # Specifies the format used for addresses in this country, including the order of address components and the separators used between them string format?; - # A unique identifier for the template, typically using the two-letter ISO country code for easy reference. + # Indicates the number of address lines that are supported or required by the address format of this country + string addressLines?; + # The full name of the country to which this address template applies, ensuring clarity and consistency in international addressing + string countryName?; + # A unique identifier for the template, typically using the two-letter ISO country code for easy reference string id?; - # Provides examples of valid postal or zip codes for the country, useful as a guide for users when entering address information. - string postalCodeExamples?; - # The label used for the postal or zip code field, which may be customized based on the country's postal system terminology. + # The label used for the postal or zip code field, which may be customized based on the country's postal system terminology string postalCodeLabel?; - # A regular expression pattern used to validate the format of postal or zip codes for addresses in this country, ensuring data accuracy and compliance with local postal standards. - string postalCodeRegex?; - # A comma-separated list of address fields that are mandatory for this country, allowing for dynamic form validation that adapts to different countries' addressing requirements. - string requiredFields?; - # The label for the state or province field in address forms, accommodating the terminology used in the country's addressing system. - string stateProvLabel?; + # Provides examples of valid postal or zip codes for the country, useful as a guide for users when entering address information + string postalCodeExamples?; }; -# Specifies settings for reapplying output suppression rules to a transaction, indicating whether certain communications or document outputs should be included or suppressed based on specific criteria. +# Specifies settings for reapplying output suppression rules to a transaction, indicating whether certain communications or document outputs should be included or suppressed based on specific criteria public type ReapplyOutputSuppression record { - # A unique identifier for the output suppression rule, enabling tracking and management of suppression settings. - string id?; - # Indicates whether the suppression rule should be included in the current transaction, determining if related outputs are generated. + # Indicates whether the suppression rule should be included in the current transaction, determining if related outputs are generated boolean includeInd?; + # A unique identifier for the output suppression rule, enabling tracking and management of suppression settings + string id?; }; -# Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies. +# Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies public type UmbrellaPolicyInfo record { - # The unique identifier for the umbrella policy, used to uniquely distinguish this policy from others within the system. + # The policy number assigned to the umbrella policy, serving as a human-readable identifier that is often used in documentation and communications + string policyNumber?; + # The unique identifier for the umbrella policy, used to uniquely distinguish this policy from others within the system string id?; - # A reference identifier that links this umbrella policy to related records or entities within the system, facilitating cross-referencing and data integrity. + # A reference identifier that links this umbrella policy to related records or entities within the system, facilitating cross-referencing and data integrity string idRef?; - # The policy number assigned to the umbrella policy, serving as a human-readable identifier that is often used in documentation and communications. - string policyNumber?; +}; + +# Represents the Queries record for the operation: getPolicy +public type GetPolicyQueries record { + # Returns the policy details from a specified date (e.g. 2021-01-01). If not provided, the current date will be used + string asOfDate?; }; diff --git a/ballerina/utils.bal b/ballerina/utils.bal index e6dabd1..3cbf6df 100644 --- a/ballerina/utils.bal +++ b/ballerina/utils.bal @@ -17,6 +17,7 @@ // specific language governing permissions and limitations // under the License. +import ballerina/http; import ballerina/url; type SimpleBasicType string|boolean|int|float|decimal; @@ -74,11 +75,11 @@ isolated function getFormStyleRequest(string parent, record {} anyRecord, boolea string[] recordArray = []; if explode { foreach [string, anydata] [key, value] in anyRecord.entries() { - if (value is SimpleBasicType) { + if value is SimpleBasicType { recordArray.push(key, "=", getEncodedUri(value.toString())); - } else if (value is SimpleBasicType[]) { + } else if value is SimpleBasicType[] { recordArray.push(getSerializedArray(key, value, explode = explode)); - } else if (value is record {}) { + } else if value is record {} { recordArray.push(getFormStyleRequest(parent, value, explode)); } recordArray.push("&"); @@ -86,11 +87,11 @@ isolated function getFormStyleRequest(string parent, record {} anyRecord, boolea _ = recordArray.pop(); } else { foreach [string, anydata] [key, value] in anyRecord.entries() { - if (value is SimpleBasicType) { + if value is SimpleBasicType { recordArray.push(key, ",", getEncodedUri(value.toString())); - } else if (value is SimpleBasicType[]) { + } else if value is SimpleBasicType[] { recordArray.push(getSerializedArray(key, value, explode = false)); - } else if (value is record {}) { + } else if value is record {} { recordArray.push(getFormStyleRequest(parent, value, explode)); } recordArray.push(","); @@ -110,23 +111,23 @@ isolated function getFormStyleRequest(string parent, record {} anyRecord, boolea isolated function getSerializedArray(string arrayName, anydata[] anyArray, string style = "form", boolean explode = true) returns string { string key = arrayName; string[] arrayValues = []; - if (anyArray.length() > 0) { - if (style == FORM && !explode) { + if anyArray.length() > 0 { + if style == FORM && !explode { arrayValues.push(key, "="); foreach anydata i in anyArray { arrayValues.push(getEncodedUri(i.toString()), ","); } - } else if (style == SPACEDELIMITED && !explode) { + } else if style == SPACEDELIMITED && !explode { arrayValues.push(key, "="); foreach anydata i in anyArray { arrayValues.push(getEncodedUri(i.toString()), "%20"); } - } else if (style == PIPEDELIMITED && !explode) { + } else if style == PIPEDELIMITED && !explode { arrayValues.push(key, "="); foreach anydata i in anyArray { arrayValues.push(getEncodedUri(i.toString()), "|"); } - } else if (style == DEEPOBJECT) { + } else if style == DEEPOBJECT { foreach anydata i in anyArray { arrayValues.push(key, "[]", "=", getEncodedUri(i.toString()), "&"); } @@ -156,7 +157,7 @@ isolated function getSerializedRecordArray(string parent, record {}[] value, str arayIndex = arayIndex + 1; } } else { - if (!explode) { + if !explode { serializedArray.push(parent, "="); } foreach var recordItem in value { @@ -173,7 +174,7 @@ isolated function getSerializedRecordArray(string parent, record {}[] value, str # + return - Encoded string isolated function getEncodedUri(anydata value) returns string { string|error encoded = url:encode(value.toString(), "UTF8"); - if (encoded is string) { + if encoded is string { return encoded; } else { return value.toString(); @@ -186,21 +187,22 @@ isolated function getEncodedUri(anydata value) returns string { # + encodingMap - Details on serialization mechanism # + return - Returns generated Path or error at failure of client initialization isolated function getPathForQueryParam(map queryParam, map encodingMap = {}) returns string|error { + map queriesMap = http:getQueryMap(queryParam); string[] param = []; - if (queryParam.length() > 0) { + if queriesMap.length() > 0 { param.push("?"); - foreach var [key, value] in queryParam.entries() { + foreach var [key, value] in queriesMap.entries() { if value is () { - _ = queryParam.remove(key); + _ = queriesMap.remove(key); continue; } Encoding encodingData = encodingMap.hasKey(key) ? encodingMap.get(key) : defaultEncoding; - if (value is SimpleBasicType) { + if value is SimpleBasicType { param.push(key, "=", getEncodedUri(value.toString())); - } else if (value is SimpleBasicType[]) { + } else if value is SimpleBasicType[] { param.push(getSerializedArray(key, value, encodingData.style, encodingData.explode)); - } else if (value is record {}) { - if (encodingData.style == DEEPOBJECT) { + } else if value is record {} { + if encodingData.style == DEEPOBJECT { param.push(getDeepObjectStyleRequest(key, value)); } else { param.push(getFormStyleRequest(key, value, encodingData.explode)); diff --git a/docs/spec/openapi.yml b/docs/spec/openapi.yml index 4625a34..1e55218 100644 --- a/docs/spec/openapi.yml +++ b/docs/spec/openapi.yml @@ -1,523 +1,652 @@ -openapi: "3.0.2" +openapi: 3.0.2 info: title: GuideWire InsuranceNow Cloud API + description: | + This OpenAPI specification outlines the interface for the Guidewire InsuranceNow Cloud API version 5.0.0, providing a comprehensive description of available endpoints, operations, parameters, request bodies, and response structures for integrating with the cloud-based insurance platform, InsuranceNow. Designed to streamline operations for insurance companies, InsuranceNow offers functionalities including policy management, claims management, and customer engagement. The API enables developers to access and manipulate insurance data, facilitating automation, custom integrations, and workflow enhancements. Key features include policy management, claims processing, and customer management. version: 5.0.0 - description: > - This OpenAPI specification outlines the interface for the Guidewire InsuranceNow Cloud API version 5.0.0, providing a comprehensive description of available endpoints, operations, parameters, request bodies, and response structures for integrating with the cloud-based insurance platform, InsuranceNow. - Designed to streamline operations for insurance companies, InsuranceNow offers functionalities including policy management, claims management, and customer engagement. The API enables developers to access and manipulate insurance data, facilitating automation, custom integrations, and workflow enhancements. - Key features include policy management, claims processing, and customer management. - - +servers: +- url: / +security: +- BasicAuth: [] +- BearerAuth: [] paths: /addresses/countries: get: - operationId: getSupportedCountries description: Returns a list of supported countries. + operationId: getSupportedCountries parameters: - - in: query - name: sortType - schema: - type: string - enum: - - asc - - desc - default: asc - description: Indicates the method used to sort the results by name. + - name: sortType + in: query + description: Indicates the method used to sort the results by name + required: false + style: form + explode: true + schema: + type: string + default: asc + enum: + - asc + - desc responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListCountry" + $ref: '#/components/schemas/ListCountry' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /addresses/countries/{isoCd}: get: + description: Returns the AddressCountryTemplate bean for the given IsoCd (e.g. + US). operationId: getCountryByIsoCd - description: Returns the AddressCountryTemplate bean for the given IsoCd (e.g. US). parameters: - - description: ISO Country code. - in: path - name: isoCd - required: true - schema: - type: string + - name: isoCd + in: path + description: ISO Country code + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/AddressCountryTemplate" + $ref: '#/components/schemas/AddressCountryTemplate' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /addresses/googlePlacesFill: get: + description: "Fills an address from a Google Places search. Using the placeId\ + \ from a Google Places search, an address will be returned that has all of\ + \ the address components filled. If the placeId is not known, Google Places\ + \ will be called to search and fill the address components." operationId: fillAddressFromGooglePlaces - description: Fills an address from a Google Places search. Using the placeId from a Google Places search, an address will be returned that has all of the address components filled. If the placeId is not known, Google Places will be called to search and fill the address components. parameters: - - in: query - name: addressLine - schema: - type: string - description: The address line to have Google Places search and fill the address components. - - in: query - name: placeId - schema: - type: string - description: Place Id from the Google Places search. + - name: addressLine + in: query + description: The address line to have Google Places search and fill the address + components + required: false + style: form + explode: true + schema: + type: string + - name: placeId + in: query + description: Place Id from the Google Places search + required: false + style: form + explode: true + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/Address" + $ref: '#/components/schemas/Address' "404": description: Unable to obtain address details. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /addresses/isVerifiedRequest: post: - operationId: isAddressVerified description: Indicates whether a given address is already verified. + operationId: isAddressVerified requestBody: - required: true content: application/json: schema: $ref: '#/components/schemas/Address' + required: true responses: "200": - description: Successful response. + description: Successful response "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "404": description: Address is no longer verified. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /addresses/verificationRequest: post: + description: "Normalizes, verifies, and provides a more complete address. The\ + \ verified address may include additional address properties. The response\ + \ either returns one or more addresses that match the given address, or it\ + \ will return an error if the address cannot be verified. If more than one\ + \ address is returned, select an address and then resubmit the API request\ + \ to perform address verification on the selected address." operationId: verifyAddress - description: Normalizes, verifies, and provides a more complete address. The verified address may include additional address properties. The response either returns one or more addresses that match the given address, or it will return an error if the address cannot be verified. If more than one address is returned, select an address and then resubmit the API request to perform address verification on the selected address. parameters: - - in: query - name: addressType - schema: - type: string - enum: - - Combined - - Uncombined - default: Combined - description: Indicates the requested format of the address after verification. Uncombined returns the street address in components. The default is Combined. + - name: addressType + in: query + description: Indicates the requested format of the address after verification. + Uncombined returns the street address in components. The default is Combined + required: false + style: form + explode: true + schema: + type: string + default: Combined + enum: + - Combined + - Uncombined requestBody: - required: true content: application/json: schema: $ref: '#/components/schemas/ListAddress' + required: true responses: "200": - description: Successful response. + description: Successful response "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "404": description: Address is no longer verified. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications: get: - operationId: getQuotes description: Returns a list of quotes or applications. + operationId: getQuotes parameters: - - in: query - name: applicationOrQuoteNumber - description: Application or quote number. - schema: - type: string - - in: query - name: continuationId - description: Indicates the starting offset for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, the limit on your first API call was 100 and the results populated a list on the page. To request the next page of 100 results, call the API again with continuationId=101 and limit=100. - schema: - type: string - - in: query - name: createdSinceDate - description: Select applications where application creation date is equal to or greater than the provided createdSinceDate. - schema: - type: string - - in: query - name: customerId - description: Customer ID number. - schema: - type: string - - in: query - name: includeClosed - description: Includes closed applications. If true, results will include "Closed" applications. If false (or not provided), results will not include "Closed" applications. - schema: - type: boolean - - in: query - name: includeDeleted - description: Includes deleted applications. If true, results will include "Deleted" applications. If false (or not provided), results will not include "Deleted" applications. - schema: - type: boolean - - in: query - name: limit - description: The maximum number of results to return. - schema: - type: string - - in: query - name: optionalFields - description: Comma-delimited list of optional fields to be included. Currently supports customer and product. - schema: - type: string - - in: query - name: policyId - description: Policy ID. - schema: - type: string - - in: query - name: providerId - description: Provider code number. - schema: - type: string - - in: query - name: recentlyViewed - description: Finds applications recently viewed by the caller/user. If true, results will be restricted to applications recently viewed by the caller/user. If false (or not provided), results will not be restricted to applications recently viewed by the caller/user. - schema: - type: boolean - - in: query - name: status - description: Application status (e.g. In Process). - schema: - type: string - - in: query - name: transactionCd - description: Transaction code (e.g. New Business) Use where a specific transactionCd(s) is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup contains a value. - schema: - type: string - - in: query - name: transactionCdGroup - description: Find applications by transactionCdGroup. Use when a specific transactionCd(s) is not known. Accepts a comma-separated list of values. Valid values are Quote, Cancellation, Renewal, or Other. - schema: - type: string - - in: query - name: type - description: Application type. Valid values are Application, QuickQuote, or Quote. - schema: - type: string + - name: applicationOrQuoteNumber + in: query + description: Application or quote number + required: false + style: form + explode: true + schema: + type: string + - name: continuationId + in: query + description: "Indicates the starting offset for the API results when you want\ + \ to return a specific portion of the full results. You can use this parameter\ + \ with the limit parameter. For example, the limit on your first API call\ + \ was 100 and the results populated a list on the page. To request the next\ + \ page of 100 results, call the API again with continuationId=101 and limit=100" + required: false + style: form + explode: true + schema: + type: string + - name: createdSinceDate + in: query + description: Select applications where application creation date is equal + to or greater than the provided createdSinceDate + required: false + style: form + explode: true + schema: + type: string + - name: customerId + in: query + description: Customer ID number + required: false + style: form + explode: true + schema: + type: string + - name: includeClosed + in: query + description: "Includes closed applications. If true, results will include\ + \ \"Closed\" applications. If false (or not provided), results will not\ + \ include \"Closed\" applications" + required: false + style: form + explode: true + schema: + type: boolean + - name: includeDeleted + in: query + description: "Includes deleted applications. If true, results will include\ + \ \"Deleted\" applications. If false (or not provided), results will not\ + \ include \"Deleted\" applications" + required: false + style: form + explode: true + schema: + type: boolean + - name: limit + in: query + description: The maximum number of results to return + required: false + style: form + explode: true + schema: + type: string + - name: optionalFields + in: query + description: Comma-delimited list of optional fields to be included. Currently + supports customer and product + required: false + style: form + explode: true + schema: + type: string + - name: policyId + in: query + description: Policy ID + required: false + style: form + explode: true + schema: + type: string + - name: providerId + in: query + description: Provider code number + required: false + style: form + explode: true + schema: + type: string + - name: recentlyViewed + in: query + description: "Finds applications recently viewed by the caller/user. If true,\ + \ results will be restricted to applications recently viewed by the caller/user.\ + \ If false (or not provided), results will not be restricted to applications\ + \ recently viewed by the caller/user" + required: false + style: form + explode: true + schema: + type: boolean + - name: status + in: query + description: Application status (e.g. In Process) + required: false + style: form + explode: true + schema: + type: string + - name: transactionCd + in: query + description: Transaction code (e.g. New Business) Use where a specific transactionCd(s) + is known. Accepts a comma-separated list of values. Ignored when transactionCdGroup + contains a value + required: false + style: form + explode: true + schema: + type: string + - name: transactionCdGroup + in: query + description: "Find applications by transactionCdGroup. Use when a specific\ + \ transactionCd(s) is not known. Accepts a comma-separated list of values.\ + \ Valid values are Quote, Cancellation, Renewal, or Other" + required: false + style: form + explode: true + schema: + type: string + - name: type + in: query + description: "Application type. Valid values are Application, QuickQuote,\ + \ or Quote" + required: false + style: form + explode: true + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListApplication" + $ref: '#/components/schemas/ListApplication' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' post: + description: "Starts a new QuickQuote or Quote. To create a QuickQuote, basicPolicy\ + \ productVersionIdRef (e.g. Homeowners-1.00.00), providerRef (e.g. 19), and\ + \ effectiveDt strings are required. To create a Quote, basicPolicy productVersionIdRef,\ + \ providerRef, and effectiveDt strings, plus one piece of insured information\ + \ to create a customer, are required." operationId: createQuote - description: Starts a new QuickQuote or Quote. To create a QuickQuote, basicPolicy productVersionIdRef (e.g. Homeowners-1.00.00), providerRef (e.g. 19), and effectiveDt strings are required. To create a Quote, basicPolicy productVersionIdRef, providerRef, and effectiveDt strings, plus one piece of insured information to create a customer, are required. parameters: - - in: query - name: requestedTypeCd - description: Starts a quote of the specified type. Valid values are QuickQuote or Quote. If a type is not specified, a QuickQuote will be created if the selected product supports quick quotes and you can perform quick quotes; otherwise, a Quote will be created. If QuickQuote is specified but the selected product does not support quick quotes or you cannot perform quick quotes, then either a 400 or 403 response code will be returned. - schema: - type: string + - name: requestedTypeCd + in: query + description: "Starts a quote of the specified type. Valid values are QuickQuote\ + \ or Quote. If a type is not specified, a QuickQuote will be created if\ + \ the selected product supports quick quotes and you can perform quick quotes;\ + \ otherwise, a Quote will be created. If QuickQuote is specified but the\ + \ selected product does not support quick quotes or you cannot perform quick\ + \ quotes, then either a 400 or 403 response code will be returned" + required: false + style: form + explode: true + schema: + type: string requestBody: - required: true content: application/json: schema: $ref: '#/components/schemas/Quote' + required: true responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}: delete: - operationId: deleteQuote description: Delete the quote or application. + operationId: deleteQuote parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the quote or application + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/bindRequest: post: - operationId: convertQuoteToApplication description: Converts a quote to an application. + operationId: convertQuoteToApplication parameters: - - in: path - name: systemId - description: System identifier of the quote. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the quote + required: true + style: simple + explode: false + schema: + type: string responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/convertToQuoteRequest: post: - operationId: convertQuickQuoteToQuote description: Converts a QuickQuote to a Quote. + operationId: convertQuickQuoteToQuote parameters: - - in: path - name: systemId - description: System identifier of the quote. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the quote + required: true + style: simple + explode: false + schema: + type: string responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/documents: get: - operationId: getDocumentsForQuote description: Returns a list of documents for a quote or application. + operationId: getDocumentsForQuote parameters: - - in: path - name: systemId - description: System identifier of the application. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the application + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListDocument" + $ref: '#/components/schemas/ListDocument' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' post: - operationId: addDocumentToQuote description: Adds an attachment to a quote or application. + operationId: addDocumentToQuote parameters: - - in: path - name: systemId - description: System identifier of the application. - schema: - type: string - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the application required: true + style: simple + explode: false + schema: + type: string + requestBody: content: application/json: schema: $ref: '#/components/schemas/Attachment' + required: true responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/documents/{documentId}: delete: + description: Deletes an attachment associated with a quote or application. Requires + the attachment ref number (e.g. "Attachment-26808155-290885540"). operationId: deleteAttachment - description: Deletes an attachment associated with a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540"). parameters: - - in: path - name: systemId - description: System identifier of the application. - schema: - type: string - required: true - - in: path - name: documentId - description: The identifier of the document. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the application + required: true + style: simple + explode: false + schema: + type: string + - name: documentId + in: path + description: The identifier of the document + required: true + style: simple + explode: false + schema: + type: string responses: "204": - description: Successful response. + description: Successful response "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/documents/{documentId}/content: get: + description: Downloads a document for a quote or application. Requires the attachment + ref number (e.g. "Attachment-26808155-290885540"). operationId: downloadAttachment - description: Downloads a document for a quote or application. Requires the attachment ref number (e.g. "Attachment-26808155-290885540"). parameters: - - in: path - name: systemId - description: System identifier of the application. - schema: - type: string - required: true - - in: path - name: documentId - description: The identifier of the document. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the application + required: true + style: simple + explode: false + schema: + type: string + - name: documentId + in: path + description: The identifier of the document + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/octet-stream: schema: @@ -528,3266 +657,4238 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/drivers: get: - operationId: getDrivers description: Returns a list of the drivers or non-drivers of a quote or application. + operationId: getDrivers parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - - in: query - name: continuationId - schema: - type: string - description: Indicates the starting offset for the API results when you want to return a specific portion of the full results. - - in: query - name: includeDeleted - schema: - type: boolean - description: Includes deleted drivers/non-drivers. If true, results will include "Deleted" drivers/non-drivers. If false (or not provided), results will not include "Deleted" drivers/non-drivers. - - in: query - name: limit - schema: - type: string - description: For pagination -- the maximum number of results to return. - - in: query - name: typeCd - schema: - type: string - enum: - - Driver - - NonDriver - description: Filter by type of driver. + - name: systemId + in: path + description: System identifier of the quote or application + required: true + style: simple + explode: false + schema: + type: string + - name: continuationId + in: query + description: Indicates the starting offset for the API results when you want + to return a specific portion of the full results + required: false + style: form + explode: true + schema: + type: string + - name: includeDeleted + in: query + description: "Includes deleted drivers/non-drivers. If true, results will\ + \ include \"Deleted\" drivers/non-drivers. If false (or not provided), results\ + \ will not include \"Deleted\" drivers/non-drivers" + required: false + style: form + explode: true + schema: + type: boolean + - name: limit + in: query + description: For pagination -- the maximum number of results to return + required: false + style: form + explode: true + schema: + type: string + - name: typeCd + in: query + description: Filter by type of driver + required: false + style: form + explode: true + schema: + type: string + enum: + - Driver + - NonDriver responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListDriver" + $ref: '#/components/schemas/ListDriver' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' post: + description: Creates a new driver or non-driver. You must include a partyTypeCd + (DriverParty or NonDriverParty). Other details may be required depending on + the insurance product being quoted. operationId: createDriver - description: Creates a new driver or non-driver. You must include a partyTypeCd (DriverParty or NonDriverParty). Other details may be required depending on the insurance product being quoted. parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the quote or application required: true + style: simple + explode: false + schema: + type: string + requestBody: content: application/json: schema: $ref: '#/components/schemas/Driver' + required: true responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /applications/{systemId}/drivers/{driverNumber}: get: - operationId: getDriver description: Returns details about a driver or non-driver. + operationId: getDriver parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - - in: path - name: driverNumber - description: Driver/non-driver number. - schema: - type: integer - format: int32 - required: true + - name: systemId + in: path + description: System identifier of the quote or application + required: true + style: simple + explode: false + schema: + type: string + - name: driverNumber + in: path + description: Driver/non-driver number + required: true + style: simple + explode: false + schema: + type: integer + format: int32 responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/Driver" + $ref: '#/components/schemas/Driver' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" - patch: - operationId: changeDriverDetails - description: Makes changes to details about a driver/non-driver. + $ref: '#/components/schemas/Error' + put: + description: Replaces the details about a driver or non-driver. + operationId: replaceDriverDetails parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - - in: path - name: driverNumber - description: Driver/non-driver number. - schema: - type: integer - format: int32 - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the quote or application + required: true + style: simple + explode: false + schema: + type: string + - name: driverNumber + in: path + description: Driver/non-driver number required: true + style: simple + explode: false + schema: + type: integer + format: int32 + requestBody: content: application/json: schema: $ref: '#/components/schemas/Driver' + required: true responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/Driver" + $ref: '#/components/schemas/Driver' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" - put: - operationId: replaceDriverDetails - description: Replaces the details about a driver or non-driver. + $ref: '#/components/schemas/Error' + delete: + description: Deletes a driver/non-driver. + operationId: deleteDriver parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - - in: path - name: driverNumber - description: Driver/non-driver number. - schema: - type: integer - format: int32 - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the quote or application required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Driver' + style: simple + explode: false + schema: + type: string + - name: driverNumber + in: path + description: Driver/non-driver number + required: true + style: simple + explode: false + schema: + type: integer + format: int32 responses: "200": - description: Successful response. - content: - application/json: - schema: - $ref: "#/components/schemas/Driver" + description: Successful response "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" - delete: - operationId: deleteDriver - description: Deletes a driver/non-driver. + $ref: '#/components/schemas/Error' + patch: + description: Makes changes to details about a driver/non-driver. + operationId: changeDriverDetails parameters: - - in: path - name: systemId - description: System identifier of the quote or application. - schema: - type: string - required: true - - in: path - name: driverNumber - description: Driver/non-driver number. - schema: - type: integer - format: int32 - required: true + - name: systemId + in: path + description: System identifier of the quote or application + required: true + style: simple + explode: false + schema: + type: string + - name: driverNumber + in: path + description: Driver/non-driver number + required: true + style: simple + explode: false + schema: + type: integer + format: int32 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Driver' + required: true responses: "200": - description: Successful response. + description: Successful response + content: + application/json: + schema: + $ref: '#/components/schemas/Driver' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /claims/{systemId}/documents: get: - operationId: getDocumentsForClaim description: Returns the list of documents attached to a claim. + operationId: getDocumentsForClaim parameters: - - in: path - name: systemId - description: System identifier of the claim. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the claim + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListDocument" + $ref: '#/components/schemas/ListDocument' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' post: - operationId: addAttachmentToClaim description: Adds an attachment to a claim. + operationId: addAttachmentToClaim parameters: - - in: path - name: systemId - description: System identifier of the claim. - schema: - type: string - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the claim required: true + style: simple + explode: false + schema: + type: string + requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentDetail' + required: true responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /claims/{systemId}/notes: get: - operationId: getClaimNotes description: Returns a list of notes for a claim. + operationId: getClaimNotes parameters: - - in: path - name: systemId - description: System identifier of the claim. - schema: - type: string - required: true + - name: systemId + in: path + description: System identifier of the claim + required: true + style: simple + explode: false + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListNote" + $ref: '#/components/schemas/ListNote' "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' post: - operationId: addNoteToClaim description: Adds a note to a claim. + operationId: addNoteToClaim parameters: - - in: path - name: systemId - description: System identifier of the claim. - schema: - type: string - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the claim required: true + style: simple + explode: false + schema: + type: string + requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteDetail' + required: true responses: "201": - description: Successful response. + description: Successful response headers: Location: + description: Updated resource's location. + style: simple + explode: false schema: type: string - description: Updated resource's location. "400": description: Error with the submitted request. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected internal error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /policies: get: - operationId: getPolicies description: Returns a list of policies. + operationId: getPolicies parameters: - - in: query - name: continuationId - description: Indicates the starting list value for the API results when you want to return a specific portion of the full results. You can use this parameter with the limit parameter. For example, if the limit on your first API call was 10 and the results populated a list on the page. To request the next page of 10 results, call the API again with continuationId=11 and limit=10. - schema: - type: string - - in: query - name: createdSinceDate - description: Selects policies where policy creation date is equal to or greater than the provided createdSinceDate (e.g. 2020-01-01). - schema: - type: string - - in: query - name: customerId - description: Finds policies by customer id (e.g. 212). - schema: - type: string - - in: query - name: expiredDateAfter - description: Selects policies where policy expiration date is equal to or lesser than the provided expirationDateBefore (e.g. 2020-01-01). - schema: - type: string - - in: query - name: includePriorTerms - description: Includes prior terms.If true, results will include prior terms. If false (or not provided), results will not include prior terms. - schema: - type: boolean - - in: query - name: limit - description: Indicates how many results to return. - schema: - type: string - - in: query - name: optionalFields - description: Comma-delimited list of optional fields to be included. Currently supports customer and product. - schema: - type: string - - in: query - name: policyNumber - description: Finds policies by policyNumber (e.g. HO00000058). - schema: - type: string - - in: query - name: providerRef - description: Filters policies by provider identifier (e.g. 28). - schema: - type: string - - in: query - name: recentlyViewed - description: Limits policies to those recently viewed by the caller or user. If true, results will be restricted to policies recently viewed by the caller or user. If false (or not provided), results will not be restricted to policies recently viewed by the caller or user. - schema: - type: boolean - - in: query - name: status - description: Finds policies by policy status (e.g Active). - schema: - type: string + - name: continuationId + in: query + description: "Indicates the starting list value for the API results when you\ + \ want to return a specific portion of the full results. You can use this\ + \ parameter with the limit parameter. For example, if the limit on your\ + \ first API call was 10 and the results populated a list on the page. To\ + \ request the next page of 10 results, call the API again with continuationId=11\ + \ and limit=10" + required: false + style: form + explode: true + schema: + type: string + - name: createdSinceDate + in: query + description: Selects policies where policy creation date is equal to or greater + than the provided createdSinceDate (e.g. 2020-01-01) + required: false + style: form + explode: true + schema: + type: string + - name: customerId + in: query + description: Finds policies by customer id (e.g. 212) + required: false + style: form + explode: true + schema: + type: string + - name: expiredDateAfter + in: query + description: Selects policies where policy expiration date is equal to or + lesser than the provided expirationDateBefore (e.g. 2020-01-01) + required: false + style: form + explode: true + schema: + type: string + - name: includePriorTerms + in: query + description: "Includes prior terms.If true, results will include prior terms.\ + \ If false (or not provided), results will not include prior terms" + required: false + style: form + explode: true + schema: + type: boolean + - name: limit + in: query + description: Indicates how many results to return + required: false + style: form + explode: true + schema: + type: string + - name: optionalFields + in: query + description: Comma-delimited list of optional fields to be included. Currently + supports customer and product + required: false + style: form + explode: true + schema: + type: string + - name: policyNumber + in: query + description: Finds policies by policyNumber (e.g. HO00000058) + required: false + style: form + explode: true + schema: + type: string + - name: providerRef + in: query + description: Filters policies by provider identifier (e.g. 28) + required: false + style: form + explode: true + schema: + type: string + - name: recentlyViewed + in: query + description: "Limits policies to those recently viewed by the caller or user.\ + \ If true, results will be restricted to policies recently viewed by the\ + \ caller or user. If false (or not provided), results will not be restricted\ + \ to policies recently viewed by the caller or user" + required: false + style: form + explode: true + schema: + type: boolean + - name: status + in: query + description: Finds policies by policy status (e.g Active) + required: false + style: form + explode: true + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/ListPolicy" + $ref: '#/components/schemas/ListPolicy' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' /policies/{systemId}: get: - operationId: getPolicy description: Returns the full details of a policy. + operationId: getPolicy parameters: - - in: path - name: systemId - description: System identifier of the policy. - schema: - type: string - required: true - - in: query - name: asOfDate - description: Returns the policy details from a specified date (e.g. 2021-01-01). If not provided, the current date will be used. - schema: - type: string + - name: systemId + in: path + description: System identifier of the policy + required: true + style: simple + explode: false + schema: + type: string + - name: asOfDate + in: query + description: "Returns the policy details from a specified date (e.g. 2021-01-01).\ + \ If not provided, the current date will be used" + required: false + style: form + explode: true + schema: + type: string responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/PolicyDetails" + $ref: '#/components/schemas/PolicyDetails' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' patch: + description: Updates the preferred delivery method and insured email address + of the policy. Requires the systemId. operationId: updatePolicy - description: Updates the preferred delivery method and insured email address of the policy. Requires the systemId. parameters: - - in: path - name: systemId - description: System identifier of the policy. - schema: - type: string - required: true - requestBody: + - name: systemId + in: path + description: System identifier of the policy required: true + style: simple + explode: false + schema: + type: string + requestBody: content: application/json: schema: $ref: '#/components/schemas/PolicyDetails' + required: true responses: "200": - description: Successful response. + description: Successful response content: application/json: schema: - $ref: "#/components/schemas/PolicyDetails" + $ref: '#/components/schemas/PolicyDetails' "400": description: Invalid request or response. content: application/json: schema: - $ref: "#/components/schemas/Error" + $ref: '#/components/schemas/Error' "500": description: Unexpected error. content: application/json: schema: - $ref: "#/components/schemas/Error" - + $ref: '#/components/schemas/Error' components: schemas: - ListCountry: - description: "A structured response that enumerates all countries supported by the system. This can be used to populate selection lists or validate country data in user inputs." + Policy: type: object properties: - countries: - description: "An array of country objects, each representing a country supported by the system. This list includes both the ISO code and the name of each country." - items: - $ref: "#/components/schemas/Country" + policyMini: + $ref: '#/components/schemas/PolicyMini' + ref: + type: string + description: "A general reference identifier for the policy item, usable\ + \ for cross-referencing or linkage" + _links: type: array - required: - - countries - Country: - description: "Contains detailed information about a single country, including its ISO code and the full country name. This schema is crucial for ensuring accurate country representation and selection across the application." + description: "Hypermedia links associated with the policy item, providing\ + \ navigational URLs to related resources" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + customerInfo: + $ref: '#/components/schemas/CustomerInfo' + productInfo: + $ref: '#/components/schemas/ProductInfo' + description: "Represents a comprehensive view of an insurance policy, including\ + \ customer details, policy specifics, associated contacts, and system references.\ + \ It's designed to encapsulate all relevant information about a policy, facilitating\ + \ easy access and management within the system" + Issue: type: object properties: - isoCd: - description: "The ISO 3166-1 alpha-2 code of the country, providing a two-letter code that is universally recognized for representing country names." + msg: type: string - name: - description: "The official name of the country as recognized internationally. This name is used for display purposes and in user interfaces." + description: "A descriptive message or summary of the issue, offering insight\ + \ into the nature and potential impact of the problem" + attributeRefs: + type: array + description: "A collection of references to attributes associated with the\ + \ issue, providing context and details that may aid in issue analysis\ + \ and resolution" + items: + $ref: '#/components/schemas/AttributeRef' + typeCd: type: string - AddressCountryTemplate: - description: "Defines the template for constructing and validating addresses within a specific country. This schema includes details like the required fields, address format, and labels for various address components, tailored to the country's postal system." + description: "The primary classification code of the issue, indicating its\ + \ general category and facilitating appropriate routing and response strategies" + subTypeCd: + type: string + description: "A code further categorizing the issue within its broader type,\ + \ allowing for more granular classification and handling" + id: + type: string + description: "A unique identifier for the issue, enabling tracking and management\ + \ within the system" + description: "Defines an issue related to an entity within the system, capturing\ + \ details such as the type of issue, associated attributes, and descriptive\ + \ messages to aid in identification and resolution" + PersonInfo: type: object properties: - addressLines: - type: string - description: "Indicates the number of address lines that are supported or required by the address format of this country." - addressStateProvinceTemplates: - $ref: "#/components/schemas/AddressStateProvinceTemplates" - description: "A reference to the schema defining templates for state or province addresses within this country, accommodating regional variations in address formats." - cityLabel: + yearsLicensed: + type: integer + description: "The total number of years the individual has been licensed\ + \ to drive, a direct measure of driving experience" + birthDt: type: string - description: "The label used for the city field in address forms, which may vary based on the country's addressing system." - countryName: + description: "The individual’s date of birth, in a standard format such\ + \ as ISO 8601, foundational for many aspects of insurance processing and\ + \ decision-making" + positionTitle: type: string - description: "The full name of the country to which this address template applies, ensuring clarity and consistency in international addressing." - format: + description: "The professional title or role of the individual within their\ + \ place of employment, relevant for understanding socioeconomic factors\ + \ and occupational risks" + bestTimeToContact: type: string - description: "Specifies the format used for addresses in this country, including the order of address components and the separators used between them." - id: + description: "Preferred time for contacting the individual, ensuring communications\ + \ are made at convenient times, enhancing customer service" + ageLicensed: + type: integer + description: "The age at which the individual was first licensed to drive,\ + \ providing insight into driving experience and proficiency" + maritalStatusCd: type: string - description: "A unique identifier for the template, typically using the two-letter ISO country code for easy reference." - postalCodeExamples: + description: "A code indicating the marital status of the individual, which\ + \ can be a factor in policy rates and coverage options" + bestWayToContact: type: string - description: "Provides examples of valid postal or zip codes for the country, useful as a guide for users when entering address information." - postalCodeLabel: + description: "Preferred method of contact (e.g., email, phone, text), allowing\ + \ for personalized communication strategies" + genderCd: type: string - description: "The label used for the postal or zip code field, which may be customized based on the country's postal system terminology." - postalCodeRegex: + description: "The individual's gender as officially recorded, relevant in\ + \ contexts where gender may impact insurance analytics or product offerings" + employerCd: type: string - description: "A regular expression pattern used to validate the format of postal or zip codes for addresses in this country, ensuring data accuracy and compliance with local postal standards." - requiredFields: + description: "A code identifying the individual’s employer, useful in policies\ + \ where employment status or employer partnerships affect coverage options" + educationCd: type: string - description: "A comma-separated list of address fields that are mandatory for this country, allowing for dynamic form validation that adapts to different countries' addressing requirements." - stateProvLabel: + description: "A code representing the highest level of education attained\ + \ by the individual, which may influence insurance rates or eligibility\ + \ for certain benefits" + personTypeCd: type: string - description: "The label for the state or province field in address forms, accommodating the terminology used in the country's addressing system." - AddressStateProvinceTemplates: - description: "Provides a structured format for representing state or province information associated with addresses, facilitating consistency and accuracy in address data across various geographic locations." - type: object - properties: - stateProvinces: - type: array - description: "A collection of state or province entities, each conforming to the defined StateProvinces schema, allowing for detailed representation of geographic administrative divisions." - items: - $ref: "#/components/schemas/StateProvinces" - StateProvinces: - description: "Defines the attributes of a state or province, providing key identifiers and names for use in addressing and location services within the insurance application." - type: object - properties: + description: "Indicates the context or category of personal information\ + \ provided, with 'ContactPersonal' denoting a direct, personal contact\ + \ type" + default: ContactPersonal id: type: string - description: "The unique identifier or code for the state or province, often used as a standard abbreviation or code in address formats." - stateProvName: + description: "A unique identifier for the person's information record, ensuring\ + \ accurate tracking and updating of personal details within the system" + age: + type: integer + description: "The current age of the individual, crucial for assessing eligibility\ + \ and risk factors for certain insurance products" + occupationCd: type: string - description: "The full name of the state or province, providing a clear and unambiguous reference for users and systems interacting with address information." - ListAddress: - description: "A structured response payload containing an array of addresses. This schema facilitates the return of multiple address records in a single API response, typically used in search or list endpoints where multiple addresses need to be communicated." - type: object - properties: - addresses: - type: array - description: "An array of Address objects, each representing detailed information about a specific address. The structure of each Address object is defined by the Address schema." - items: - $ref: '#/components/schemas/Address' - Address: - description: "Comprehensive details about an address, encapsulating both the physical location attributes and metadata for validation, geocoding, and postal delivery optimization." + description: "A code that classifies the individual's occupation, providing\ + \ risk assessment data and potential eligibility for occupation-based\ + \ discounts" + occupationClassCd: + type: string + description: "Further classification of the individual’s occupation, offering\ + \ nuanced insight into professional risks and coverage needs" + description: "Encapsulates a comprehensive set of personal details for an individual,\ + \ covering demographic information, contact preferences, professional background,\ + \ and licensing history, facilitating tailored interactions and personalized\ + \ insurance services" + BusinessInfo: type: object properties: - addition: + yearsInBusiness: type: string - description: "Additional detail to further specify the location within complex addresses, such as unit or apartment number." - additionalLegal: + description: "The total number of years the business has been operational,\ + \ indicating stability and experience in its field" + businessTypeCd: type: string - description: "Any legal descriptors that provide further detail to the address, often used in legal contexts or when precise property identification is necessary." - addr1: + description: "A code indicating the type of business, such as corporation,\ + \ sole proprietorship, or partnership, relevant for underwriting and policy\ + \ customization" + natureBusinessCd: type: string - description: "The primary address line, typically containing the street number and name." - addr2: + description: "A code describing the nature of the business, used for classification\ + \ and risk assessment purposes" + numberEmployees: type: string - description: "Secondary address line, used for additional location information, such as building or suite number." - addr3: + description: "The number of employees working for the business, impacting\ + \ liability exposures and coverage requirements" + annualPayrollAmt: type: string - description: "Tertiary address line for further detail, less commonly used." - addr4: + description: "The total amount of payroll paid annually by the business,\ + \ a factor in workers' compensation and liability coverages" + annualSalesAmt: type: string - description: "Quaternary address line, utilized in complex addressing scenarios where multiple lines are needed for clarity." - addrTypeCd: + description: "The total annual sales or revenue generated by the business,\ + \ influencing coverage needs and premium calculations" + businessInfoCd: type: string - default: "ContactAddr" - description: "A code indicating the type of address, such as 'ContactAddr' for a primary contact address." - addressHash: + description: A code categorizing the business information record for internal + tracking and management + id: type: string - description: "A unique hash value representing the address, used for identifying and detecting changes to address data." - attention: + description: "A unique identifier for the business information record within\ + \ the system, facilitating accurate reference and management" + natureOfBusiness: type: string - description: "Designates a specific individual or department at the address for targeted delivery." - barcodeDigits: + description: "A textual description of the business's primary operations,\ + \ providing context for underwriting and coverage considerations" + description: "Details the business-related aspects of a party, including financial,\ + \ operational, and classification information, tailored for commercial insurance\ + \ contexts" + PolicyMini: + type: object + properties: + systemId: type: string - description: "Numeric representation of the postal barcode associated with the address, used for mail sorting and delivery." - block: + description: "System identifier that manages or tracks the policy, indicating\ + \ the source or platform of policy management" + externalSystemInd: type: string - description: "The block number or identifier, relevant in urban planning and real estate contexts." - carrierRoute: + description: "Indicator for the association of the policy with an external\ + \ system, highlighting integrations or external dependencies" + insured: + $ref: '#/components/schemas/Insured' + statementAccountRef: type: string - description: "A postal service designation indicating the specific route for mail delivery, comprising a type and code." - city: + description: "Reference to the statement account related to the policy,\ + \ used for financial transactions and billing" + _links: + type: array + description: "A collection of hypermedia links to related resources, facilitating\ + \ navigation and further actions" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + version: type: string - description: "The city or town associated with the address." - congressCode: + description: "Version identifier for the policy information, denoting the\ + \ format or structure level of the policy data" + vipLevel: type: string - description: "Identifies the congressional district in which the address is located, relevant for political and demographic purposes." - county: + description: "Indicates the VIP level of the policy or associated customer,\ + \ used for service prioritization or benefits" + basicPolicy: + $ref: '#/components/schemas/BasicPolicy' + customerRef: type: string - description: "The county in which the address resides, providing an additional layer of geographic specificity." - countyCode: + description: "A reference to the customer associated with the policy, enabling\ + \ linkage to detailed customer information" + accountRef: type: string - description: "A specific code assigned to the county, used for administrative and geographic classification." - dpv: + description: "Reference identifier to the account associated with this policy,\ + \ linking to account-specific details" + id: type: string - description: "Delivery Point Validation code, indicating the deliverability status of the address as per postal service validation." - dpvDesc: + description: "Unique identifier for the policy, facilitating identification\ + \ and retrieval within the system" + auditAccountRef: type: string - description: "A textual description of the Delivery Point Validation code, offering insights into mail delivery capabilities." - dpvNotes: + description: "Reference to the audit account, if applicable, providing a\ + \ connection to audit-related information and actions" + iVANSCheck: type: string - description: "Additional notes from the Delivery Point Validation process, highlighting specific issues or considerations." - dpvNotesDesc: + description: "Result or status from an IVANS insurance verification process,\ + \ reflecting verification outcomes" + contacts: + type: array + description: "An array of contacts related to the policy, detailing individuals\ + \ or entities associated in various capacities" + items: + $ref: '#/components/schemas/Contact' + description: "Provides a condensed overview of policy information, including\ + \ key attributes and links for deeper exploration" + Address: + required: + - addr1 + - addrTypeCd + - city + - id + - postalCd + - regionCd + - regionISOCd + - stateProvCd + - verificationHash + type: object + properties: + verificationHash: type: string - description: "Descriptive elaboration on the DPV notes, providing context and explanations for validation outcomes." - geocodeLevel: + description: A cryptographic hash value generated from the address details. + This hash is used to ensure the integrity of the address data and to verify + that no changes have occurred since the last validation + rangeDir: type: string - description: "Indicates the precision of geocoding for the address, such as 'street' or 'postal code' level." - geocodeLevelDescription: + description: "Directional indicator for the range, providing spatial orientation\ + \ in rural addressing schemes" + postDirectional: type: string - description: "Narrative description of the geocode level, explaining the extent of location accuracy achieved." - id: + description: "A directional suffix in an address, specifying the compass\ + \ point after the street name, for geographical clarity" + legalDesc: type: string - description: "A unique identifier for the address within the system, used for tracking and reference." - latitude: + description: "A legal narrative description of the property associated with\ + \ the address, used in formal documentation and contracts" + primaryMeridian: type: string - description: "The latitude coordinate of the address, resulting from geocoding processes." - legalDesc: + description: "Specifies the primary meridian reference, important in certain\ + \ legal and surveying contexts" + postalCode: type: string - description: "A legal narrative description of the property associated with the address, used in formal documentation and contracts." - longitude: + description: "The ZIP or postal code, crucial for mail sorting, delivery,\ + \ and regional identification" + county: type: string - description: "The longitude coordinate of the address, resulting from geocoding processes." - lot: + description: "The county in which the address resides, providing an additional\ + \ layer of geographic specificity" + section: type: string - description: "Identifies the specific lot within a subdivision or development, relevant in property identification." - meridian: + description: "Designates a specific section within the Public Land Survey\ + \ System (PLSS) or a similar land division system, providing additional\ + \ precision to rural and agricultural property locations" + suffix: type: string - description: "Refers to the principal meridian used in surveying and legal descriptions within the region of the address." - plssCounty: + description: "A suffix indicating the type or category of the street or\ + \ thoroughfare, such as Road, Avenue, Circle, etc., providing additional\ + \ context to the street name" + score: type: string - description: "Indicates the Public Land Survey System (PLSS) county code, relevant in the United States for land division and legal descriptions." - postDirectional: + description: "A numerical score representing the accuracy of the address\ + \ verification, where higher scores indicate higher confidence levels" + block: type: string - description: "A directional suffix in an address, specifying the compass point after the street name, for geographical clarity." - postalCode: + description: "The block number or identifier, relevant in urban planning\ + \ and real estate contexts" + id: type: string - description: "The ZIP or postal code, crucial for mail sorting, delivery, and regional identification." - preDirectional: + description: "A unique identifier for the address within the system, used\ + \ for tracking and reference" + addition: type: string - description: "A directional prefix in an address, specifying the compass point before the street name, enhancing locational accuracy." - primaryMeridian: + description: "Additional detail to further specify the location within complex\ + \ addresses, such as unit or apartment number" + longitude: type: string - description: "Specifies the primary meridian reference, important in certain legal and surveying contexts." - primaryNumber: + description: "The longitude coordinate of the address, resulting from geocoding\ + \ processes" + secondaryNumber: type: string - description: "The number assigned to the building or property within the street, fundamental for address identification." - primaryNumberSuffix: + description: "The specific number or identifier of the unit within a larger\ + \ building, essential for accurate mail delivery to multi-unit locations" + barcodeDigits: type: string - description: "A suffix to the primary number, providing additional specificity, such as indicating a range of units." - range: + description: "Numeric representation of the postal barcode associated with\ + \ the address, used for mail sorting and delivery" + geocodeLevel: type: string - description: "Specifies the range for rural or agricultural properties, often used in conjunction with township and section." - rangeDir: + description: "Indicates the precision of geocoding for the address, such\ + \ as 'street' or 'postal code' level" + primaryNumber: type: string - description: "Directional indicator for the range, providing spatial orientation in rural addressing schemes." + description: "The number assigned to the building or property within the\ + \ street, fundamental for address identification" regionCd: type: string - description: "The full name of the country or major administrative region for the address." - regionISOCd: + description: The full name of the country or major administrative region + for the address + addrTypeCd: type: string - description: "The ISO Alpha-2 country code, standardizing country identification across international systems." - score: + description: "A code indicating the type of address, such as 'ContactAddr'\ + \ for a primary contact address" + default: ContactAddr + townshipDir: type: string - description: "A numerical score representing the accuracy of the address verification, where higher scores indicate higher confidence levels." - secondaryDesignator: + description: "Directional indicator associated with the township, aiding\ + \ in the geographical orientation and precise location of properties within\ + \ larger rural or unincorporated areas" + dpvDesc: type: string - description: "Indicates a specific unit or sub-location within a larger complex or building, such as 'Apt' or 'Suite'." - secondaryNumber: + description: "A textual description of the Delivery Point Validation code,\ + \ offering insights into mail delivery capabilities" + additionalLegal: type: string - description: "The specific number or identifier of the unit within a larger building, essential for accurate mail delivery to multi-unit locations." - section: + description: "Any legal descriptors that provide further detail to the address,\ + \ often used in legal contexts or when precise property identification\ + \ is necessary" + addressHash: type: string - description: "Designates a specific section within the Public Land Survey System (PLSS) or a similar land division system, providing additional precision to rural and agricultural property locations." - stateProvCd: + description: "A unique hash value representing the address, used for identifying\ + \ and detecting changes to address data" + dpvNotesDesc: type: string - description: "The code representing the state or province of the address. This may be an abbreviation or a full name, depending on local conventions and requirements." - streetName: + description: "Descriptive elaboration on the DPV notes, providing context\ + \ and explanations for validation outcomes" + congressCode: type: string - description: "The name of the street or thoroughfare, excluding numerical or directional prefixes and suffixes, essential for identifying the location within a city or region." - suffix: + description: "Identifies the congressional district in which the address\ + \ is located, relevant for political and demographic purposes" + city: type: string - description: "A suffix indicating the type or category of the street or thoroughfare, such as Road, Avenue, Circle, etc., providing additional context to the street name." - township: + description: The city or town associated with the address + latitude: type: string - description: "Identifies the township or equivalent jurisdictional division, used primarily in rural addressing to specify location within larger, often unincorporated, areas." - townshipDir: + description: "The latitude coordinate of the address, resulting from geocoding\ + \ processes" + primaryNumberSuffix: type: string - description: "Directional indicator associated with the township, aiding in the geographical orientation and precise location of properties within larger rural or unincorporated areas." - validated: + description: "A suffix to the primary number, providing additional specificity,\ + \ such as indicating a range of units" + carrierRoute: type: string - description: "Indicates the validation status of the address, particularly the accuracy of the township, section, and range components, confirming the address has been verified against official records or databases." - verificationHash: + description: "A postal service designation indicating the specific route\ + \ for mail delivery, comprising a type and code" + range: type: string - description: "A cryptographic hash value generated from the address details. This hash is used to ensure the integrity of the address data and to verify that no changes have occurred since the last validation." + description: "Specifies the range for rural or agricultural properties,\ + \ often used in conjunction with township and section" verificationMsg: type: string - description: "A message summarizing the outcome of the latest address verification attempt, providing insights into any discrepancies, issues, or confirmation of address accuracy." - required: - - "id" - - "addrTypeCd" - - "addr1" - - "city" - - "stateProvCd" - - "postalCd" - - "regionCd" - - "regionISOCd" - - "verificationHash" - ListDocument: - description: "Encapsulates a response structure for API calls that return multiple documents, facilitating easy access to and manipulation of a collection of documents within the system." - type: object - properties: - documentListItems: - type: array - description: "An array of Document objects, each representing detailed information about a specific document within the system." - items: - $ref: '#/components/schemas/Document' - Document: - description: "Detailed metadata and properties associated with a specific document, including access permissions, document type, and identifiers." - type: object - properties: - _links: - type: array - description: "Hypermedia links related to the document, providing navigational paths to related data and actions available for the document." - items: - $ref: '#/components/schemas/Link' - addDt: + description: "A message summarizing the outcome of the latest address verification\ + \ attempt, providing insights into any discrepancies, issues, or confirmation\ + \ of address accuracy" + secondaryDesignator: type: string - description: "The date the document was added to the system, typically in ISO 8601 format." - addTm: + description: "Indicates a specific unit or sub-location within a larger\ + \ complex or building, such as 'Apt' or 'Suite'" + lot: type: string - description: "The time the document was added to the system, often complementing the addition date for precise tracking." - addUser: + description: "Identifies the specific lot within a subdivision or development,\ + \ relevant in property identification" + streetName: type: string - description: "Identifier of the user who added the document, useful for audit trails and permissions management." - canDeleteInd: - type: boolean - description: "Indicator of whether the document can be deleted, based on current user permissions and document status." - canViewInd: - type: boolean - description: "Indicator of whether the current user has permissions to view the document, ensuring compliance with access control policies." - deliveryCd: + description: "The name of the street or thoroughfare, excluding numerical\ + \ or directional prefixes and suffixes, essential for identifying the\ + \ location within a city or region" + validated: type: string - description: "Code representing the delivery method or status of the document, such as electronic, mailed, or pending." - description: + description: "Indicates the validation status of the address, particularly\ + \ the accuracy of the township, section, and range components, confirming\ + \ the address has been verified against official records or databases" + stateProvCd: type: string - description: "A brief description or summary of the document's content or purpose, aiding in identification and categorization." - documentTypeCd: + description: "The code representing the state or province of the address.\ + \ This may be an abbreviation or a full name, depending on local conventions\ + \ and requirements" + preDirectional: type: string - description: "A code categorizing the document by type, such as policy, claim, or identification, for systematic organization." - filename: + description: "A directional prefix in an address, specifying the compass\ + \ point before the street name, enhancing locational accuracy" + regionISOCd: type: string - description: "The name of the file as stored within the system, including file extension, facilitating file retrieval and management." - formCd: + description: "The ISO Alpha-2 country code, standardizing country identification\ + \ across international systems" + addr2: type: string - description: "A code identifying the form associated with the document, relevant in contexts where documents are generated from standardized forms." - itemDescription: + description: "Secondary address line, used for additional location information,\ + \ such as building or suite number" + addr1: type: string - description: "Detailed description of the item or content covered by the document, providing additional context beyond the basic description." - itemName: + description: "The primary address line, typically containing the street\ + \ number and name" + addr4: type: string - description: "The name or title of the item or subject matter the document pertains to, offering a quick reference to the document's focus." - name: + description: "Quaternary address line, utilized in complex addressing scenarios\ + \ where multiple lines are needed for clarity" + addr3: type: string - description: "The title or name of the document, used as a primary identifier in listings and searches." - outputNumber: + description: "Tertiary address line for further detail, less commonly used" + dpv: type: string - description: "A unique number or identifier generated during the document's output or creation process, useful for tracking and reference." - ref: + description: "Delivery Point Validation code, indicating the deliverability\ + \ status of the address as per postal service validation" + geocodeLevelDescription: type: string - description: "A general reference field that could be used to link the document to other entities or identifiers within the system." - templateIdRef: + description: "Narrative description of the geocode level, explaining the\ + \ extent of location accuracy achieved" + countyCode: type: string - description: "Reference to the template used for generating the document, linking the document to its source for replication or audit purposes." - transactionNumber: + description: "A specific code assigned to the county, used for administrative\ + \ and geographic classification" + meridian: type: string - description: "A unique identifier for the transaction that resulted in the document's creation or modification, essential for traceability." - type: + description: Refers to the principal meridian used in surveying and legal + descriptions within the region of the address + attention: type: string - description: "General categorization of the document, possibly overlapping with documentTypeCd but allowing for broader classification." - Link: - description: "Represents a hypermedia link, providing navigational capabilities between related resources within the API, akin to links in web pages." + description: Designates a specific individual or department at the address + for targeted delivery + dpvNotes: + type: string + description: "Additional notes from the Delivery Point Validation process,\ + \ highlighting specific issues or considerations" + plssCounty: + type: string + description: "Indicates the Public Land Survey System (PLSS) county code,\ + \ relevant in the United States for land division and legal descriptions" + township: + type: string + description: "Identifies the township or equivalent jurisdictional division,\ + \ used primarily in rural addressing to specify location within larger,\ + \ often unincorporated, areas" + description: "Comprehensive details about an address, encapsulating both the\ + \ physical location attributes and metadata for validation, geocoding, and\ + \ postal delivery optimization" + AuditPayPlan: type: object properties: - href: + electronicPaymentSource: + $ref: '#/components/schemas/ElectronicPaymentSource' + paymentDay: type: string - description: "The absolute or relative URL pointing to the linked resource, which can be used to directly access or query the target resource." - rel: + description: "Indicates the adjusted day of the month for payment due dates\ + \ under the audited payment plan, which may have been modified from the\ + \ original schedule" + auditPayPlanCd: + type: string + description: "A code representing the specific payment plan determined as\ + \ a result of the audit, which may differ from the initial payment plan\ + \ based on actual policy performance or other factors" + id: type: string - description: "A descriptor that indicates the relationship of the linked resource to the current context, such as 'self', 'next', or specific action-related terms." + description: "A unique identifier for the audit pay plan record, ensuring\ + \ the ability to reference and apply the specific plan adjustments post-audit" + payPlanTemplateIdRef: + type: string + description: "References the template from which the audited payment plan\ + \ was derived, indicating the base plan prior to any adjustments" + description: "Defines the payment plan for a policy as adjusted following an\ + \ audit, which may result in changes to payment schedules or methods based\ + \ on the audited information" Attachment: - description: "Encapsulates details about an attachment, including files, metadata, and policies related to the retention and deletion of the attachment." type: object properties: - compositeFile: - type: array - description: "An array of file identifiers that are to be combined into this single composite attachment, facilitating document management and access." - items: - $ref: '#/components/schemas/CompositeFile' - description: + filename: type: string - description: "A user or system-provided description of the attachment, often detailing its content, purpose, or any relevant context." + description: "The storage path and unique filename under which the attachment\ + \ is saved on the server, crucial for retrieval and management" eraseInfo: $ref: '#/components/schemas/EraseInfo' - description: "Structured information detailing the conditions, methods, and policies governing the secure erasure of the attachment to comply with data protection standards." - filename: + description: + type: string + description: "A user or system-provided description of the attachment, often\ + \ detailing its content, purpose, or any relevant context" + memo: type: string - description: "The storage path and unique filename under which the attachment is saved on the server, crucial for retrieval and management." + description: "Optional user-entered notes or commentary about the attachment,\ + \ which can include usage notes, revision information, or any other pertinent\ + \ details" + compositeFile: + type: array + description: "An array of file identifiers that are to be combined into\ + \ this single composite attachment, facilitating document management and\ + \ access" + items: + $ref: '#/components/schemas/CompositeFile' id: type: string - description: "A unique identifier for the attachment, facilitating tracking, reference, and operations like update or deletion." + description: "A unique identifier for the attachment, facilitating tracking,\ + \ reference, and operations like update or deletion" linkReferences: type: array - description: "An array of identifiers for other resources or entities within the system that this attachment is linked to, enhancing data connectivity and context." + description: "An array of identifiers for other resources or entities within\ + \ the system that this attachment is linked to, enhancing data connectivity\ + \ and context" items: $ref: '#/components/schemas/LinkReference' - memo: - type: string - description: "Optional user-entered notes or commentary about the attachment, which can include usage notes, revision information, or any other pertinent details." purgeInfo: type: object - description: "Contains details regarding the policies and processes for purging the attachment from the system, including timelines, methods, and compliance requirements." + description: "Contains details regarding the policies and processes for\ + \ purging the attachment from the system, including timelines, methods,\ + \ and compliance requirements" + templateId: + type: string + description: "Identifies the template from which the attachment was created,\ + \ if any, linking it to standardized document formats or predefined content\ + \ structures" tags: type: array - description: "A collection of tags associated with the attachment, serving as metadata for categorization, searchability, and organization." + description: "A collection of tags associated with the attachment, serving\ + \ as metadata for categorization, searchability, and organization" items: $ref: '#/components/schemas/Tag' - templateId: - type: string - description: "Identifies the template from which the attachment was created, if any, linking it to standardized document formats or predefined content structures." - CompositeFile: - description: "Represents the details of a composite file, which is typically created by combining multiple files or parts of files into a single file attachment. This schema facilitates the management and assembly of such files." + description: "Encapsulates details about an attachment, including files, metadata,\ + \ and policies related to the retention and deletion of the attachment" + PhoneInfo: type: object properties: - fileName: + phoneTypeCd: + type: string + description: "A code that categorizes the type of phone number (e.g., mobile,\ + \ home, work), aiding in its appropriate use and prioritization" + default: ContactPhone + phoneNumber: type: string - description: "Specifies the storage path and the unique filename under which the component file is saved on the server. These files are intended to be combined to form a composite attachment." + description: "The actual phone number, formatted according to local or international\ + \ standards, facilitating contact" id: - type: string - description: "A unique identifier for the composite file component, allowing for precise reference and manipulation within the system." - LinkReference: - description: "Encapsulates a reference to a linked resource within the system, providing context and navigational properties to enhance connectivity between different entities or data models." + type: string + description: "A unique identifier for the phone information record, allowing\ + \ for efficient tracking and management within the system" + phoneName: + type: string + description: "A label or name associated with the phone number, such as\ + \ 'Home' or 'Work', to identify the phone number's context or usage" + preferredInd: + type: boolean + description: "Indicates whether this phone number is the preferred method\ + \ of contact, prioritizing it among multiple contact options" + default: true + description: "Details an individual's or entity's phone contact information,\ + \ including type and preference, to support effective and preferred modes\ + \ of communication" + Document: type: object properties: + _links: + type: array + description: "Hypermedia links related to the document, providing navigational\ + \ paths to related data and actions available for the document" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + addUser: + type: string + description: "Identifier of the user who added the document, useful for\ + \ audit trails and permissions management" + transactionNumber: + type: string + description: "A unique identifier for the transaction that resulted in the\ + \ document's creation or modification, essential for traceability" + deliveryCd: + type: string + description: "Code representing the delivery method or status of the document,\ + \ such as electronic, mailed, or pending" description: type: string - description: "Descriptive text for the link, typically generated based on templates, that explains the nature or purpose of the link in user-readable terms." - id: + description: "A brief description or summary of the document's content or\ + \ purpose, aiding in identification and categorization" + canViewInd: + type: boolean + description: "Indicator of whether the current user has permissions to view\ + \ the document, ensuring compliance with access control policies" + type: type: string - description: "A unique identifier for the link reference, facilitating tracking and management of links within the application." - idRef: + description: "General categorization of the document, possibly overlapping\ + \ with documentTypeCd but allowing for broader classification" + documentTypeCd: type: string - description: "The reference ID of the target model to which this link points, establishing a clear connection between the link and its associated entity." - modelName: + description: "A code categorizing the document by type, such as policy,\ + \ claim, or identification, for systematic organization" + itemName: type: string - description: "The name of the model or entity type that is being linked to, providing clarity on the kind of resource the link references." - status: + description: "The name or title of the item or subject matter the document\ + \ pertains to, offering a quick reference to the document's focus" + ref: type: string - description: "Indicates the current status of the link, such as 'Active' or 'Deleted', reflecting the link's operational state within the system." - systemIdRef: + description: A general reference field that could be used to link the document + to other entities or identifiers within the system + filename: type: string - description: "The system-wide unique database identifier for the target item of this link reference, used in scenarios where objects from different containers or databases are interconnected." - Tag: - description: "Encapsulates metadata in the form of a tag, allowing for the categorization, organization, and easy retrieval of various entities within the system. Tags can be applied to documents, contacts, claims, and more, facilitating efficient data management and searchability." - type: object - properties: - id: + description: "The name of the file as stored within the system, including\ + \ file extension, facilitating file retrieval and management" + addDt: + type: string + description: "The date the document was added to the system, typically in\ + \ ISO 8601 format" + outputNumber: type: string - description: "A unique identifier for the tag, ensuring distinctness across the system and enabling precise reference and operations on the tag." + description: "A unique number or identifier generated during the document's\ + \ output or creation process, useful for tracking and reference" name: type: string - description: "The human-readable name of the tag, which succinctly describes the attribute, category, or keyword associated with the tag. This name is used for displaying, searching, and organizing entities tagged with this label." - tagTemplateIdRef: + description: "The title or name of the document, used as a primary identifier\ + \ in listings and searches" + templateIdRef: type: string - description: "The reference ID to a predefined tag template from which this tag was created, if applicable. Tag templates facilitate the standardization of tags across the system, ensuring consistency in tagging conventions and metadata application." - ListDriver: - description: "Encapsulates a paginated response structure that contains a list of drivers, including relevant metadata to handle continuation of listing if more drivers exist beyond the current response set." - type: object - properties: - continuationId: + description: "Reference to the template used for generating the document,\ + \ linking the document to its source for replication or audit purposes" + formCd: type: string - description: "A unique identifier that can be used to request subsequent pages of drivers. This value represents the row index from which the next set of results should start, facilitating pagination in client applications." - drivers: - description: "An array of Driver objects, each representing detailed information about an individual driver, including personal, contact, and policy-related details." - $ref: '#/components/schemas/Driver' - Driver: - description: "Detailed representation of a driver or potential driver, encompassing personal information, contact details, associated addresses, and other relevant information that pertains to their role and status within insurance policies." + description: "A code identifying the form associated with the document,\ + \ relevant in contexts where documents are generated from standardized\ + \ forms" + itemDescription: + type: string + description: "Detailed description of the item or content covered by the\ + \ document, providing additional context beyond the basic description" + canDeleteInd: + type: boolean + description: "Indicator of whether the document can be deleted, based on\ + \ current user permissions and document status" + addTm: + type: string + description: "The time the document was added to the system, often complementing\ + \ the addition date for precise tracking" + description: "Detailed metadata and properties associated with a specific document,\ + \ including access permissions, document type, and identifiers" + TaxInfo: type: object properties: - _links: - type: array - description: "A collection of hypermedia links related to the driver, providing quick access to related resources and actions such as fetching detailed information or initiating workflows." - items: - $ref: '#/components/schemas/Link' - _revision: + taxTypeCd: type: string - description: "A versioning identifier used to manage concurrent updates to the driver resource, ensuring data integrity through optimistic locking mechanisms." - addresses: - type: array - description: "An array of Address objects that detail the driver's associated addresses, including home, mailing, and potentially other types of addresses." - items: - $ref: '#/components/schemas/Address' - driverInfo: - description: "Structured information specific to the driver's licensing, history, and qualifications, as defined by the DriverPersonalInfo schema." - $ref: '#/components/schemas/DriverPersonalInfo' - emailInfo: - description: "Contact email information for the driver, allowing for electronic communication." - $ref: '#/components/schemas/EmailInfo' - eraseInfo: - description: "Details the conditions and policies under which the driver's information can be erased, in compliance with privacy regulations." - $ref: '#/components/schemas/EraseInfo' - futureStatusCd: - type: string - description: "A code indicating the anticipated future status of the driver with respect to the policy, such as pending renewal or cancellation." - id: - type: string - description: "A unique identifier for the driver, used to reference and manage driver information within the system." - issues: - type: array - description: "A list of issues or points of concern related to the driver, such as incidents or violations, that may affect insurance considerations." - items: - $ref: '#/components/schemas/Issue' - locationIdRef: + description: "A code describing the tax classification of the party, such\ + \ as 'Individual', 'Corporation', or 'Partnership', impacting tax treatment\ + \ and obligations" + withholdingExemptInd: + type: boolean + description: "Indicates whether the party is exempt from tax withholding,\ + \ relevant for processing payments and tax reporting" + received1099Ind: + type: boolean + description: "Indicates whether the party has received a Form 1099, used\ + \ for reporting income from sources other than wages, salaries, and tips" + taxIdTypeCd: type: string - description: "A reference to the geographical location or area associated with the driver, potentially relevant for policies with geographical considerations such as Personal Umbrella policies." - nameInfo: - description: "Basic name information for the driver, potentially including legal names, aliases, or preferred names." - $ref: '#/components/schemas/NameInfo' - partyTypeCd: + description: "A code that specifies the type of tax identification number\ + \ provided, such as SSN or FEIN, indicating the format and nature of the\ + \ ID" + receivedW9Ind: + type: boolean + description: "Indicates whether a Form W-9 has been received from the party,\ + \ used to request the taxpayer identification number and certification" + required1099Ind: + type: boolean + description: "Specifies if the issuance of a Form 1099 is required for the\ + \ party, based on the nature of payments or income received" + fein: type: string - default: "ContactParty" - description: "A categorization field that identifies the nature of the party's relationship to the policy or entity, with 'ContactParty' denoting direct contact or relation." - personInfo: - description: "Comprehensive personal information about the driver, including demographic and identity-related data." - $ref: '#/components/schemas/PersonInfo' - phoneInfo: - type: array - description: "An array detailing the phone contact information associated with the driver, facilitating various forms of communication." - items: - $ref: '#/components/schemas/PhoneInfo' - questionReplies: - description: "Responses to questions or inquiries directed at the driver, relevant to underwriting or policy management." - $ref: '#/components/schemas/QuestionReplies' - status: + description: "The Federal Employer Identification Number (FEIN) for the\ + \ entity, used in tax filings and other legal documents as a unique identifier" + id: type: string - description: "Current status of the driver, indicating their active involvement or any flags such as 'Deleted' for removed records." - underLyingPartyInfoIdRef: + description: "A unique identifier for the tax information record, facilitating\ + \ accurate tracking and association with parties or accounts" + legalEntityCd: type: string - description: "References detailed party information, linking the driver to additional contextual data or policy-related entities." - underLyingPolicyIdRef: + description: "A code indicating the legal entity type, such as corporation,\ + \ partnership, or sole proprietor, relevant for tax classification and\ + \ compliance" + ssn: type: string - description: "A reference to the specific insurance policy ID that this driver is associated with, highlighting the connection to policy structures and coverages." - yearsOfService: - type: integer - description: "Represents the number of years the driver has been associated with the insurance provider or specific policy, possibly impacting considerations such as loyalty discounts or risk assessments." - DriverPersonalInfo: - description: "Captures comprehensive personal and professional details about a driver, including driving history, license information, and eligibility for various insurance benefits based on driving qualifications and courses completed." + description: "The Social Security Number (SSN) for individuals, serving\ + \ as a primary identification number for tax and other legal purposes" + description: "Encapsulates tax identification information for an individual\ + \ or entity, including tax ID numbers, legal entity classification, and documentation\ + \ status, essential for compliance and financial reporting" + TransactionCloseReasons: type: object properties: - accidentPreventionCourseCompletionDt: - type: string - description: "The date the driver completed an accident prevention course, potentially qualifying them for insurance discounts." - accidentPreventionCourseInd: - type: boolean - default: true - description: "Indicates whether the driver has completed an accredited accident prevention course." - assignedVehicle: - type: integer - description: "The total number of vehicles assigned to the driver within the policy, illustrating the extent of the driver's responsibility." - attachedVehicleRef: + closeReasonCd: type: string - description: "Reference ID of the vehicle(s) attached to the driver within the policy, establishing a direct association between the driver and specific vehicles." - dateofHire: + description: Code indicating the reason for transaction closure + closeSubReasonLabel: type: string - description: "The date on which the driver was officially hired or employed, relevant in contexts where driving is a professional activity." - defensiveDriverEffectiveDt: + description: Label associated with the sub-reason for transaction closure + id: type: string - description: "The start date from which the benefits of completing a defensive driving course take effect, often related to policy discounts." - defensiveDriverExpirationDt: + description: Unique identifier for the transaction close reasons + closeComment: type: string - description: "The expiration date of the defensive driving course benefits, after which renewal may be necessary to maintain associated discounts." - defensiveDriverInd: - type: boolean - default: true - description: "Indicates successful completion of a defensive driving course by the driver, which may affect insurance premiums or eligibility for certain coverage options." - driverInfoCd: + description: Comment associated with transaction closure + closeSubReasonCd: type: string - default: "ContactDriver" - description: "A code that categorizes the driver within the system, often used for internal classification and processing." - driverNumber: - type: integer - description: "A unique sequence number assigned to the driver, used for identification and tracking within the insurance policy." - driverPoints: - type: array - description: "A detailed record of points accumulated by the driver, reflecting violations, infractions, or other factors that may impact insurance rates or coverage." - items: - $ref: '#/components/schemas/DriverPoint' - driverStartDt: + description: Code indicating the sub-reason for transaction closure + description: Reasons for the closure of a transaction + EmailInfo: + type: object + properties: + emailAddr: type: string - description: "The effective date when the driver was added to the policy, used for calculating the duration of coverage and experience." - driverStatusCd: + description: "The email address itself, providing a means of electronic\ + \ communication" + emailTypeCd: type: string - description: "The current status of the driver, such as 'Occasional' or 'Principal', indicating their primary role or frequency of vehicle use within the policy." - driverTrainingCompletionDt: + description: "A code identifying the type of email address provided (e.g.,\ + \ personal, work), aiding in its appropriate use and categorization" + default: ContactEmail + id: type: string - description: "The date the driver completed a formal training program, which may qualify them for additional benefits or discounts within their insurance policy." - driverTrainingInd: + description: "A unique identifier for the email information record, allowing\ + \ for reference and management within the system" + preferredInd: type: boolean - description: "A flag indicating whether the driver has undergone formal driving training, potentially influencing risk assessments and policy pricing." - driverTypeCd: - type: string - description: "Classifies the driver by type, such as 'Excluded' or 'Underaged', affecting policy terms and coverage limits." - excludeDriverInd: + description: "Indicates whether this email address is the preferred contact\ + \ method for the individual, prioritizing it among multiple contact options" + default: false + description: "Details an individual's email contact information, including type\ + \ and preference status, facilitating communication and documentation processes" + PolicyDetails: + type: object + properties: + systemId: type: string - description: "Indicates whether the driver is excluded from certain policy coverages or rating considerations, based on underwriting decisions or policy options." - goodDriverDiscountInd: - type: boolean - default: true - description: "Signals that the driver qualifies for a good driver discount, based on a history of safe driving and adherence to traffic laws." - goodDriverInd: - type: boolean - default: true - description: "Indicates recognition of the driver as a 'good driver', potentially affecting policy rates and eligibility for specific benefits." - id: + description: "An identifier for the policy within the internal or external\ + \ systems, facilitating cross-reference" + wcAdditionalInsureds: + type: array + description: "List of additional insured entities for workers' compensation\ + \ policies, detailing parties other than the primary insured that receive\ + \ coverage" + items: + $ref: '#/components/schemas/WCAdditionalInsured' + _revision: type: string - description: "A unique identifier for the driver's personal information record within the system." - lengthTimeDriving: + description: "The revision identifier of the policy, used for tracking changes\ + \ and ensuring data consistency" + x-ballerina-name: revision + updateCount: type: integer - description: "The total number of years the driver has been actively driving, reflecting experience and potentially influencing risk profiles." - licenseDt: + description: A counter indicating the number of times the policy has been + updated + externalSystemInd: type: string - description: "The date on which the driver's license was issued, critical for verifying legal driving status and calculating experience." - licenseNumber: + description: Indicator flag signifying if the policy is synchronized with + an external system + insured: + $ref: '#/components/schemas/Insured' + statementAccountRef: type: string - description: "The official number associated with the driver's license, essential for identity verification and records management." - licenseStatus: + description: Reference identifier for the account associated with billing + statements for the policy + _links: + type: array + description: "Hypermedia links associated with the policy item, providing\ + \ navigational URLs to related resources" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + wcCoveredStates: + type: array + description: "A list of states in which workers' compensation coverage is\ + \ included within the policy as proposed by this quote, reflecting multi-state\ + \ operations and compliance" + items: + $ref: '#/components/schemas/WCCoveredState' + updateUser: type: string - description: "Current status of the driver's license, such as 'Valid', 'Suspended', or 'Expired', impacting eligibility for insurance." - licensedStateProvCd: + description: "Identifier of the user who last updated the policy, used for\ + \ audit trails and accountability" + version: type: string - description: "The code of the state or province that issued the driver's license, indicating the jurisdiction under which the license is valid." - matureDriverInd: - type: boolean - default: true - description: "Designates the driver as a 'mature driver', possibly qualifying for specific discounts based on age and experience." - mvrRequestInd: - type: boolean - default: true - description: "Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a critical step in assessing driving history and risk." - mvrStatus: + description: "The version number of the policy, used for version control\ + \ and history tracking" + updateTimestamp: type: string - description: "The status of the MVR data report, providing insights into the driver's history and any potential issues or endorsements." - mvrStatusDt: + description: "The timestamp of the last update made to the policy, formatted\ + \ in ISO 8601" + vipLevel: type: string - description: "The date on which the MVR status was last updated, important for maintaining current and accurate driver records." - permanentLicenseInd: - type: boolean - default: true - description: "Indicates whether the driver possesses a permanent driving license, as opposed to a provisional or temporary license." - relationshipToInsuredCd: + description: "The VIP level assigned to the policy or policyholder, indicating\ + \ priority or special handling requirements" + basicPolicy: + $ref: '#/components/schemas/BasicPolicy' + customerRef: type: string - description: "Specifies the driver's relationship to the insured party, such as 'Husband', 'Wife', 'Son', 'Daughter', affecting policy structure and coverages." - requiredProofOfInsuranceInd: - type: boolean - default: true - description: "Signals the requirement for the driver to provide proof of insurance to the state or regulatory body, often linked to vehicle registration processes." - scholasticCertificationDt: + description: A reference identifier for the customer associated with the + policy + accountRef: type: string - description: "The date on which the driver qualified for a scholastic achievement discount, typically based on academic performance." - scholasticDiscountInd: - type: boolean - default: true - description: "Indicates eligibility for a discount based on scholastic achievement, aimed at student drivers who maintain high academic standards." - statusComments: + description: A reference identifier linking the policy to a specific account + in the system + id: type: string - description: "Free-form comments that provide additional context or explanations for the driver's status, changes, or specific conditions noted in the record." - yearLicensed: + description: The unique identifier of the policy within the system + auditAccountRef: type: string - description: "The year in which the driver was first licensed, offering a measure of driving experience and history." - yearsExperience: + description: Reference identifier for the account associated with any audits + related to the policy + iVANSCheck: type: string - description: "The total number of years the driver has held a valid driving license, serving as an indicator of experience and proficiency." - DriverPoint: - description: "Details the points associated with a driver, typically as a result of traffic violations or incidents. These points can impact insurance premiums and coverage." + description: "Status of the IVANS check for the policy, indicating connectivity\ + \ and data exchange success with the IVANS network" + contacts: + type: array + description: "A collection of contacts related to the policy, including\ + \ individuals and entities with various roles" + items: + $ref: '#/components/schemas/Contact' + description: "Encapsulates detailed information about an individual policy,\ + \ including identification, related entities, and status indicators. This\ + \ schema serves as a comprehensive model for policy information, integrating\ + \ with both internal and external systems for full lifecycle management" + InsuranceScore: type: object properties: - comments: - type: string - description: "Additional remarks or explanations regarding the specific points or the incident leading to the points." - convictionDt: - type: string - description: "The date on which the conviction was registered, leading to points being added to the driver's record." - directPortalIncidentId: - type: string - description: "A unique identifier for the incident as recorded in the direct portal, linking the points to specific events or violations." - driverPointsNumber: - type: integer - description: "The total number of points assigned to the driver as a result of the recorded incident or conviction." - expirationDt: - type: string - description: "The date when the points are set to expire or be removed from the driver's record, following applicable laws or regulations." - id: + overriddenInsuranceScore: type: string - description: "A unique identifier for the driver point record, allowing for tracking and management within the system." - ignoreInd: - type: boolean - default: true - description: "Indicator of whether these points should be ignored or not considered in the driver's risk assessment, possibly due to mitigating circumstances." - infractionCd: + description: "If applicable, the insurance score that overrides the original\ + \ score, typically resulting from manual review or additional information" + insuranceScoreTypeCd: type: string - description: "A code representing the specific infraction or violation that resulted in the points being assigned to the driver." - infractionDt: + description: "A code categorizing the type of insurance score, such as credit-based\ + \ or claims history, indicating the basis for the scoring" + insuranceScore: type: string - description: "The date on which the infraction occurred, crucial for determining the relevance and impact of the points over time." - pointsChargeable: - type: integer - description: "The number of points that are chargeable against the driver, directly affecting insurance assessments and premiums." - pointsCharged: - type: integer - description: "The actual number of points charged to the driver after considerations such as mitigating factors or legal adjustments." + description: "The insurance score, typically a numerical value or rating,\ + \ derived from various factors and used to assess the risk associated\ + \ with an insured or applicant" sourceCd: type: string - description: "The source code identifying where the point data originated from, such as a state DMV or court system, ensuring traceability." - status: + description: "A code indicating the source of the insurance score, such\ + \ as an external credit bureau or an internal scoring system" + statusCd: type: string - description: "The current status of the points, such as 'Active', 'Expired', or 'Removed', reflecting the driver's current standing." - templateId: + description: "The current status of the insurance score, such as 'Active'\ + \ or 'Reviewed', indicating its state within the underwriting process" + id: type: string - description: "Reference to a template used for documenting or processing driver points, facilitating standardized record-keeping." - typeCd: + description: "A unique identifier for the insurance score record, facilitating\ + \ tracking and management within the system" + insuranceScoreReasons: + type: array + description: "A list of reasons contributing to the insurance score, providing\ + \ insight into factors influencing the score" + items: + $ref: '#/components/schemas/InsuranceScoreReason' + sourceIdRef: type: string - description: "A categorization code that classifies the type of points or the nature of the infractions, aiding in analysis and reporting." - EmailInfo: - description: "Details an individual's email contact information, including type and preference status, facilitating communication and documentation processes." + description: "A reference to the specific source record or identifier for\ + \ the insurance score, linking to detailed source information" + description: "Provides details about an insurance score, including the score\ + \ itself, reasons for the score, and related metadata, which is used in the\ + \ underwriting and risk assessment processes" + SubmitterIssue: type: object properties: - emailAddr: + msg: type: string - description: "The email address itself, providing a means of electronic communication." - emailTypeCd: + description: "A descriptive message detailing the nature of the issue, providing\ + \ insight into potential concerns or required actions" + typeCd: + type: string + description: "The primary classification code for the issue, indicating\ + \ its general category and aiding in prioritization and resolution strategies" + subTypeCd: type: string - default: "ContactEmail" - description: "A code identifying the type of email address provided (e.g., personal, work), aiding in its appropriate use and categorization." + description: "A code further specifying the subtype of the issue, offering\ + \ additional granularity beyond the primary type for more precise categorization" id: type: string - description: "A unique identifier for the email information record, allowing for reference and management within the system." - preferredInd: - type: boolean - default: false - description: "Indicates whether this email address is the preferred contact method for the individual, prioritizing it among multiple contact options." - EraseInfo: - description: "Contains details regarding the erasure of data, including who performed the erasure, when it was done, and the specific item erased, ensuring compliance with data protection and privacy regulations." + description: "A unique identifier for the submitter issue, facilitating\ + \ tracking and resolution efforts within the system" + description: "Encapsulates issues identified by the submitter during the insurance\ + \ application or quote submission process, including categorization and descriptive\ + \ messaging" + ApplicationMini: type: object properties: - erasedBy: + _links: + type: array + description: "A collection of hypermedia links to related resources, enabling\ + \ easy navigation to detailed views of the application, policy information,\ + \ and other associated resources" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + applicationNumber: type: string - description: "Identifier of the user or system process that performed the erasure, providing an audit trail for compliance and review." - erasedDt: + description: "The unique identifier assigned to the application, serving\ + \ as a primary reference for tracking and management throughout the application\ + \ process" + basicPolicy: + $ref: '#/components/schemas/BasicPolicy' + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + auditAccountRef: type: string - description: "The date on which the data was erased, recorded in a standard format such as ISO 8601 for consistency and clarity." - erasedInd: + description: "A reference identifier linking the application to its associated\ + \ audit account, facilitating financial tracking and audit processes" + description: "Provides a compact overview of an insurance application, summarizing\ + \ key information and linking to detailed resources for further exploration.\ + \ This schema is optimized for quick access and overview purposes" + ElectronicPaymentSource: + type: object + properties: + creditCardAuthorizationMessage: + type: string + description: Message providing additional details regarding credit card + authorization status or any associated messages + eraseInfo: + $ref: '#/components/schemas/EraseInfo' + agentTrustInd: type: boolean - description: "A boolean indicator that confirms whether the data has been successfully erased, providing a clear status update." - erasedTm: + description: "Indicates whether the payment source is an agent's trust account,\ + \ differentiating it from customer-owned accounts" + achBankAccountNumber: type: string - description: "The specific time at which the data was erased, complementing the date information for precise record-keeping." - id: + description: "The bank account number for ACH payments, essential for direct\ + \ bank transfers" + reminderDt: type: string - description: "A unique identifier for the erase information record, facilitating tracking and management of erasure actions within the system." - Issue: - description: "Defines an issue related to an entity within the system, capturing details such as the type of issue, associated attributes, and descriptive messages to aid in identification and resolution." - type: object - properties: - attributeRefs: - type: array - description: "A collection of references to attributes associated with the issue, providing context and details that may aid in issue analysis and resolution." - items: - $ref: '#/components/schemas/AttributeRef' - id: + description: "A date indicating when a payment reminder should be sent,\ + \ aiding in timely payment collection and customer notification" + format: date + paymentServiceAccountId: type: string - description: "A unique identifier for the issue, enabling tracking and management within the system." - msg: + description: "An account identifier used by the payment service provider,\ + \ linking the payment transaction to external payment processing systems" + creditCardAuthorizationCd: type: string - description: "A descriptive message or summary of the issue, offering insight into the nature and potential impact of the problem." - subTypeCd: + description: "Code indicating the status of credit card authorization, such\ + \ as approved or declined" + achBankAccountTypeCd: type: string - description: "A code further categorizing the issue within its broader type, allowing for more granular classification and handling." - typeCd: + description: "A code identifying the type of bank account (e.g., checking,\ + \ savings) used for ACH payments" + midasId: type: string - description: "The primary classification code of the issue, indicating its general category and facilitating appropriate routing and response strategies." - AttributeRef: - description: "Encapsulates a reference to a specific attribute within the system, linking issues or other entities to detailed attribute information for clarity and context." - type: object - properties: - attributeId: + description: An identifier used in MIDAS (Money Inflow/Disbursement Administration + System) or similar systems for tracking financial transactions + action: type: string - description: "The unique identifier of the attribute to which this reference points, establishing a direct link for data retrieval and analysis." + description: "Placeholder for any action related to the payment source,\ + \ such as update or deletion" id: type: string - description: "A unique identifier for the attribute reference itself, ensuring the ability to track and manage these references independently within the system." - NameInfo: - description: "Captures comprehensive details about an individual's or entity's name, accommodating various name formats and types to support a wide range of commercial and personal naming conventions." - type: object - properties: - commercialName: + description: A unique identifier for the electronic payment source record + within the system + creditCardTypeCd: type: string - description: "The official commercial name of an entity, used in business contexts and legal documents." - commercialName2: + description: "A code indicating the type of credit card (e.g., Visa, MasterCard)\ + \ used for the payment" + creditCardExpirationMonth: type: string - description: "An additional commercial name field, allowing for legal aliases or alternative business names." - dbaIndexName: + description: The expiration month of the credit card + creditCardHolderName: type: string - description: "Index name under which the business is filed 'Doing Business As' (DBA), facilitating accurate identification and indexing." - dbaName: + description: The name of the credit card holder as it appears on the card + achExceptionMsg: type: string - description: "The 'Doing Business As' (DBA) name, representing the trading name under which the business or entity operates publicly, distinct from the legal business name." - extendedName: + description: "Message detailing any exceptions or issues encountered during\ + \ the ACH payment process, useful for troubleshooting and record-keeping" + sourceTypeCd: type: string - description: "An extended version of the name that may include additional identifiers or descriptive information, enhancing clarity and specificity." - givenName: + description: "A code identifying the category of payment source (e.g., internal,\ + \ external, third-party), useful for payment routing and management" + statusCd: type: string - description: "The individual's first name or given name, used in personal identification." - id: + description: "A code indicating the current status of the payment source,\ + \ such as active, inactive, or under review, guiding its availability\ + \ for use" + achBankName: type: string - description: "A unique identifier for the name information record, ensuring trackability and distinct management within the system." - indexName: + description: "The name of the bank where the ACH account is held, providing\ + \ necessary details for payment processing" + creditCardSecurityCd: type: string - description: "A standardized name format used for indexing, typically following conventions to facilitate sorting and retrieval." - nameTypeCd: + description: "The security code associated with the credit card, typically\ + \ found on the back of the card" + customerPaymentProfileId: type: string - default: "ContactName" - description: "A code that categorizes the type of name record, such as 'ContactName', indicating the context or application of the name information." - otherGivenName: + description: "An identifier for the customer's payment profile, allowing\ + \ for the reuse of stored payment information in a secure manner" + partyInfo: + $ref: '#/components/schemas/PartyInfo' + customerProfileId: type: string - description: "An additional or middle given name of the individual, providing completeness to personal identification." - positionCd: + description: "An identifier linking the electronic payment source to a customer\ + \ profile, facilitating comprehensive customer payment management" + creditCardExpirationYr: type: string - description: "A code representing the individual's position or title within an organization, if applicable, contributing to formal identification and correspondence." - prefixCd: + description: The expiration year of the credit card + carrierCd: type: string - description: "A prefix code indicating titles or honorifics preceding the name, such as 'Mr.', 'Dr.', or 'Ms.', contributing to respectful and accurate address." - shortName: + description: "Carrier code associated with the payment, identifying the\ + \ insurance carrier in cases of payments facilitated by or through carriers" + creditCardNumber: type: string - description: "A shortened or informal version of the name, used for ease of communication or in less formal contexts." - suffixCd: + description: "The number of the credit card used for payments, sensitive\ + \ data that must be handled according to PCI compliance standards" + methodCd: type: string - description: "A suffix code indicating qualifiers or titles following the name, such as 'Jr.', 'Sr.', or academic credentials, adding to the formal identification of the individual." - surname: + description: "A code that specifies the payment method (e.g., ACH, credit\ + \ card), important for directing the payment process accordingly" + achName: type: string - description: "The individual's last name or family name, essential for personal identification and official documentation." - PersonInfo: - description: "Encapsulates a comprehensive set of personal details for an individual, covering demographic information, contact preferences, professional background, and licensing history, facilitating tailored interactions and personalized insurance services." + description: "The name associated with the ACH account, typically the account\ + \ holder's name as it appears on bank records" + sourceName: + type: string + description: "The name of the payment source, providing a human-readable\ + \ identifier for the payment method or account" + achStandardEntryClassCd: + type: string + description: "A code that categorizes the type of ACH transaction, conforming\ + \ to standard entry class specifications for payment processing" + achRoutingNumber: + type: string + description: "The routing number for the bank account, a critical component\ + \ for directing ACH payments to the correct financial institution" + description: "Defines the details of an electronic payment source, such as bank\ + \ account or credit card information, used for processing payments within\ + \ the system. It includes both ACH (Automated Clearing House) and credit card\ + \ payment methods" + Insured: type: object properties: - age: - type: integer - description: "The current age of the individual, crucial for assessing eligibility and risk factors for certain insurance products." - ageLicensed: - type: integer - description: "The age at which the individual was first licensed to drive, providing insight into driving experience and proficiency." - bestTimeToContact: + wcNAICS: type: string - description: "Preferred time for contacting the individual, ensuring communications are made at convenient times, enhancing customer service." - bestWayToContact: + description: "The North American Industry Classification System (NAICS)\ + \ code applicable to the insured's business, used for statistical and\ + \ risk assessment purposes" + indexName: type: string - description: "Preferred method of contact (e.g., email, phone, text), allowing for personalized communication strategies." - birthDt: + description: "A standardized name used for indexing and search purposes,\ + \ often formatted to meet specific regulatory or operational requirements" + websiteAddress: type: string - description: "The individual’s date of birth, in a standard format such as ISO 8601, foundational for many aspects of insurance processing and decision-making." - educationCd: + description: "The official website address for the insured or their business,\ + \ offering an additional contact point and information source" + ratingBureauID: type: string - description: "A code representing the highest level of education attained by the individual, which may influence insurance rates or eligibility for certain benefits." - employerCd: + description: "An identifier used by rating bureaus to classify or rate the\ + \ insured, relevant in jurisdictions or lines of business where bureau\ + \ ratings are applicable" + selfInsured: + type: boolean + description: "Indicates whether the insured operates under a self-insurance\ + \ model, relevant for certain types of coverage and risk management strategies" + wcNCCIRiskIdNumber: type: string - description: "A code identifying the individual’s employer, useful in policies where employment status or employer partnerships affect coverage options." - genderCd: + description: "A risk identification number assigned by the National Council\ + \ on Compensation Insurance (NCCI), relevant for workers' compensation\ + \ insurance" + yearsInBusiness: + type: integer + description: "The total number of years the insured has been in operation,\ + \ reflecting business stability and experience for underwriting and risk\ + \ assessment" + partyInfo: + type: array + description: "A list of PartyInfo objects associated with the insured, detailing\ + \ multiple roles, relationships, or contact points as needed" + items: + $ref: '#/components/schemas/PartyInfo' + preferredDeliveryMethod: type: string - description: "The individual's gender as officially recorded, relevant in contexts where gender may impact insurance analytics or product offerings." - id: + description: "The preferred method of communication or document delivery\ + \ for the insured, aligning with their convenience and regulatory preferences" + wcSIC: type: string - description: "A unique identifier for the person's information record, ensuring accurate tracking and updating of personal details within the system." - maritalStatusCd: + description: "The Standard Industrial Classification (SIC) code for the\ + \ insured's business, providing an industry-based risk indicator" + id: type: string - description: "A code indicating the marital status of the individual, which can be a factor in policy rates and coverage options." - occupationCd: + description: "A unique identifier assigned to the insured within the system,\ + \ facilitating tracking, policy association, and risk assessment" + temporaryAddressOverrideInd: + type: boolean + description: "A flag that indicates a temporary override of the insured's\ + \ standard address, useful for short-term billing or communication needs" + entityTypeCd: type: string - description: "A code that classifies the individual's occupation, providing risk assessment data and potential eligibility for occupation-based discounts." - occupationClassCd: + description: "A code that identifies the nature of the insured entity, such\ + \ as 'Individual', 'Corporation', or 'Partnership', reflecting the structure\ + \ and legal status of the insured" + description: "Represents an insured entity or individual within the system,\ + \ encompassing both basic identification and specific insurance-related information" + DriverInfo: + type: object + properties: + attachedVehicleRef: type: string - description: "Further classification of the individual’s occupation, offering nuanced insight into professional risks and coverage needs." - personTypeCd: + description: "Reference identifier for the vehicle(s) associated with the\ + \ driver, linking driver information to specific vehicles covered under\ + \ the policy" + defensiveDriverEffectiveDt: type: string - default: "ContactPersonal" - description: "Indicates the context or category of personal information provided, with 'ContactPersonal' denoting a direct, personal contact type." - positionTitle: + description: "The start date from which defensive driving course benefits\ + \ apply, reflecting eligibility for associated discounts" + format: date + goodDriverInd: + type: boolean + description: "Affirms the driver's qualification as a good driver, impacting\ + \ insurance rates and coverage eligibility" + goodDriverDiscountInd: + type: boolean + description: "Indicates eligibility for a good driver discount, based on\ + \ a history of safe driving practices" + scholasticCertificationDt: type: string - description: "The professional title or role of the individual within their place of employment, relevant for understanding socioeconomic factors and occupational risks." - yearsLicensed: + description: "The date the driver qualified for a discount based on scholastic\ + \ achievements, relevant for young or student drivers" + format: date + yearsExperience: type: integer - description: "The total number of years the individual has been licensed to drive, a direct measure of driving experience." - PhoneInfo: - description: "Details an individual's or entity's phone contact information, including type and preference, to support effective and preferred modes of communication." - type: object - properties: - id: + description: "The total number of years the driver has held a license, serving\ + \ as an indicator of experience and driving history" + mvrStatusDt: type: string - description: "A unique identifier for the phone information record, allowing for efficient tracking and management within the system." - phoneName: + description: "The date of the last update to the driver's MVR status, important\ + \ for maintaining current and accurate risk assessments" + format: date + driverTrainingCompletionDt: type: string - description: "A label or name associated with the phone number, such as 'Home' or 'Work', to identify the phone number's context or usage." - phoneNumber: + description: "The date on which the driver completed a formal driver training\ + \ program, potentially affecting policy discounts" + format: date + driverStartDt: type: string - description: "The actual phone number, formatted according to local or international standards, facilitating contact." - phoneTypeCd: + description: "The date the driver began driving, relevant for calculating\ + \ driving experience and insurance eligibility" + format: date + licenseDt: type: string - default: "ContactPhone" - description: "A code that categorizes the type of phone number (e.g., mobile, home, work), aiding in its appropriate use and prioritization." - preferredInd: + description: "The date on which the driver's license was issued, foundational\ + \ for legal driving status and insurance underwriting" + format: date + driverStatusCd: + type: string + description: "A code indicating the current status of the driver, such as\ + \ active or suspended, which may influence policy terms and pricing" + mvrRequestInd: type: boolean - default: true - description: "Indicates whether this phone number is the preferred method of contact, prioritizing it among multiple contact options." - QuestionReplies: - description: "Encapsulates responses to a set of predefined questions, typically used in underwriting or claim processes, to gather necessary information in a structured format." - type: object - properties: - id: + description: "Indicates that a Motor Vehicle Report (MVR) has been requested\ + \ for the driver, a key component in risk assessment and policy pricing" + defensiveDriverExpirationDt: type: string - description: "A unique identifier for the collection of question and replies, facilitating organization and retrieval." - questionReply: - type: array - description: "An array of responses to specific questions, each containing the question's details and the provided reply, structured according to the QuestionReply schema." - items: - $ref: '#/components/schemas/QuestionReply' - questionSourceMDA: + description: "The expiration date for defensive driving course benefits,\ + \ after which renewal may be required to maintain discounts" + format: date + yearLicensed: type: string - description: "Metadata or identifier indicating the source or context of the questions, such as a specific underwriting guideline or claim process step." - QuestionReply: - description: "Encapsulates both a specific question posed within the system and the corresponding reply, facilitating the structured collection of information for processes such as underwriting or claim assessment." - type: object - properties: - displayDesc: + description: "The year in which the driver was first licensed, offering\ + \ a measure of driving experience and proficiency" + licenseNumber: type: string - description: "A descriptive label or prompt for the question, intended to be displayed as part of the question when presented to the user." + description: "The official number associated with the driver's license,\ + \ essential for identification and record-keeping" id: type: string - description: "A unique identifier for the question and reply instance, allowing for tracking and referencing within the system." - name: + description: "A unique identifier for the driver information record, ensuring\ + \ distinct management within the insurance system" + accidentPreventionCourseCompletionDt: type: string - description: "The name or key identifying the question, which may be used to map the reply to specific processes or data fields." - text: + description: "The date the driver completed an accredited accident prevention\ + \ course, potentially qualifying for insurance discounts" + format: date + mvrStatus: type: string - description: "The full text of the question as presented to the user, detailing what information or response is being requested." - value: + description: "The status of the driver's MVR, providing insights into driving\ + \ history, violations, and overall risk profile" + permanentLicenseInd: + type: boolean + description: "Specifies whether the driver holds a permanent driving license,\ + \ as opposed to a provisional or temporary license" + assignedVehicle: + type: integer + description: "The number of vehicles officially assigned to the driver within\ + \ the policy, indicating responsibility and primary usage" + lengthTimeDriving: + type: integer + description: "The total number of years the individual has been driving,\ + \ crucial for evaluating driving experience and risk" + driverInfoCd: type: string - description: "The reply or response provided to the question, stored as a string regardless of the original format or type of the input." - visibleInd: + description: "A code categorizing the type of driver information record,\ + \ useful for system processing and classification" + driverTrainingInd: type: boolean - default: true - description: "Indicates whether the question is currently set to be visible to the user, allowing for conditional display based on context or previous answers." + description: "Indicates completion of a formal driver training program,\ + \ qualifying the driver for potential insurance benefits" + excludeDriverInd: + type: string + description: "Specifies whether the driver is excluded from certain coverages\ + \ within the policy, based on risk assessments or other factors" + requiredProofOfInsuranceInd: + type: boolean + description: "Indicates whether the driver is required to provide proof\ + \ of insurance, typically for legal or regulatory compliance" + licensedStateProvCd: + type: string + description: "The code for the state or province that issued the driver's\ + \ license, indicating jurisdiction and legal authority" + scholasticDiscountInd: + type: boolean + description: "Indicates eligibility for a discount based on scholastic performance,\ + \ encouraging responsible behavior among student drivers" + statusComments: + type: string + description: "Comments related to the driver's status, providing additional\ + \ context or explanations for status assignments or changes" + licenseStatus: + type: string + description: "The current status of the driver's license, such as valid,\ + \ suspended, or expired, directly affecting insurance eligibility" + matureDriverInd: + type: boolean + description: "Indicates recognition of the driver as a mature driver, possibly\ + \ affecting insurance premiums and coverage options" + accidentPreventionCourseInd: + type: boolean + description: Indicates whether the driver has successfully completed an + accident prevention course + driverTypeCd: + type: string + description: "Categorizes the driver by type, such as 'Primary' or 'Occasional',\ + \ affecting policy coverage and premiums" + relationshipToInsuredCd: + type: string + description: "Describes the driver's relationship to the insured entity\ + \ or individual, such as family member or employee, impacting coverage\ + \ details" + dateofHire: + type: string + description: "The date the driver was hired for employment, applicable when\ + \ driving is a part of professional duties" + format: date + driverPoints: + type: array + description: "A list of points accrued by the driver for traffic violations\ + \ or other infractions, impacting risk assessment and premium calculation" + items: + $ref: '#/components/schemas/DriverPoint' + defensiveDriverInd: + type: boolean + description: "Indicates whether the driver has completed a defensive driving\ + \ course, affecting insurance premiums and coverage options" + description: "Captures comprehensive driving-related information for an individual,\ + \ including licensing details, driving history, and eligibility for discounts\ + \ based on driving courses and behavior" ListApplication: - description: "Encapsulates a response that includes a list of insurance applications, potentially spanning multiple pages, along with pagination control via a continuation identifier." type: object properties: + continuationId: + type: string + description: "A pagination control identifier that specifies the starting\ + \ point for the next set of results, used when additional results are\ + \ available beyond the current response" applicationListItems: type: array - description: "An array of Application objects, each representing an individual insurance application with summary and detailed data." + description: "An array of Application objects, each representing an individual\ + \ insurance application with summary and detailed data" items: $ref: '#/components/schemas/Application' - continuationId: - type: string - description: "A pagination control identifier that specifies the starting point for the next set of results, used when additional results are available beyond the current response." - Application: - description: "Detailed representation of an insurance application, including its status, ownership, associated customer and product information, and permissions regarding user actions." + description: "Encapsulates a response that includes a list of insurance applications,\ + \ potentially spanning multiple pages, along with pagination control via a\ + \ continuation identifier" + CompositeFile: type: object properties: - _links: - type: array - description: "Hypermedia links related to the application, facilitating navigation to related resources and actions such as editing or inquiry." - items: - $ref: '#/components/schemas/Link' - applicationMini: - $ref: '#/components/schemas/ApplicationMini' - description: "A summarized version of the application details, providing key information at a glance without the need for full detail retrieval." - canEdit: - type: boolean - description: "Indicates whether the current user has permissions to edit the application, reflecting access control based on user roles and application status." - canInquiry: - type: boolean - description: "Indicates whether the current user is permitted to make inquiries regarding the application, typically used for customer service and support roles." - currentOwner: + fileName: type: string - description: "Identifies the current owner or responsible party for the application, which may be an individual agent or a team within the insurance organization." - customerInfo: - $ref: '#/components/schemas/CustomerInfo' - description: "Contains comprehensive information about the customer associated with the application, including personal and contact details." - productInfo: - $ref: '#/components/schemas/ProductInfo' - description: "Provides detailed information about the insurance product being applied for, including product codes, descriptions, and potentially coverage options." - ref: + description: Specifies the storage path and the unique filename under which + the component file is saved on the server. These files are intended to + be combined to form a composite attachment + id: type: string - description: "A unique reference identifier for the application, used within the system for tracking, management, and retrieval purposes." - ApplicationMini: - description: "Provides a compact overview of an insurance application, summarizing key information and linking to detailed resources for further exploration. This schema is optimized for quick access and overview purposes." + description: "A unique identifier for the composite file component, allowing\ + \ for precise reference and manipulation within the system" + description: "Represents the details of a composite file, which is typically\ + \ created by combining multiple files or parts of files into a single file\ + \ attachment. This schema facilitates the management and assembly of such\ + \ files" + WCCoveredState: type: object properties: - _links: - type: array - description: "A collection of hypermedia links to related resources, enabling easy navigation to detailed views of the application, policy information, and other associated resources." - items: - $ref: '#/components/schemas/Link' - applicationInfo: - $ref: '#/components/schemas/ApplicationInfo' - description: "Consolidates detailed information about the application, including status, applicant details, and product specifics, providing a comprehensive snapshot within a condensed format." - applicationNumber: + eLVoluntaryCompensationInd: + type: boolean + description: "Indicates whether Employers' Liability Voluntary Compensation\ + \ is included, extending coverage beyond statutory workers' compensation\ + \ requirements" + coinsuranceInd: + type: boolean + description: "Indicates the presence of a coinsurance arrangement for the\ + \ covered state, impacting the distribution of risk between insurer and\ + \ insured" + deductibleAmt: type: string - description: "The unique identifier assigned to the application, serving as a primary reference for tracking and management throughout the application process." - auditAccountRef: + description: "The amount of deductible applied to the policy for the covered\ + \ state, influencing out-of-pocket costs before insurance coverage begins" + deductibleType: type: string - description: "A reference identifier linking the application to its associated audit account, facilitating financial tracking and audit processes." - basicPolicy: - $ref: '#/components/schemas/BasicPolicy' - description: "Summarizes the foundational policy information derived from the application, including key policy identifiers, dates, and basic coverage details." - ApplicationInfo: - description: "Encapsulates a detailed record of an insurance application's lifecycle within the system, tracking its creation, updates, mailing history, closure, and any related correction or reinstatement transactions." - type: object - properties: - addDt: + description: "Specifies the type of deductible, such as 'per claim' or 'aggregate',\ + \ defining how the deductible applies within the policy terms" + unemploymentNumber: type: string - format: date - description: "The date when the application was initially added to the system, marking the start of its lifecycle." - addTm: + description: "The unemployment insurance number for the insured within the\ + \ covered state, relevant for businesses and compliance reporting" + ruleStatus: type: string - description: "The precise time of day when the application was added to the system, complementing the add date for accurate tracking." - addUser: + description: "Indicates the status of regulatory or internal rules applied\ + \ to the coverage, such as 'active', 'pending', or 'expired'" + totalManualPremiumAmt: type: string - description: "The identifier (e.g., username) of the user who added the application, providing an audit trail for creation actions." - closeComment: + description: The total premium calculated based on manual rates before application + of experience modifications or other adjustments + workfareProgramWeeksNum: type: string - description: "Any comments or notes regarding the reasons or circumstances surrounding the application's closure." - closeDt: + description: "The number of weeks covered under a workfare program, applicable\ + \ for policies including workfare participants" + managedCareCreditInd: + type: boolean + description: "Indicates the application of a credit for participation in\ + \ managed care programs, reflecting cost savings from efficient care management" + productVersionIdRef: type: string - format: date - description: "The date when the application was officially closed, terminating its active processing or consideration within the system." - closeReasonCd: + description: "Reference to the product version associated with this coverage,\ + \ linking state-specific terms to overall policy structure and offerings" + aRDRuleEnabled: + type: boolean + description: "Indicates whether the Alternate Risk Distribution (ARD) rule\ + \ is enabled for this state, affecting risk assessment and premium distribution" + totalSubjectPremiumAmt: type: string - description: "A code that categorizes the reason for the application's closure, such as 'withdrawn' or 'issued'." - closeSubReasonCd: + description: "The portion of the premium subject to adjustments and modifications,\ + \ based on covered payroll, classification rates, and experience factors" + workStudyProgram: type: string - description: "A more specific code that provides additional detail on the reason for application closure, used for finer categorization." - closeSubReasonLabel: + description: "Details about any work-study programs affecting coverage or\ + \ premium calculations, relevant for educational institutions or employers" + id: type: string - description: "The textual description corresponding to the close sub-reason code, offering human-readable insight into the closure reason." - closeTm: + description: A unique identifier for the workers' compensation coverage + record within the specified state + totalDiscountedPremiumAmt: type: string - description: "The exact time of day when the application was closed, providing precise timing alongside the closure date." - closeUser: + description: "The total premium amount after applying discounts, reflecting\ + \ cost adjustments based on risk management practices or other criteria" + waiverOfSubrogationFlatInd: + type: boolean + description: "Indicates whether a flat waiver of subrogation applies, limiting\ + \ the insurer's right to recover from third parties causing loss" + totalStateEstimatedPremium: type: string - description: "The identifier of the user who performed the closure action, contributing to the audit trail." - correctedByTransactionNumber: - type: integer - format: int64 - description: "If the application was corrected by a subsequent transaction, this is the number of that correcting transaction." - correctionOfTransactionNumber: + description: "An estimate of the total premium for the covered state, considering\ + \ specific state rates, classifications, and coverage requirements" + experienceModificationFactor: + type: string + description: "A factor reflecting the insured's historical claims experience\ + \ relative to the industry average, affecting premium calculations" + gLScheduledPremiumMod: + type: string + description: "Scheduled premium modification for General Liability, affecting\ + \ the overall premium calculation based on specific risk adjustments" + order: type: integer - format: int64 - description: "If this application serves as a correction, this is the original transaction number that it corrects." - firstMailedDt: + description: "Specifies the order in which this state's coverage details\ + \ are presented or processed, indicating sequencing within multi-state\ + \ policies" + noncomplianceChargeAmt: type: string - format: date - description: "The date when the application or associated documents were first mailed to the customer or relevant party." - id: + description: "The amount charged for noncompliance with specified conditions\ + \ or requirements, serving as a penalty or incentive for adherence to\ + \ policy terms" + noOfContractsForWaiverOfSubrogation: type: string - description: "A unique identifier for the application information record, ensuring distinct and retrievable records within the system." - iterationDescription: + description: "The number of contracts under which a waiver of subrogation\ + \ applies, affecting the rights of the insurer to pursue recovery from\ + \ third parties" + largeDeductibleFactor: type: string - description: "A description or identifier for the particular iteration or version of the application, useful in tracking changes over time." - lastMailedDt: + description: "A factor applied in cases of large deductibles, influencing\ + \ the premium calculation by accounting for the increased self-assumed\ + \ risk" + index: + type: integer + description: "A numerical index used for ordering or categorization within\ + \ the system, facilitating data organization and retrieval" + numberOfClaims: + type: string + description: "The number of claims filed under the policy for the covered\ + \ state, providing a measure of risk and loss history" + ratingEffectiveDt: type: string + description: "The effective date of the rating and pricing structure applied\ + \ to the covered state, marking the beginning of the applicable terms" format: date - description: "The most recent date on which the application or related documents were mailed out, indicating the latest communication attempt." - masterQuoteRef: + totalStandardPremiumAmt: type: string - description: "A reference to the master quote associated with this application, linking application data to quoting details." - needByDt: + description: "The standard premium amount prior to any discounts or modifications,\ + \ serving as a baseline for subsequent premium calculations" + certifiedSafetyHealthProgPct: type: string - format: date - description: "The date by which the application processing needs to be completed, often tied to coverage start dates or customer requirements." - pendForReleaseInd: + description: "The percentage credit applied for participation in certified\ + \ safety and health programs, encouraging workplace safety initiatives" + packageFactorInd: type: boolean - description: "Indicates if the application is currently on hold, pending release for further processing or decision-making." - reinstatedByTransactionNumber: - type: integer - format: int64 - description: "Identifies the transaction number that led to the reinstatement of this application, if it was previously closed or withdrawn." - reinstatementOfTransactionNumber: - type: integer - format: int64 - description: "For applications that are reinstatements, this is the original transaction number of the application that is being reinstated." - renewalApplyInd: + description: "Indicates whether package factors, combining multiple coverages\ + \ or policies, are applied in premium calculations for the state" + alcoholDrugFreeCreditInd: type: boolean - description: "Flags whether the application is marked for renewal, indicating an ongoing relationship or coverage continuation." - renewalApplyOfTransactionNumber: - type: integer - format: int64 - description: "For renewal applications, this field links to the transaction number of the previous application or policy being renewed." - submittedDt: - type: string - format: date - description: "The date when the application was formally submitted for review or processing, moving it forward in the underwriting or issuance pipeline." - updateDt: + description: Indicates eligibility for a credit based on participation in + alcohol and drug-free workplace programs + experienceRatingCd: type: string - format: date - description: "The date of the last update made to the application, reflecting the most recent changes or progress." - updateTm: + description: "A code representing the insured's experience rating, categorizing\ + \ the risk level based on past claims history" + stateCd: type: string - description: "The time at which the last update to the application was made, providing time-specific tracking of modifications." - updateUser: + description: "The code representing the state for which the coverage details\ + \ apply, identifying the jurisdiction covered by the policy terms" + experienceModificationStatus: type: string - description: "The identifier of the user who made the most recent update to the application, part of the comprehensive audit trail." - ProductInfo: - description: "Provides key details about an insurance product, including its identification and descriptive name, facilitating product-specific processing and categorization." - type: object - properties: - id: + description: "Status of the experience modification, such as 'applied' or\ + \ 'pending', indicating the current application of the experience factor" + contrClassPremAdjCreditPct: type: string - description: "A unique identifier for the insurance product, enabling precise reference and retrieval within the system." - name: + description: "The percentage credit applied based on adjustments to the\ + \ contractor classification premium, reflecting specific risk profiles\ + \ and experience" + primaryInd: + type: boolean + description: "Designates the state as the primary state of coverage, relevant\ + \ for policies covering multiple jurisdictions" + status: type: string - description: "The descriptive name of the product as defined in the Product Master, providing a human-readable identifier that may correspond to marketing or regulatory naming conventions." - CustomerInfo: - description: "Captures essential identification and reference information for a customer, supporting customer management, service, and correspondence within the insurance system." + description: "The current status of the coverage for the specified state,\ + \ indicating active, inactive, or pending states of the coverage terms" + description: "Details specific workers' compensation coverage options and conditions\ + \ for a given state, including discounts, deductibles, experience modifications,\ + \ and other factors influencing the policy's terms and premium calculations" + EraseInfo: type: object properties: - customerNumber: + erasedTm: type: string - description: "A unique identifier or number assigned to the customer, serving as a primary reference for account management, policy administration, and customer service activities." - customerRef: + description: "The specific time at which the data was erased, complementing\ + \ the date information for precise record-keeping" + erasedBy: type: string - description: "A reference string or identifier that links the customer to external systems, records, or databases, enhancing interoperability and data cohesion." - id: + description: "Identifier of the user or system process that performed the\ + \ erasure, providing an audit trail for compliance and review" + erasedDt: type: string - description: "The system-generated unique identifier for the customer's record, ensuring the ability to uniquely identify, track, and manage customer information within the system." - name: + description: "The date on which the data was erased, recorded in a standard\ + \ format such as ISO 8601 for consistency and clarity" + id: type: string - description: "The full name of the customer as registered or recognized within the system, facilitating personalization, correspondence, and customer engagement." - Quote: - description: "Encapsulates comprehensive details about a quotation for insurance coverage, including linked resources, policy information, and the status of the quote." + description: "A unique identifier for the erase information record, facilitating\ + \ tracking and management of erasure actions within the system" + erasedInd: + type: boolean + description: "A boolean indicator that confirms whether the data has been\ + \ successfully erased, providing a clear status update" + description: "Contains details regarding the erasure of data, including who\ + \ performed the erasure, when it was done, and the specific item erased, ensuring\ + \ compliance with data protection and privacy regulations" + Note: type: object properties: - _links: - description: "A collection of hypermedia links to related resources and actions available for the quote, facilitating easy navigation and interaction within the API ecosystem." - type: array - items: - $ref: '#/components/schemas/Link' - _revision: + ref: type: string - description: "A system-generated version identifier for the quote, used to manage updates and ensure data integrity through optimistic concurrency control." - applicationInfo: - $ref: '#/components/schemas/ApplicationInfo' - description: "Contains detailed information about the associated application from which this quote was generated, providing context and linkage between application and quoting processes." - basicPolicy: - $ref: '#/components/schemas/BasicPolicy' - description: "Summarizes key policy information derived from the quote, including identifiers and foundational coverage details." - contacts: - description: "A list of contacts associated with the quote, including individuals or entities involved in the policy as insureds, beneficiaries, or other roles." - type: array - items: - $ref: '#/components/schemas/Contact' - customerRef: + description: "A reference identifier linking the note to related records\ + \ or entities, enhancing data connectivity and retrieval" + comments: type: string - description: "A reference identifier linking the quote to a customer record, enabling correlation between customer details and quotation data." - description: + description: "Additional comments associated with the note, offering further\ + \ clarification, instructions, or context" + addDt: type: string - description: "A brief description or summary of the quote, providing insights into the coverage scope, purpose, or specific considerations." - externalStateData: + description: "The date when the note was initially added to the system,\ + \ providing a temporal context for the information" + priorityCd: type: string - description: "External system data related to the quote, potentially including state-specific requirements, third-party data, or external identifiers." - id: + description: "A code indicating the note's priority, such as 'High', 'Medium',\ + \ or 'Low', affecting its visibility and urgency" + addUser: type: string - description: "The unique identifier for the quote, facilitating tracking, management, and retrieval within the system." - insured: - $ref: '#/components/schemas/Insured' - description: "Details about the insured entity or individual covered under the policy proposed by this quote, including demographic and contact information." - lockTaskId: + description: "The identifier of the user who created the note, linking the\ + \ note to its author for reference or follow-up" + stickyInd: + type: boolean + description: "A boolean indicator specifying whether the note is marked\ + \ as 'sticky' or particularly important, ensuring prominence in listings\ + \ or displays" + description: type: string - description: "An identifier for a system task or process that has locked the quote for exclusive access, preventing concurrent modifications." - policyRef: + description: "A brief description or summary of the note's content, providing\ + \ an at-a-glance understanding of its purpose or subject matter" + memo: type: string - description: "A reference identifier linking the quote to a specific policy or policy proposal, establishing a connection between quoting and policy issuance." - statementAccountRef: + description: "A detailed memorandum contained within the note, elaborating\ + \ on the topic, decision-making process, or action items" + templateId: type: string - description: "A reference to the statement account associated with this quote, used for billing and financial transactions related to the policy." - status: + description: "An identifier for a note template that was used as a basis\ + \ for this note, standardizing the format and content for specific types\ + \ of annotations" + addTm: type: string - description: "The current status of the quote, indicating its progression through the quoting process, approval state, or any conditions affecting its validity." - submitterIssues: - description: "A list of issues or concerns raised by the submitter or system during the quoting process, requiring attention or resolution before proceeding." - type: array - items: - $ref: '#/components/schemas/SubmitterIssue' - transactionInfo: - $ref: '#/components/schemas/TransactionInfo' - description: "Provides transactional details related to the quote, including dates, identifiers, and statuses of relevant transactions." - vipLevel: + description: "The precise time of day when the note was added, complementing\ + \ the date for accurate chronological tracking" + status: type: string - description: "Indicates the VIP level or priority of the quote, which may affect processing speed, service levels, or access to special pricing." - wcAdditionalInsureds: - description: "List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage." - type: array - items: - $ref: '#/components/schemas/WCAdditionalInsured' - wcCoveredStates: - description: "A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance." + description: "The current status of the note, such as 'Active', 'Completed',\ + \ or 'Cancelled', reflecting its relevance and actionability" + description: "Represents a detailed record of a note, capturing contextual comments,\ + \ priority, and administrative metadata, aiding in communication and documentation\ + \ processes" + ListDocument: + type: object + properties: + documentListItems: type: array + description: "An array of Document objects, each representing detailed information\ + \ about a specific document within the system" items: - $ref: '#/components/schemas/WCCoveredState' - BasicPolicy: - description: "Summarizes foundational information about a policy, including its identification, associated affinity group, and details about its payment plan." + $ref: '#/components/schemas/Document' + description: "Encapsulates a response structure for API calls that return multiple\ + \ documents, facilitating easy access to and manipulation of a collection\ + \ of documents within the system" + Country: type: object properties: - affinityGroupCd: + name: type: string - description: "The code representing the affinity group associated with the policy, which may qualify the policyholder for certain benefits or discounts." - auditPayPlan: - $ref: '#/components/schemas/AuditPayPlan' - description: "Details the audit payment plan associated with the policy, including payment schedules and amounts." - autoDataPrefillInd: - type: boolean - description: "Indicator of whether data prefilling is enabled for automatic data capture and form completion." - branch: + description: The official name of the country as recognized internationally. + This name is used for display purposes and in user interfaces + isoCd: type: string - description: "The branch or division of the insurance provider issuing the policy." - businessSourceCd: + description: "The ISO 3166-1 alpha-2 code of the country, providing a two-letter\ + \ code that is universally recognized for representing country names" + description: "Contains detailed information about a single country, including\ + \ its ISO code and the full country name. This schema is crucial for ensuring\ + \ accurate country representation and selection across the application" + NoteDetail: + type: object + properties: + eraseInfo: + $ref: '#/components/schemas/EraseInfo' + priorityCd: type: string - description: "The code indicating the source of business, such as direct, broker, or agent." - cALineSelectedInd: + description: "A code indicating the note's priority level, such as 'High',\ + \ 'Medium', or 'Low', guiding attention and response urgency" + stickyInd: type: boolean - description: "Indicator of whether commercial auto line coverage is selected in the policy." - cAPolicyType: + description: "Specifies whether the note is marked as 'sticky' or important,\ + \ warranting prominent display or special attention" + description: type: string - description: "The type of commercial auto policy, detailing specific coverage options selected." - cCLineSelectedInd: - type: boolean - description: "Indicator of whether commercial property coverage is selected." - cCPolicyType: + description: "A brief overview or summary of the note's content, providing\ + \ insight into its purpose and significance" + memo: type: string - description: "The type of commercial property policy, detailing the specific coverage options selected." - cCSubline: + description: "An extended memo or detailed commentary associated with the\ + \ note, providing additional context, explanations, or action items" + id: type: string - description: "Subline code for commercial coverage, providing additional detail on the specific nature of the coverage." - cGLineSelectedInd: - type: boolean - description: "Indicator of whether general liability coverage is selected." - cILineSelectedInd: - type: boolean - description: "Indicator of whether commercial inland marine coverage is selected." - cLLineSelectedInd: - type: boolean - description: "Indicator of whether commercial lines coverage is selected, encompassing a range of commercial policies." - cPLineSelectedInd: + description: "A unique identifier assigned to the note, enabling distinct\ + \ tracking and retrieval within the system" + linkReferences: + type: array + description: "A collection of references linking the note to other related\ + \ records or documents, enhancing contextual understanding and data integration" + items: + $ref: '#/components/schemas/LinkReference' + purgeInfo: + type: object + description: "Details regarding the conditions and policies for purging\ + \ the note from the system, ensuring data management compliance" + templateId: + type: string + description: "Identifier for the template used in creating the note, standardizing\ + \ format and content for specific types of notes" + showOnAllProducerContainersInd: type: boolean - description: "Indicator of whether commercial package policy coverage is selected." - cPPolicyType: + description: "Indicates whether the note should be visible across all producer\ + \ containers, ensuring broad visibility when necessary" + tags: + type: array + description: "A set of tags categorizing or highlighting aspects of the\ + \ note, facilitating organization and thematic grouping" + items: + $ref: '#/components/schemas/Tag' + description: "Provides an in-depth view of a note, including its content, priority,\ + \ and associated metadata, facilitating detailed documentation and tracking\ + \ within the system" + ListPolicy: + type: object + properties: + continuationId: type: string - description: "The type of commercial package policy, detailing the specific coverage options selected." - carrierCd: + description: "If more results are available, the ContinuationId should be\ + \ the row index of the next row" + policyListItems: + type: array + description: "An array of policy items, each containing detailed information\ + \ about individual policies" + items: + $ref: '#/components/schemas/Policy' + description: "Provides a paginated structure for listing policies, facilitating\ + \ the retrieval of policy information in a segmented manner. This schema supports\ + \ operations that require the listing of multiple policies, including search\ + \ results and batch processing views" + CustomerInfo: + type: object + properties: + customerRef: type: string - description: "The code representing the insurance carrier providing the policy." - carrierGroupCd: + description: "A reference string or identifier that links the customer to\ + \ external systems, records, or databases, enhancing interoperability\ + \ and data cohesion" + name: type: string - description: "The code representing the group of insurance carriers, if applicable, under which the policy is issued." - commCLUERequestInd: - type: boolean - description: "Indicator of whether a commercial CLUE (Comprehensive Loss Underwriting Exchange) report has been requested for underwriting purposes." - comments: + description: "The full name of the customer as registered or recognized\ + \ within the system, facilitating personalization, correspondence, and\ + \ customer engagement" + id: type: string - description: "Free-form comments or notes associated with the policy." - companyProductCd: + description: "The system-generated unique identifier for the customer's\ + \ record, ensuring the ability to uniquely identify, track, and manage\ + \ customer information within the system" + customerNumber: type: string - description: "The product code of the company, identifying the specific insurance product offered." - controllingStateCd: + description: "A unique identifier or number assigned to the customer, serving\ + \ as a primary reference for account management, policy administration,\ + \ and customer service activities" + description: "Captures essential identification and reference information for\ + \ a customer, supporting customer management, service, and correspondence\ + \ within the insurance system" + Application: + type: object + properties: + applicationMini: + $ref: '#/components/schemas/ApplicationMini' + ref: type: string - description: "The code of the state that has jurisdiction over the policy, particularly important for multi-state operations." - dPLineSelectedInd: + description: "A unique reference identifier for the application, used within\ + \ the system for tracking, management, and retrieval purposes" + _links: + type: array + description: "Hypermedia links related to the application, facilitating\ + \ navigation to related resources and actions such as editing or inquiry" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + canInquiry: type: boolean - description: "Indicator of whether dwelling property coverage is selected." - description: - type: string - description: "A brief description of the policy, summarizing the key coverage and policy details." - directorsAndOfficersLineSelectedInd: + description: "Indicates whether the current user is permitted to make inquiries\ + \ regarding the application, typically used for customer service and support\ + \ roles" + canEdit: type: boolean - description: "Indicator of whether Directors and Officers (D&O) liability coverage is selected." - displayDescription: - type: string - description: "A description of the policy designed for display purposes, often used in customer-facing documents." - effectiveDt: + description: "Indicates whether the current user has permissions to edit\ + \ the application, reflecting access control based on user roles and application\ + \ status" + currentOwner: type: string - format: date - description: "The effective date of the policy, indicating when coverage begins." - effectiveTm: + description: "Identifies the current owner or responsible party for the\ + \ application, which may be an individual agent or a team within the insurance\ + \ organization" + customerInfo: + $ref: '#/components/schemas/CustomerInfo' + productInfo: + $ref: '#/components/schemas/ProductInfo' + description: "Detailed representation of an insurance application, including\ + \ its status, ownership, associated customer and product information, and\ + \ permissions regarding user actions" + Link: + type: object + properties: + rel: type: string - description: "The effective time of the policy, providing precise coverage start time." - electronicPaymentSource: - $ref: '#/components/schemas/ElectronicPaymentSource' - description: "Details regarding the source of electronic payments for the policy." - employmentAndPracticeLineSelectedInd: - type: boolean - description: "Indicator of whether employment practices liability coverage is selected." - errorsAndOmissionLineSelectedInd: - type: boolean - description: "Indicator of whether Errors and Omissions (E&O) coverage is selected." - expirationDt: + description: "A descriptor that indicates the relationship of the linked\ + \ resource to the current context, such as 'self', 'next', or specific\ + \ action-related terms" + href: type: string - format: date - description: "The expiration date of the policy, indicating when coverage ends." - extendedCoverageInd: - type: boolean - description: "Indicator of whether the policy includes extended coverage beyond standard terms." - externalId: + description: "The absolute or relative URL pointing to the linked resource,\ + \ which can be used to directly access or query the target resource" + description: "Represents a hypermedia link, providing navigational capabilities\ + \ between related resources within the API, akin to links in web pages" + AttributeRef: + type: object + properties: + attributeId: type: string - description: "An external identifier for the policy, used for integration with external systems or databases." - fireLightningInd: - type: boolean - description: "Indicator of whether the policy includes coverage for fire and lightning damage." - gLLineSelectedInd: - type: boolean - description: "Indicator of whether general liability coverage is selected." + description: "The unique identifier of the attribute to which this reference\ + \ points, establishing a direct link for data retrieval and analysis" id: type: string - description: "The unique identifier for the policy within the system." - inceptionDt: + description: "A unique identifier for the attribute reference itself, ensuring\ + \ the ability to track and manage these references independently within\ + \ the system" + description: "Encapsulates a reference to a specific attribute within the system,\ + \ linking issues or other entities to detailed attribute information for clarity\ + \ and context" + ApplicationInfo: + type: object + properties: + addUser: + type: string + description: "The identifier (e.g., username) of the user who added the\ + \ application, providing an audit trail for creation actions" + pendForReleaseInd: + type: boolean + description: "Indicates if the application is currently on hold, pending\ + \ release for further processing or decision-making" + closeDt: type: string + description: "The date when the application was officially closed, terminating\ + \ its active processing or consideration within the system" format: date - description: "The inception date of the policy, marking the beginning of coverage, distinct from the effective date in some cases." - inceptionTm: + closeSubReasonCd: type: string - description: "The inception time of the policy, providing precise start time of coverage." - legacyPolicyNumber: + description: "A more specific code that provides additional detail on the\ + \ reason for application closure, used for finer categorization" + renewalApplyOfTransactionNumber: + type: integer + description: "For renewal applications, this field links to the transaction\ + \ number of the previous application or policy being renewed" + format: int64 + masterQuoteRef: type: string - description: "A policy number from a legacy system, maintained for historical or cross-reference purposes." - llcOwnedDt: + description: "A reference to the master quote associated with this application,\ + \ linking application data to quoting details" + addDt: type: string + description: "The date when the application was initially added to the system,\ + \ marking the start of its lifecycle" format: date - description: "The date on which the covered property was transferred to an LLC, if applicable." - lossSettlementType: - type: string - description: "The type of loss settlement provided by the policy, such as actual cash value or replacement cost." - manualBillingEntitySplitInd: - type: boolean - description: "Indicator of whether the billing for the policy is manually split among multiple entities." - manualReinstateInd: - type: boolean - description: "Indicator of whether the policy has been manually reinstated after cancellation or lapse." - manualReinstateReason: + closeReasonCd: type: string - description: "The reason for manually reinstating the policy, providing context for the action." - manualRenewalInd: - type: boolean - description: "Indicator of whether the policy is manually renewed, as opposed to automatically renewed." - manualRenewalReason: + description: "A code that categorizes the reason for the application's closure,\ + \ such as 'withdrawn' or 'issued'" + id: type: string - description: "The reason for manually renewing the policy, providing context for the renewal decision." - namedNonOwnedInd: - type: boolean - description: "Indicator of whether the policy includes coverage for named non-owned vehicles or properties." - oldSubTypeCd: + description: "A unique identifier for the application information record,\ + \ ensuring distinct and retrievable records within the system" + closeUser: type: string - description: "A legacy sub-type code for the policy, maintained for historical or compatibility purposes." - pLLineSelectedInd: + description: "The identifier of the user who performed the closure action,\ + \ contributing to the audit trail" + renewalApplyInd: type: boolean - description: "Indicator of whether personal lines coverage is selected, identifying if the policy includes insurance products designed for individuals and families, such as personal auto, homeowners, or personal umbrella coverage." - payPlanCd: + description: "Flags whether the application is marked for renewal, indicating\ + \ an ongoing relationship or coverage continuation" + lastMailedDt: type: string - description: "The code identifying the payment plan associated with the policy, dictating the schedule and method of premium payments." - paymentDay: + description: "The most recent date on which the application or related documents\ + \ were mailed out, indicating the latest communication attempt" + format: date + reinstatementOfTransactionNumber: + type: integer + description: "For applications that are reinstatements, this is the original\ + \ transaction number of the application that is being reinstated" + format: int64 + closeSubReasonLabel: type: string - description: "Specifies the day of the month on which recurring payments are due for the policy." - policySource: + description: "The textual description corresponding to the close sub-reason\ + \ code, offering human-readable insight into the closure reason" + correctedByTransactionNumber: + type: integer + description: "If the application was corrected by a subsequent transaction,\ + \ this is the number of that correcting transaction" + format: int64 + updateUser: type: string - description: "Identifies the origin of the policy, such as an online application, agent submission, or broker referral." - policyType: + description: "The identifier of the user who made the most recent update\ + \ to the application, part of the comprehensive audit trail" + iterationDescription: type: string - description: "Defines the type of insurance policy, such as auto, homeowners, commercial, etc., categorizing the policy for administrative and product-specific purposes." - previousCarrierCd: + description: "A description or identifier for the particular iteration or\ + \ version of the application, useful in tracking changes over time" + correctionOfTransactionNumber: + type: integer + description: "If this application serves as a correction, this is the original\ + \ transaction number that it corrects" + format: int64 + reinstatedByTransactionNumber: + type: integer + description: "Identifies the transaction number that led to the reinstatement\ + \ of this application, if it was previously closed or withdrawn" + format: int64 + needByDt: type: string - description: "The code of the insurance carrier that issued the previous policy, used for history tracking and risk assessment." - previousExpirationDt: + description: "The date by which the application processing needs to be completed,\ + \ often tied to coverage start dates or customer requirements" + format: date + updateDt: type: string + description: "The date of the last update made to the application, reflecting\ + \ the most recent changes or progress" format: date - description: "The expiration date of the policyholder's previous insurance policy, important for underwriting and continuity of coverage considerations." - previousPolicyNumber: + closeTm: type: string - description: "The policy number of the policyholder's previous insurance policy, used for reference and transferring information." - previousPremium: + description: "The exact time of day when the application was closed, providing\ + \ precise timing alongside the closure date" + updateTm: type: string - description: "The premium amount paid for the previous policy period, used for underwriting and pricing analysis." - productTypeCd: + description: "The time at which the last update to the application was made,\ + \ providing time-specific tracking of modifications" + firstMailedDt: type: string - description: "The code representing the specific insurance product type, facilitating product management and policy administration." - productVersionIdRef: + description: The date when the application or associated documents were + first mailed to the customer or relevant party + format: date + submittedDt: type: string - description: "A reference to the version ID of the insurance product, ensuring that the policy aligns with the correct product specifications and terms." - programCd: + description: "The date when the application was formally submitted for review\ + \ or processing, moving it forward in the underwriting or issuance pipeline" + format: date + closeComment: type: string - description: "The code identifying the insurance program under which the policy is issued, often related to specialized markets or groupings of policies." - promotionCd: + description: Any comments or notes regarding the reasons or circumstances + surrounding the application's closure + addTm: type: string - description: "The code for any promotional offers or discounts applied to the policy, used for marketing and billing purposes." - providerRef: + description: "The precise time of day when the application was added to\ + \ the system, complementing the add date for accurate tracking" + description: "Encapsulates a detailed record of an insurance application's lifecycle\ + \ within the system, tracking its creation, updates, mailing history, closure,\ + \ and any related correction or reinstatement transactions" + Driver: + type: object + properties: + addresses: + type: array + description: "An array of Address objects that detail the driver's associated\ + \ addresses, including home, mailing, and potentially other types of addresses" + items: + $ref: '#/components/schemas/Address' + _revision: type: string - description: "A reference identifier for the provider or originator of the policy, such as an agent, broker, or direct application system." - renewalProviderRef: + description: "A versioning identifier used to manage concurrent updates\ + \ to the driver resource, ensuring data integrity through optimistic locking\ + \ mechanisms" + x-ballerina-name: revision + _links: + type: array + description: "A collection of hypermedia links related to the driver, providing\ + \ quick access to related resources and actions such as fetching detailed\ + \ information or initiating workflows" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + eraseInfo: + $ref: '#/components/schemas/EraseInfo' + nameInfo: + $ref: '#/components/schemas/NameInfo' + partyTypeCd: type: string - description: "A reference identifier for the provider managing the renewal of the policy, which may differ from the original issuing provider." - renewalSubProducerCd: + description: "A categorization field that identifies the nature of the party's\ + \ relationship to the policy or entity, with 'ContactParty' denoting direct\ + \ contact or relation" + default: ContactParty + issues: + type: array + description: "A list of issues or points of concern related to the driver,\ + \ such as incidents or violations, that may affect insurance considerations" + items: + $ref: '#/components/schemas/Issue' + personInfo: + $ref: '#/components/schemas/PersonInfo' + locationIdRef: type: string - description: "The code for the sub-producer responsible for the renewal of the policy, part of the distribution channel management." - renewalTermCd: + description: "A reference to the geographical location or area associated\ + \ with the driver, potentially relevant for policies with geographical\ + \ considerations such as Personal Umbrella policies" + driverInfo: + $ref: '#/components/schemas/DriverPersonalInfo' + yearsOfService: + type: integer + description: "Represents the number of years the driver has been associated\ + \ with the insurance provider or specific policy, possibly impacting considerations\ + \ such as loyalty discounts or risk assessments" + emailInfo: + $ref: '#/components/schemas/EmailInfo' + phoneInfo: + type: array + description: "An array detailing the phone contact information associated\ + \ with the driver, facilitating various forms of communication" + items: + $ref: '#/components/schemas/PhoneInfo' + futureStatusCd: type: string - description: "The code representing the term for the policy renewal, dictating the duration and conditions for the renewed coverage period." - sessionLink: + description: "A code indicating the anticipated future status of the driver\ + \ with respect to the policy, such as pending renewal or cancellation" + id: type: string - description: "A URL or identifier linking to the session or transaction where the policy was created or modified, for audit and tracking purposes." - sicCode: + description: "A unique identifier for the driver, used to reference and\ + \ manage driver information within the system" + questionReplies: + $ref: '#/components/schemas/QuestionReplies' + underLyingPolicyIdRef: type: string - description: "The Standard Industrial Classification (SIC) code associated with the policyholder's primary business activity, used for underwriting and risk assessment." - subProducerCd: + description: "A reference to the specific insurance policy ID that this\ + \ driver is associated with, highlighting the connection to policy structures\ + \ and coverages" + underLyingPartyInfoIdRef: type: string - description: "The code identifying the sub-producer or agent responsible for the policy, part of the distribution and sales network." - subTypeCd: + description: "References detailed party information, linking the driver\ + \ to additional contextual data or policy-related entities" + status: type: string - description: "A more specific classification within the overall policy type, providing further detail on the coverage or policy structure." - transactionCd: + description: "Current status of the driver, indicating their active involvement\ + \ or any flags such as 'Deleted' for removed records" + description: "Detailed representation of a driver or potential driver, encompassing\ + \ personal information, contact details, associated addresses, and other relevant\ + \ information that pertains to their role and status within insurance policies" + QuestionReplies: + type: object + properties: + questionSourceMDA: type: string - description: "The code representing the type of transaction (e.g., new business, renewal, endorsement) that the policy record is associated with." - transactionNumber: - type: integer - format: int64 - description: "A unique identifier for the transaction involving the policy, used for tracking and auditing purposes." - transactionStatus: + description: "Metadata or identifier indicating the source or context of\ + \ the questions, such as a specific underwriting guideline or claim process\ + \ step" + id: type: string - description: "Indicates the current status of the policy transaction, such as pending, completed, or canceled." - transactionHistory: + description: "A unique identifier for the collection of question and replies,\ + \ facilitating organization and retrieval" + questionReply: type: array - description: "Detailed information on the previous transactions in this policy." + description: "An array of responses to specific questions, each containing\ + \ the question's details and the provided reply, structured according\ + \ to the QuestionReply schema" items: - $ref: "#/components/schemas/TransactionDetails" - umbrellaPolicyInfo: - $ref: '#/components/schemas/UmbrellaPolicyInfo' - description: "Details of any associated umbrella policy, providing extended liability coverage beyond the primary policy limits." - underwriterCd: + $ref: '#/components/schemas/QuestionReply' + description: "Encapsulates responses to a set of predefined questions, typically\ + \ used in underwriting or claim processes, to gather necessary information\ + \ in a structured format" + ListAddress: + type: object + properties: + addresses: + type: array + description: "An array of Address objects, each representing detailed information\ + \ about a specific address. The structure of each Address object is defined\ + \ by the Address schema" + items: + $ref: '#/components/schemas/Address' + description: "A structured response payload containing an array of addresses.\ + \ This schema facilitates the return of multiple address records in a single\ + \ API response, typically used in search or list endpoints where multiple\ + \ addresses need to be communicated" + TransactionText: + type: object + properties: + transactionTextTypeCd: type: string - description: "The code identifying the underwriter responsible for the policy, critical for risk management and policy approval processes." - underwritingHoldInd: - type: boolean - description: "Indicator of whether the policy is currently on hold due to underwriting review, awaiting additional information or decision." - vandalismMaliciousMischiefInd: - type: boolean - description: "Indicator of whether the policy includes coverage for vandalism and malicious mischief, protecting against specific types of property damage." - wcARDRuleEnabled: - type: boolean - description: "Indicator of whether the workers' compensation Average Rate Differential (ARD) rule is enabled, affecting premium calculations." - wcAnniversaryRatingDay: + description: Code indicating the type of transaction text + textCd: type: string - description: "The day on which the workers' compensation policy's rating and premium are reassessed annually, important for policy management and pricing." - wcPremiumDiscountTableTypeCd: + description: Code associated with the text + id: type: string - description: "The code for the type of premium discount table applied to the workers' compensation policy, affecting discounts for larger premium volumes." - UmbrellaPolicyInfo: + description: Unique identifier for the transaction text + text: + type: string + description: Text associated with the transaction + description: "Defines the structure for transaction text within the system,\ + \ including its ID, textual content, associated code, and transaction text\ + \ type" + StateProvinces: type: object - description: "Encapsulates detailed information regarding an umbrella insurance policy within the Guidewire InsuranceNow system. This schema is designed to capture and organize key identifiers and attributes of an umbrella policy, facilitating effective policy management, identification, and reference across the platform. It serves as a foundational element for operations such as policy lookup, modification, and integration with related insurance processes, ensuring a coherent and unified approach to managing umbrella policies." properties: id: type: string - description: "The unique identifier for the umbrella policy, used to uniquely distinguish this policy from others within the system." - idRef: - type: string - description: "A reference identifier that links this umbrella policy to related records or entities within the system, facilitating cross-referencing and data integrity." - policyNumber: + description: "The unique identifier or code for the state or province, often\ + \ used as a standard abbreviation or code in address formats" + stateProvName: type: string - description: "The policy number assigned to the umbrella policy, serving as a human-readable identifier that is often used in documentation and communications." - AuditPayPlan: - description: "Defines the payment plan for a policy as adjusted following an audit, which may result in changes to payment schedules or methods based on the audited information." + description: "The full name of the state or province, providing a clear\ + \ and unambiguous reference for users and systems interacting with address\ + \ information" + description: "Defines the attributes of a state or province, providing key identifiers\ + \ and names for use in addressing and location services within the insurance\ + \ application" + LinkReference: type: object properties: - auditPayPlanCd: + modelName: type: string - description: "A code representing the specific payment plan determined as a result of the audit, which may differ from the initial payment plan based on actual policy performance or other factors." - electronicPaymentSource: - $ref: '#/components/schemas/ElectronicPaymentSource' - description: "Details the electronic payment source to be used for payments under this audited pay plan, specifying account information and preferences." + description: "The name of the model or entity type that is being linked\ + \ to, providing clarity on the kind of resource the link references" + systemIdRef: + type: string + description: "The system-wide unique database identifier for the target\ + \ item of this link reference, used in scenarios where objects from different\ + \ containers or databases are interconnected" + description: + type: string + description: "Descriptive text for the link, typically generated based on\ + \ templates, that explains the nature or purpose of the link in user-readable\ + \ terms" id: type: string - description: "A unique identifier for the audit pay plan record, ensuring the ability to reference and apply the specific plan adjustments post-audit." - payPlanTemplateIdRef: + description: "A unique identifier for the link reference, facilitating tracking\ + \ and management of links within the application" + idRef: type: string - description: "References the template from which the audited payment plan was derived, indicating the base plan prior to any adjustments." - paymentDay: + description: "The reference ID of the target model to which this link points,\ + \ establishing a clear connection between the link and its associated\ + \ entity" + status: type: string - description: "Indicates the adjusted day of the month for payment due dates under the audited payment plan, which may have been modified from the original schedule." - TransactionDetails: - description: "Defines the details of a transaction within the system." + description: "Indicates the current status of the link, such as 'Active'\ + \ or 'Deleted', reflecting the link's operational state within the system" + description: "Encapsulates a reference to a linked resource within the system,\ + \ providing context and navigational properties to enhance connectivity between\ + \ different entities or data models" + TransactionInfo: type: object properties: - applicationRef: + paymentAmt: type: string - description: "Reference to the application." - bookDt: + description: "The amount of payment made or processed in this transaction,\ + \ relevant for transactions involving financial exchanges" + transactionShortDescription: + type: string + description: "A brief summary of the transaction, useful for quick reference\ + \ and overview in listings or summaries" + transactionEffectiveDt: type: string + description: "The effective date of the transaction, indicating when the\ + \ changes or actions associated with the transaction take effect" format: date - description: "Date when the transaction was booked." + newPolicyExpirationDt: + type: string + description: "The expiration date of the policy resulting from this transaction,\ + \ indicating the end of the current policy term" + format: date + sourceCd: + type: string + description: "Code that identifies the source of the transaction, such as\ + \ an online portal, agent submission, or system-generated adjustment" + newPolicyEffectiveDt: + type: string + description: "The effective date of the policy resulting from this transaction,\ + \ marking the start of the new or adjusted policy term" + format: date + renewalApplyOfTransactionNumber: + type: integer + description: "Transaction number of a renewal application associated with\ + \ this transaction, indicating continuity in the policy lifecycle" cancelOfTransactionNumber: type: integer - description: "Transaction number associated with the cancellation." - cancelRequestedByCd: + description: Transaction number of a previous transaction that this transaction + cancels or nullifies + reapplyOutputSuppressions: + type: array + description: "A list of output suppression settings to be reapplied as a\ + \ result of this transaction, affecting document generation and communication\ + \ preferences" + items: + $ref: '#/components/schemas/ReapplyOutputSuppression' + transactionEffectiveTm: type: string - description: "Code indicating who requested the cancellation." + description: "The precise time at which the transaction becomes effective,\ + \ providing additional specificity beyond the effective date" + releaseHoldReason: + type: string + description: "The reason provided for releasing any holds associated with\ + \ this transaction, facilitating administrative processing and documentation" cancelTypeCd: type: string - description: "Code indicating the type of cancellation." - cancelledByTransactionNumber: - type: integer - description: "Transaction number associated with the cancellation." + description: "Code categorizing the type of cancellation, aiding in the\ + \ processing and reporting of cancellations" + holdType: + type: string + description: "Specifies the type of hold placed on a transaction, impacting\ + \ how the transaction is processed and when it becomes effective" + id: + type: string + description: "A unique identifier for the transaction information record,\ + \ ensuring distinct management and tracking within the system" + renewalSubProducerCd: + type: string + description: "Code identifying the sub-producer or agent responsible for\ + \ the renewal, part of the distribution and sales tracking" chargeReinstatementFeeInd: type: boolean - description: "Indicates whether a reinstatement fee was charged." + description: "Indicator of whether a reinstatement fee is charged for this\ + \ transaction, typically associated with policy reinstatements" + wcReinstatementCd: + type: string + description: "For workers' compensation policies, a code that indicates\ + \ the conditions or reasons for reinstatement following cancellation or\ + \ lapse" checkNumber: type: string - description: "Number associated with the check." - conversionGroup: + description: "The number of the check used for payment in this transaction,\ + \ applicable for transactions involving check payments" + reinstatementOfTransactionNumber: + type: integer + description: "Transaction number of a previous transaction that this one\ + \ reinstates, creating a connection within the reinstatement process" + correctedByTransactionNumber: + type: integer + description: "Transaction number of a subsequent transaction that corrects\ + \ this one, facilitating tracking of corrections through transaction chains" + transactionNumber: + type: integer + description: "A system-assigned sequential number for the transaction, serving\ + \ as a unique identifier within the policy's transaction history" + transactionCd: type: string - description: "Group associated with conversion." - conversionJobRef: + description: "A code categorizing the transaction type, facilitating processing,\ + \ reporting, and historical tracking of policy transactions" + wcWaiveCancellationAuditInd: + type: boolean + description: "Indicates whether the audit requirement at cancellation has\ + \ been waived for a workers' compensation policy, affecting end-of-term\ + \ processing" + outputTypeCd: type: string - description: "Reference to the conversion job." - conversionTemplateIdRef: + description: "Code that identifies the type of output or document generation\ + \ triggered by this transaction, such as policy declarations or billing\ + \ statements" + paymentTypeCd: type: string - description: "Reference to the conversion template ID." - correctedByTransactionNumber: - type: integer - description: "Transaction number associated with correction." + description: "Code that classifies the type of payment made, such as premium\ + \ payment, reinstatement fee, or other transaction-related payment" + renewalProviderRef: + type: string + description: "Reference identifier for the renewal provider or system associated\ + \ with this transaction, linking to external systems managing renewals" correctionOfTransactionNumber: type: integer - description: "Transaction number associated with correction." + description: "Transaction number of a previous transaction that this one\ + \ corrects, establishing a correction relationship within the transaction\ + \ history" + reinstatedByTransactionNumber: + type: integer + description: "Transaction number of a subsequent transaction that reinstates\ + \ this one, linking transactions within the context of policy reinstatements" + transactionLongDescription: + type: string + description: "A detailed description of the transaction, offering insights\ + \ into its purpose, scope, and impact on the policy or customer" + electronicPaymentSource: + $ref: '#/components/schemas/ElectronicPaymentSource' + cancelRequestedByCd: + type: string + description: "Code identifying who requested the cancellation, providing\ + \ insight into the source of the transaction" + wcTotalNetLocationsManualPremiumAmt: + type: string + description: "In workers' compensation policies, the total premium amount\ + \ for manually rated locations, reflecting specific risk assessments" + rewriteToProductVersion: + type: string + description: "Specifies the product version to which the policy is being\ + \ rewritten as a result of this transaction, indicating product updates\ + \ or changes" + cancelledByTransactionNumber: + type: integer + description: "Transaction number of a subsequent transaction that cancels\ + \ this one, indicating a linkage between transactions within the policy\ + \ history" delayInvoiceInd: type: boolean - description: "Indicates whether invoice is delayed." - holdType: + description: "Indicator that the generation of an invoice for this transaction\ + \ should be delayed, according to specific processing rules or conditions" + description: "Captures detailed information related to a specific transaction\ + \ within the policy lifecycle, including cancellations, corrections, payments,\ + \ and policy term adjustments, among others" + ESignatureInfo: + type: object + properties: + signingType: type: string - description: "Type of hold." - id: + description: "Describes the method by which the electronic signature is\ + \ captured or verified, providing details on the procedural aspects of\ + \ the signing process" + eSignatureTypeCd: type: string - description: "Unique identifier for the transaction." - inforceChangePremiumAmt: + description: "A code that identifies the type of electronic signature process\ + \ or technology used, such as digital signatures or clickwrap agreements" + recipientCd: type: string - description: "Amount of change in premium for in-force policy." - inforcePremiumAmt: + description: "A code categorizing the recipient of the document requiring\ + \ an electronic signature, such as 'Insured', 'Agent', or 'Third Party'" + id: type: string - description: "Amount of in-force premium." - masterTransactionNumber: - type: integer - description: "Master transaction number." - newPolicyEffectiveDt: + description: "A unique identifier for the electronic signature information\ + \ record, enabling distinct management and tracking within the system" + description: "Contains information related to electronic signatures, including\ + \ the type of signature, recipient category, and signing methodology, facilitating\ + \ digital document execution and verification" + ListDriver: + type: object + properties: + continuationId: type: string - format: date - description: "Effective date of the new policy." - newPolicyExpirationDt: + description: "A unique identifier that can be used to request subsequent\ + \ pages of drivers. This value represents the row index from which the\ + \ next set of results should start, facilitating pagination in client\ + \ applications" + drivers: + $ref: '#/components/schemas/Driver' + description: "Encapsulates a paginated response structure that contains a list\ + \ of drivers, including relevant metadata to handle continuation of listing\ + \ if more drivers exist beyond the current response set" + ListNote: + type: object + properties: + noteListItems: + type: array + description: "An array of Note objects, each representing an individual\ + \ note with details such as content, priority, and status" + items: + $ref: '#/components/schemas/Note' + description: "Encapsulates a response that includes a list of notes associated\ + \ with a specific entity, such as a policy or claim, providing a structured\ + \ overview of textual annotations or reminders" + BasicPolicy: + type: object + properties: + effectiveDt: type: string + description: "The effective date of the policy, indicating when coverage\ + \ begins" format: date - description: "Expiration date of the new policy." - outputTypeCd: + payPlanCd: type: string - description: "Code indicating the type of output." - paymentAmt: + description: "The code identifying the payment plan associated with the\ + \ policy, dictating the schedule and method of premium payments" + businessSourceCd: type: string - description: "Amount of payment." - paymentTypeCd: + description: "The code indicating the source of business, such as direct,\ + \ broker, or agent" + branch: type: string - description: "Code indicating the type of payment." - reinstatedByTransactionNumber: - type: integer - description: "Transaction number associated with reinstatement." - reinstatementOfTransactionNumber: - type: integer - description: "Transaction number associated with reinstatement." - releaseHoldReason: + description: The branch or division of the insurance provider issuing the + policy + employmentAndPracticeLineSelectedInd: + type: boolean + description: Indicator of whether employment practices liability coverage + is selected + renewalTermCd: type: string - description: "Reason for releasing hold." - renewalApplyOfTransactionNumber: - type: integer - description: "Transaction number associated with renewal application." - renewalProviderRef: + description: "The code representing the term for the policy renewal, dictating\ + \ the duration and conditions for the renewed coverage period" + controllingStateCd: type: string - description: "Reference to renewal provider." - renewalSubProducerCd: + description: "The code of the state that has jurisdiction over the policy,\ + \ particularly important for multi-state operations" + productVersionIdRef: type: string - description: "Code indicating the sub-producer of renewal." - replacedByTransactionNumber: - type: integer - description: "Transaction number associated with replacement." - replacementOfTransactionNumber: - type: integer - description: "Transaction number associated with replacement." - rewriteToProductVersion: + description: "A reference to the version ID of the insurance product, ensuring\ + \ that the policy aligns with the correct product specifications and terms" + effectiveTm: type: string - description: "Version of the product for rewrite." - sourceCd: + description: "The effective time of the policy, providing precise coverage\ + \ start time" + errorsAndOmissionLineSelectedInd: + type: boolean + description: Indicator of whether Errors and Omissions (E&O) coverage is + selected + subProducerCd: type: string - description: "Code indicating the source of transaction." - submissionNumber: - type: integer - description: "Submission number." - transactionCd: + description: "The code identifying the sub-producer or agent responsible\ + \ for the policy, part of the distribution and sales network" + paymentDay: type: string - description: "Code indicating the type of transaction." - transactionCloseReasons: - $ref: '#/components/schemas/TransactionCloseReasons' - description: "Reasons for transaction closure." - transactionDt: + description: Specifies the day of the month on which recurring payments + are due for the policy + sessionLink: type: string - format: date - description: "Date of the transaction." - transactionEffectiveDt: + description: "A URL or identifier linking to the session or transaction\ + \ where the policy was created or modified, for audit and tracking purposes" + oldSubTypeCd: type: string - format: date - description: "Effective date of the transaction." - transactionEffectiveTm: + description: "A legacy sub-type code for the policy, maintained for historical\ + \ or compatibility purposes" + vandalismMaliciousMischiefInd: + type: boolean + description: "Indicator of whether the policy includes coverage for vandalism\ + \ and malicious mischief, protecting against specific types of property\ + \ damage" + autoDataPrefillInd: + type: boolean + description: Indicator of whether data prefilling is enabled for automatic + data capture and form completion + gLLineSelectedInd: + type: boolean + description: Indicator of whether general liability coverage is selected + id: type: string - description: "Time when the transaction became effective." - transactionLongDescription: + description: The unique identifier for the policy within the system + cCSubline: type: string - description: "Long description of the transaction." - transactionNumber: - type: integer - description: "Transaction number." - transactionReasons: - type: array - items: - $ref: '#/components/schemas/TransactionReason' - description: "Reasons associated with the transaction." - transactionShortDescription: + description: "Subline code for commercial coverage, providing additional\ + \ detail on the specific nature of the coverage" + pLLineSelectedInd: + type: boolean + description: "Indicator of whether personal lines coverage is selected,\ + \ identifying if the policy includes insurance products designed for individuals\ + \ and families, such as personal auto, homeowners, or personal umbrella\ + \ coverage" + displayDescription: type: string - description: "Short description of the transaction." - transactionText: - type: array - items: - $ref: '#/components/schemas/TransactionText' - description: "Text associated with the transaction." - transactionTm: + description: "A description of the policy designed for display purposes,\ + \ often used in customer-facing documents" + productTypeCd: type: string - description: "Time of the transaction." - transactionUser: + description: "The code representing the specific insurance product type,\ + \ facilitating product management and policy administration" + previousPolicyNumber: type: string - description: "User associated with the transaction." - unAppliedByTransactionNumber: - type: integer - description: "Transaction number associated with un-application." - unApplyOfTransactionNumber: - type: integer - description: "Transaction number associated with un-application." - unapplySource: + description: "The policy number of the policyholder's previous insurance\ + \ policy, used for reference and transferring information" + inceptionTm: type: string - description: "Source of un-application." - wcReinstatementCd: + description: "The inception time of the policy, providing precise start\ + \ time of coverage" + policySource: type: string - description: "Code indicating the reinstatement of workers compensation." - wcTotalNetLocationsManualPremiumAmt: + description: "Identifies the origin of the policy, such as an online application,\ + \ agent submission, or broker referral" + renewalProviderRef: type: string - description: "Total net locations manual premium amount for workers compensation." - wcWaiveCancellationAuditInd: + description: "A reference identifier for the provider managing the renewal\ + \ of the policy, which may differ from the original issuing provider" + cLLineSelectedInd: type: boolean - description: "Indicates whether cancellation audit for workers compensation is waived." - writtenChangePremiumAmt: + description: "Indicator of whether commercial lines coverage is selected,\ + \ encompassing a range of commercial policies" + directorsAndOfficersLineSelectedInd: + type: boolean + description: Indicator of whether Directors and Officers (D&O) liability + coverage is selected + carrierCd: type: string - description: "Amount of change in premium for written policy." - writtenFeeAmt: + description: The code representing the insurance carrier providing the policy + cCPolicyType: type: string - description: "Fee amount for written policy." - writtenPremiumAmt: + description: "The type of commercial property policy, detailing the specific\ + \ coverage options selected" + wcPremiumDiscountTableTypeCd: type: string - description: "Premium amount for written policy." - TransactionCloseReasons: - description: "Reasons for the closure of a transaction." - type: object - properties: - closeComment: + description: "The code for the type of premium discount table applied to\ + \ the workers' compensation policy, affecting discounts for larger premium\ + \ volumes" + cCLineSelectedInd: + type: boolean + description: Indicator of whether commercial property coverage is selected + transactionHistory: + type: array + description: Detailed information on the previous transactions in this policy + items: + $ref: '#/components/schemas/TransactionDetails' + cPPolicyType: type: string - description: "Comment associated with transaction closure." - closeReasonCd: + description: "The type of commercial package policy, detailing the specific\ + \ coverage options selected" + manualRenewalInd: + type: boolean + description: "Indicator of whether the policy is manually renewed, as opposed\ + \ to automatically renewed" + programCd: type: string - description: "Code indicating the reason for transaction closure." - closeSubReasonCd: + description: "The code identifying the insurance program under which the\ + \ policy is issued, often related to specialized markets or groupings\ + \ of policies" + wcAnniversaryRatingDay: type: string - description: "Code indicating the sub-reason for transaction closure." - closeSubReasonLabel: + description: "The day on which the workers' compensation policy's rating\ + \ and premium are reassessed annually, important for policy management\ + \ and pricing" + extendedCoverageInd: + type: boolean + description: Indicator of whether the policy includes extended coverage + beyond standard terms + previousExpirationDt: type: string - description: "Label associated with the sub-reason for transaction closure." - id: + description: "The expiration date of the policyholder's previous insurance\ + \ policy, important for underwriting and continuity of coverage considerations" + format: date + previousPremium: type: string - description: "Unique identifier for the transaction close reasons." - TransactionReason: - description: "Reason associated with a transaction." - type: object - properties: - id: + description: "The premium amount paid for the previous policy period, used\ + \ for underwriting and pricing analysis" + commCLUERequestInd: + type: boolean + description: Indicator of whether a commercial CLUE (Comprehensive Loss + Underwriting Exchange) report has been requested for underwriting purposes + description: type: string - description: "Unique identifier for the transaction reason." - reasonCd: + description: "A brief description of the policy, summarizing the key coverage\ + \ and policy details" + wcARDRuleEnabled: + type: boolean + description: "Indicator of whether the workers' compensation Average Rate\ + \ Differential (ARD) rule is enabled, affecting premium calculations" + carrierGroupCd: type: string - description: "Code indicating the reason for the transaction." - TransactionText: - description: "Defines the structure for transaction text within the system, including its ID, textual content, associated code, and transaction text type." - type: object - properties: - id: + description: "The code representing the group of insurance carriers, if\ + \ applicable, under which the policy is issued" + umbrellaPolicyInfo: + $ref: '#/components/schemas/UmbrellaPolicyInfo' + cALineSelectedInd: + type: boolean + description: Indicator of whether commercial auto line coverage is selected + in the policy + namedNonOwnedInd: + type: boolean + description: Indicator of whether the policy includes coverage for named + non-owned vehicles or properties + dPLineSelectedInd: + type: boolean + description: Indicator of whether dwelling property coverage is selected + previousCarrierCd: type: string - description: "Unique identifier for the transaction text." - text: + description: "The code of the insurance carrier that issued the previous\ + \ policy, used for history tracking and risk assessment" + renewalSubProducerCd: type: string - description: "Text associated with the transaction." - textCd: + description: "The code for the sub-producer responsible for the renewal\ + \ of the policy, part of the distribution channel management" + fireLightningInd: + type: boolean + description: Indicator of whether the policy includes coverage for fire + and lightning damage + inceptionDt: type: string - description: "Code associated with the text." - transactionTextTypeCd: + description: "The inception date of the policy, marking the beginning of\ + \ coverage, distinct from the effective date in some cases" + format: date + manualRenewalReason: type: string - description: "Code indicating the type of transaction text." - ElectronicPaymentSource: - description: "Defines the details of an electronic payment source, such as bank account or credit card information, used for processing payments within the system. It includes both ACH (Automated Clearing House) and credit card payment methods." - type: object - properties: - achBankAccountNumber: + description: "The reason for manually renewing the policy, providing context\ + \ for the renewal decision" + cILineSelectedInd: + type: boolean + description: Indicator of whether commercial inland marine coverage is selected + comments: type: string - description: "The bank account number for ACH payments, essential for direct bank transfers." - achBankAccountTypeCd: + description: Free-form comments or notes associated with the policy + affinityGroupCd: type: string - description: "A code identifying the type of bank account (e.g., checking, savings) used for ACH payments." - achBankName: + description: "The code representing the affinity group associated with the\ + \ policy, which may qualify the policyholder for certain benefits or discounts" + subTypeCd: type: string - description: "The name of the bank where the ACH account is held, providing necessary details for payment processing." - achExceptionMsg: + description: "A more specific classification within the overall policy type,\ + \ providing further detail on the coverage or policy structure" + transactionStatus: type: string - description: "Message detailing any exceptions or issues encountered during the ACH payment process, useful for troubleshooting and record-keeping." - achName: + description: "Indicates the current status of the policy transaction, such\ + \ as pending, completed, or canceled" + manualReinstateReason: type: string - description: "The name associated with the ACH account, typically the account holder's name as it appears on bank records." - achRoutingNumber: + description: "The reason for manually reinstating the policy, providing\ + \ context for the action" + transactionNumber: + type: integer + description: "A unique identifier for the transaction involving the policy,\ + \ used for tracking and auditing purposes" + format: int64 + transactionCd: type: string - description: "The routing number for the bank account, a critical component for directing ACH payments to the correct financial institution." - achStandardEntryClassCd: + description: "The code representing the type of transaction (e.g., new business,\ + \ renewal, endorsement) that the policy record is associated with" + externalId: type: string - description: "A code that categorizes the type of ACH transaction, conforming to standard entry class specifications for payment processing." - agentTrustInd: - type: boolean - description: "Indicates whether the payment source is an agent's trust account, differentiating it from customer-owned accounts." - carrierCd: + description: "An external identifier for the policy, used for integration\ + \ with external systems or databases" + companyProductCd: type: string - description: "Carrier code associated with the payment, identifying the insurance carrier in cases of payments facilitated by or through carriers." - creditCardNumber: + description: "The product code of the company, identifying the specific\ + \ insurance product offered" + auditPayPlan: + $ref: '#/components/schemas/AuditPayPlan' + cPLineSelectedInd: + type: boolean + description: Indicator of whether commercial package policy coverage is + selected + legacyPolicyNumber: type: string - description: "The number of the credit card used for payments, sensitive data that must be handled according to PCI compliance standards." - creditCardTypeCd: + description: "A policy number from a legacy system, maintained for historical\ + \ or cross-reference purposes" + manualBillingEntitySplitInd: + type: boolean + description: Indicator of whether the billing for the policy is manually + split among multiple entities + expirationDt: type: string - description: "A code indicating the type of credit card (e.g., Visa, MasterCard) used for the payment." - customerPaymentProfileId: + description: "The expiration date of the policy, indicating when coverage\ + \ ends" + format: date + lossSettlementType: type: string - description: "An identifier for the customer's payment profile, allowing for the reuse of stored payment information in a secure manner." - customerProfileId: + description: "The type of loss settlement provided by the policy, such as\ + \ actual cash value or replacement cost" + providerRef: type: string - description: "An identifier linking the electronic payment source to a customer profile, facilitating comprehensive customer payment management." - eraseInfo: - $ref: '#/components/schemas/EraseInfo' - description: "Contains details regarding the policies and procedures for erasing this payment source information, ensuring compliance with data protection laws." - id: + description: "A reference identifier for the provider or originator of the\ + \ policy, such as an agent, broker, or direct application system" + electronicPaymentSource: + $ref: '#/components/schemas/ElectronicPaymentSource' + promotionCd: type: string - description: "A unique identifier for the electronic payment source record within the system." - methodCd: + description: "The code for any promotional offers or discounts applied to\ + \ the policy, used for marketing and billing purposes" + manualReinstateInd: + type: boolean + description: Indicator of whether the policy has been manually reinstated + after cancellation or lapse + sicCode: type: string - description: "A code that specifies the payment method (e.g., ACH, credit card), important for directing the payment process accordingly." - midasId: + description: "The Standard Industrial Classification (SIC) code associated\ + \ with the policyholder's primary business activity, used for underwriting\ + \ and risk assessment" + policyType: type: string - description: "An identifier used in MIDAS (Money Inflow/Disbursement Administration System) or similar systems for tracking financial transactions." - partyInfo: - $ref: '#/components/schemas/PartyInfo' - description: "Detailed information about the party responsible for the payment, including contact and identification data." - paymentServiceAccountId: + description: "Defines the type of insurance policy, such as auto, homeowners,\ + \ commercial, etc., categorizing the policy for administrative and product-specific\ + \ purposes" + underwritingHoldInd: + type: boolean + description: "Indicator of whether the policy is currently on hold due to\ + \ underwriting review, awaiting additional information or decision" + cAPolicyType: type: string - description: "An account identifier used by the payment service provider, linking the payment transaction to external payment processing systems." - reminderDt: + description: "The type of commercial auto policy, detailing specific coverage\ + \ options selected" + llcOwnedDt: type: string + description: "The date on which the covered property was transferred to\ + \ an LLC, if applicable" format: date - description: "A date indicating when a payment reminder should be sent, aiding in timely payment collection and customer notification." - sourceName: - type: string - description: "The name of the payment source, providing a human-readable identifier for the payment method or account." - sourceTypeCd: + cGLineSelectedInd: + type: boolean + description: Indicator of whether general liability coverage is selected + underwriterCd: type: string - description: "A code identifying the category of payment source (e.g., internal, external, third-party), useful for payment routing and management." - statusCd: + description: "The code identifying the underwriter responsible for the policy,\ + \ critical for risk management and policy approval processes" + description: "Summarizes foundational information about a policy, including\ + \ its identification, associated affinity group, and details about its payment\ + \ plan" + DriverPoint: + type: object + properties: + pointsChargeable: + type: integer + description: "The number of points that are chargeable against the driver,\ + \ directly affecting insurance assessments and premiums" + comments: type: string - description: "A code indicating the current status of the payment source, such as active, inactive, or under review, guiding its availability for use." - action: + description: Additional remarks or explanations regarding the specific points + or the incident leading to the points + pointsCharged: + type: integer + description: The actual number of points charged to the driver after considerations + such as mitigating factors or legal adjustments + sourceCd: type: string - description: "Placeholder for any action related to the payment source, such as update or deletion." - creditCardAuthorizationCd: + description: "The source code identifying where the point data originated\ + \ from, such as a state DMV or court system, ensuring traceability" + driverPointsNumber: + type: integer + description: The total number of points assigned to the driver as a result + of the recorded incident or conviction + templateId: type: string - description: "Code indicating the status of credit card authorization, such as approved or declined." - creditCardAuthorizationMessage: + description: "Reference to a template used for documenting or processing\ + \ driver points, facilitating standardized record-keeping" + infractionCd: type: string - description: "Message providing additional details regarding credit card authorization status or any associated messages." - creditCardExpirationMonth: + description: A code representing the specific infraction or violation that + resulted in the points being assigned to the driver + infractionDt: type: string - description: "The expiration month of the credit card." - creditCardExpirationYr: + description: "The date on which the infraction occurred, crucial for determining\ + \ the relevance and impact of the points over time" + directPortalIncidentId: type: string - description: "The expiration year of the credit card." - creditCardHolderName: + description: "A unique identifier for the incident as recorded in the direct\ + \ portal, linking the points to specific events or violations" + expirationDt: type: string - description: "The name of the credit card holder as it appears on the card." - creditCardSecurityCd: + description: "The date when the points are set to expire or be removed from\ + \ the driver's record, following applicable laws or regulations" + typeCd: type: string - description: "The security code associated with the credit card, typically found on the back of the card." - Contact: - description: "Details a contact entity, capturing essential identification, type, and communication preferences, facilitating targeted and effective interactions." - type: object - properties: - contactTypeCd: + description: "A categorization code that classifies the type of points or\ + \ the nature of the infractions, aiding in analysis and reporting" + convictionDt: type: string - description: "A code that categorizes the contact by their relationship or role, such as 'Agent', 'Insured', or 'Claimant', aiding in context-specific communication and processes." + description: "The date on which the conviction was registered, leading to\ + \ points being added to the driver's record" + ignoreInd: + type: boolean + description: "Indicator of whether these points should be ignored or not\ + \ considered in the driver's risk assessment, possibly due to mitigating\ + \ circumstances" + default: true id: type: string - description: "A unique identifier for the contact within the system, enabling precise reference and management." - partyInfo: - $ref: '#/components/schemas/PartyInfo' - description: "Comprehensive demographic and identification information for the contact, linking to a structured record of their personal or organizational details." - preferredDeliveryMethod: - type: string - description: "Specifies the contact's preferred method for receiving communications, such as 'Email', 'Paper Mail', or 'SMS', ensuring compliance with their preferences." + description: "A unique identifier for the driver point record, allowing\ + \ for tracking and management within the system" status: type: string - description: "Indicates the current status of the contact within the system, such as 'Active' or 'Inactive', reflecting their availability for communication and transactions." - Insured: - description: "Represents an insured entity or individual within the system, encompassing both basic identification and specific insurance-related information." + description: "The current status of the points, such as 'Active', 'Expired',\ + \ or 'Removed', reflecting the driver's current standing" + description: "Details the points associated with a driver, typically as a result\ + \ of traffic violations or incidents. These points can impact insurance premiums\ + \ and coverage" + ProductInfo: type: object properties: - entityTypeCd: + name: type: string - description: "A code that identifies the nature of the insured entity, such as 'Individual', 'Corporation', or 'Partnership', reflecting the structure and legal status of the insured." + description: "The descriptive name of the product as defined in the Product\ + \ Master, providing a human-readable identifier that may correspond to\ + \ marketing or regulatory naming conventions" id: type: string - description: "A unique identifier assigned to the insured within the system, facilitating tracking, policy association, and risk assessment." - indexName: - type: string - description: "A standardized name used for indexing and search purposes, often formatted to meet specific regulatory or operational requirements." - partyInfo: + description: "A unique identifier for the insurance product, enabling precise\ + \ reference and retrieval within the system" + description: "Provides key details about an insurance product, including its\ + \ identification and descriptive name, facilitating product-specific processing\ + \ and categorization" + ListCountry: + required: + - countries + type: object + properties: + countries: type: array - description: "A list of PartyInfo objects associated with the insured, detailing multiple roles, relationships, or contact points as needed." + description: "An array of country objects, each representing a country supported\ + \ by the system. This list includes both the ISO code and the name of\ + \ each country" items: - $ref: '#/components/schemas/PartyInfo' - preferredDeliveryMethod: + $ref: '#/components/schemas/Country' + description: A structured response that enumerates all countries supported by + the system. This can be used to populate selection lists or validate country + data in user inputs + DriverPersonalInfo: + type: object + properties: + attachedVehicleRef: type: string - description: "The preferred method of communication or document delivery for the insured, aligning with their convenience and regulatory preferences." - ratingBureauID: + description: "Reference ID of the vehicle(s) attached to the driver within\ + \ the policy, establishing a direct association between the driver and\ + \ specific vehicles" + defensiveDriverEffectiveDt: type: string - description: "An identifier used by rating bureaus to classify or rate the insured, relevant in jurisdictions or lines of business where bureau ratings are applicable." - selfInsured: + description: "The start date from which the benefits of completing a defensive\ + \ driving course take effect, often related to policy discounts" + goodDriverInd: type: boolean - description: "Indicates whether the insured operates under a self-insurance model, relevant for certain types of coverage and risk management strategies." - temporaryAddressOverrideInd: + description: "Indicates recognition of the driver as a 'good driver', potentially\ + \ affecting policy rates and eligibility for specific benefits" + default: true + goodDriverDiscountInd: type: boolean - description: "A flag that indicates a temporary override of the insured's standard address, useful for short-term billing or communication needs." - wcNAICS: + description: "Signals that the driver qualifies for a good driver discount,\ + \ based on a history of safe driving and adherence to traffic laws" + default: true + scholasticCertificationDt: type: string - description: "The North American Industry Classification System (NAICS) code applicable to the insured's business, used for statistical and risk assessment purposes." - wcNCCIRiskIdNumber: + description: "The date on which the driver qualified for a scholastic achievement\ + \ discount, typically based on academic performance" + yearsExperience: type: string - description: "A risk identification number assigned by the National Council on Compensation Insurance (NCCI), relevant for workers' compensation insurance." - wcSIC: + description: "The total number of years the driver has held a valid driving\ + \ license, serving as an indicator of experience and proficiency" + mvrStatusDt: type: string - description: "The Standard Industrial Classification (SIC) code for the insured's business, providing an industry-based risk indicator." - websiteAddress: + description: "The date on which the MVR status was last updated, important\ + \ for maintaining current and accurate driver records" + driverTrainingCompletionDt: type: string - description: "The official website address for the insured or their business, offering an additional contact point and information source." - yearsInBusiness: + description: "The date the driver completed a formal training program, which\ + \ may qualify them for additional benefits or discounts within their insurance\ + \ policy" + driverNumber: type: integer - description: "The total number of years the insured has been in operation, reflecting business stability and experience for underwriting and risk assessment." - SubmitterIssue: - description: "Encapsulates issues identified by the submitter during the insurance application or quote submission process, including categorization and descriptive messaging." - type: object - properties: - id: + description: "A unique sequence number assigned to the driver, used for\ + \ identification and tracking within the insurance policy" + driverStartDt: type: string - description: "A unique identifier for the submitter issue, facilitating tracking and resolution efforts within the system." - msg: + description: "The effective date when the driver was added to the policy,\ + \ used for calculating the duration of coverage and experience" + licenseDt: type: string - description: "A descriptive message detailing the nature of the issue, providing insight into potential concerns or required actions." - subTypeCd: + description: "The date on which the driver's license was issued, critical\ + \ for verifying legal driving status and calculating experience" + driverStatusCd: type: string - description: "A code further specifying the subtype of the issue, offering additional granularity beyond the primary type for more precise categorization." - typeCd: + description: "The current status of the driver, such as 'Occasional' or\ + \ 'Principal', indicating their primary role or frequency of vehicle use\ + \ within the policy" + mvrRequestInd: + type: boolean + description: "Indicates that a Motor Vehicle Report (MVR) has been requested\ + \ for the driver, a critical step in assessing driving history and risk" + default: true + defensiveDriverExpirationDt: type: string - description: "The primary classification code for the issue, indicating its general category and aiding in prioritization and resolution strategies." - TransactionInfo: - description: "Captures detailed information related to a specific transaction within the policy lifecycle, including cancellations, corrections, payments, and policy term adjustments, among others." - type: object - properties: - cancelOfTransactionNumber: - type: integer - description: "Transaction number of a previous transaction that this transaction cancels or nullifies." - cancelRequestedByCd: + description: "The expiration date of the defensive driving course benefits,\ + \ after which renewal may be necessary to maintain associated discounts" + yearLicensed: type: string - description: "Code identifying who requested the cancellation, providing insight into the source of the transaction." - cancelTypeCd: + description: "The year in which the driver was first licensed, offering\ + \ a measure of driving experience and history" + licenseNumber: type: string - description: "Code categorizing the type of cancellation, aiding in the processing and reporting of cancellations." - cancelledByTransactionNumber: - type: integer - description: "Transaction number of a subsequent transaction that cancels this one, indicating a linkage between transactions within the policy history." - chargeReinstatementFeeInd: - type: boolean - description: "Indicator of whether a reinstatement fee is charged for this transaction, typically associated with policy reinstatements." - checkNumber: + description: "The official number associated with the driver's license,\ + \ essential for identity verification and records management" + id: type: string - description: "The number of the check used for payment in this transaction, applicable for transactions involving check payments." - correctedByTransactionNumber: + description: A unique identifier for the driver's personal information record + within the system + accidentPreventionCourseCompletionDt: + type: string + description: "The date the driver completed an accident prevention course,\ + \ potentially qualifying them for insurance discounts" + mvrStatus: + type: string + description: "The status of the MVR data report, providing insights into\ + \ the driver's history and any potential issues or endorsements" + permanentLicenseInd: + type: boolean + description: "Indicates whether the driver possesses a permanent driving\ + \ license, as opposed to a provisional or temporary license" + default: true + assignedVehicle: type: integer - description: "Transaction number of a subsequent transaction that corrects this one, facilitating tracking of corrections through transaction chains." - correctionOfTransactionNumber: + description: "The total number of vehicles assigned to the driver within\ + \ the policy, illustrating the extent of the driver's responsibility" + lengthTimeDriving: type: integer - description: "Transaction number of a previous transaction that this one corrects, establishing a correction relationship within the transaction history." - delayInvoiceInd: + description: "The total number of years the driver has been actively driving,\ + \ reflecting experience and potentially influencing risk profiles" + driverInfoCd: + type: string + description: "A code that categorizes the driver within the system, often\ + \ used for internal classification and processing" + default: ContactDriver + driverTrainingInd: type: boolean - description: "Indicator that the generation of an invoice for this transaction should be delayed, according to specific processing rules or conditions." - electronicPaymentSource: - $ref: '#/components/schemas/ElectronicPaymentSource' - description: "Details the electronic payment source used for this transaction, providing information on the payment method and account." - holdType: + description: "A flag indicating whether the driver has undergone formal\ + \ driving training, potentially influencing risk assessments and policy\ + \ pricing" + excludeDriverInd: type: string - description: "Specifies the type of hold placed on a transaction, impacting how the transaction is processed and when it becomes effective." - id: + description: "Indicates whether the driver is excluded from certain policy\ + \ coverages or rating considerations, based on underwriting decisions\ + \ or policy options" + requiredProofOfInsuranceInd: + type: boolean + description: "Signals the requirement for the driver to provide proof of\ + \ insurance to the state or regulatory body, often linked to vehicle registration\ + \ processes" + default: true + licensedStateProvCd: type: string - description: "A unique identifier for the transaction information record, ensuring distinct management and tracking within the system." - newPolicyEffectiveDt: + description: "The code of the state or province that issued the driver's\ + \ license, indicating the jurisdiction under which the license is valid" + scholasticDiscountInd: + type: boolean + description: "Indicates eligibility for a discount based on scholastic achievement,\ + \ aimed at student drivers who maintain high academic standards" + default: true + statusComments: type: string - format: date - description: "The effective date of the policy resulting from this transaction, marking the start of the new or adjusted policy term." - newPolicyExpirationDt: + description: "Free-form comments that provide additional context or explanations\ + \ for the driver's status, changes, or specific conditions noted in the\ + \ record" + licenseStatus: type: string - format: date - description: "The expiration date of the policy resulting from this transaction, indicating the end of the current policy term." - outputTypeCd: + description: "Current status of the driver's license, such as 'Valid', 'Suspended',\ + \ or 'Expired', impacting eligibility for insurance" + matureDriverInd: + type: boolean + description: "Designates the driver as a 'mature driver', possibly qualifying\ + \ for specific discounts based on age and experience" + default: true + accidentPreventionCourseInd: + type: boolean + description: Indicates whether the driver has completed an accredited accident + prevention course + default: true + driverTypeCd: type: string - description: "Code that identifies the type of output or document generation triggered by this transaction, such as policy declarations or billing statements." - paymentAmt: + description: "Classifies the driver by type, such as 'Excluded' or 'Underaged',\ + \ affecting policy terms and coverage limits" + relationshipToInsuredCd: type: string - description: "The amount of payment made or processed in this transaction, relevant for transactions involving financial exchanges." - paymentTypeCd: + description: "Specifies the driver's relationship to the insured party,\ + \ such as 'Husband', 'Wife', 'Son', 'Daughter', affecting policy structure\ + \ and coverages" + dateofHire: type: string - description: "Code that classifies the type of payment made, such as premium payment, reinstatement fee, or other transaction-related payment." - reapplyOutputSuppressions: + description: "The date on which the driver was officially hired or employed,\ + \ relevant in contexts where driving is a professional activity" + driverPoints: type: array - description: "A list of output suppression settings to be reapplied as a result of this transaction, affecting document generation and communication preferences." + description: "A detailed record of points accumulated by the driver, reflecting\ + \ violations, infractions, or other factors that may impact insurance\ + \ rates or coverage" items: - $ref: '#/components/schemas/ReapplyOutputSuppression' - reinstatedByTransactionNumber: + $ref: '#/components/schemas/DriverPoint' + defensiveDriverInd: + type: boolean + description: "Indicates successful completion of a defensive driving course\ + \ by the driver, which may affect insurance premiums or eligibility for\ + \ certain coverage options" + default: true + description: "Captures comprehensive personal and professional details about\ + \ a driver, including driving history, license information, and eligibility\ + \ for various insurance benefits based on driving qualifications and courses\ + \ completed" + Error: + required: + - code + - message + type: object + properties: + code: type: integer - description: "Transaction number of a subsequent transaction that reinstates this one, linking transactions within the context of policy reinstatements." - reinstatementOfTransactionNumber: + description: The HTTP status code + stackTrace: + type: string + description: Information about the error stack trace + message: + type: string + description: A brief description of the error + description: Detailed information about an error + AddressStateProvinceTemplates: + type: object + properties: + stateProvinces: + type: array + description: "A collection of state or province entities, each conforming\ + \ to the defined StateProvinces schema, allowing for detailed representation\ + \ of geographic administrative divisions" + items: + $ref: '#/components/schemas/StateProvinces' + description: "Provides a structured format for representing state or province\ + \ information associated with addresses, facilitating consistency and accuracy\ + \ in address data across various geographic locations" + TransactionDetails: + type: object + properties: + transactionUser: + type: string + description: User associated with the transaction + replacementOfTransactionNumber: + type: integer + description: Transaction number associated with replacement + unAppliedByTransactionNumber: type: integer - description: "Transaction number of a previous transaction that this one reinstates, creating a connection within the reinstatement process." + description: Transaction number associated with un-application releaseHoldReason: type: string - description: "The reason provided for releasing any holds associated with this transaction, facilitating administrative processing and documentation." - renewalApplyOfTransactionNumber: + description: Reason for releasing hold + conversionJobRef: + type: string + description: Reference to the conversion job + replacedByTransactionNumber: type: integer - description: "Transaction number of a renewal application associated with this transaction, indicating continuity in the policy lifecycle." - renewalProviderRef: + description: Transaction number associated with replacement + writtenChangePremiumAmt: type: string - description: "Reference identifier for the renewal provider or system associated with this transaction, linking to external systems managing renewals." - renewalSubProducerCd: + description: Amount of change in premium for written policy + id: type: string - description: "Code identifying the sub-producer or agent responsible for the renewal, part of the distribution and sales tracking." - rewriteToProductVersion: + description: Unique identifier for the transaction + checkNumber: type: string - description: "Specifies the product version to which the policy is being rewritten as a result of this transaction, indicating product updates or changes." - sourceCd: + description: Number associated with the check + reinstatementOfTransactionNumber: + type: integer + description: Transaction number associated with reinstatement + inforcePremiumAmt: type: string - description: "Code that identifies the source of the transaction, such as an online portal, agent submission, or system-generated adjustment." - transactionCd: + description: Amount of in-force premium + outputTypeCd: type: string - description: "A code categorizing the transaction type, facilitating processing, reporting, and historical tracking of policy transactions." - transactionEffectiveDt: + description: Code indicating the type of output + paymentTypeCd: type: string - format: date - description: "The effective date of the transaction, indicating when the changes or actions associated with the transaction take effect." - transactionEffectiveTm: + description: Code indicating the type of payment + renewalProviderRef: type: string - description: "The precise time at which the transaction becomes effective, providing additional specificity beyond the effective date." + description: Reference to renewal provider + correctionOfTransactionNumber: + type: integer + description: Transaction number associated with correction transactionLongDescription: type: string - description: "A detailed description of the transaction, offering insights into its purpose, scope, and impact on the policy or customer." - transactionNumber: + description: Long description of the transaction + transactionCloseReasons: + $ref: '#/components/schemas/TransactionCloseReasons' + wcTotalNetLocationsManualPremiumAmt: + type: string + description: Total net locations manual premium amount for workers compensation + rewriteToProductVersion: + type: string + description: Version of the product for rewrite + transactionDt: + type: string + description: Date of the transaction + format: date + paymentAmt: + type: string + description: Amount of payment + submissionNumber: type: integer - description: "A system-assigned sequential number for the transaction, serving as a unique identifier within the policy's transaction history." + description: Submission number + transactionTm: + type: string + description: Time of the transaction transactionShortDescription: type: string - description: "A brief summary of the transaction, useful for quick reference and overview in listings or summaries." - wcReinstatementCd: + description: Short description of the transaction + unapplySource: type: string - description: "For workers' compensation policies, a code that indicates the conditions or reasons for reinstatement following cancellation or lapse." - wcTotalNetLocationsManualPremiumAmt: + description: Source of un-application + transactionEffectiveDt: type: string - description: "In workers' compensation policies, the total premium amount for manually rated locations, reflecting specific risk assessments." - wcWaiveCancellationAuditInd: - type: boolean - description: "Indicates whether the audit requirement at cancellation has been waived for a workers' compensation policy, affecting end-of-term processing." - ReapplyOutputSuppression: - description: "Specifies settings for reapplying output suppression rules to a transaction, indicating whether certain communications or document outputs should be included or suppressed based on specific criteria." - type: object - properties: - id: + description: Effective date of the transaction + format: date + newPolicyExpirationDt: type: string - description: "A unique identifier for the output suppression rule, enabling tracking and management of suppression settings." - includeInd: - type: boolean - description: "Indicates whether the suppression rule should be included in the current transaction, determining if related outputs are generated." - WCAdditionalInsured: - description: "Details an additional insured entity or individual on a workers' compensation policy, providing key identification and insurance-related information." - type: object - properties: - entityTypeCd: + description: Expiration date of the new policy + format: date + writtenFeeAmt: type: string - example: "Additional Named Insured" - description: "A code indicating the type of entity the additional insured represents, such as 'Additional Named Insured', categorizing their role within the policy context." - id: + description: Fee amount for written policy + sourceCd: type: string - description: "A unique identifier for the additional insured record, facilitating distinct management and reference within the system." - indexName: + description: Code indicating the source of transaction + newPolicyEffectiveDt: type: string - description: "A standardized name used for indexing and searching purposes, often formatted to meet specific operational or regulatory requirements." - insuranceScore: - type: array - description: "An array of InsuranceScore objects that provide scoring or rating information related to the additional insured, used in underwriting and risk assessment." - items: - $ref: '#/components/schemas/InsuranceScore' - insuredNumber: + description: Effective date of the new policy + format: date + conversionTemplateIdRef: + type: string + description: Reference to the conversion template ID + renewalApplyOfTransactionNumber: type: integer - description: "A numerical identifier assigned to the additional insured, useful for tracking and differentiation from other insured entities on the policy." - linkReference: - type: array - description: "A collection of references linking the additional insured to related records or external entities, enhancing data connectivity and context." - items: - $ref: '#/components/schemas/LinkReference' - partyInfo: - $ref: '#/components/schemas/PartyInfo' - description: "Comprehensive demographic and identification information for the additional insured, providing a full profile of the entity or individual." - preferredDeliveryMethod: + description: Transaction number associated with renewal application + bookDt: type: string - description: "Indicates the preferred method for delivering communications or documents to the additional insured, aligning with their convenience and regulatory preferences." - status: + description: Date when the transaction was booked + format: date + cancelOfTransactionNumber: + type: integer + description: Transaction number associated with the cancellation + transactionEffectiveTm: type: string - description: "The current status of the additional insured within the policy, such as 'Active' or 'Inactive', reflecting their involvement and coverage status." - InsuranceScore: - description: "Provides details about an insurance score, including the score itself, reasons for the score, and related metadata, which is used in the underwriting and risk assessment processes." - type: object - properties: - id: + description: Time when the transaction became effective + writtenPremiumAmt: type: string - description: "A unique identifier for the insurance score record, facilitating tracking and management within the system." - insuranceScore: + description: Premium amount for written policy + unApplyOfTransactionNumber: + type: integer + description: Transaction number associated with un-application + cancelTypeCd: type: string - description: "The insurance score, typically a numerical value or rating, derived from various factors and used to assess the risk associated with an insured or applicant." - insuranceScoreReasons: - type: array - description: "A list of reasons contributing to the insurance score, providing insight into factors influencing the score." - items: - $ref: '#/components/schemas/InsuranceScoreReason' - insuranceScoreTypeCd: + description: Code indicating the type of cancellation + holdType: type: string - description: "A code categorizing the type of insurance score, such as credit-based or claims history, indicating the basis for the scoring." - overriddenInsuranceScore: + description: Type of hold + renewalSubProducerCd: type: string - description: "If applicable, the insurance score that overrides the original score, typically resulting from manual review or additional information." - sourceCd: + description: Code indicating the sub-producer of renewal + chargeReinstatementFeeInd: + type: boolean + description: Indicates whether a reinstatement fee was charged + wcReinstatementCd: type: string - description: "A code indicating the source of the insurance score, such as an external credit bureau or an internal scoring system." - sourceIdRef: + description: Code indicating the reinstatement of workers compensation + applicationRef: type: string - description: "A reference to the specific source record or identifier for the insurance score, linking to detailed source information." - statusCd: + description: Reference to the application + correctedByTransactionNumber: + type: integer + description: Transaction number associated with correction + transactionNumber: + type: integer + description: Transaction number + inforceChangePremiumAmt: type: string - description: "The current status of the insurance score, such as 'Active' or 'Reviewed', indicating its state within the underwriting process." - InsuranceScoreReason: - description: "Describes a specific reason contributing to an insurance score, offering explanations for adjustments or factors affecting the score." - type: object - properties: - description: + description: Amount of change in premium for in-force policy + transactionCd: type: string - description: "A textual description of the reason, explaining its impact or relevance to the insurance score." - id: + description: Code indicating the type of transaction + transactionReasons: + type: array + description: Reasons associated with the transaction + items: + $ref: '#/components/schemas/TransactionReason' + wcWaiveCancellationAuditInd: + type: boolean + description: Indicates whether cancellation audit for workers compensation + is waived + conversionGroup: type: string - description: "A unique identifier for the insurance score reason, enabling distinct management and reference." - reasonCd: + description: Group associated with conversion + reinstatedByTransactionNumber: + type: integer + description: Transaction number associated with reinstatement + masterTransactionNumber: + type: integer + description: Master transaction number + transactionText: + type: array + description: Text associated with the transaction + items: + $ref: '#/components/schemas/TransactionText' + cancelRequestedByCd: type: string - description: "A code representing the specific reason affecting the insurance score, used for categorization and analysis." + description: Code indicating who requested the cancellation + cancelledByTransactionNumber: + type: integer + description: Transaction number associated with the cancellation + delayInvoiceInd: + type: boolean + description: Indicates whether invoice is delayed + description: Defines the details of a transaction within the system PartyInfo: - description: "Encapsulates comprehensive information about a party involved in the insurance process, including personal, business, and contact details, facilitating holistic management and communication." type: object properties: addresses: - description: "A list of addresses associated with the party, detailing physical locations for billing, correspondence, or property coverage." type: array + description: "A list of addresses associated with the party, detailing physical\ + \ locations for billing, correspondence, or property coverage" items: $ref: '#/components/schemas/Address' - businessInfo: - $ref: '#/components/schemas/BusinessInfo' - description: "Details about the party's business operations, applicable for commercial clients or insureds, including business type and financial information." - driverInfo: - $ref: '#/components/schemas/DriverInfo' - description: "Driving-related information for the party, relevant for policies involving vehicle coverage or where driving history affects eligibility or rates." - eSignatureInfo: - $ref: '#/components/schemas/ESignatureInfo' - description: "Information related to electronic signatures, facilitating document signing and verification processes in a digital context." - emailInfo: - $ref: '#/components/schemas/EmailInfo' - description: "Email contact information for the party, supporting electronic communication preferences and correspondence." eraseInfo: $ref: '#/components/schemas/EraseInfo' - description: "Details regarding data erasure requests or actions for the party's information, addressing privacy and regulatory compliance." - id: - type: string - description: "A unique identifier for the party record within the system, ensuring accurate reference and integration across processes." - locationIdRef: - type: string - description: "Reference to a specific location associated with the party, often used for underwriting or claims purposes." nameInfo: $ref: '#/components/schemas/NameInfo' - description: "Name information for the party, encompassing formal, commercial, or alternative names used in various contexts." partyTypeCd: type: string - description: "A code indicating the type of party (e.g., individual, corporation), aiding in classification and process differentiation." + description: "A code indicating the type of party (e.g., individual, corporation),\ + \ aiding in classification and process differentiation" personInfo: $ref: '#/components/schemas/PersonInfo' - description: "Personal demographics and identification details for the party, applicable to individual clients or contacts." + businessInfo: + $ref: '#/components/schemas/BusinessInfo' + locationIdRef: + type: string + description: "Reference to a specific location associated with the party,\ + \ often used for underwriting or claims purposes" + taxInfo: + $ref: '#/components/schemas/TaxInfo' + driverInfo: + $ref: '#/components/schemas/DriverInfo' + eSignatureInfo: + $ref: '#/components/schemas/ESignatureInfo' + yearsOfService: + type: integer + description: "The number of years the party has been associated with services\ + \ or policies within the system, indicating tenure or loyalty" + emailInfo: + $ref: '#/components/schemas/EmailInfo' phoneInfo: - description: "A collection of phone numbers for the party, covering different types, purposes, and preferences." type: array + description: "A collection of phone numbers for the party, covering different\ + \ types, purposes, and preferences" items: $ref: '#/components/schemas/PhoneInfo' + id: + type: string + description: "A unique identifier for the party record within the system,\ + \ ensuring accurate reference and integration across processes" questionReplies: $ref: '#/components/schemas/QuestionReplies' - description: "Responses to questions posed to the party, relevant for underwriting, claims, or service inquiries." - status: + underLyingPolicyIdRef: type: string - description: "The current status of the party within the system, reflecting activity, eligibility, or compliance states." - taxInfo: - $ref: '#/components/schemas/TaxInfo' - description: "Tax-related information for the party, including identification numbers and status, crucial for financial transactions and reporting." + description: "A reference to an underlying policy associated with the party,\ + \ establishing connections for coverage, claims, or account management" underLyingPartyInfoIdRef: type: string - description: "A reference to underlying party information, linking related records or entities within the system." - underLyingPolicyIdRef: + description: "A reference to underlying party information, linking related\ + \ records or entities within the system" + status: type: string - description: "A reference to an underlying policy associated with the party, establishing connections for coverage, claims, or account management." - yearsOfService: - type: integer - description: "The number of years the party has been associated with services or policies within the system, indicating tenure or loyalty." - BusinessInfo: - description: "Details the business-related aspects of a party, including financial, operational, and classification information, tailored for commercial insurance contexts." + description: "The current status of the party within the system, reflecting\ + \ activity, eligibility, or compliance states" + description: "Encapsulates comprehensive information about a party involved\ + \ in the insurance process, including personal, business, and contact details,\ + \ facilitating holistic management and communication" + Contact: type: object properties: - annualPayrollAmt: - type: string - description: "The total amount of payroll paid annually by the business, a factor in workers' compensation and liability coverages." - annualSalesAmt: - type: string - description: "The total annual sales or revenue generated by the business, influencing coverage needs and premium calculations." - businessInfoCd: + contactTypeCd: type: string - description: "A code categorizing the business information record for internal tracking and management." - businessTypeCd: + description: "A code that categorizes the contact by their relationship\ + \ or role, such as 'Agent', 'Insured', or 'Claimant', aiding in context-specific\ + \ communication and processes" + partyInfo: + $ref: '#/components/schemas/PartyInfo' + preferredDeliveryMethod: type: string - description: "A code indicating the type of business, such as corporation, sole proprietorship, or partnership, relevant for underwriting and policy customization." + description: "Specifies the contact's preferred method for receiving communications,\ + \ such as 'Email', 'Paper Mail', or 'SMS', ensuring compliance with their\ + \ preferences" id: type: string - description: "A unique identifier for the business information record within the system, facilitating accurate reference and management." - natureBusinessCd: - type: string - description: "A code describing the nature of the business, used for classification and risk assessment purposes." - natureOfBusiness: - type: string - description: "A textual description of the business's primary operations, providing context for underwriting and coverage considerations." - numberEmployees: - type: string - description: "The number of employees working for the business, impacting liability exposures and coverage requirements." - yearsInBusiness: + description: "A unique identifier for the contact within the system, enabling\ + \ precise reference and management" + status: type: string - description: "The total number of years the business has been operational, indicating stability and experience in its field." - DriverInfo: - description: "Captures comprehensive driving-related information for an individual, including licensing details, driving history, and eligibility for discounts based on driving courses and behavior." + description: "Indicates the current status of the contact within the system,\ + \ such as 'Active' or 'Inactive', reflecting their availability for communication\ + \ and transactions" + description: "Details a contact entity, capturing essential identification,\ + \ type, and communication preferences, facilitating targeted and effective\ + \ interactions" + Quote: type: object properties: - accidentPreventionCourseCompletionDt: - type: string - format: date - description: "The date the driver completed an accredited accident prevention course, potentially qualifying for insurance discounts." - accidentPreventionCourseInd: - type: boolean - description: "Indicates whether the driver has successfully completed an accident prevention course." - assignedVehicle: - type: integer - description: "The number of vehicles officially assigned to the driver within the policy, indicating responsibility and primary usage." - attachedVehicleRef: - type: string - description: "Reference identifier for the vehicle(s) associated with the driver, linking driver information to specific vehicles covered under the policy." - dateofHire: - type: string - format: date - description: "The date the driver was hired for employment, applicable when driving is a part of professional duties." - defensiveDriverEffectiveDt: - type: string - format: date - description: "The start date from which defensive driving course benefits apply, reflecting eligibility for associated discounts." - defensiveDriverExpirationDt: - type: string - format: date - description: "The expiration date for defensive driving course benefits, after which renewal may be required to maintain discounts." - defensiveDriverInd: - type: boolean - description: "Indicates whether the driver has completed a defensive driving course, affecting insurance premiums and coverage options." - driverInfoCd: - type: string - description: "A code categorizing the type of driver information record, useful for system processing and classification." - driverPoints: + wcAdditionalInsureds: type: array - description: "A list of points accrued by the driver for traffic violations or other infractions, impacting risk assessment and premium calculation." + description: "List of additional insured entities for workers' compensation\ + \ policies, detailing parties other than the primary insured that receive\ + \ coverage" items: - $ref: '#/components/schemas/DriverPoint' - driverStartDt: - type: string - format: date - description: "The date the driver began driving, relevant for calculating driving experience and insurance eligibility." - driverStatusCd: - type: string - description: "A code indicating the current status of the driver, such as active or suspended, which may influence policy terms and pricing." - driverTrainingCompletionDt: - type: string - format: date - description: "The date on which the driver completed a formal driver training program, potentially affecting policy discounts." - driverTrainingInd: - type: boolean - description: "Indicates completion of a formal driver training program, qualifying the driver for potential insurance benefits." - driverTypeCd: - type: string - description: "Categorizes the driver by type, such as 'Primary' or 'Occasional', affecting policy coverage and premiums." - excludeDriverInd: - type: string - description: "Specifies whether the driver is excluded from certain coverages within the policy, based on risk assessments or other factors." - goodDriverDiscountInd: - type: boolean - description: "Indicates eligibility for a good driver discount, based on a history of safe driving practices." - goodDriverInd: - type: boolean - description: "Affirms the driver's qualification as a good driver, impacting insurance rates and coverage eligibility." - id: - type: string - description: "A unique identifier for the driver information record, ensuring distinct management within the insurance system." - lengthTimeDriving: - type: integer - description: "The total number of years the individual has been driving, crucial for evaluating driving experience and risk." - licenseDt: - type: string - format: date - description: "The date on which the driver's license was issued, foundational for legal driving status and insurance underwriting." - licenseNumber: - type: string - description: "The official number associated with the driver's license, essential for identification and record-keeping." - licenseStatus: - type: string - description: "The current status of the driver's license, such as valid, suspended, or expired, directly affecting insurance eligibility." - licensedStateProvCd: + $ref: '#/components/schemas/WCAdditionalInsured' + _revision: type: string - description: "The code for the state or province that issued the driver's license, indicating jurisdiction and legal authority." - matureDriverInd: - type: boolean - description: "Indicates recognition of the driver as a mature driver, possibly affecting insurance premiums and coverage options." - mvrRequestInd: - type: boolean - description: "Indicates that a Motor Vehicle Report (MVR) has been requested for the driver, a key component in risk assessment and policy pricing." - mvrStatus: + description: "A system-generated version identifier for the quote, used\ + \ to manage updates and ensure data integrity through optimistic concurrency\ + \ control" + x-ballerina-name: revision + insured: + $ref: '#/components/schemas/Insured' + statementAccountRef: type: string - description: "The status of the driver's MVR, providing insights into driving history, violations, and overall risk profile." - mvrStatusDt: + description: "A reference to the statement account associated with this\ + \ quote, used for billing and financial transactions related to the policy" + _links: + type: array + description: "A collection of hypermedia links to related resources and\ + \ actions available for the quote, facilitating easy navigation and interaction\ + \ within the API ecosystem" + items: + $ref: '#/components/schemas/Link' + x-ballerina-name: links + wcCoveredStates: + type: array + description: "A list of states in which workers' compensation coverage is\ + \ included within the policy as proposed by this quote, reflecting multi-state\ + \ operations and compliance" + items: + $ref: '#/components/schemas/WCCoveredState' + description: type: string - format: date - description: "The date of the last update to the driver's MVR status, important for maintaining current and accurate risk assessments." - permanentLicenseInd: - type: boolean - description: "Specifies whether the driver holds a permanent driving license, as opposed to a provisional or temporary license." - relationshipToInsuredCd: + description: "A brief description or summary of the quote, providing insights\ + \ into the coverage scope, purpose, or specific considerations" + externalStateData: type: string - description: "Describes the driver's relationship to the insured entity or individual, such as family member or employee, impacting coverage details." - requiredProofOfInsuranceInd: - type: boolean - description: "Indicates whether the driver is required to provide proof of insurance, typically for legal or regulatory compliance." - scholasticCertificationDt: + description: "External system data related to the quote, potentially including\ + \ state-specific requirements, third-party data, or external identifiers" + submitterIssues: + type: array + description: "A list of issues or concerns raised by the submitter or system\ + \ during the quoting process, requiring attention or resolution before\ + \ proceeding" + items: + $ref: '#/components/schemas/SubmitterIssue' + policyRef: type: string - format: date - description: "The date the driver qualified for a discount based on scholastic achievements, relevant for young or student drivers." - scholasticDiscountInd: - type: boolean - description: "Indicates eligibility for a discount based on scholastic performance, encouraging responsible behavior among student drivers." - statusComments: + description: "A reference identifier linking the quote to a specific policy\ + \ or policy proposal, establishing a connection between quoting and policy\ + \ issuance" + transactionInfo: + $ref: '#/components/schemas/TransactionInfo' + lockTaskId: type: string - description: "Comments related to the driver's status, providing additional context or explanations for status assignments or changes." - yearLicensed: + description: "An identifier for a system task or process that has locked\ + \ the quote for exclusive access, preventing concurrent modifications" + vipLevel: type: string - description: "The year in which the driver was first licensed, offering a measure of driving experience and proficiency." - yearsExperience: - type: integer - description: "The total number of years the driver has held a license, serving as an indicator of experience and driving history." - ESignatureInfo: - description: "Contains information related to electronic signatures, including the type of signature, recipient category, and signing methodology, facilitating digital document execution and verification." - type: object - properties: - eSignatureTypeCd: + description: "Indicates the VIP level or priority of the quote, which may\ + \ affect processing speed, service levels, or access to special pricing" + basicPolicy: + $ref: '#/components/schemas/BasicPolicy' + customerRef: type: string - description: "A code that identifies the type of electronic signature process or technology used, such as digital signatures or clickwrap agreements." + description: "A reference identifier linking the quote to a customer record,\ + \ enabling correlation between customer details and quotation data" id: type: string - description: "A unique identifier for the electronic signature information record, enabling distinct management and tracking within the system." - recipientCd: - type: string - description: "A code categorizing the recipient of the document requiring an electronic signature, such as 'Insured', 'Agent', or 'Third Party'." - signingType: + description: "The unique identifier for the quote, facilitating tracking,\ + \ management, and retrieval within the system" + applicationInfo: + $ref: '#/components/schemas/ApplicationInfo' + contacts: + type: array + description: "A list of contacts associated with the quote, including individuals\ + \ or entities involved in the policy as insureds, beneficiaries, or other\ + \ roles" + items: + $ref: '#/components/schemas/Contact' + status: type: string - description: "Describes the method by which the electronic signature is captured or verified, providing details on the procedural aspects of the signing process." - TaxInfo: - description: "Encapsulates tax identification information for an individual or entity, including tax ID numbers, legal entity classification, and documentation status, essential for compliance and financial reporting." + description: "The current status of the quote, indicating its progression\ + \ through the quoting process, approval state, or any conditions affecting\ + \ its validity" + description: "Encapsulates comprehensive details about a quotation for insurance\ + \ coverage, including linked resources, policy information, and the status\ + \ of the quote" + InsuranceScoreReason: type: object properties: - fein: + description: type: string - description: "The Federal Employer Identification Number (FEIN) for the entity, used in tax filings and other legal documents as a unique identifier." + description: "A textual description of the reason, explaining its impact\ + \ or relevance to the insurance score" id: type: string - description: "A unique identifier for the tax information record, facilitating accurate tracking and association with parties or accounts." - legalEntityCd: - type: string - description: "A code indicating the legal entity type, such as corporation, partnership, or sole proprietor, relevant for tax classification and compliance." - received1099Ind: - type: boolean - description: "Indicates whether the party has received a Form 1099, used for reporting income from sources other than wages, salaries, and tips." - receivedW9Ind: - type: boolean - description: "Indicates whether a Form W-9 has been received from the party, used to request the taxpayer identification number and certification." - required1099Ind: - type: boolean - description: "Specifies if the issuance of a Form 1099 is required for the party, based on the nature of payments or income received." - ssn: - type: string - description: "The Social Security Number (SSN) for individuals, serving as a primary identification number for tax and other legal purposes." - taxIdTypeCd: - type: string - description: "A code that specifies the type of tax identification number provided, such as SSN or FEIN, indicating the format and nature of the ID." - taxTypeCd: + description: "A unique identifier for the insurance score reason, enabling\ + \ distinct management and reference" + reasonCd: type: string - description: "A code describing the tax classification of the party, such as 'Individual', 'Corporation', or 'Partnership', impacting tax treatment and obligations." - withholdingExemptInd: - type: boolean - description: "Indicates whether the party is exempt from tax withholding, relevant for processing payments and tax reporting." - WCCoveredState: - description: "Details specific workers' compensation coverage options and conditions for a given state, including discounts, deductibles, experience modifications, and other factors influencing the policy's terms and premium calculations." + description: "A code representing the specific reason affecting the insurance\ + \ score, used for categorization and analysis" + description: "Describes a specific reason contributing to an insurance score,\ + \ offering explanations for adjustments or factors affecting the score" + WCAdditionalInsured: type: object properties: - aRDRuleEnabled: - type: boolean - description: "Indicates whether the Alternate Risk Distribution (ARD) rule is enabled for this state, affecting risk assessment and premium distribution." - alcoholDrugFreeCreditInd: - type: boolean - description: "Indicates eligibility for a credit based on participation in alcohol and drug-free workplace programs." - certifiedSafetyHealthProgPct: - type: string - description: "The percentage credit applied for participation in certified safety and health programs, encouraging workplace safety initiatives." - coinsuranceInd: - type: boolean - description: "Indicates the presence of a coinsurance arrangement for the covered state, impacting the distribution of risk between insurer and insured." - contrClassPremAdjCreditPct: - type: string - description: "The percentage credit applied based on adjustments to the contractor classification premium, reflecting specific risk profiles and experience." - deductibleAmt: - type: string - description: "The amount of deductible applied to the policy for the covered state, influencing out-of-pocket costs before insurance coverage begins." - deductibleType: - type: string - description: "Specifies the type of deductible, such as 'per claim' or 'aggregate', defining how the deductible applies within the policy terms." - eLVoluntaryCompensationInd: - type: boolean - description: "Indicates whether Employers' Liability Voluntary Compensation is included, extending coverage beyond statutory workers' compensation requirements." - experienceModificationFactor: - type: string - description: "A factor reflecting the insured's historical claims experience relative to the industry average, affecting premium calculations." - experienceModificationStatus: - type: string - description: "Status of the experience modification, such as 'applied' or 'pending', indicating the current application of the experience factor." - experienceRatingCd: + partyInfo: + $ref: '#/components/schemas/PartyInfo' + insuranceScore: + type: array + description: "An array of InsuranceScore objects that provide scoring or\ + \ rating information related to the additional insured, used in underwriting\ + \ and risk assessment" + items: + $ref: '#/components/schemas/InsuranceScore' + indexName: type: string - description: "A code representing the insured's experience rating, categorizing the risk level based on past claims history." - gLScheduledPremiumMod: + description: "A standardized name used for indexing and searching purposes,\ + \ often formatted to meet specific operational or regulatory requirements" + preferredDeliveryMethod: type: string - description: "Scheduled premium modification for General Liability, affecting the overall premium calculation based on specific risk adjustments." + description: "Indicates the preferred method for delivering communications\ + \ or documents to the additional insured, aligning with their convenience\ + \ and regulatory preferences" + linkReference: + type: array + description: "A collection of references linking the additional insured\ + \ to related records or external entities, enhancing data connectivity\ + \ and context" + items: + $ref: '#/components/schemas/LinkReference' id: type: string - description: "A unique identifier for the workers' compensation coverage record within the specified state." - index: - type: integer - description: "A numerical index used for ordering or categorization within the system, facilitating data organization and retrieval." - largeDeductibleFactor: + description: "A unique identifier for the additional insured record, facilitating\ + \ distinct management and reference within the system" + entityTypeCd: type: string - description: "A factor applied in cases of large deductibles, influencing the premium calculation by accounting for the increased self-assumed risk." - managedCareCreditInd: - type: boolean - description: "Indicates the application of a credit for participation in managed care programs, reflecting cost savings from efficient care management." - noOfContractsForWaiverOfSubrogation: + description: "A code indicating the type of entity the additional insured\ + \ represents, such as 'Additional Named Insured', categorizing their role\ + \ within the policy context" + example: Additional Named Insured + insuredNumber: + type: integer + description: "A numerical identifier assigned to the additional insured,\ + \ useful for tracking and differentiation from other insured entities\ + \ on the policy" + status: type: string - description: "The number of contracts under which a waiver of subrogation applies, affecting the rights of the insurer to pursue recovery from third parties." - noncomplianceChargeAmt: + description: "The current status of the additional insured within the policy,\ + \ such as 'Active' or 'Inactive', reflecting their involvement and coverage\ + \ status" + description: "Details an additional insured entity or individual on a workers'\ + \ compensation policy, providing key identification and insurance-related\ + \ information" + NameInfo: + type: object + properties: + nameTypeCd: type: string - description: "The amount charged for noncompliance with specified conditions or requirements, serving as a penalty or incentive for adherence to policy terms." - numberOfClaims: + description: "A code that categorizes the type of name record, such as 'ContactName',\ + \ indicating the context or application of the name information" + default: ContactName + prefixCd: type: string - description: "The number of claims filed under the policy for the covered state, providing a measure of risk and loss history." - order: - type: integer - description: "Specifies the order in which this state's coverage details are presented or processed, indicating sequencing within multi-state policies." - packageFactorInd: - type: boolean - description: "Indicates whether package factors, combining multiple coverages or policies, are applied in premium calculations for the state." - primaryInd: - type: boolean - description: "Designates the state as the primary state of coverage, relevant for policies covering multiple jurisdictions." - productVersionIdRef: + description: "A prefix code indicating titles or honorifics preceding the\ + \ name, such as 'Mr.', 'Dr.', or 'Ms.', contributing to respectful and\ + \ accurate address" + extendedName: type: string - description: "Reference to the product version associated with this coverage, linking state-specific terms to overall policy structure and offerings." - ratingEffectiveDt: + description: "An extended version of the name that may include additional\ + \ identifiers or descriptive information, enhancing clarity and specificity" + indexName: type: string - format: date - description: "The effective date of the rating and pricing structure applied to the covered state, marking the beginning of the applicable terms." - ruleStatus: + description: "A standardized name format used for indexing, typically following\ + \ conventions to facilitate sorting and retrieval" + givenName: type: string - description: "Indicates the status of regulatory or internal rules applied to the coverage, such as 'active', 'pending', or 'expired'." - stateCd: + description: "The individual's first name or given name, used in personal\ + \ identification" + dbaIndexName: type: string - description: "The code representing the state for which the coverage details apply, identifying the jurisdiction covered by the policy terms." - status: + description: "Index name under which the business is filed 'Doing Business\ + \ As' (DBA), facilitating accurate identification and indexing" + dbaName: type: string - description: "The current status of the coverage for the specified state, indicating active, inactive, or pending states of the coverage terms." - totalDiscountedPremiumAmt: + description: "The 'Doing Business As' (DBA) name, representing the trading\ + \ name under which the business or entity operates publicly, distinct\ + \ from the legal business name" + commercialName2: type: string - description: "The total premium amount after applying discounts, reflecting cost adjustments based on risk management practices or other criteria." - totalManualPremiumAmt: + description: "An additional commercial name field, allowing for legal aliases\ + \ or alternative business names" + suffixCd: type: string - description: "The total premium calculated based on manual rates before application of experience modifications or other adjustments." - totalStandardPremiumAmt: + description: "A suffix code indicating qualifiers or titles following the\ + \ name, such as 'Jr.', 'Sr.', or academic credentials, adding to the formal\ + \ identification of the individual" + surname: type: string - description: "The standard premium amount prior to any discounts or modifications, serving as a baseline for subsequent premium calculations." - totalStateEstimatedPremium: + description: "The individual's last name or family name, essential for personal\ + \ identification and official documentation" + positionCd: type: string - description: "An estimate of the total premium for the covered state, considering specific state rates, classifications, and coverage requirements." - totalSubjectPremiumAmt: + description: "A code representing the individual's position or title within\ + \ an organization, if applicable, contributing to formal identification\ + \ and correspondence" + id: type: string - description: "The portion of the premium subject to adjustments and modifications, based on covered payroll, classification rates, and experience factors." - unemploymentNumber: + description: "A unique identifier for the name information record, ensuring\ + \ trackability and distinct management within the system" + shortName: type: string - description: "The unemployment insurance number for the insured within the covered state, relevant for businesses and compliance reporting." - waiverOfSubrogationFlatInd: - type: boolean - description: "Indicates whether a flat waiver of subrogation applies, limiting the insurer's right to recover from third parties causing loss." - workStudyProgram: + description: "A shortened or informal version of the name, used for ease\ + \ of communication or in less formal contexts" + otherGivenName: type: string - description: "Details about any work-study programs affecting coverage or premium calculations, relevant for educational institutions or employers." - workfareProgramWeeksNum: + description: "An additional or middle given name of the individual, providing\ + \ completeness to personal identification" + commercialName: type: string - description: "The number of weeks covered under a workfare program, applicable for policies including workfare participants." - ListNote: - description: "Encapsulates a response that includes a list of notes associated with a specific entity, such as a policy or claim, providing a structured overview of textual annotations or reminders." - type: object - properties: - noteListItems: - description: "An array of Note objects, each representing an individual note with details such as content, priority, and status." - type: array - items: - $ref: '#/components/schemas/Note' - Note: - description: "Represents a detailed record of a note, capturing contextual comments, priority, and administrative metadata, aiding in communication and documentation processes." + description: "The official commercial name of an entity, used in business\ + \ contexts and legal documents" + description: "Captures comprehensive details about an individual's or entity's\ + \ name, accommodating various name formats and types to support a wide range\ + \ of commercial and personal naming conventions" + QuestionReply: type: object properties: - addDt: - type: string - description: "The date when the note was initially added to the system, providing a temporal context for the information." - addTm: - type: string - description: "The precise time of day when the note was added, complementing the date for accurate chronological tracking." - addUser: - type: string - description: "The identifier of the user who created the note, linking the note to its author for reference or follow-up." - comments: + visibleInd: + type: boolean + description: "Indicates whether the question is currently set to be visible\ + \ to the user, allowing for conditional display based on context or previous\ + \ answers" + default: true + displayDesc: type: string - description: "Additional comments associated with the note, offering further clarification, instructions, or context." - description: + description: "A descriptive label or prompt for the question, intended to\ + \ be displayed as part of the question when presented to the user" + name: type: string - description: "A brief description or summary of the note's content, providing an at-a-glance understanding of its purpose or subject matter." - memo: + description: "The name or key identifying the question, which may be used\ + \ to map the reply to specific processes or data fields" + id: type: string - description: "A detailed memorandum contained within the note, elaborating on the topic, decision-making process, or action items." - priorityCd: + description: "A unique identifier for the question and reply instance, allowing\ + \ for tracking and referencing within the system" + text: type: string - description: "A code indicating the note's priority, such as 'High', 'Medium', or 'Low', affecting its visibility and urgency." - ref: + description: "The full text of the question as presented to the user, detailing\ + \ what information or response is being requested" + value: type: string - description: "A reference identifier linking the note to related records or entities, enhancing data connectivity and retrieval." - status: + description: "The reply or response provided to the question, stored as\ + \ a string regardless of the original format or type of the input" + description: "Encapsulates both a specific question posed within the system\ + \ and the corresponding reply, facilitating the structured collection of information\ + \ for processes such as underwriting or claim assessment" + TransactionReason: + type: object + properties: + id: type: string - description: "The current status of the note, such as 'Active', 'Completed', or 'Cancelled', reflecting its relevance and actionability." - stickyInd: - type: boolean - description: "A boolean indicator specifying whether the note is marked as 'sticky' or particularly important, ensuring prominence in listings or displays." - templateId: + description: Unique identifier for the transaction reason + reasonCd: type: string - description: "An identifier for a note template that was used as a basis for this note, standardizing the format and content for specific types of annotations." - NoteDetail: - description: "Provides an in-depth view of a note, including its content, priority, and associated metadata, facilitating detailed documentation and tracking within the system." + description: Code indicating the reason for the transaction + description: Reason associated with a transaction + DocumentDetail: type: object properties: - description: + filename: type: string - description: "A brief overview or summary of the note's content, providing insight into its purpose and significance." + description: "The name of the file as stored within the system, including\ + \ extension, facilitating file identification and access" eraseInfo: $ref: '#/components/schemas/EraseInfo' - description: "Information related to the erasure of the note, addressing data privacy and compliance requirements." - id: + description: type: string - description: "A unique identifier assigned to the note, enabling distinct tracking and retrieval within the system." - linkReferences: - type: array - description: "A collection of references linking the note to other related records or documents, enhancing contextual understanding and data integration." - items: - $ref: '#/components/schemas/LinkReference' + description: "A textual summary of the document's content or purpose, aiding\ + \ in identification and categorization" memo: type: string - description: "An extended memo or detailed commentary associated with the note, providing additional context, explanations, or action items." - priorityCd: - type: string - description: "A code indicating the note's priority level, such as 'High', 'Medium', or 'Low', guiding attention and response urgency." - purgeInfo: - type: object - description: "Details regarding the conditions and policies for purging the note from the system, ensuring data management compliance." - showOnAllProducerContainersInd: - type: boolean - description: "Indicates whether the note should be visible across all producer containers, ensuring broad visibility when necessary." - stickyInd: - type: boolean - description: "Specifies whether the note is marked as 'sticky' or important, warranting prominent display or special attention." - tags: - type: array - description: "A set of tags categorizing or highlighting aspects of the note, facilitating organization and thematic grouping." - items: - $ref: '#/components/schemas/Tag' - templateId: - type: string - description: "Identifier for the template used in creating the note, standardizing format and content for specific types of notes." - DocumentDetail: - description: "Outlines detailed information about a document, including its description, associated files, and metadata, supporting comprehensive document management and access." - type: object - properties: + description: "An accompanying memo providing further detail or context about\ + \ the document, enhancing understanding or guiding action" compositeFile: type: array - description: "A collection of files that comprise the document, accommodating multi-part documents or attachments." + description: "A collection of files that comprise the document, accommodating\ + \ multi-part documents or attachments" items: $ref: '#/components/schemas/CompositeFile' - description: - type: string - description: "A textual summary of the document's content or purpose, aiding in identification and categorization." - eraseInfo: - $ref: '#/components/schemas/EraseInfo' - description: "Information pertaining to the erasure of the document, related to data retention policies and privacy regulations." - filename: - type: string - description: "The name of the file as stored within the system, including extension, facilitating file identification and access." id: type: string - description: "A unique identifier for the document, ensuring unambiguous reference across the system." + description: "A unique identifier for the document, ensuring unambiguous\ + \ reference across the system" linkReferences: type: array - description: "Links connecting the document to related entities or records, promoting interconnectedness and contextual awareness." + description: "Links connecting the document to related entities or records,\ + \ promoting interconnectedness and contextual awareness" items: $ref: '#/components/schemas/LinkReference' - memo: - type: string - description: "An accompanying memo providing further detail or context about the document, enhancing understanding or guiding action." purgeInfo: type: object - description: "Details the criteria and processes for purging the document from the system, aligning with data governance practices." + description: "Details the criteria and processes for purging the document\ + \ from the system, aligning with data governance practices" + templateId: + type: string + description: "The identifier of the template utilized for the document,\ + \ indicating conformity to specific formats or standards" tags: type: array - description: "Tags applied to the document for categorization, searchability, and thematic association." + description: "Tags applied to the document for categorization, searchability,\ + \ and thematic association" items: $ref: '#/components/schemas/Tag' - templateId: - type: string - description: "The identifier of the template utilized for the document, indicating conformity to specific formats or standards." - ListPolicy: - description: "Provides a paginated structure for listing policies, facilitating the retrieval of policy information in a segmented manner. This schema supports operations that require the listing of multiple policies, including search results and batch processing views." + description: "Outlines detailed information about a document, including its\ + \ description, associated files, and metadata, supporting comprehensive document\ + \ management and access" + Tag: type: object properties: - continuationId: - description: If more results are available, the ContinuationId should be the row index of the next row + name: type: string - policyListItems: - type: array - items: - $ref: '#/components/schemas/Policy' - description: "An array of policy items, each containing detailed information about individual policies." - Policy: - description: "Represents a comprehensive view of an insurance policy, including customer details, policy specifics, associated contacts, and system references. It's designed to encapsulate all relevant information about a policy, facilitating easy access and management within the system." - type: object - properties: - _links: - type: array - items: - $ref: '#/components/schemas/Link' - description: "Hypermedia links associated with the policy item, providing navigational URLs to related resources." - customerInfo: - $ref: '#/components/schemas/CustomerInfo' - description: "Detailed information about the customer associated with the policy." - policyMini: - $ref: '#/components/schemas/PolicyMini' - description: "A condensed version of the policy information, highlighting key details and references." - productInfo: - $ref: '#/components/schemas/ProductInfo' - description: "General information about the product associated with the policy." - ref: + description: "The human-readable name of the tag, which succinctly describes\ + \ the attribute, category, or keyword associated with the tag. This name\ + \ is used for displaying, searching, and organizing entities tagged with\ + \ this label" + tagTemplateIdRef: type: string - description: "A general reference identifier for the policy item, usable for cross-referencing or linkage." - PolicyMini: + description: "The reference ID to a predefined tag template from which this\ + \ tag was created, if applicable. Tag templates facilitate the standardization\ + \ of tags across the system, ensuring consistency in tagging conventions\ + \ and metadata application" + id: + type: string + description: "A unique identifier for the tag, ensuring distinctness across\ + \ the system and enabling precise reference and operations on the tag" + description: "Encapsulates metadata in the form of a tag, allowing for the categorization,\ + \ organization, and easy retrieval of various entities within the system.\ + \ Tags can be applied to documents, contacts, claims, and more, facilitating\ + \ efficient data management and searchability" + AddressCountryTemplate: type: object - description: "Provides a condensed overview of policy information, including key attributes and links for deeper exploration." properties: - _links: - type: array - items: - $ref: '#/components/schemas/Link' - description: "A collection of hypermedia links to related resources, facilitating navigation and further actions." - accountRef: + addressStateProvinceTemplates: + $ref: '#/components/schemas/AddressStateProvinceTemplates' + postalCodeRegex: type: string - description: "Reference identifier to the account associated with this policy, linking to account-specific details." - auditAccountRef: + description: "A regular expression pattern used to validate the format of\ + \ postal or zip codes for addresses in this country, ensuring data accuracy\ + \ and compliance with local postal standards" + cityLabel: type: string - description: "Reference to the audit account, if applicable, providing a connection to audit-related information and actions." - basicPolicy: - $ref: '#/components/schemas/BasicPolicy' - description: "Summarized information about the policy's basic attributes, including coverage details and policy-specific flags." - contacts: - type: array - items: - $ref: '#/components/schemas/Contact' - description: "An array of contacts related to the policy, detailing individuals or entities associated in various capacities." - customerRef: + description: "The label used for the city field in address forms, which\ + \ may vary based on the country's addressing system" + stateProvLabel: type: string - description: "A reference to the customer associated with the policy, enabling linkage to detailed customer information." - externalSystemInd: + description: "The label for the state or province field in address forms,\ + \ accommodating the terminology used in the country's addressing system" + requiredFields: type: string - description: "Indicator for the association of the policy with an external system, highlighting integrations or external dependencies." - iVANSCheck: + description: "A comma-separated list of address fields that are mandatory\ + \ for this country, allowing for dynamic form validation that adapts to\ + \ different countries' addressing requirements" + format: type: string - description: "Result or status from an IVANS insurance verification process, reflecting verification outcomes." - id: + description: "Specifies the format used for addresses in this country, including\ + \ the order of address components and the separators used between them" + addressLines: type: string - description: "Unique identifier for the policy, facilitating identification and retrieval within the system." - insured: - $ref: '#/components/schemas/Insured' - description: "Details regarding the insured party or entity under the policy, outlining coverage and risk information." - statementAccountRef: + description: Indicates the number of address lines that are supported or + required by the address format of this country + countryName: type: string - description: "Reference to the statement account related to the policy, used for financial transactions and billing." - systemId: + description: "The full name of the country to which this address template\ + \ applies, ensuring clarity and consistency in international addressing" + id: type: string - description: "System identifier that manages or tracks the policy, indicating the source or platform of policy management." - version: + description: "A unique identifier for the template, typically using the\ + \ two-letter ISO country code for easy reference" + postalCodeLabel: type: string - description: "Version identifier for the policy information, denoting the format or structure level of the policy data." - vipLevel: + description: "The label used for the postal or zip code field, which may\ + \ be customized based on the country's postal system terminology" + postalCodeExamples: type: string - description: "Indicates the VIP level of the policy or associated customer, used for service prioritization or benefits." - PolicyDetails: - description: "Encapsulates detailed information about an individual policy, including identification, related entities, and status indicators. This schema serves as a comprehensive model for policy information, integrating with both internal and external systems for full lifecycle management." + description: "Provides examples of valid postal or zip codes for the country,\ + \ useful as a guide for users when entering address information" + description: "Defines the template for constructing and validating addresses\ + \ within a specific country. This schema includes details like the required\ + \ fields, address format, and labels for various address components, tailored\ + \ to the country's postal system" + ReapplyOutputSuppression: type: object properties: - _links: - type: array - items: - $ref: '#/components/schemas/Link' - description: "Hypermedia links associated with the policy item, providing navigational URLs to related resources." - _revision: - type: string - description: "The revision identifier of the policy, used for tracking changes and ensuring data consistency." - accountRef: - type: string - description: "A reference identifier linking the policy to a specific account in the system." - auditAccountRef: - type: string - description: "Reference identifier for the account associated with any audits related to the policy." - basicPolicy: - $ref: '#/components/schemas/BasicPolicy' - description: "A reference to the basic policy schema, encapsulating core policy details." - contacts: - type: array - items: - $ref: '#/components/schemas/Contact' - description: "A collection of contacts related to the policy, including individuals and entities with various roles." - customerRef: - type: string - description: "A reference identifier for the customer associated with the policy." - externalSystemInd: - type: string - description: "Indicator flag signifying if the policy is synchronized with an external system." - iVANSCheck: - type: string - description: "Status of the IVANS check for the policy, indicating connectivity and data exchange success with the IVANS network." + includeInd: + type: boolean + description: "Indicates whether the suppression rule should be included\ + \ in the current transaction, determining if related outputs are generated" id: type: string - description: "The unique identifier of the policy within the system." - insured: - $ref: '#/components/schemas/Insured' - description: "A reference to the schema detailing the insured parties under the policy." - statementAccountRef: - type: string - description: "Reference identifier for the account associated with billing statements for the policy." - systemId: - type: string - description: "An identifier for the policy within the internal or external systems, facilitating cross-reference." - updateCount: - type: integer - description: "A counter indicating the number of times the policy has been updated." - updateTimestamp: - type: string - description: "The timestamp of the last update made to the policy, formatted in ISO 8601." - updateUser: - type: string - description: "Identifier of the user who last updated the policy, used for audit trails and accountability." - version: - type: string - description: "The version number of the policy, used for version control and history tracking." - vipLevel: - type: string - description: "The VIP level assigned to the policy or policyholder, indicating priority or special handling requirements." - wcAdditionalInsureds: - description: "List of additional insured entities for workers' compensation policies, detailing parties other than the primary insured that receive coverage." - type: array - items: - $ref: '#/components/schemas/WCAdditionalInsured' - wcCoveredStates: - description: "A list of states in which workers' compensation coverage is included within the policy as proposed by this quote, reflecting multi-state operations and compliance." - type: array - items: - $ref: '#/components/schemas/WCCoveredState' - Error: - description: "Detailed information about an error." + description: "A unique identifier for the output suppression rule, enabling\ + \ tracking and management of suppression settings" + description: "Specifies settings for reapplying output suppression rules to\ + \ a transaction, indicating whether certain communications or document outputs\ + \ should be included or suppressed based on specific criteria" + UmbrellaPolicyInfo: type: object properties: - code: - description: "The HTTP status code." - type: integer - message: - description: "A brief description of the error." + policyNumber: type: string - stackTrace: - description: "Information about the error stack trace." + description: "The policy number assigned to the umbrella policy, serving\ + \ as a human-readable identifier that is often used in documentation and\ + \ communications" + id: type: string - required: - - code - - message + description: "The unique identifier for the umbrella policy, used to uniquely\ + \ distinguish this policy from others within the system" + idRef: + type: string + description: "A reference identifier that links this umbrella policy to\ + \ related records or entities within the system, facilitating cross-referencing\ + \ and data integrity" + description: "Encapsulates detailed information regarding an umbrella insurance\ + \ policy within the Guidewire InsuranceNow system. This schema is designed\ + \ to capture and organize key identifiers and attributes of an umbrella policy,\ + \ facilitating effective policy management, identification, and reference\ + \ across the platform. It serves as a foundational element for operations\ + \ such as policy lookup, modification, and integration with related insurance\ + \ processes, ensuring a coherent and unified approach to managing umbrella\ + \ policies" securitySchemes: BasicAuth: type: http @@ -3795,7 +4896,3 @@ components: BearerAuth: type: http scheme: bearer - -security: - - BasicAuth: [] - - BearerAuth: [] diff --git a/gradle.properties b/gradle.properties index 2322620..f7775ef 100644 --- a/gradle.properties +++ b/gradle.properties @@ -10,4 +10,4 @@ releasePluginVersion=2.8.0 testngVersion=7.6.1 eclipseLsp4jVersion=0.12.0 ballerinaGradlePluginVersion=2.2.4 -ballerinaLangVersion=2201.8.6 +ballerinaLangVersion=2201.12.2 From c95181d190a09885cf7e06305726cc50da5f2b93 Mon Sep 17 00:00:00 2001 From: Ayesh Almeida Date: Wed, 9 Apr 2025 15:41:05 +0530 Subject: [PATCH 2/6] [Automated] Update the toml files --- ballerina/Ballerina.toml | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index bcf565e..1353d3f 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,8 +1,8 @@ [package] -distribution = "2201.8.6" +distribution = "2201.12.2" org = "ballerinax" name = "guidewire.insnow" -version = "0.1.0" +version = "0.2.0" license = ["Apache-2.0"] authors = ["Ballerina"] keywords = ["Insurance", "Guidewire", "Cloud API"] @@ -11,6 +11,3 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-guidewire. [build-options] observabilityIncluded = false - -[platform.java17] -graalvmCompatible = true From d5a52ac39d3b65a2f7d10f9134b19c3879b2e5d8 Mon Sep 17 00:00:00 2001 From: Ayesh Almeida Date: Wed, 9 Apr 2025 15:43:18 +0530 Subject: [PATCH 3/6] [Automated] Update the toml files --- ballerina/Dependencies.toml | 55 ++++++++++++++++++++++++------------- 1 file changed, 36 insertions(+), 19 deletions(-) diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index 22c51d7..bbfc2e7 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -5,12 +5,12 @@ [ballerina] dependencies-toml-version = "2" -distribution-version = "2201.8.6" +distribution-version = "2201.12.2" [[package]] org = "ballerina" name = "auth" -version = "2.10.0" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "crypto"}, {org = "ballerina", name = "jballerina.java"}, @@ -22,7 +22,7 @@ dependencies = [ [[package]] org = "ballerina" name = "cache" -version = "3.7.1" +version = "3.10.0" dependencies = [ {org = "ballerina", name = "constraint"}, {org = "ballerina", name = "jballerina.java"}, @@ -33,7 +33,7 @@ dependencies = [ [[package]] org = "ballerina" name = "constraint" -version = "1.5.0" +version = "1.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -41,16 +41,28 @@ dependencies = [ [[package]] org = "ballerina" name = "crypto" -version = "2.6.2" +version = "2.9.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "time"} ] +[[package]] +org = "ballerina" +name = "data.jsondata" +version = "1.1.0" +dependencies = [ + {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.object"} +] +modules = [ + {org = "ballerina", packageName = "data.jsondata", moduleName = "data.jsondata"} +] + [[package]] org = "ballerina" name = "file" -version = "1.9.0" +version = "1.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -61,12 +73,13 @@ dependencies = [ [[package]] org = "ballerina" name = "http" -version = "2.10.12" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "auth"}, {org = "ballerina", name = "cache"}, {org = "ballerina", name = "constraint"}, {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "data.jsondata"}, {org = "ballerina", name = "file"}, {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -93,7 +106,7 @@ modules = [ [[package]] org = "ballerina" name = "io" -version = "1.6.0" +version = "1.8.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "lang.value"} @@ -107,10 +120,11 @@ version = "0.0.0" [[package]] org = "ballerina" name = "jwt" -version = "2.10.0" +version = "2.15.0" dependencies = [ {org = "ballerina", name = "cache"}, {org = "ballerina", name = "crypto"}, + {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "lang.int"}, {org = "ballerina", name = "lang.string"}, @@ -204,7 +218,7 @@ dependencies = [ [[package]] org = "ballerina" name = "log" -version = "2.9.0" +version = "2.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, @@ -218,17 +232,18 @@ modules = [ [[package]] org = "ballerina" name = "mime" -version = "2.9.0" +version = "2.12.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"}, - {org = "ballerina", name = "lang.int"} + {org = "ballerina", name = "lang.int"}, + {org = "ballerina", name = "log"} ] [[package]] org = "ballerina" name = "oauth2" -version = "2.10.0" +version = "2.14.0" dependencies = [ {org = "ballerina", name = "cache"}, {org = "ballerina", name = "crypto"}, @@ -241,7 +256,7 @@ dependencies = [ [[package]] org = "ballerina" name = "observe" -version = "1.2.2" +version = "1.5.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -249,7 +264,7 @@ dependencies = [ [[package]] org = "ballerina" name = "os" -version = "1.8.0" +version = "1.10.0" dependencies = [ {org = "ballerina", name = "io"}, {org = "ballerina", name = "jballerina.java"} @@ -261,7 +276,7 @@ modules = [ [[package]] org = "ballerina" name = "task" -version = "2.5.0" +version = "2.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"}, {org = "ballerina", name = "time"} @@ -274,6 +289,7 @@ version = "0.0.0" scope = "testOnly" dependencies = [ {org = "ballerina", name = "jballerina.java"}, + {org = "ballerina", name = "lang.array"}, {org = "ballerina", name = "lang.error"} ] modules = [ @@ -283,7 +299,7 @@ modules = [ [[package]] org = "ballerina" name = "time" -version = "2.4.0" +version = "2.7.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -291,7 +307,7 @@ dependencies = [ [[package]] org = "ballerina" name = "url" -version = "2.4.0" +version = "2.6.0" dependencies = [ {org = "ballerina", name = "jballerina.java"} ] @@ -302,8 +318,9 @@ modules = [ [[package]] org = "ballerinax" name = "guidewire.insnow" -version = "0.1.0" +version = "0.2.0" dependencies = [ + {org = "ballerina", name = "data.jsondata"}, {org = "ballerina", name = "http"}, {org = "ballerina", name = "log"}, {org = "ballerina", name = "os"}, From 7f1c7f679a939d9fed5bcc2f6fa8f84a80d5cded Mon Sep 17 00:00:00 2001 From: Ayesh Almeida Date: Wed, 9 Apr 2025 15:43:31 +0530 Subject: [PATCH 4/6] Fix build failures --- ballerina/tests/guidewire_insnow_mock_backend.bal | 10 +++++----- ballerina/tests/test.bal | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ballerina/tests/guidewire_insnow_mock_backend.bal b/ballerina/tests/guidewire_insnow_mock_backend.bal index d4c8866..851ebba 100644 --- a/ballerina/tests/guidewire_insnow_mock_backend.bal +++ b/ballerina/tests/guidewire_insnow_mock_backend.bal @@ -146,7 +146,7 @@ service / on ep0 { return http:OK; } - resource function get applications(string? applicationOrQuoteNumber, string? continuationId, string? createdSinceDate, string? customerId, boolean? includeClosed, boolean? includeDeleted, string? 'limit, string? optionalFields, string? policyId, string? providerId, boolean? recentlyViewed, string? status, string? transactionCd, string? transactionCdGroup, string? 'type) returns ListApplication { + resource function get applications(string? applicationOrQuoteNumber, string? continuationId, string? createdSinceDate, string? customerId, boolean? includeClosed, boolean? includeDeleted, string? 'limit, string? optionalFields, string? policyId, string? providerId, boolean? recentlyViewed, string? status, string? transactionCd, string? transactionCdGroup, string? 'type) returns json { return { applicationListItems: [ { @@ -300,7 +300,7 @@ service / on ep0 { return http:CREATED; } - resource function get applications/[string systemId]/documents() returns ListDocument { + resource function get applications/[string systemId]/documents() returns json { return { documentListItems: [ { @@ -357,7 +357,7 @@ service / on ep0 { return payload; } - resource function get claims/[string systemId]/documents() returns ListDocument { + resource function get claims/[string systemId]/documents() returns json { return { documentListItems: [ { @@ -418,7 +418,7 @@ service / on ep0 { return http:CREATED; } - resource function get policies(string? continuationId, string? createdSinceDate, string? customerId, string? expiredDateAfter, boolean? includePriorTerms, string? 'limit, string? optionalFields, string? policyNumber, string? providerRef, boolean? recentlyViewed, string? status) returns ListPolicy { + resource function get policies(string? continuationId, string? createdSinceDate, string? customerId, string? expiredDateAfter, boolean? includePriorTerms, string? 'limit, string? optionalFields, string? policyNumber, string? providerRef, boolean? recentlyViewed, string? status) returns json { return { continuationId: "cont123456789", policyListItems: [ @@ -547,7 +547,7 @@ service / on ep0 { }; } - resource function get policies/[string systemId](string? asOfDate) returns PolicyDetails { + resource function get policies/[string systemId](string? asOfDate) returns json { return { _links: [ { diff --git a/ballerina/tests/test.bal b/ballerina/tests/test.bal index 1d79461..32aab20 100644 --- a/ballerina/tests/test.bal +++ b/ballerina/tests/test.bal @@ -48,13 +48,13 @@ function testListApplications() returns error? { } function testCreateApplication() returns error? { Quote quote = { - _links: [ + links: [ { href: "/api/resource/123", rel: "self" } ], - _revision: "1", + revision: "1", applicationInfo: { correctedByTransactionNumber: 12345, correctionOfTransactionNumber: 12344, From 093c09b2066d18a3351b63c83b298fa3211fbad8 Mon Sep 17 00:00:00 2001 From: Ayesh Almeida Date: Wed, 9 Apr 2025 15:43:42 +0530 Subject: [PATCH 5/6] Update package details --- build-config/resources/Ballerina.toml | 5 +---- gradle.properties | 4 ++-- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/build-config/resources/Ballerina.toml b/build-config/resources/Ballerina.toml index 8726f5d..91a8982 100644 --- a/build-config/resources/Ballerina.toml +++ b/build-config/resources/Ballerina.toml @@ -1,5 +1,5 @@ [package] -distribution = "2201.8.6" +distribution = "2201.12.2" org = "ballerinax" name = "guidewire.insnow" version = "@toml.version@" @@ -11,6 +11,3 @@ repository = "https://github.com/ballerina-platform/module-ballerinax-guidewire. [build-options] observabilityIncluded = false - -[platform.java17] -graalvmCompatible = true diff --git a/gradle.properties b/gradle.properties index f7775ef..a7134c2 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,6 @@ org.gradle.caching=true group=io.ballerina.lib -version=0.1.1-SNAPSHOT +version=0.2.0-SNAPSHOT checkstylePluginVersion=10.12.0 spotbugsPluginVersion=5.0.14 @@ -9,5 +9,5 @@ downloadPluginVersion=5.4.0 releasePluginVersion=2.8.0 testngVersion=7.6.1 eclipseLsp4jVersion=0.12.0 -ballerinaGradlePluginVersion=2.2.4 +ballerinaGradlePluginVersion=3.0.0 ballerinaLangVersion=2201.12.2 From e0178f092bf109f524f979c7c5003ee0ba96c276 Mon Sep 17 00:00:00 2001 From: Ayesh Almeida Date: Wed, 9 Apr 2025 15:49:04 +0530 Subject: [PATCH 6/6] Fix build failures --- examples/online-application-portal/service.bal | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/examples/online-application-portal/service.bal b/examples/online-application-portal/service.bal index 39671f0..1a1c08b 100644 --- a/examples/online-application-portal/service.bal +++ b/examples/online-application-portal/service.bal @@ -39,11 +39,12 @@ service ApplicationPortal /portal on new http:Listener(9090) { # + limit - The maximum number of results to return # + return - List of applications or an error resource function get applications(string? customerId = (), string? continuationId = (), string? 'limit = ()) returns insnow:ListApplication|error { - return self.insuranceNow->/applications( - customerId = customerId, - continuationId = continuationId, - 'limit = 'limit - ); + insnow:GetQuotesQueries queries = { + customerId, + continuationId, + 'limit + }; + return self.insuranceNow->/applications(queries = queries); } # Starts a new QuickQuote or Quote. @@ -52,7 +53,10 @@ service ApplicationPortal /portal on new http:Listener(9090) { # + requestedTypeCd - The type of the quote, QuickQuote or Quote # + return - An error or nil resource function post applications(insnow:Quote quote, string? requestedTypeCd = ()) returns error? { - _ = check self.insuranceNow->/applications.post(quote, requestedTypeCd); + insnow:CreateQuoteQueries queries = { + requestedTypeCd + }; + _ = check self.insuranceNow->/applications.post(quote, queries = queries); } # Adds an attachment to a quote or application.