diff --git a/dist/openapi.json b/dist/openapi.json index 5732712..f0ebdd2 100644 --- a/dist/openapi.json +++ b/dist/openapi.json @@ -745,6 +745,18 @@ }, { "$ref": "#/components/parameters/TagsParam" + }, + { + "name": "context", + "in": "query", + "style": "form", + "explode": false, + "required": false, + "example": "gbr", + "schema": { + "type": "string" + }, + "description": "Specify the country\n" } ], "requestBody": { @@ -761,6 +773,21 @@ "type": "string", "description": "Freeform address input to cleanse\n", "example": "10 Downing Street, London, SW2A 2BN" + }, + "postcode": { + "type": "string", + "description": "Optionally specify postal code for the address.\n", + "example": "SW1A 2BN" + }, + "post_town": { + "type": "string", + "description": "Optionally specify the city or town of the address.\n\nFor UK verifications, this should be the \"post town\" of the address.\n\nFor USA verifications, this should be the city of the address.\n", + "example": "London" + }, + "county": { + "type": "string", + "description": "Optionally specify the county or state of the address.\n\nFor UK verifications, we recommend omitting this field as county data is unreliable.\n\nFor USA verifications, this should be the state of the address.\n", + "example": "Kent" } } } @@ -6927,7 +6954,8 @@ "heresa", "heret", "email", - "phone" + "phone", + "gnaf" ], "properties": { "paf": { @@ -7347,6 +7375,11 @@ "type": "boolean", "description": "Email validation is enabled", "example": true + }, + "gnaf": { + "type": "boolean", + "description": "Autralia Geoscape Geocoded National Address File", + "example": true } } } @@ -7429,6 +7462,292 @@ } } }, + "UsaCassVerifiedAddress": { + "title": "United States CASS Verified Address", + "type": "object", + "description": "Address retrieved using CASS compliant address verification process\n", + "required": [ + "address1", + "address2", + "address3", + "area_code", + "carrier_route", + "check_digit", + "city", + "city_abbreviation", + "congressional_district", + "country_code", + "county", + "day_light_savings", + "delivery_point", + "dpv", + "dpv_cmra", + "dpv_footnotes", + "dpv_fp", + "dpv_no_stat", + "dpv_vacant", + "elot", + "finance_number", + "fips_county_code", + "firm", + "footnotes", + "geo_coded", + "lacs_indicator", + "lacs_link_footnote", + "lacs_link_indicator", + "latitude", + "longitude", + "parsed_pmb_designator", + "parsed_pmb_number", + "parsed_post_directional", + "parsed_pre_directional", + "parsed_primary_number", + "parsed_street_name", + "parsed_suffix", + "parsed_unit_designator", + "parsed_unit_number", + "rdi", + "record_type", + "secondary_address_info", + "state", + "suite_link_footnote", + "time_zone", + "urbanization", + "zip_code" + ], + "properties": { + "address1": { + "type": "string", + "description": "Primary delivery address\n" + }, + "address2": { + "type": "string", + "description": "Secondary address information\n" + }, + "address3": { + "type": "string", + "description": "Additional secondary address information\n" + }, + "area_code": { + "type": "string", + "description": "Area code\n" + }, + "carrier_route": { + "type": "string", + "description": "Data required to perform a Carrier Route sort\n" + }, + "check_digit": { + "type": "string", + "description": "Character following the 5- or 9-digit ZIP Code\n" + }, + "city": { + "type": "string", + "description": "City name\n" + }, + "city_abbreviation": { + "type": "string", + "description": "City Abbreviation. Empty string if not present\n" + }, + "congressional_district": { + "type": "string", + "description": "Identifies the Congressional District. Empty string if not present\n" + }, + "country_code": { + "type": "string", + "description": "ISO3166 country code. Empty string if not present\n" + }, + "county": { + "type": "string", + "description": "Name of the county\n" + }, + "day_light_savings": { + "type": "string", + "description": "Daylight saving time indicator\n" + }, + "delivery_point": { + "type": "string", + "description": "Last 2 digits of the primary street address number or Post Office™ box\n" + }, + "dpv": { + "type": "string", + "description": "DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No).\n" + }, + "dpv_cmra": { + "type": "string", + "description": "DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No).\n" + }, + "dpv_footnotes": { + "type": "string", + "description": "DPV Footnotes. Empty string if not present\n" + }, + "dpv_fp": { + "type": "string", + "description": "False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space). Empty string if not present\n" + }, + "dpv_no_stat": { + "type": "string", + "description": "DPV NoStat code. Empty string if not present\n" + }, + "dpv_vacant": { + "type": "string", + "description": "DPV Vacant code. Empty string if not present\n" + }, + "elot": { + "type": "string", + "description": "Enhanced Line of Travel\n" + }, + "finance_number": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Internal accounting number used by the USPS. Empty string if not present\n" + }, + "fips_county_code": { + "type": "string", + "description": "Federal Information Processing Standard code for a county. Empty string if not present\n" + }, + "firm": { + "type": "string", + "description": "Company name in a business address\n" + }, + "footnotes": { + "type": "string", + "description": "Letter codes returned by ZIP + 4® encoding. Empty string if not present\n" + }, + "geo_coded": { + "type": "string", + "description": "Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No).\n" + }, + "lacs_indicator": { + "type": "string", + "description": "Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No).\n" + }, + "lacs_link_footnote": { + "type": "string", + "description": "LACSLink Footnote. Empty string if not present\n" + }, + "lacs_link_indicator": { + "type": "string", + "description": "LACSLink Indicator. Empty string if not present\n" + }, + "latitude": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Latitude of the encoded address. Empty string if not present\n" + }, + "longitude": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Longitude of the encoded address. Empty string if not present\n" + }, + "parsed_pmb_designator": { + "type": "string", + "description": "Information if a PMB is found in an address. Empty string if not present\n" + }, + "parsed_pmb_number": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Information if a PMB is found in an address. Empty string if not present\n" + }, + "parsed_post_directional": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Notation following the street name indicating street direction. Empty string if not present\n" + }, + "parsed_pre_directional": { + "type": "string", + "description": "Notation preceding the street name indicating street direction. Empty string if not present\n" + }, + "parsed_primary_number": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "number" + } + ], + "description": "Number preceding the street name. Empty string if not present\n" + }, + "parsed_street_name": { + "type": "string", + "description": "Street name. Empty string if not present\n" + }, + "parsed_suffix": { + "type": "string", + "description": "Part of the delivery address line following the street name. Empty string if not present\n" + }, + "parsed_unit_designator": { + "type": "string", + "description": "Identification of the secondary address unit. Empty string if not present\n" + }, + "parsed_unit_number": { + "type": "string", + "description": "Apartment or suite number. Empty string if not present\n" + }, + "rdi": { + "type": "string", + "description": "Reserved for future use. Empty string if not present\n" + }, + "record_type": { + "type": "string", + "description": "Type of address record (Street, PO Box, High-rise, etc.)\n" + }, + "secondary_address_info": { + "type": "string", + "description": "Additional secondary address information. Empty string if not present\n" + }, + "state": { + "type": "string", + "description": "Standard two-letter state abbreviation\n" + }, + "suite_link_footnote": { + "type": "string", + "description": "Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). Empty string if not present\n" + }, + "time_zone": { + "type": "string", + "description": "Time zone. Empty string if not present\n" + }, + "urbanization": { + "type": "string", + "description": "Urban name required in the address of all mail being delivered to Puerto Rico. Empty string if not present\n" + }, + "zip_code": { + "type": "string", + "description": "5-digit ZIP Code™ and the four additional digits\n" + } + } + }, "GbrCleanseMatch": { "title": "Address Match", "type": "object", @@ -7467,6 +7786,9 @@ }, { "$ref": "#/components/schemas/WelshPafAddress" + }, + { + "$ref": "#/components/schemas/UsaCassVerifiedAddress" } ] }, diff --git a/dist/openapi.yaml b/dist/openapi.yaml index 2a6b45b..0e5ce27 100644 --- a/dist/openapi.yaml +++ b/dist/openapi.yaml @@ -795,6 +795,16 @@ paths: parameters: - $ref: '#/components/parameters/ApiKeyParam' - $ref: '#/components/parameters/TagsParam' + - name: context + in: query + style: form + explode: false + required: false + example: gbr + schema: + type: string + description: | + Specify the country requestBody: required: true content: @@ -809,6 +819,29 @@ paths: description: | Freeform address input to cleanse example: 10 Downing Street, London, SW2A 2BN + postcode: + type: string + description: | + Optionally specify postal code for the address. + example: SW1A 2BN + post_town: + type: string + description: | + Optionally specify the city or town of the address. + + For UK verifications, this should be the "post town" of the address. + + For USA verifications, this should be the city of the address. + example: London + county: + type: string + description: | + Optionally specify the county or state of the address. + + For UK verifications, we recommend omitting this field as county data is unreliable. + + For USA verifications, this should be the state of the address. + example: Kent responses: '200': description: Success @@ -5986,6 +6019,7 @@ components: - heret - email - phone + - gnaf properties: paf: type: boolean @@ -6324,6 +6358,10 @@ components: type: boolean description: Email validation is enabled example: true + gnaf: + type: boolean + description: Autralia Geoscape Geocoded National Address File + example: true KeyUsageResult: title: Key Usage type: object @@ -6382,6 +6420,260 @@ components: type: string enum: - Success + UsaCassVerifiedAddress: + title: United States CASS Verified Address + type: object + description: | + Address retrieved using CASS compliant address verification process + required: + - address1 + - address2 + - address3 + - area_code + - carrier_route + - check_digit + - city + - city_abbreviation + - congressional_district + - country_code + - county + - day_light_savings + - delivery_point + - dpv + - dpv_cmra + - dpv_footnotes + - dpv_fp + - dpv_no_stat + - dpv_vacant + - elot + - finance_number + - fips_county_code + - firm + - footnotes + - geo_coded + - lacs_indicator + - lacs_link_footnote + - lacs_link_indicator + - latitude + - longitude + - parsed_pmb_designator + - parsed_pmb_number + - parsed_post_directional + - parsed_pre_directional + - parsed_primary_number + - parsed_street_name + - parsed_suffix + - parsed_unit_designator + - parsed_unit_number + - rdi + - record_type + - secondary_address_info + - state + - suite_link_footnote + - time_zone + - urbanization + - zip_code + properties: + address1: + type: string + description: | + Primary delivery address + address2: + type: string + description: | + Secondary address information + address3: + type: string + description: | + Additional secondary address information + area_code: + type: string + description: | + Area code + carrier_route: + type: string + description: | + Data required to perform a Carrier Route sort + check_digit: + type: string + description: | + Character following the 5- or 9-digit ZIP Code + city: + type: string + description: | + City name + city_abbreviation: + type: string + description: | + City Abbreviation. Empty string if not present + congressional_district: + type: string + description: | + Identifies the Congressional District. Empty string if not present + country_code: + type: string + description: | + ISO3166 country code. Empty string if not present + county: + type: string + description: | + Name of the county + day_light_savings: + type: string + description: | + Daylight saving time indicator + delivery_point: + type: string + description: | + Last 2 digits of the primary street address number or Post Office™ box + dpv: + type: string + description: | + DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No). + dpv_cmra: + type: string + description: | + DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No). + dpv_footnotes: + type: string + description: | + DPV Footnotes. Empty string if not present + dpv_fp: + type: string + description: | + False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space). Empty string if not present + dpv_no_stat: + type: string + description: | + DPV NoStat code. Empty string if not present + dpv_vacant: + type: string + description: | + DPV Vacant code. Empty string if not present + elot: + type: string + description: | + Enhanced Line of Travel + finance_number: + oneOf: + - type: string + - type: number + description: | + Internal accounting number used by the USPS. Empty string if not present + fips_county_code: + type: string + description: | + Federal Information Processing Standard code for a county. Empty string if not present + firm: + type: string + description: | + Company name in a business address + footnotes: + type: string + description: | + Letter codes returned by ZIP + 4® encoding. Empty string if not present + geo_coded: + type: string + description: | + Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No). + lacs_indicator: + type: string + description: | + Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No). + lacs_link_footnote: + type: string + description: | + LACSLink Footnote. Empty string if not present + lacs_link_indicator: + type: string + description: | + LACSLink Indicator. Empty string if not present + latitude: + oneOf: + - type: string + - type: number + description: | + Latitude of the encoded address. Empty string if not present + longitude: + oneOf: + - type: string + - type: number + description: | + Longitude of the encoded address. Empty string if not present + parsed_pmb_designator: + type: string + description: | + Information if a PMB is found in an address. Empty string if not present + parsed_pmb_number: + oneOf: + - type: string + - type: number + description: | + Information if a PMB is found in an address. Empty string if not present + parsed_post_directional: + oneOf: + - type: string + - type: number + description: | + Notation following the street name indicating street direction. Empty string if not present + parsed_pre_directional: + type: string + description: | + Notation preceding the street name indicating street direction. Empty string if not present + parsed_primary_number: + oneOf: + - type: string + - type: number + description: | + Number preceding the street name. Empty string if not present + parsed_street_name: + type: string + description: | + Street name. Empty string if not present + parsed_suffix: + type: string + description: | + Part of the delivery address line following the street name. Empty string if not present + parsed_unit_designator: + type: string + description: | + Identification of the secondary address unit. Empty string if not present + parsed_unit_number: + type: string + description: | + Apartment or suite number. Empty string if not present + rdi: + type: string + description: | + Reserved for future use. Empty string if not present + record_type: + type: string + description: | + Type of address record (Street, PO Box, High-rise, etc.) + secondary_address_info: + type: string + description: | + Additional secondary address information. Empty string if not present + state: + type: string + description: | + Standard two-letter state abbreviation + suite_link_footnote: + type: string + description: | + Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). Empty string if not present + time_zone: + type: string + description: | + Time zone. Empty string if not present + urbanization: + type: string + description: | + Urban name required in the address of all mail being delivered to Puerto Rico. Empty string if not present + zip_code: + type: string + description: | + 5-digit ZIP Code™ and the four additional digits GbrCleanseMatch: title: Address Match type: object @@ -6409,6 +6701,7 @@ components: - $ref: '#/components/schemas/NybAddress' - $ref: '#/components/schemas/PafAliasAddress' - $ref: '#/components/schemas/WelshPafAddress' + - $ref: '#/components/schemas/UsaCassVerifiedAddress' count: type: number description: | diff --git a/openapi.ts b/openapi.ts index d3357ff..3d91cdd 100644 --- a/openapi.ts +++ b/openapi.ts @@ -3120,7 +3120,7 @@ export interface components { * @description Australia Geocoded National Address File * @example true */ - gnaf?: boolean; + gnaf: boolean; /** * @description Asia Pacific Address File * @example true @@ -3374,6 +3374,11 @@ export interface components { * @example true */ email?: boolean; + /** + * @description Autralia Geoscape Geocoded National Address File + * @example true + */ + gnaf?: boolean; }; }; /** Key Usage */ @@ -3416,6 +3421,106 @@ export interface components { /** @enum {string} */ message: "Success"; }; + /** + * United States CASS Verified Address + * @description Address retrieved using CASS compliant address verification process + */ + UsaCassVerifiedAddress: { + /** @description Primary delivery address */ + address1: string; + /** @description Secondary address information */ + address2: string; + /** @description Additional secondary address information */ + address3: string; + /** @description Area code */ + area_code: string; + /** @description Data required to perform a Carrier Route sort */ + carrier_route: string; + /** @description Character following the 5- or 9-digit ZIP Code */ + check_digit: string; + /** @description City name */ + city: string; + /** @description City Abbreviation. Empty string if not present */ + city_abbreviation: string; + /** @description Identifies the Congressional District. Empty string if not present */ + congressional_district: string; + /** @description ISO3166 country code. Empty string if not present */ + country_code: string; + /** @description Name of the county */ + county: string; + /** @description Daylight saving time indicator */ + day_light_savings: string; + /** @description Last 2 digits of the primary street address number or Post Office™ box */ + delivery_point: string; + /** @description DPV Confirmation code. Possible values: 'Y' (Yes), 'S' (Suspicious), 'D' (No). */ + dpv: string; + /** @description DPV CMRA code. Possible values: 'Y' (Yes), 'N' (No). */ + dpv_cmra: string; + /** @description DPV Footnotes. Empty string if not present */ + dpv_footnotes: string; + /** @description False Positive Indicator from the DPV lookup. Possible values: 'Y' (Yes), 'N' (No), ' ' (Space). Empty string if not present */ + dpv_fp: string; + /** @description DPV NoStat code. Empty string if not present */ + dpv_no_stat: string; + /** @description DPV Vacant code. Empty string if not present */ + dpv_vacant: string; + /** @description Enhanced Line of Travel */ + elot: string; + /** @description Internal accounting number used by the USPS. Empty string if not present */ + finance_number: string | number; + /** @description Federal Information Processing Standard code for a county. Empty string if not present */ + fips_county_code: string; + /** @description Company name in a business address */ + firm: string; + /** @description Letter codes returned by ZIP + 4® encoding. Empty string if not present */ + footnotes: string; + /** @description Indicates whether the address was geo-coded. Possible values: 'Y' (Yes), 'N' (No). */ + geo_coded: string; + /** @description Indicates whether a record may benefit from LACS processing. Possible values: 'L' (Yes), ' ' (No). */ + lacs_indicator: string; + /** @description LACSLink Footnote. Empty string if not present */ + lacs_link_footnote: string; + /** @description LACSLink Indicator. Empty string if not present */ + lacs_link_indicator: string; + /** @description Latitude of the encoded address. Empty string if not present */ + latitude: string | number; + /** @description Longitude of the encoded address. Empty string if not present */ + longitude: string | number; + /** @description Information if a PMB is found in an address. Empty string if not present */ + parsed_pmb_designator: string; + /** @description Information if a PMB is found in an address. Empty string if not present */ + parsed_pmb_number: string | number; + /** @description Notation following the street name indicating street direction. Empty string if not present */ + parsed_post_directional: string | number; + /** @description Notation preceding the street name indicating street direction. Empty string if not present */ + parsed_pre_directional: string; + /** @description Number preceding the street name. Empty string if not present */ + parsed_primary_number: string | number; + /** @description Street name. Empty string if not present */ + parsed_street_name: string; + /** @description Part of the delivery address line following the street name. Empty string if not present */ + parsed_suffix: string; + /** @description Identification of the secondary address unit. Empty string if not present */ + parsed_unit_designator: string; + /** @description Apartment or suite number. Empty string if not present */ + parsed_unit_number: string; + /** @description Reserved for future use. Empty string if not present */ + rdi: string; + /** @description Type of address record (Street, PO Box, High-rise, etc.) */ + record_type: string; + /** @description Additional secondary address information. Empty string if not present */ + secondary_address_info: string; + /** @description Standard two-letter state abbreviation */ + state: string; + /** @description Results of the SuiteLink lookup. Possible values: ' ' (Space), '00' (Double Zero), 'A' (A). Empty string if not present */ + suite_link_footnote: string; + /** @description Time zone. Empty string if not present */ + time_zone: string; + /** @description Urban name required in the address of all mail being delivered to Puerto Rico. Empty string if not present */ + urbanization: string; + /** @description 5-digit ZIP Code™ and the four additional digits */ + zip_code: string; + }; /** Address Match */ GbrCleanseMatch: { /** @description Originally submitted query */ @@ -3426,7 +3531,8 @@ export interface components { | components["schemas"]["MrAddress"] | components["schemas"]["NybAddress"] | components["schemas"]["PafAliasAddress"] - | components["schemas"]["WelshPafAddress"]; + | components["schemas"]["WelshPafAddress"] + | components["schemas"]["UsaCassVerifiedAddress"]; /** @description The number of addresses we matched to the input. We return the closest match by default. */ count: number; /** @description A score represented as number between 1 and 0. Fit compares the address elements present in your query against the matching address elements. It does not incorporate elements you have not presented in the score. A partial address (e.g. 12 Pye Green Road) will have a fit of 1 even though it is missing post town and postcode. Its confidence score will be less than 1 however because it is missing some crucial elements. */ @@ -5273,6 +5379,8 @@ export interface operations { * If multiple tags are specified, the response will only comprise of requests for which all the tags are satisfied - i.e. searching `"foo,bar"` will only query requests which tagged both `"foo"` and `"bar"`. */ Tags?: components["parameters"]["TagsParam"]; + /** Specify the country */ + context?: string; }; }; responses: { @@ -5310,6 +5418,32 @@ export interface operations { * @example 10 Downing Street, London, SW2A 2BN */ query: string; + /** + * @description Optionally specify postal code for the address. + * + * @example SW1A 2BN + */ + postcode?: string; + /** + * @description Optionally specify the city or town of the address. + * + * For UK verifications, this should be the "post town" of the address. + * + * For USA verifications, this should be the city of the address. + * + * @example London + */ + post_town?: string; + /** + * @description Optionally specify the county or state of the address. + * + * For UK verifications, we recommend omitting this field as county data is unreliable. + * + * For USA verifications, this should be the state of the address. + * + * @example Kent + */ + county?: string; }; }; };