models

type GCSCoordinate struct {

	// latitude specifies the North/South position of a coordinate, as measured from the equator.
	// Example: 40.740776
	// Maximum: 90
	// Minimum: -90
	Latitude *float64 `json:"latitude,omitempty"`

	// longitude specifies the East/West position of a coordinate, as measured from the International Reference Meridian.
	// Example: -74.001852
	// Maximum: 180
	// Minimum: -180
	Longitude *float64 `json:"longitude,omitempty"`
}

type Geocoding struct {

	// The confidence that the address was correctly geocoded. Range 0-100. 100 was an exact record match, 0 is a wild guess.
	// Example: 90
	// Required: true
	// Maximum: 100
	// Minimum: 0
	Confidence *int64 `json:"confidence"`

	// The result object containing the latitude and longitude.
	Coordinate *GCSCoordinate `json:"coordinate,omitempty"`

	// Whether the original data source requires citation via their license terms. This is not used at the moment, but will be in the future.
	// Example: false
	// Required: true
	DatasetCitationRequired *bool `json:"dataset_citation_required"`

	// The address that was matched. This may be different from the input record when the record match was not an exact record match.
	// Required: true
	MatchedAddress *USAddress `json:"matched_address"`

	// The dataset that the result was derived from.
	// Example: US Census TIGER 2020
	// Required: true
	ResultDataset *string `json:"result_dataset"`

	// The description of where the point is. At the moment, all of the points are offset from the road, but in the future this will additionally include rooftop and entrance locations.
	// Example: offset
	// Required: true
	ResultLocation *string `json:"result_location"`

	// Describes how the location was derived. All geocodings are interpolated at the moment, but in the future this will include direct lookups.
	// Example: interpolated
	// Required: true
	ResultType *string `json:"result_type"`
}

type ReverseZIPCode struct {

	// The distance in meters that the point was from the ZIP Code. If it was within the ZIP code, this will be 0. Calculated using the distance between the input point and the ZIP Code's geometry.
	// Example: 0
	Distance float64 `json:"distance,omitempty"`

	// The result object containing the ZIP Code. Will always be present if a lookup was successful.
	// Required: true
	ZIPCode *ZIPCode `json:"zip_code"`
}

type USAddress struct {

	// The city of the address.
	// Example: New York
	// Required: true
	City *string `json:"city"`

	// A fully-formatted version of the address.
	// Example: 111 8th Ave\nNew York, NY 10011
	// Required: true
	Formatted *string `json:"formatted"`

	// The 2-letter state code of the address. Note that in addition to the 50 states, you might also see 2 letter codes for American territories, or the District of Columbia.
	// Example: NY
	// Required: true
	StateCode *string `json:"state_code"`

	// The structured street address parsed from the input.
	// Required: true
	StreetAddress *USStreetAddress `json:"street_address"`

	// The ZIP code and optional plus-four code for the address.
	// Required: true
	ZIPCode *ZIPCode `json:"zip_code"`
}

type USStreetAddress struct {

	// The formatted version of the street address.
	// Example: 111 8th Ave
	// Required: true
	Formatted *string `json:"formatted"`

	// The number of the street address. It is important that this is stored in a string. Many valid house numbers cannot be represented by just a number, in which case the alphanumeric_number field will be populated: Some fake examples include '1/2 Smith Street', '41-13 39th Place', 'E400N200 Pike Street'. Note that the alpha version of the API only includes numeric addresses, but our stable release will handle this"
	// Example: 111
	Number string `json:"number,omitempty"`

	// A directional (N, E, S, W, etc) that appears after the street name. For example, 'W' is the postdirectional in '1 Main Street W'.
	// Example: SE
	Postdirectional string `json:"postdirectional,omitempty"`

	// A directional (N, E, S, W, etc) that appears before the street name. For example, 'E' is the predirectional in '1 E Main Street'.
	// Example: NW
	Predirectional string `json:"predirectional,omitempty"`

	// The street name of the address. This omits the road type. So the address '101 Main Street' would have 'Main' in the StreetName field.
	// Example: 8th
	// Required: true
	StreetName *string `json:"street_name"`

	// The type of the street: Rd, St, Ave, etc. So the address '101 Main Street' would be 'St'. May be omitted for some roads. For example, 'Broadway' and 'The Embarcadero' are valid road names that do not have road types.
	// Example: Avenue
	Type string `json:"type,omitempty"`

	// A unit designator in an address, if one is present. For example, 'Apt 3' is the unit designator in '1 Main Street Apt 3'. This may combine more than one designator into the same field: 'Building 2 Floor 1'.
	// Example: Apt 3B
	UnitDesignator string `json:"unit_designator,omitempty"`
}

type ZIPCode struct {

	// A string with the formatted version of the ZIP code. This may include the +4 extension if available.
	// Example: 10011-1234
	Formatted string `json:"formatted,omitempty"`

	// The optional plus-four code, if available. Note that this will omit leading zeroes, so if you need to display the ZIP Code, you need to either pad with zeroes or use the 'formatted' field. Provided as a convenience for developers that need the numeric form.
	// Example: 1234
	PlusFour int64 `json:"plus_four,omitempty"`

	// The main 5-digit ZIP Code. Note that this will omit leading zeroes, so if you need to display the ZIP Code, you need to either pad with zeroes or use the 'formatted' field. Provided as a convenience for developers that need the numeric form.
	// Example: 10011
	// Required: true
	ZIP *int64 `json:"zip"`
}