import * as z from "zod/v3"; import { CleansingInternationalBatchOnOff } from "./cleansinginternationalbatchonoff.js"; import { CleansingInternationalBatchOutputCasingOptions } from "./cleansinginternationalbatchoutputcasingoptions.js"; import { CleansingInternationalBatchOutputScriptOptions } from "./cleansinginternationalbatchoutputscriptoptions.js"; import { CleansingInternationalBatchOutputSortTypeOptions } from "./cleansinginternationalbatchoutputsorttypeoptions.js"; import { CleansingInternationalBatchRangeDecomposeOptions } from "./cleansinginternationalbatchrangedecomposeoptions.js"; import { CleansingInternationalBatchTrueFalse } from "./cleansinginternationalbatchtruefalse.js"; import { CleansingInternationalBatchYesNo } from "./cleansinginternationalbatchyesno.js"; export type CleansingInternationalBatchServiceRequestServerOptions = { activeCassLibrary?: string | undefined; /** * Used to specify the string which will separate the output address lines within the output Address field */ addressLineSeparator?: string | undefined; cassAvcEnable?: CleansingInternationalBatchYesNo | undefined; cassCityAbbreviation?: CleansingInternationalBatchYesNo | undefined; cassPreserveAlias?: CleansingInternationalBatchYesNo | undefined; cassUrbFirst?: CleansingInternationalBatchYesNo | undefined; cassZipFields?: CleansingInternationalBatchYesNo | undefined; /** * Used to specify a comma-delimited list of countries where data should be processed using the relevant certified process. e.g. "USA,CAN,AUS" to give CASS, SERP, and AMAS certified output respectively. */ certifiedCountryList?: string | undefined; combinedSearchMethods?: CleansingInternationalBatchYesNo | undefined; combinedVerifyMethods?: CleansingInternationalBatchYesNo | undefined; /** * Used to specify the threshold at which to stop returning parse interpretations, as a percentage of the confidence of the top result. */ confidenceThreshold?: string | undefined; conformToReference?: CleansingInternationalBatchYesNo | undefined; /** * Used to specify the comma delimited list of fields to be searched for country information. This should be a subset of the ParseFields entry. */ countryFields?: string | undefined; /** * Used to specify the ISO 3166-1 alpha-3 code which should be used if no identifiable country can be found in an input record. */ defaultCountry?: string | undefined; /** * Used to specify the duplicate handling level, between 0 and 15. Default is 0. When option is set, duplicate components in the input address are removed if it meets a certain criteria. */ duplicateHandlingMask?: string | undefined; enhancedCountryTool?: CleansingInternationalBatchOnOff | undefined; /** * Used to specify the default field name weight, between 1 and 255. Default 10. A larger value will give more precedence to the supplied field name, a smaller value will give more precedence to the GKR matches. Individual field name weights can also be declared using the syntax '=|=', etc. For instance 'Organization=240|AdministrativeArea=100|50' would mean a field name weight of 240 for the Organization field, 100 for the AdministrativeArea field, and a default of 50 for all remaining fields. */ fieldNameWeight?: string | undefined; fieldStatus?: CleansingInternationalBatchTrueFalse | undefined; /** * Used to specify the ISO 3166-1 alpha-3 code which should be used for all input records. */ forceCountry?: string | undefined; /** * Used to specify a comma-delimited list of ISO 3166-1 alpha-3 codes of acceptable countries to geocode. Input records from other countries will not return geocodes. */ geocodeCountryList?: string | undefined; /** * A list of default match rules specifying how fields can be combined when attempting to generate a geocode match. This can be overridden on a per-country basis, and should only be changed if requested by Support staff. */ geocodeMatchRules?: string | undefined; ignoreUnmatched?: CleansingInternationalBatchYesNo | undefined; /** * Used to specify the minimum matchscore a record must reach in the Match process to be taken into account as a candidate for matching. */ matchScoreAbsoluteThreshold?: string | undefined; /** * This is a value that is used as a factor of the highest matching result. The resulting value is then used as a cut-off for considering candidates for the results. The higher the value of the factor, the higher the chance of getting a good verification result. */ matchScoreThresholdFactor?: string | undefined; /** * Used to specify the maximum GeoDistance a geocode can reach and still be returned as a result. */ maximumGeoDistance?: string | undefined; /** * Used to specify the minimum GeoAccuracy level a geocode must reach in order to be returned as a result. */ minimumGeoAccuracyLevel?: string | undefined; /** * Used to specify the minimum matchscore a record must reach in order to avoid reversion. */ minimumMatchscore?: string | undefined; /** * Used to specify the minimum postcode status a record must reach in order to avoid reversion. */ minimumPostcode?: string | undefined; /** * Used to specify the minimum similarity score that is needed to make a match to a candidate result. */ minimumSimilarity?: string | undefined; /** * Used to specify the minimum verification level a record must reach in order to avoid reversion. */ minimumVerificationLevel?: string | undefined; outputAddressFormat?: CleansingInternationalBatchYesNo | undefined; outputCasing?: CleansingInternationalBatchOutputCasingOptions | undefined; outputScript?: CleansingInternationalBatchOutputScriptOptions | undefined; outputSortType?: CleansingInternationalBatchOutputSortTypeOptions | undefined; preferPrimaryValidAlias?: CleansingInternationalBatchYesNo | undefined; rangeDecompose?: CleansingInternationalBatchRangeDecomposeOptions | undefined; /** * Used to specify the number of MRU reference datasets to cache. */ referenceDatasetCacheSize?: string | undefined; /** * This option will return only verified fields, meaning that it will remove anything that isn't verified from any field. SuppressUnmatched option will only suppress the unverified components in the Address field. Default No, meaning all fields will be returned. This can be specified on a per-country basis, with the added ability to specify fields to ignore during the check, using the following syntax ReturnVerifiedFieldsOnly=[:;;…;][,:;…;,…,]. e.g. ReturnVerifiedFieldsOnly=BE:SubBuilding;Premise,DE:SubBuilding;Premise,AT:SubBuilding;Premise or ReturnVerifiedFieldsOnly=US,CA,GB. The former will return verified fields only in Belgium, Germany, and Austria, but will retain non-verified data in the Premise and SubBuilding fields, the latter will return verified fields only in USA, Canada, UK. */ returnVerifiedFieldsOnly?: string | undefined; serpWesternStyle?: CleansingInternationalBatchYesNo | undefined; simpleParse?: CleansingInternationalBatchYesNo | undefined; strictReferenceMatch?: CleansingInternationalBatchYesNo | undefined; /** * This is a list of ISO2 countries that you would like to have the option StrictReferenceMatch turned on for. */ strictRefMatchCountryList?: string | undefined; /** * Used to specify the comma-delimited list of fields that should not be added to an output result if they do not appear in the input record. */ suppressAdditionFields?: string | undefined; /** * Used to specify the comma-delimited list of fields that should be suppressed from the Address field output. */ suppressAddressFields?: string | undefined; /** * Used to specify the comma-delimited list of fields that should be suppressed from the output. */ suppressFields?: string | undefined; suppressUnmatched?: CleansingInternationalBatchOnOff | undefined; /** * Used to specify the comma-delimited list of fields that should be suppressed when determining the Address Verification Code. */ suppressMatchFields?: string | undefined; /** * Used to specify the fields that should not be transliterated. */ transliterationIgnoreFields?: string | undefined; toolInfo?: CleansingInternationalBatchYesNo | undefined; useSymbolicTransliteration?: CleansingInternationalBatchYesNo | undefined; /** * Used to specify a comma-delimited list of ISO 3166-1 alpha-3 codes of acceptable countries to process. */ verifyCountryList?: string | undefined; /** * A list of default match rules specifying how fields can be combined when attempting to generate a verification match. This can be overridden on a per-country basis, and should only be changed if requested by Support staff. */ verifyMatchRules?: string | undefined; }; /** @internal */ export type CleansingInternationalBatchServiceRequestServerOptions$Outbound = { ActiveCassLibrary: string; AddressLineSeparator: string; CassAvcEnable?: string | undefined; CassCityAbbreviation?: string | undefined; CassPreserveAlias?: string | undefined; CassUrbFirst?: string | undefined; CassZipFields?: string | undefined; CertifiedCountryList: string; CombinedSearchMethods?: string | undefined; CombinedVerifyMethods?: string | undefined; ConfidenceThreshold: string; ConformToReference?: string | undefined; CountryFields: string; DefaultCountry: string; DuplicateHandlingMask: string; EnhancedCountryTool?: string | undefined; FieldNameWeight: string; FieldStatus?: string | undefined; ForceCountry: string; GeocodeCountryList: string; GeocodeMatchRules: string; IgnoreUnmatched?: string | undefined; MatchScoreAbsoluteThreshold: string; MatchScoreThresholdFactor: string; MaximumGeoDistance: string; MinimumGeoAccuracyLevel: string; MinimumMatchscore: string; MinimumPostcode: string; MinimumSimilarity: string; MinimumVerificationLevel: string; OutputAddressFormat?: string | undefined; OutputCasing?: string | undefined; OutputScript?: string | undefined; OutputSortType?: string | undefined; PreferPrimaryValidAlias?: string | undefined; RangeDecompose?: string | undefined; ReferenceDatasetCacheSize: string; ReturnVerifiedFieldsOnly: string; SerpWesternStyle?: string | undefined; SimpleParse?: string | undefined; StrictReferenceMatch?: string | undefined; StrictRefMatchCountryList: string; SuppressAdditionFields: string; SuppressAddressFields: string; SuppressFields: string; SuppressUnmatched?: string | undefined; SuppressMatchFields: string; TransliterationIgnoreFields: string; ToolInfo?: string | undefined; UseSymbolicTransliteration?: string | undefined; VerifyCountryList: string; VerifyMatchRules: string; }; /** @internal */ export declare const CleansingInternationalBatchServiceRequestServerOptions$outboundSchema: z.ZodType; export declare function cleansingInternationalBatchServiceRequestServerOptionsToJSON(cleansingInternationalBatchServiceRequestServerOptions: CleansingInternationalBatchServiceRequestServerOptions): string; //# sourceMappingURL=cleansinginternationalbatchservicerequestserveroptions.d.ts.map