Documentation
¶
Index ¶
- type AlternateProductProposal
- type Describing
- type ErrorRepresentation
- type FieldedAddress
- func (m *FieldedAddress) AtReferredType() string
- func (m *FieldedAddress) AtType() string
- func (m *FieldedAddress) Href() string
- func (m *FieldedAddress) ID() string
- func (m *FieldedAddress) MarshalBinary() ([]byte, error)
- func (m FieldedAddress) MarshalJSON() ([]byte, error)
- func (m *FieldedAddress) Role() *string
- func (m *FieldedAddress) SetAtReferredType(val string)
- func (m *FieldedAddress) SetAtType(val string)
- func (m *FieldedAddress) SetHref(val string)
- func (m *FieldedAddress) SetID(val string)
- func (m *FieldedAddress) SetRole(val *string)
- func (m *FieldedAddress) UnmarshalBinary(b []byte) error
- func (m *FieldedAddress) UnmarshalJSON(raw []byte) error
- func (m *FieldedAddress) Validate(formats strfmt.Registry) error
- type FormattedAddress
- func (m *FormattedAddress) AtReferredType() string
- func (m *FormattedAddress) AtType() string
- func (m *FormattedAddress) Href() string
- func (m *FormattedAddress) ID() string
- func (m *FormattedAddress) MarshalBinary() ([]byte, error)
- func (m FormattedAddress) MarshalJSON() ([]byte, error)
- func (m *FormattedAddress) Role() *string
- func (m *FormattedAddress) SetAtReferredType(val string)
- func (m *FormattedAddress) SetAtType(val string)
- func (m *FormattedAddress) SetHref(val string)
- func (m *FormattedAddress) SetID(val string)
- func (m *FormattedAddress) SetRole(val *string)
- func (m *FormattedAddress) UnmarshalBinary(b []byte) error
- func (m *FormattedAddress) UnmarshalJSON(raw []byte) error
- func (m *FormattedAddress) Validate(formats strfmt.Registry) error
- type GeographicLocation
- func (m *GeographicLocation) AtReferredType() string
- func (m *GeographicLocation) AtType() string
- func (m *GeographicLocation) Href() string
- func (m *GeographicLocation) ID() string
- func (m *GeographicLocation) MarshalBinary() ([]byte, error)
- func (m GeographicLocation) MarshalJSON() ([]byte, error)
- func (m *GeographicLocation) Role() *string
- func (m *GeographicLocation) SetAtReferredType(val string)
- func (m *GeographicLocation) SetAtType(val string)
- func (m *GeographicLocation) SetHref(val string)
- func (m *GeographicLocation) SetID(val string)
- func (m *GeographicLocation) SetRole(val *string)
- func (m *GeographicLocation) UnmarshalBinary(b []byte) error
- func (m *GeographicLocation) UnmarshalJSON(raw []byte) error
- func (m *GeographicLocation) Validate(formats strfmt.Registry) error
- type GeographicPoint
- type GeographicSubAddress
- type Hub
- type HubInput
- type Product
- func (m *Product) MarshalBinary() ([]byte, error)
- func (m Product) MarshalJSON() ([]byte, error)
- func (m *Product) Place() []RelatedPlaceReforValue
- func (m *Product) SetPlace(val []RelatedPlaceReforValue)
- func (m *Product) UnmarshalBinary(b []byte) error
- func (m *Product) UnmarshalJSON(raw []byte) error
- func (m *Product) Validate(formats strfmt.Registry) error
- type ProductActionType
- type ProductOfferingQualification
- type ProductOfferingQualificationCreate
- type ProductOfferingQualificationFind
- type ProductOfferingQualificationItem
- type ProductOfferingQualificationItemCreate
- type ProductOfferingQualificationItemRelationship
- type ProductOfferingQualificationItemStateType
- type ProductOfferingQualificationStateType
- type ProductOfferingRef
- type ProductRef
- type ProductRelationship
- type ProductSpecificationRef
- func (m *ProductSpecificationRef) Describing() Describing
- func (m *ProductSpecificationRef) MarshalBinary() ([]byte, error)
- func (m ProductSpecificationRef) MarshalJSON() ([]byte, error)
- func (m *ProductSpecificationRef) SetDescribing(val Describing)
- func (m *ProductSpecificationRef) UnmarshalBinary(b []byte) error
- func (m *ProductSpecificationRef) UnmarshalJSON(raw []byte) error
- func (m *ProductSpecificationRef) Validate(formats strfmt.Registry) error
- type ReferencedAddress
- func (m *ReferencedAddress) AtReferredType() string
- func (m *ReferencedAddress) AtType() string
- func (m *ReferencedAddress) Href() string
- func (m *ReferencedAddress) ID() string
- func (m *ReferencedAddress) MarshalBinary() ([]byte, error)
- func (m ReferencedAddress) MarshalJSON() ([]byte, error)
- func (m *ReferencedAddress) Role() *string
- func (m *ReferencedAddress) SetAtReferredType(val string)
- func (m *ReferencedAddress) SetAtType(val string)
- func (m *ReferencedAddress) SetHref(val string)
- func (m *ReferencedAddress) SetID(val string)
- func (m *ReferencedAddress) SetRole(val *string)
- func (m *ReferencedAddress) UnmarshalBinary(b []byte) error
- func (m *ReferencedAddress) UnmarshalJSON(raw []byte) error
- func (m *ReferencedAddress) Validate(formats strfmt.Registry) error
- type RelatedParty
- type RelatedPlaceReforValue
- type RelationshipType
- type ServiceabilityColor
- type StateChange
- type SubUnit
- type TerminationError
- type TimeInterval
- type TimeUnit
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlternateProductProposal ¶
type AlternateProductProposal struct { // Technical attribute to extend the class. AtType string `json:"@type,omitempty"` // eligible product offering EligibleProductOffering []*ProductOfferingRef `json:"eligibleProductOffering"` // Identifier of the Product Offering Qualification alternate proposal // Required: true ID *string `json:"id"` // installation interval InstallationInterval *TimeInterval `json:"installationInterval,omitempty"` // product specification ProductSpecification *ProductSpecificationRef `json:"productSpecification,omitempty"` }
AlternateProductProposal If in the request the buyer has requested to have alternate product proposals, then this class represents these proposals.
swagger:model AlternateProductProposal
func (*AlternateProductProposal) MarshalBinary ¶
func (m *AlternateProductProposal) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlternateProductProposal) UnmarshalBinary ¶
func (m *AlternateProductProposal) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Describing ¶
type Describing interface { runtime.Validatable // This field provided a link to the schema describing this REST resource. AtSchemaLocation() string SetAtSchemaLocation(string) // Indicates the (class) type of resource AtType() string SetAtType(string) }
Describing Target to the schema describing the product spec resource (and type)
swagger:discriminator Describing @type
func UnmarshalDescribing ¶
UnmarshalDescribing unmarshals polymorphic Describing
func UnmarshalDescribingSlice ¶
UnmarshalDescribingSlice unmarshals polymorphic slices of Describing
type ErrorRepresentation ¶
type ErrorRepresentation struct { // Link to the schema describing the REST resource Used to extend Error class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name 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 mode 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 for example Status string `json:"status,omitempty"` }
ErrorRepresentation Standard Class used to describe API response error
swagger:model ErrorRepresentation
func (*ErrorRepresentation) MarshalBinary ¶
func (m *ErrorRepresentation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorRepresentation) UnmarshalBinary ¶
func (m *ErrorRepresentation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldedAddress ¶
type FieldedAddress struct { // The city that the address is in // Required: true // Max Length: 50 City *string `json:"city"` // Country that the address is in // Required: true // Max Length: 50 Country *string `json:"country"` // geographic sub address GeographicSubAddress *GeographicSubAddress `json:"geographicSubAddress,omitempty"` // The locality that the address is in // Max Length: 50 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 // Max Length: 6 Postcode *string `json:"postcode"` // An extension of a postal code. E.g. the part following the dash in an american urban property address // Max Length: 4 PostcodeExtension string `json:"postcodeExtension,omitempty"` // The State or Province that the address is in // Required: true // Max Length: 50 StateOrProvince *string `json:"stateOrProvince"` // Name of the street or other street type // Max Length: 60 StreetName string `json:"streetName,omitempty"` // Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses // Max Length: 10 StreetNr string `json:"streetNr,omitempty"` // Last number in a range of street numbers allocated to a property // Max Length: 10 StreetNrLast string `json:"streetNrLast,omitempty"` // Last street number suffix for a ranged address // Max Length: 10 StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"` // The first street number suffix // Max Length: 10 StreetNrSuffix string `json:"streetNrSuffix,omitempty"` // A modifier denoting a relative direction // Max Length: 2 StreetSuffix string `json:"streetSuffix,omitempty"` // Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf // Required: true // Max Length: 25 StreetType *string `json:"streetType"` // contains filtered or unexported fields }
FieldedAddress A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example “street number” is one field, “street name” is another field, etc.
swagger:model FieldedAddress
func (*FieldedAddress) AtReferredType ¶
func (m *FieldedAddress) AtReferredType() string
AtReferredType gets the at referred type of this subtype
func (*FieldedAddress) AtType ¶
func (m *FieldedAddress) AtType() string
AtType gets the at type of this subtype
func (*FieldedAddress) Href ¶
func (m *FieldedAddress) Href() string
Href gets the href of this subtype
func (*FieldedAddress) MarshalBinary ¶
func (m *FieldedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (FieldedAddress) MarshalJSON ¶
func (m FieldedAddress) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*FieldedAddress) Role ¶
func (m *FieldedAddress) Role() *string
Role gets the role of this subtype
func (*FieldedAddress) SetAtReferredType ¶
func (m *FieldedAddress) SetAtReferredType(val string)
SetAtReferredType sets the at referred type of this subtype
func (*FieldedAddress) SetAtType ¶
func (m *FieldedAddress) SetAtType(val string)
SetAtType sets the at type of this subtype
func (*FieldedAddress) SetHref ¶
func (m *FieldedAddress) SetHref(val string)
SetHref sets the href of this subtype
func (*FieldedAddress) SetID ¶
func (m *FieldedAddress) SetID(val string)
SetID sets the id of this subtype
func (*FieldedAddress) SetRole ¶
func (m *FieldedAddress) SetRole(val *string)
SetRole sets the role of this subtype
func (*FieldedAddress) UnmarshalBinary ¶
func (m *FieldedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*FieldedAddress) UnmarshalJSON ¶
func (m *FieldedAddress) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type FormattedAddress ¶
type FormattedAddress struct { // The first address line in a formatted address // Required: true // Max Length: 25 AddrLine1 *string `json:"addrLine1"` // The second address line in a formatted address // Max Length: 25 AddrLine2 string `json:"addrLine2,omitempty"` // The city that the address is in // Required: true // Max Length: 50 City *string `json:"city"` // Country that the address is in // Required: true // Max Length: 50 Country *string `json:"country"` // An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi rural in nature // Max Length: 50 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 // Max Length: 6 Postcode *string `json:"postcode"` // An extension of a postal code. E.g. the part following the dash in an American urban property address // Max Length: 4 PostcodeExtension string `json:"postcodeExtension,omitempty"` // The State or Province that the address is in // Required: true // Max Length: 50 StateOrProvince *string `json:"stateOrProvince"` // contains filtered or unexported fields }
FormattedAddress A type of Address that has discrete fields for each type of boundary or identifier with the exception of street and more specific location details, which are combined into a maximum of two strings based on local postal addressing conventions.
swagger:model FormattedAddress
func (*FormattedAddress) AtReferredType ¶
func (m *FormattedAddress) AtReferredType() string
AtReferredType gets the at referred type of this subtype
func (*FormattedAddress) AtType ¶
func (m *FormattedAddress) AtType() string
AtType gets the at type of this subtype
func (*FormattedAddress) Href ¶
func (m *FormattedAddress) Href() string
Href gets the href of this subtype
func (*FormattedAddress) MarshalBinary ¶
func (m *FormattedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (FormattedAddress) MarshalJSON ¶
func (m FormattedAddress) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*FormattedAddress) Role ¶
func (m *FormattedAddress) Role() *string
Role gets the role of this subtype
func (*FormattedAddress) SetAtReferredType ¶
func (m *FormattedAddress) SetAtReferredType(val string)
SetAtReferredType sets the at referred type of this subtype
func (*FormattedAddress) SetAtType ¶
func (m *FormattedAddress) SetAtType(val string)
SetAtType sets the at type of this subtype
func (*FormattedAddress) SetHref ¶
func (m *FormattedAddress) SetHref(val string)
SetHref sets the href of this subtype
func (*FormattedAddress) SetID ¶
func (m *FormattedAddress) SetID(val string)
SetID sets the id of this subtype
func (*FormattedAddress) SetRole ¶
func (m *FormattedAddress) SetRole(val *string)
SetRole sets the role of this subtype
func (*FormattedAddress) UnmarshalBinary ¶
func (m *FormattedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*FormattedAddress) UnmarshalJSON ¶
func (m *FormattedAddress) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type GeographicLocation ¶
type GeographicLocation struct { // geographic point // Required: true GeographicPoint *GeographicPoint `json:"geographicPoint"` // The spatial reference system used to determine the coordinates // Required: true SpatialRef *string `json:"spatialRef"` // contains filtered or unexported fields }
GeographicLocation A set of coordinates (typically including latitude and longitude) that describes a particular loca-tion on earth.
swagger:model GeographicLocation
func (*GeographicLocation) AtReferredType ¶
func (m *GeographicLocation) AtReferredType() string
AtReferredType gets the at referred type of this subtype
func (*GeographicLocation) AtType ¶
func (m *GeographicLocation) AtType() string
AtType gets the at type of this subtype
func (*GeographicLocation) Href ¶
func (m *GeographicLocation) Href() string
Href gets the href of this subtype
func (*GeographicLocation) ID ¶
func (m *GeographicLocation) ID() string
ID gets the id of this subtype
func (*GeographicLocation) MarshalBinary ¶
func (m *GeographicLocation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (GeographicLocation) MarshalJSON ¶
func (m GeographicLocation) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*GeographicLocation) Role ¶
func (m *GeographicLocation) Role() *string
Role gets the role of this subtype
func (*GeographicLocation) SetAtReferredType ¶
func (m *GeographicLocation) SetAtReferredType(val string)
SetAtReferredType sets the at referred type of this subtype
func (*GeographicLocation) SetAtType ¶
func (m *GeographicLocation) SetAtType(val string)
SetAtType sets the at type of this subtype
func (*GeographicLocation) SetHref ¶
func (m *GeographicLocation) SetHref(val string)
SetHref sets the href of this subtype
func (*GeographicLocation) SetID ¶
func (m *GeographicLocation) SetID(val string)
SetID sets the id of this subtype
func (*GeographicLocation) SetRole ¶
func (m *GeographicLocation) SetRole(val *string)
SetRole sets the role of this subtype
func (*GeographicLocation) UnmarshalBinary ¶
func (m *GeographicLocation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*GeographicLocation) UnmarshalJSON ¶
func (m *GeographicLocation) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type GeographicPoint ¶
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"` }
GeographicPoint geographic point
swagger:model GeographicPoint
func (*GeographicPoint) MarshalBinary ¶
func (m *GeographicPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicPoint) UnmarshalBinary ¶
func (m *GeographicPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSubAddress ¶
type GeographicSubAddress struct { // Technical attribute to exend this class if needed (JSON schema locator) AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // Allows for buildings that have well-known names // Max Length: 60 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 // Max Length: 25 LevelNumber string `json:"levelNumber,omitempty"` // Describes level types within a building // Max Length: 25 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 // Max Length: 60 PrivateStreetName string `json:"privateStreetName,omitempty"` // Private streets numbers internal to a private street // Max Length: 10 PrivateStreetNumber string `json:"privateStreetNumber,omitempty"` // sub unit SubUnit []*SubUnit `json:"subUnit"` }
GeographicSubAddress It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
swagger:model GeographicSubAddress
func (*GeographicSubAddress) MarshalBinary ¶
func (m *GeographicSubAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSubAddress) UnmarshalBinary ¶
func (m *GeographicSubAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Hub ¶
type Hub struct { // This callback address is an url. the norification will be sent to this url address // Required: true Callback *string `json:"callback"` // id of the Hub // Required: true ID *string `json:"id"` // This attribute is used to define notification type. Example: ","query":”eventType = ProductOfferingQualificationStateChangeNotification”} // Required: true Query *string `json:"query"` }
Hub This resource is used to manage notification subscription.
swagger:model Hub
func (*Hub) MarshalBinary ¶
MarshalBinary interface implementation
func (*Hub) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HubInput ¶
type HubInput struct { // This attribute is the callback url where event will be sent when occurs, for instance an url http://yourdomain/listener/api/v1/event // Required: true Callback *string `json:"callback"` // This attribute is used to define notification type. Example: ","query":”eventType = ProductOfferingQualificationStateChangeNotification”} // Required: true Query *string `json:"query"` }
HubInput This class is used to request a HUB creation - Used in the POST operation.
swagger:model HubInput
func (*HubInput) MarshalBinary ¶
MarshalBinary interface implementation
func (*HubInput) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Product ¶
type Product struct { // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // Link to product Href string `json:"href,omitempty"` // Unique identifier of the product ID string `json:"id,omitempty"` // product relationship ProductRelationship []*ProductRelationship `json:"productRelationship"` // product specification ProductSpecification *ProductSpecificationRef `json:"productSpecification,omitempty"` // contains filtered or unexported fields }
Product One or more services sold to a Buyer by a Seller. A particular Product Offering defines the technical and commercial attributes and behaviors of a Product.
swagger:model Product
func (*Product) MarshalBinary ¶
MarshalBinary interface implementation
func (Product) MarshalJSON ¶
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*Product) Place ¶
func (m *Product) Place() []RelatedPlaceReforValue
Place gets the place of this base type
func (*Product) SetPlace ¶
func (m *Product) SetPlace(val []RelatedPlaceReforValue)
SetPlace sets the place of this base type
func (*Product) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*Product) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type ProductActionType ¶
type ProductActionType string
ProductActionType Action to be performed on the Product
swagger:model ProductActionType
const ( // ProductActionTypeAdd captures enum value "add" ProductActionTypeAdd ProductActionType = "add" // ProductActionTypeChange captures enum value "change" ProductActionTypeChange ProductActionType = "change" // ProductActionTypeRemove captures enum value "remove" ProductActionTypeRemove ProductActionType = "remove" // ProductActionTypeNoChange captures enum value "noChange" ProductActionTypeNoChange ProductActionType = "noChange" )
type ProductOfferingQualification ¶
type ProductOfferingQualification struct { // Technical attribute to extend the class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // Effective date seller provides qualification result. // Format: date-time EffectiveQualificationCompletionDate strfmt.DateTime `json:"effectiveQualificationCompletionDate,omitempty"` // The date the seller is expected to provide qualification result. // Format: date-time ExpectedResponseDate strfmt.DateTime `json:"expectedResponseDate,omitempty"` // Link to this POQ resource Href string `json:"href,omitempty"` // The Serviceability Request's unique identifier. // Required: true ID *string `json:"id"` // If this flag is set to Yes, Buyer requests to have instant qualificationto be provided in operation POST response InstantSyncQualification *bool `json:"instantSyncQualification,omitempty"` // product offering qualification item // Required: true // Min Items: 1 ProductOfferingQualificationItem []*ProductOfferingQualificationItem `json:"productOfferingQualificationItem"` // This value MAY be assigned by the Buyer/Seller to identify a project the serviceability request is associated with. ProjectID string `json:"projectId,omitempty"` // This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available. ProvideAlternative bool `json:"provideAlternative,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date-time RequestedResponseDate strfmt.DateTime `json:"requestedResponseDate,omitempty"` // state // Required: true State ProductOfferingQualificationStateType `json:"state"` // state change StateChange []*StateChange `json:"stateChange"` }
ProductOfferingQualification A grouping of POQ Items formulated into a request made by a Buyer to a Seller
swagger:model ProductOfferingQualification
func (*ProductOfferingQualification) MarshalBinary ¶
func (m *ProductOfferingQualification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualification) UnmarshalBinary ¶
func (m *ProductOfferingQualification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationCreate ¶
type ProductOfferingQualificationCreate struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // If this flag is set to Yes, Buyer requests to have instant qualification to be provided in operation POST response InstantSyncQualification *bool `json:"instantSyncQualification,omitempty"` // product offering qualification item // Required: true // Min Items: 1 ProductOfferingQualificationItem []*ProductOfferingQualificationItemCreate `json:"productOfferingQualificationItem"` // This value MAY be assigned by the Buyer/Seller to identify a project the qualification request is associated with. ProjectID string `json:"projectId,omitempty"` // This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available. ProvideAlternative *bool `json:"provideAlternative,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date RequestedResponseDate strfmt.Date `json:"requestedResponseDate,omitempty"` }
ProductOfferingQualificationCreate This structure serves as a request for a product offering qualification. A POQ is a grouping of POQ Items formulated into a request made by a Buyer to a Seller
swagger:model ProductOfferingQualification_Create
func (*ProductOfferingQualificationCreate) MarshalBinary ¶
func (m *ProductOfferingQualificationCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationCreate) UnmarshalBinary ¶
func (m *ProductOfferingQualificationCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationFind ¶
type ProductOfferingQualificationFind struct { // The Serviceability Request's unique identifier. ID string `json:"id,omitempty"` // This value MAY be assigned by the Buyer/Seller to identify a project the serviceability request is associated with. ProjectID string `json:"projectId,omitempty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date RequestedResponseDate strfmt.Date `json:"requestedResponseDate,omitempty"` // state State ProductOfferingQualificationStateType `json:"state,omitempty"` }
ProductOfferingQualificationFind This class is used to describe attribute to be used for requesting POQ list (used in the GET by list)
swagger:model ProductOfferingQualification_Find
func (*ProductOfferingQualificationFind) MarshalBinary ¶
func (m *ProductOfferingQualificationFind) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationFind) UnmarshalBinary ¶
func (m *ProductOfferingQualificationFind) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItem ¶
type ProductOfferingQualificationItem struct { // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // action // Required: true Action ProductActionType `json:"action"` // alternate product proposal AlternateProductProposal []*AlternateProductProposal `json:"alternateProductProposal"` // eligible product offering EligibleProductOffering []*ProductOfferingRef `json:"eligibleProductOffering"` // Date until seller is guaranted the qualification result. // Format: date-time GuaranteedUntilDate strfmt.DateTime `json:"guaranteedUntilDate,omitempty"` // Id of this POQ item // Required: true ID *string `json:"id"` // installation interval InstallationInterval *TimeInterval `json:"installationInterval,omitempty"` // product Product *Product `json:"product,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product offering qualification item relationship ProductOfferingQualificationItemRelationship []*ProductOfferingQualificationItemRelationship `json:"productOfferingQualificationItemRelationship"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // A description of the reason a particular color is being provided. This may include a specific standard reason codes and descriptions. ServiceConfidenceReason string `json:"serviceConfidenceReason,omitempty"` // serviceability confidence ServiceabilityConfidence ServiceabilityColor `json:"serviceabilityConfidence,omitempty"` // state // Required: true State ProductOfferingQualificationItemStateType `json:"state"` // state change StateChange []*StateChange `json:"stateChange"` // termination error TerminationError []*TerminationError `json:"terminationError"` }
ProductOfferingQualificationItem An individual article included in a POQ that describes a Product of a particular type (Product Offering) being delivered to a specific geographical location. The objective is to determine if it is feasible for the Seller to deliver this item as described and for the Seller to inform the Buyer of the estimated time interval to complete this delivery.
swagger:model ProductOfferingQualificationItem
func (*ProductOfferingQualificationItem) MarshalBinary ¶
func (m *ProductOfferingQualificationItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItem) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemCreate ¶
type ProductOfferingQualificationItemCreate struct { // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // action Action ProductActionType `json:"action,omitempty"` // Id of the productOfferingQualification item. // This id must be unique within POQ create request // Required: true ID *string `json:"id"` // product // Required: true Product *Product `json:"product"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product offering qualification item relationship ProductOfferingQualificationItemRelationship []*ProductOfferingQualificationItemRelationship `json:"productOfferingQualificationItemRelationship"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` }
ProductOfferingQualificationItemCreate This structure serves as a request for a product offering qualification item An individual article included in a POQ that describes a Product of a particular type (Product Offering) being delivered to a specific geographical location. The objective is to determine if it is feasible for the Seller to deliver this item as described and for the Seller to inform the Buyer of the estimated time interval to complete this delivery.
swagger:model ProductOfferingQualificationItem_Create
func (*ProductOfferingQualificationItemCreate) MarshalBinary ¶
func (m *ProductOfferingQualificationItemCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItemCreate) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItemCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemRelationship ¶
type ProductOfferingQualificationItemRelationship struct { // id of the targeted POQ item // Required: true ID *string `json:"id"` // type // Required: true Type RelationshipType `json:"type"` }
ProductOfferingQualificationItemRelationship The relationship between product offering qualification items that can be used to validate business rules between POQ Items
swagger:model ProductOfferingQualificationItemRelationship
func (*ProductOfferingQualificationItemRelationship) MarshalBinary ¶
func (m *ProductOfferingQualificationItemRelationship) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItemRelationship) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItemRelationship) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemStateType ¶
type ProductOfferingQualificationItemStateType string
ProductOfferingQualificationItemStateType POQ item states - The specific states are managed by the Seller based on its processing and/or based on Buyer's action.
swagger:model ProductOfferingQualificationItemStateType
const ( // ProductOfferingQualificationItemStateTypeDone captures enum value "done" ProductOfferingQualificationItemStateTypeDone ProductOfferingQualificationItemStateType = "done" // ProductOfferingQualificationItemStateTypeTerminatedWithErrorUnableToProvide captures enum value "terminatedWithError.unableToProvide" ProductOfferingQualificationItemStateTypeTerminatedWithErrorUnableToProvide ProductOfferingQualificationItemStateType = "terminatedWithError.unableToProvide" // ProductOfferingQualificationItemStateTypeTerminatedWithErrorInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" ProductOfferingQualificationItemStateTypeTerminatedWithErrorInsufficientInformationProvided ProductOfferingQualificationItemStateType = "terminatedWithError.insufficientInformationProvided" // ProductOfferingQualificationItemStateTypeInProgress captures enum value "inProgress" ProductOfferingQualificationItemStateTypeInProgress ProductOfferingQualificationItemStateType = "inProgress" )
type ProductOfferingQualificationStateType ¶
type ProductOfferingQualificationStateType string
ProductOfferingQualificationStateType These values represent the valid states through which the product offering qualification can transition
swagger:model ProductOfferingQualificationStateType
const ( // ProductOfferingQualificationStateTypeDone captures enum value "done" ProductOfferingQualificationStateTypeDone ProductOfferingQualificationStateType = "done" // ProductOfferingQualificationStateTypeTerminatedWithErrorUnableToProvide captures enum value "terminatedWithError.unableToProvide" ProductOfferingQualificationStateTypeTerminatedWithErrorUnableToProvide ProductOfferingQualificationStateType = "terminatedWithError.unableToProvide" // ProductOfferingQualificationStateTypeTerminatedWithErrorInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" ProductOfferingQualificationStateTypeTerminatedWithErrorInsufficientInformationProvided ProductOfferingQualificationStateType = "terminatedWithError.insufficientInformationProvided" // ProductOfferingQualificationStateTypeInProgress captures enum value "inProgress" ProductOfferingQualificationStateTypeInProgress ProductOfferingQualificationStateType = "inProgress" )
type ProductOfferingRef ¶
type ProductOfferingRef struct { // The actual type of the target instance when needed for disambiguation. AtReferredType string `json:"@referredType,omitempty"` // id of a productOffering ID string `json:"id,omitempty"` }
ProductOfferingRef The commercial and technical details of a Product sold by a particular Seller. A Product Offering defines all of the commercial terms and, through association with a particular Product Specification, defines all the technical attributes and behaviors of the Product. A Product Offering may constrain the allowable set of configurable technical attributes and/or behaviors specified in the associated Product Specification.
swagger:model ProductOfferingRef
func (*ProductOfferingRef) MarshalBinary ¶
func (m *ProductOfferingRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingRef) UnmarshalBinary ¶
func (m *ProductOfferingRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductRef ¶
type ProductRef struct { // The actual type of the target instance when needed for disambiguation. AtReferredType string `json:"@referredType,omitempty"` // Targeted Buyer product id - Informative BuyerProductID string `json:"buyerProductId,omitempty"` // hyerplink to the product in the inventory Href string `json:"href,omitempty"` // id of the product (provided by the seller) // Required: true ID *string `json:"id"` }
ProductRef Reference to an existing product in the inventory
swagger:model ProductRef
func (*ProductRef) MarshalBinary ¶
func (m *ProductRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductRef) UnmarshalBinary ¶
func (m *ProductRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductRelationship ¶
type ProductRelationship struct { // product // Required: true Product *ProductRef `json:"product"` // type // Required: true Type RelationshipType `json:"type"` }
ProductRelationship Indicates a relationship between products.
swagger:model ProductRelationship
func (*ProductRelationship) MarshalBinary ¶
func (m *ProductRelationship) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductRelationship) UnmarshalBinary ¶
func (m *ProductRelationship) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductSpecificationRef ¶
type ProductSpecificationRef struct { // The actual type of the target instance when needed for disambiguation. AtReferredType string `json:"@referredType,omitempty"` // Unique identifier of the product specification ID string `json:"id,omitempty"` // contains filtered or unexported fields }
ProductSpecificationRef A structured set of well-defined technical attributes and/or behaviors that are used to construct a Product Offering for sale to a market.
swagger:model ProductSpecificationRef
func (*ProductSpecificationRef) Describing ¶
func (m *ProductSpecificationRef) Describing() Describing
Describing gets the describing of this base type
func (*ProductSpecificationRef) MarshalBinary ¶
func (m *ProductSpecificationRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ProductSpecificationRef) MarshalJSON ¶
func (m ProductSpecificationRef) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*ProductSpecificationRef) SetDescribing ¶
func (m *ProductSpecificationRef) SetDescribing(val Describing)
SetDescribing sets the describing of this base type
func (*ProductSpecificationRef) UnmarshalBinary ¶
func (m *ProductSpecificationRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ProductSpecificationRef) UnmarshalJSON ¶
func (m *ProductSpecificationRef) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type ReferencedAddress ¶
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"` // contains filtered or unexported fields }
ReferencedAddress A globally unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
swagger:model ReferencedAddress
func (*ReferencedAddress) AtReferredType ¶
func (m *ReferencedAddress) AtReferredType() string
AtReferredType gets the at referred type of this subtype
func (*ReferencedAddress) AtType ¶
func (m *ReferencedAddress) AtType() string
AtType gets the at type of this subtype
func (*ReferencedAddress) Href ¶
func (m *ReferencedAddress) Href() string
Href gets the href of this subtype
func (*ReferencedAddress) ID ¶
func (m *ReferencedAddress) ID() string
ID gets the id of this subtype
func (*ReferencedAddress) MarshalBinary ¶
func (m *ReferencedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (ReferencedAddress) MarshalJSON ¶
func (m ReferencedAddress) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object with a polymorphic type to a JSON structure
func (*ReferencedAddress) Role ¶
func (m *ReferencedAddress) Role() *string
Role gets the role of this subtype
func (*ReferencedAddress) SetAtReferredType ¶
func (m *ReferencedAddress) SetAtReferredType(val string)
SetAtReferredType sets the at referred type of this subtype
func (*ReferencedAddress) SetAtType ¶
func (m *ReferencedAddress) SetAtType(val string)
SetAtType sets the at type of this subtype
func (*ReferencedAddress) SetHref ¶
func (m *ReferencedAddress) SetHref(val string)
SetHref sets the href of this subtype
func (*ReferencedAddress) SetID ¶
func (m *ReferencedAddress) SetID(val string)
SetID sets the id of this subtype
func (*ReferencedAddress) SetRole ¶
func (m *ReferencedAddress) SetRole(val *string)
SetRole sets the role of this subtype
func (*ReferencedAddress) UnmarshalBinary ¶
func (m *ReferencedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*ReferencedAddress) UnmarshalJSON ¶
func (m *ReferencedAddress) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure
type RelatedParty ¶
type RelatedParty struct { // The actual type of the target instance when needed for disambiguation. AtReferredType string `json:"@referredType,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // Party email address EmailAddress string `json:"emailAddress,omitempty"` // Id of the party // Max Length: 45 ID string `json:"id,omitempty"` // Name of the party // Required: true Name *string `json:"name"` // Party phone number // Required: true Number *string `json:"number"` // Party phone number extension NumberExtension string `json:"numberExtension,omitempty"` // Role for this party for this product offering qualification (as “Technical contact” or “Implementation Contact” for example) // Required: true Role []string `json:"role"` }
RelatedParty An entity or organization that is involved in the product offering qualification. It may be the "Buyer", the "Seller", or other related party
swagger:model RelatedParty
func (*RelatedParty) MarshalBinary ¶
func (m *RelatedParty) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RelatedParty) UnmarshalBinary ¶
func (m *RelatedParty) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RelatedPlaceReforValue ¶
type RelatedPlaceReforValue interface { runtime.Validatable // The actual type of the target instance when needed for disambiguation. // Used when place is described by reference // @referredType could be valued to FormattedAddress, FieldedAddress, GeographicSite, GeographicLocation or ReferencedAddress AtReferredType() string SetAtReferredType(string) // When sub-classing, this defines the sub-class entity name. // Used when place is described by value (litterally) // Could be valued to FormattedAddress, FieldedAddress, GeographicLocation or ReferencedAddress AtType() string SetAtType(string) // href to this place resource Href() string SetHref(string) // id of this place // Max Length: 45 ID() string SetID(string) // Role of this place // Required: true Role() *string SetRole(*string) }
RelatedPlaceReforValue Place defines the places where the products qualification must be done.
swagger:discriminator RelatedPlaceReforValue @type
func UnmarshalRelatedPlaceReforValue ¶
func UnmarshalRelatedPlaceReforValue(reader io.Reader, consumer runtime.Consumer) (RelatedPlaceReforValue, error)
UnmarshalRelatedPlaceReforValue unmarshals polymorphic RelatedPlaceReforValue
func UnmarshalRelatedPlaceReforValueSlice ¶
func UnmarshalRelatedPlaceReforValueSlice(reader io.Reader, consumer runtime.Consumer) ([]RelatedPlaceReforValue, error)
UnmarshalRelatedPlaceReforValueSlice unmarshals polymorphic slices of RelatedPlaceReforValue
type RelationshipType ¶
type RelationshipType string
RelationshipType Relationship type to be used between POQ item or product
swagger:model RelationshipType
const ( // RelationshipTypeReliesOn captures enum value "reliesOn" RelationshipTypeReliesOn RelationshipType = "reliesOn" // RelationshipTypeBundled captures enum value "bundled" RelationshipTypeBundled RelationshipType = "bundled" // RelationshipTypeComesFrom captures enum value "comesFrom" RelationshipTypeComesFrom RelationshipType = "comesFrom" )
type ServiceabilityColor ¶
type ServiceabilityColor string
ServiceabilityColor A color that indicates confidence to service the request.
swagger:model ServiceabilityColor
const ( // ServiceabilityColorGreen captures enum value "green" ServiceabilityColorGreen ServiceabilityColor = "green" // ServiceabilityColorRed captures enum value "red" ServiceabilityColorRed ServiceabilityColor = "red" // ServiceabilityColorYellow captures enum value "yellow" ServiceabilityColorYellow ServiceabilityColor = "yellow" )
type StateChange ¶
type StateChange struct { // change date // Format: date-time ChangeDate strfmt.DateTime `json:"changeDate,omitempty"` // change reason ChangeReason string `json:"changeReason,omitempty"` // state State ProductOfferingQualificationStateType `json:"state,omitempty"` }
StateChange Holds the state notification reasons and associated date the state changed, populated by the server
swagger:model StateChange
func (*StateChange) MarshalBinary ¶
func (m *StateChange) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateChange) UnmarshalBinary ¶
func (m *StateChange) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubUnit ¶
type SubUnit struct { // The discriminator used for the subunit, often just a simple number but may also be a range. // Required: true // Max Length: 10 SubUnitIdentifier *string `json:"subUnitIdentifier"` // The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF. // Required: true // Max Length: 25 SubUnitType *string `json:"subUnitType"` }
SubUnit sub unit
swagger:model SubUnit
func (*SubUnit) MarshalBinary ¶
MarshalBinary interface implementation
func (*SubUnit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TerminationError ¶
type TerminationError struct { // Id of the termination error ID string `json:"id,omitempty"` // Value (text) for the termination error Value string `json:"value,omitempty"` }
TerminationError Termination error may be provided if seller is unable to perform qualification
swagger:model TerminationError
func (*TerminationError) MarshalBinary ¶
func (m *TerminationError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TerminationError) UnmarshalBinary ¶
func (m *TerminationError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TimeInterval ¶
type TimeInterval struct { // Amount // Required: true Amount *int32 `json:"amount"` // time unit // Required: true TimeUnit TimeUnit `json:"timeUnit"` }
TimeInterval A time interval, e.g. 3 hours, or 5 days.
swagger:model TimeInterval
func (*TimeInterval) MarshalBinary ¶
func (m *TimeInterval) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TimeInterval) UnmarshalBinary ¶
func (m *TimeInterval) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TimeUnit ¶
type TimeUnit string
TimeUnit Represents a unit of time.
swagger:model TimeUnit
const ( // TimeUnitCalendarDays captures enum value "calendarDays" TimeUnitCalendarDays TimeUnit = "calendarDays" // TimeUnitCalendarHours captures enum value "calendarHours" TimeUnitCalendarHours TimeUnit = "calendarHours" // TimeUnitCalendarMinutes captures enum value "calendarMinutes" TimeUnitCalendarMinutes TimeUnit = "calendarMinutes" // TimeUnitBusinessDays captures enum value "businessDays" TimeUnitBusinessDays TimeUnit = "businessDays" // TimeUnitBusinessHours captures enum value "businessHours" TimeUnitBusinessHours TimeUnit = "businessHours" // TimeUnitBusinessMinutes captures enum value "businessMinutes" TimeUnitBusinessMinutes TimeUnit = "businessMinutes" )
Source Files
¶
- alternate_product_proposal.go
- describing.go
- error_representation.go
- fielded_address.go
- formatted_address.go
- geographic_location.go
- geographic_point.go
- geographic_sub_address.go
- hub.go
- hub_input.go
- product.go
- product_action_type.go
- product_offering_qualification.go
- product_offering_qualification_create.go
- product_offering_qualification_find.go
- product_offering_qualification_item.go
- product_offering_qualification_item_create.go
- product_offering_qualification_item_relationship.go
- product_offering_qualification_item_state_type.go
- product_offering_qualification_state_type.go
- product_offering_ref.go
- product_ref.go
- product_relationship.go
- product_specification_ref.go
- referenced_address.go
- related_party.go
- related_place_refor_value.go
- relationship_type.go
- serviceability_color.go
- state_change.go
- sub_unit.go
- termination_error.go
- time_interval.go
- time_unit.go