models

type ErrorRepresentation struct {

	// it provides a link to the schema describing a REST resource.
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// The class type of a REST resource.
	AtType string `json:"@type,omitempty"`

	// Application related code (as defined in the API or from a common list)
	// Required: true
	Code *int32 `json:"code"`

	// Text that provide more details and corrective actions related to the error. This can be shown to a client user.
	// Required: true
	Message *string `json:"message"`

	// Text that explains the reason for error. This can be shown to a client user.
	Reason string `json:"reason,omitempty"`

	// url pointing to documentation describing the error
	ReferenceError string `json:"referenceError,omitempty"`

	// http error code extension like 400-2
	Status string `json:"status,omitempty"`
}

type FieldedAddress struct {

	// The city that the address is in
	// Required: true
	City *string `json:"city"`

	// Country that the address is in
	// Required: true
	Country *string `json:"country"`

	// geographic sub address
	GeographicSubAddress *GeographicSubAddress `json:"geographicSubAddress,omitempty"`

	// id of the fielded address
	ID string `json:"id,omitempty"`

	// The locality that the address is in
	Locality string `json:"locality,omitempty"`

	// Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode)
	// Required: true
	Postcode *string `json:"postcode"`

	// An extension of a postal code. E.g. the part following the dash in an american urban property address
	PostcodeExtension string `json:"postcodeExtension,omitempty"`

	// The State or Province that the address is in
	// Required: true
	StateOrProvince *string `json:"stateOrProvince"`

	// Name of the street or other street type
	StreetName string `json:"streetName,omitempty"`

	// Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses
	StreetNr string `json:"streetNr,omitempty"`

	// Last number in a range of street numbers allocated to a property
	StreetNrLast string `json:"streetNrLast,omitempty"`

	// Last street number suffix for a ranged address
	StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"`

	// The first street number suffix
	StreetNrSuffix string `json:"streetNrSuffix,omitempty"`

	// A modifier denoting a relative direction
	StreetSuffix string `json:"streetSuffix,omitempty"`

	// Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf
	// Required: true
	StreetType *string `json:"streetType"`
}

type FormattedAddress struct {

	// The first address line in a formatted address
	// Required: true
	AddrLine1 *string `json:"addrLine1"`

	// The second address line in a formatted address
	AddrLine2 string `json:"addrLine2,omitempty"`

	// The city that the address is in
	// Required: true
	City *string `json:"city"`

	// Country that the address is in
	// Required: true
	Country *string `json:"country"`

	// id of the formatted address
	ID string `json:"id,omitempty"`

	// An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature
	Locality string `json:"locality,omitempty"`

	// Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as ZIP code)
	// Required: true
	Postcode *string `json:"postcode"`

	// An extension of a postal code. E.g. the part following the dash in an American urban property address
	PostcodeExtension string `json:"postcodeExtension,omitempty"`

	// The State or Province that the address is in
	// Required: true
	StateOrProvince *string `json:"stateOrProvince"`
}

type GeographicAddressFindResp struct {

	// fielded address
	FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"`

	// formatted address
	FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"`
}

type GeographicLocation struct {

	// geographic point
	// Required: true
	GeographicPoint *GeographicPoint `json:"geographicPoint"`

	// id of the GeographicLocation
	ID string `json:"id,omitempty"`

	// The spatial reference system used to determine the coordinates
	// Required: true
	SpatialRef *string `json:"spatialRef"`
}

type GeographicPoint struct {

	// The latitude expressed in decimal degrees format
	// Required: true
	Latitude *string `json:"latitude"`

	// The longitude expressed in decimal degrees format
	// Required: true
	Longitude *string `json:"longitude"`
}

