Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorRepresentation ¶
type ErrorRepresentation struct {
// Link to the schema describing the REST resource Used to extend Error class
AtSchemaLocation string `json:"@schemaLocation,omitempty"`
// Type of the REST resource Used to extend Error class
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 Event ¶
type Event struct {
// event
// Required: true
Event *PoqEvent `json:"event"`
// Id of the event
// Required: true
EventID *string `json:"eventId"`
// Datetime when the event occurred
// Required: true
// Format: date-time
EventTime *strfmt.DateTime `json:"eventTime"`
// event type
// Required: true
EventType PoqEventType `json:"eventType"`
}
Event Event class is used to describe information structure used for notification.
swagger:model Event
func (*Event) MarshalBinary ¶
MarshalBinary interface implementation
func (*Event) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type EventPlus ¶
type EventPlus struct {
Event
// Path to the field which has value changed or information required
// Required: true
FieldPath []string `json:"fieldPath"`
// Path to the resource (where an information is required or an attribute changed value)
// Required: true
ResourcePath *string `json:"resourcePath"`
}
EventPlus Event class is used to describe information structure used for notification.
swagger:model EventPlus
func (*EventPlus) MarshalBinary ¶
MarshalBinary interface implementation
func (EventPlus) MarshalJSON ¶
MarshalJSON marshals this object to a JSON structure
func (*EventPlus) UnmarshalBinary ¶
UnmarshalBinary interface implementation
func (*EventPlus) UnmarshalJSON ¶
UnmarshalJSON unmarshals this object from a JSON structure
type Notification ¶
type Notification interface{}
Notification Notification class is used to describe structure used for product offering qualification notification (product offering qualification created, product offering qualification state change, product offering qualification attribute value change)
swagger:model Notification
type PoqEvent ¶
type PoqEvent struct {
// Link to the POQ
Href string `json:"href,omitempty"`
// The Serviceability Request's unique identifier.
ID string `json:"id,omitempty"`
}
PoqEvent The product offering qualification passed as the "event" in a notification.
swagger:model PoqEvent
func (*PoqEvent) MarshalBinary ¶
MarshalBinary interface implementation
func (*PoqEvent) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PoqEventType ¶
type PoqEventType string
PoqEventType Indicates the type of product offering qualification event.
swagger:model PoqEventType
const ( // PoqEventTypeProductOfferingQualificationCreateEventNotification captures enum value "ProductOfferingQualificationCreateEventNotification" PoqEventTypeProductOfferingQualificationCreateEventNotification PoqEventType = "ProductOfferingQualificationCreateEventNotification" // PoqEventTypeProductOfferingQualificationStateChangeEventNotification captures enum value "ProductOfferingQualificationStateChangeEventNotification" PoqEventTypeProductOfferingQualificationStateChangeEventNotification PoqEventType = "ProductOfferingQualificationStateChangeEventNotification" )
type PoqItemEvent ¶
type PoqItemEvent struct {
// Desired Activation Date for the product requested in this item
// Format: date
DesiredActivationDate strfmt.Date `json:"desiredActivationDate,omitempty"`
// Id of this POQ item
// Required: true
ID *string `json:"id"`
// serviceability confidence
ServiceabilityConfidence ServiceabilityColor `json:"serviceabilityConfidence,omitempty"`
// state
State QualificationState `json:"state,omitempty"`
}
PoqItemEvent The product offering qualification item event structure that gets passed in the "event" of a notification.
swagger:model PoqItemEvent
func (*PoqItemEvent) MarshalBinary ¶
func (m *PoqItemEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PoqItemEvent) UnmarshalBinary ¶
func (m *PoqItemEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QualificationState ¶
type QualificationState string
QualificationState These values represent the valid states through which the product offering qualification can transition
swagger:model QualificationState
const ( // QualificationStateInProgress captures enum value "inProgress" QualificationStateInProgress QualificationState = "inProgress" // QualificationStateDone captures enum value "done" QualificationStateDone QualificationState = "done" // QualificationStateTerminatedWithErrorUnableToProvide captures enum value "terminatedWithError.unableToProvide" QualificationStateTerminatedWithErrorUnableToProvide QualificationState = "terminatedWithError.unableToProvide" // QualificationStateTerminatedWithErrorInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" QualificationStateTerminatedWithErrorInsufficientInformationProvided QualificationState = "terminatedWithError.insufficientInformationProvided" )
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" // ServiceabilityColorYellow captures enum value "yellow" ServiceabilityColorYellow ServiceabilityColor = "yellow" // ServiceabilityColorRed captures enum value "red" ServiceabilityColorRed ServiceabilityColor = "red" )
Source Files