addressvalidationep

type AddressValidationSvc interface {
	AutocompleteAddress(ctx context.Context, req *AutocompleteAddressRequest) (*apiresource.List[apiresource.AddressSuggestion], *apierror.APIError)
	GetAddressDetails(ctx context.Context, req *RetrieveAddressDetailsRequest) (*apiresource.AddressDetailsResult, *apierror.APIError)
	ValidateAddress(ctx context.Context, req *ValidateAddressRequest) (*apiresource.ValidatedAddress, *apierror.APIError)
}

type AddressValidationSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}

type AutocompleteAddressEndpoint struct{}

type AutocompleteAddressRequest struct {
	// Partial address text to generate suggestions for.
	Input string `query:"input" validate:"required"`
	// Opaque token that groups a series of related autocomplete requests into a single session.
	//
	// Reuse the same token for each keystroke of one address entry, and again when you retrieve the details of the suggestion the user picks, so the whole entry is treated as one lookup.
	SessionToken *string `query:"session_token"` // #nosec G117 -- not a secret, Google Maps session correlation token
}

type RetrieveAddressDetailsEndpoint struct{}

type RetrieveAddressDetailsRequest struct {
	// The place ID to look up, as returned in the `id` field of an address suggestion.
	PlaceID string `path:"id" validate:"required"`
	// Opaque token that ties this lookup to the autocomplete requests the suggestion came from.
	//
	// Pass the same token used for those autocomplete requests so the whole address entry is treated as one lookup.
	SessionToken *string `query:"session_token"` // #nosec G117 -- not a secret, Google Maps session correlation token
}

type ValidateAddressEndpoint struct{}

type ValidateAddressRequest struct {
	// First line of the street address.
	AddressLine1 string `json:"address_line_1" validate:"required"`
	// Second line of the street address.
	AddressLine2 field.Optional[string] `json:"address_line_2,omitzero"`
	// City or locality.
	City string `json:"city" validate:"required"`
	// State or administrative area.
	State string `json:"state" validate:"required"`
	// Postal or ZIP code.
	PostalCode string `json:"postal_code" validate:"required"`
	// Two-letter country code, such as `US`.
	//
	// A full country name such as `United States` is recognized for a handful of common countries; send the two-letter code for anywhere else.
	Country string `json:"country" validate:"required"`
}