type GeographicSite struct {

	// Technical attribute to extend this class
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Technical attribute to extend this class
	AtType string `json:"@type,omitempty"`

	// Additional site information
	AdditionnalSiteInformation string `json:"additionnalSiteInformation,omitempty"`

	// A textual description of the Service Site.
	Description string `json:"description,omitempty"`

	// fielded address
	FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"`

	// formatted adress
	FormattedAdress *FormattedAddress `json:"formattedAdress,omitempty"`

	// geographic location
	GeographicLocation *GeographicLocation `json:"geographicLocation,omitempty"`

	// Identifier of the Service Site unique within the Seller.
	ID string `json:"id,omitempty"`

	// referenced address
	ReferencedAddress *ReferencedAddress `json:"referencedAddress,omitempty"`

	// related party
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// The name of the company that is the administrative authority (e.g. controls access) for this Service Site. (For example, the building owner)
	SiteCompanyName string `json:"siteCompanyName,omitempty"`

	// The name of the company that is the administrative authority for the space within this Service Site. (For example, the company leasing space in a multi-tenant building).
	SiteCustomerName string `json:"siteCustomerName,omitempty"`

	// A name commonly used by people to refer to this Service Site.
	SiteName string `json:"siteName,omitempty"`

	// This defines whether a Service Site is public or private.  “PUBLIC” means that the existence of this Service Site is public information.  A meet-me-room in a hosted data center facility (where all interconnects between parties take place) is an example of a public Service Site.  A shared facility in the basement of a multi-tenant business building where all interconnects between parties take place is another example of a public Service Site.  “PRIVATE” means that the existence of this Service Site is on a need-to-know basis.  A wiring closet set up inside a customer facility just to connect two parties is an example of a private Service Site. For “PRIVATE” sites, the Seller does not return any information regarding the existence of this Service Site unless it has been established that this Buyer is authorized to obtain this information.
	SiteType string `json:"siteType,omitempty"`

	// status
	Status Status `json:"status,omitempty"`
}

type GeographicSiteFindResp struct {

	// geographic address
	GeographicAddress *GeographicAddressFindResp `json:"geographicAddress,omitempty"`

	// id of the site. This is coud be used in other API as a place
	ID string `json:"id,omitempty"`

	// The name of the company that is the administrative authority (e.g. controls access) for this Service Site. (For example, the building owner)
	SiteCompanyName string `json:"siteCompanyName,omitempty"`

	// Name of the relatedParty which has role 'Site Contact' in the Site record.
	SiteContactName string `json:"siteContactName,omitempty"`

	// The name of the company that is the administrative authority for the space within this Service Site. (For example, the company leasing space in a multi-tenant building).
	SiteCustomerName string `json:"siteCustomerName,omitempty"`

	// A textual description of the Service Site.
	SiteDescription string `json:"siteDescription,omitempty"`

	// A name commonly used by people to refer to this Service Site.
	SiteName string `json:"siteName,omitempty"`

	// This defines whether a Service Site is public or private.
	SiteType string `json:"siteType,omitempty"`

	// status
	Status Status `json:"status,omitempty"`
}

type GeographicSubAddress struct {

	// Technical attribute to exend this class if needed (JSON schema locator)
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Technical attribute to exend this class if needed
	AtType string `json:"@type,omitempty"`

	// Allows for buildings that have well-known names
	BuildingName string `json:"buildingName,omitempty"`

	// Unique Identifier of the subAddress
	ID string `json:"id,omitempty"`

	// Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2
	LevelNumber string `json:"levelNumber,omitempty"`

	// Describes level types within a building
	LevelType string `json:"levelType,omitempty"`

	// "Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office
	PrivateStreetName string `json:"privateStreetName,omitempty"`

	// Private streets numbers internal to a private street
	PrivateStreetNumber string `json:"privateStreetNumber,omitempty"`

	// sub unit
	SubUnit []*SubUnit `json:"subUnit"`
}

type ReferencedAddress struct {

	// A reference to an address by id; this would include such things as CLLI Codes, or Seller-assigned address identifiers
	// Required: true
	ReferenceID *string `json:"referenceId"`

	// The type of the reference. For North American providers this would normally be CLLI
	// Required: true
	ReferenceType *string `json:"referenceType"`
}

type RelatedParty struct {

	// Allow to specify the party type like Organization or Individual
	AtReferredType string `json:"@referredType,omitempty"`

	// The email address of the related party.
	EmailAddress string `json:"emailAddress,omitempty"`

	// An identifier of the related party.
	// Required: true
	ID *string `json:"id"`

	// The name of the related party, e.g. "Jean Pontus".
	// Required: true
	Name *string `json:"name"`

	// The telephone number of the related party.
	Number string `json:"number,omitempty"`

	// Phone number Extension.
	NumberExtension string `json:"numberExtension,omitempty"`

	// Role played by this party for this Site as UNISiteContact for example.
	// Required: true
	Role []string `json:"role"`
}

type Status string

type SubUnit struct {

	// The discriminator used for the subunit, often just a simple number but may also be a range.
	// Required: true
	SubUnitIdentifier *string `json:"subUnitIdentifier"`

	// The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF.
	// Required: true
	SubUnitType *string `json:"subUnitType"`
}