models

package
v0.0.0-...-36f1224 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 2, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Addressable 

type Addressable struct {

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	ID string `json:"id,omitempty"`
}

Addressable Base schema for adressable entities

swagger:model Addressable

func (*Addressable) ContextValidate 

func (m *Addressable) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this addressable based on context it is used

func (*Addressable) MarshalBinary 

func (m *Addressable) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Addressable) UnmarshalBinary 

func (m *Addressable) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Addressable) Validate 

func (m *Addressable) Validate(formats strfmt.Registry) error

Validate validates this addressable

type Any 

type Any interface{}

Any any

swagger:model Any

type AppointmentRef 

type AppointmentRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// An explanatory text regarding the appointment made with a party
	Description string `json:"description,omitempty"`

	// The reference of the appointment
	Href string `json:"href,omitempty"`

	// The identifier of the referred appointment
	// Required: true
	ID *string `json:"id"`
}

AppointmentRef Refers an appointment, such as a Customer presentation or internal meeting or site visit

swagger:model AppointmentRef

func (*AppointmentRef) ContextValidate 

func (m *AppointmentRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this appointment ref based on context it is used

func (*AppointmentRef) MarshalBinary 

func (m *AppointmentRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*AppointmentRef) UnmarshalBinary 

func (m *AppointmentRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*AppointmentRef) Validate 

func (m *AppointmentRef) Validate(formats strfmt.Registry) error

Validate validates this appointment ref

type CancelOrder 

type CancelOrder struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Reason why the order is cancelled.
	CancellationReason string `json:"cancellationReason,omitempty"`

	// Date when the order is cancelled.
	// Format: date-time
	EffectiveCancellationDate strfmt.DateTime `json:"effectiveCancellationDate,omitempty"`

	// Hyperlink to access the cancellation request
	Href string `json:"href,omitempty"`

	// id of the cancellation request (this is not an order id)
	ID string `json:"id,omitempty"`

	// Date when the submitter wants the order to be cancelled
	// Format: date-time
	RequestedCancellationDate strfmt.DateTime `json:"requestedCancellationDate,omitempty"`

	// Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.
	State TaskStateType `json:"state,omitempty"`
}

CancelOrder A Order cancel is a type of task which can be used to place a request to cancel an order

swagger:model CancelOrder

func (*CancelOrder) ContextValidate 

func (m *CancelOrder) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel order based on the context it is used

func (*CancelOrder) MarshalBinary 

func (m *CancelOrder) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelOrder) UnmarshalBinary 

func (m *CancelOrder) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelOrder) Validate 

func (m *CancelOrder) Validate(formats strfmt.Registry) error

Validate validates this cancel order

type CancelServiceOrder 

type CancelServiceOrder struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Reason why the order is cancelled.
	CancellationReason string `json:"cancellationReason,omitempty"`

	// an optional message describing the completion of the task if it is done as expected or it is denied for a reason (like order in an state of PoNR).
	CompletionMessage string `json:"completionMessage,omitempty"`

	// Date when the order is cancelled.
	// Format: date-time
	EffectiveCancellationDate strfmt.DateTime `json:"effectiveCancellationDate,omitempty"`

	// error message
	ErrorMessage *Error `json:"errorMessage,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	ID string `json:"id,omitempty"`

	// Date when the submitter wants the order to be cancelled
	// Format: date-time
	RequestedCancellationDate strfmt.DateTime `json:"requestedCancellationDate,omitempty"`

	// service order
	ServiceOrder *ServiceOrderRef `json:"serviceOrder,omitempty"`

	// Tracks the lifecycle status of the cancellation request, such as Acknowledged, Rejected, InProgress, Pending and so on.
	State TaskStateType `json:"state,omitempty"`
}

CancelServiceOrder Request for cancellation an existing Service order

swagger:model CancelServiceOrder

func (*CancelServiceOrder) ContextValidate 

func (m *CancelServiceOrder) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order based on the context it is used

func (*CancelServiceOrder) MarshalBinary 

func (m *CancelServiceOrder) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrder) UnmarshalBinary 

func (m *CancelServiceOrder) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrder) Validate 

func (m *CancelServiceOrder) Validate(formats strfmt.Registry) error

Validate validates this cancel service order

type CancelServiceOrderCreate 

type CancelServiceOrderCreate struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Reason why the order is cancelled.
	CancellationReason string `json:"cancellationReason,omitempty"`

	// an optional message describing the completion of the task if it is done as expected or it is denied for a reason (like order in an state of PoNR).
	CompletionMessage string `json:"completionMessage,omitempty"`

	// error message
	ErrorMessage *Error `json:"errorMessage,omitempty"`

	// Date when the submitter wants the order to be cancelled
	// Format: date-time
	RequestedCancellationDate strfmt.DateTime `json:"requestedCancellationDate,omitempty"`

	// service order
	// Required: true
	ServiceOrder *ServiceOrderRef `json:"serviceOrder"`
}

CancelServiceOrderCreate Request for cancellation an existing Service order Skipped properties: id,href,state,effectiveCancellationDate

swagger:model CancelServiceOrder_Create

func (*CancelServiceOrderCreate) ContextValidate 

func (m *CancelServiceOrderCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order create based on the context it is used

func (*CancelServiceOrderCreate) MarshalBinary 

func (m *CancelServiceOrderCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderCreate) UnmarshalBinary 

func (m *CancelServiceOrderCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderCreate) Validate 

func (m *CancelServiceOrderCreate) Validate(formats strfmt.Registry) error

Validate validates this cancel service order create

type CancelServiceOrderCreateEvent 

type CancelServiceOrderCreateEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *CancelServiceOrderCreateEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

CancelServiceOrderCreateEvent The notification data structure

swagger:model CancelServiceOrderCreateEvent

func (*CancelServiceOrderCreateEvent) ContextValidate 

func (m *CancelServiceOrderCreateEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order create event based on the context it is used

func (*CancelServiceOrderCreateEvent) MarshalBinary 

func (m *CancelServiceOrderCreateEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderCreateEvent) UnmarshalBinary 

func (m *CancelServiceOrderCreateEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderCreateEvent) Validate 

func (m *CancelServiceOrderCreateEvent) Validate(formats strfmt.Registry) error

Validate validates this cancel service order create event

type CancelServiceOrderCreateEventPayload 

type CancelServiceOrderCreateEventPayload struct {

	// The involved resource data for the event
	CancelServiceOrder *CancelServiceOrder `json:"cancelServiceOrder,omitempty"`
}

CancelServiceOrderCreateEventPayload The event data structure

swagger:model CancelServiceOrderCreateEventPayload

func (*CancelServiceOrderCreateEventPayload) ContextValidate 

func (m *CancelServiceOrderCreateEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order create event payload based on the context it is used

func (*CancelServiceOrderCreateEventPayload) MarshalBinary 

func (m *CancelServiceOrderCreateEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderCreateEventPayload) UnmarshalBinary 

func (m *CancelServiceOrderCreateEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderCreateEventPayload) Validate 

func (m *CancelServiceOrderCreateEventPayload) Validate(formats strfmt.Registry) error

Validate validates this cancel service order create event payload

type CancelServiceOrderInformationRequiredEvent 

type CancelServiceOrderInformationRequiredEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *CancelServiceOrderInformationRequiredEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// The path identifying the object field concerned by this notification.
	FieldPath string `json:"fieldPath,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

CancelServiceOrderInformationRequiredEvent The notification data structure

swagger:model CancelServiceOrderInformationRequiredEvent

func (*CancelServiceOrderInformationRequiredEvent) ContextValidate 

func (m *CancelServiceOrderInformationRequiredEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order information required event based on the context it is used

func (*CancelServiceOrderInformationRequiredEvent) MarshalBinary 

func (m *CancelServiceOrderInformationRequiredEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderInformationRequiredEvent) UnmarshalBinary 

func (m *CancelServiceOrderInformationRequiredEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderInformationRequiredEvent) Validate 

func (m *CancelServiceOrderInformationRequiredEvent) Validate(formats strfmt.Registry) error

Validate validates this cancel service order information required event

type CancelServiceOrderInformationRequiredEventPayload 

type CancelServiceOrderInformationRequiredEventPayload struct {

	// The involved resource data for the event
	CancelServiceOrder *CancelServiceOrder `json:"cancelServiceOrder,omitempty"`
}

CancelServiceOrderInformationRequiredEventPayload The event data structure

swagger:model CancelServiceOrderInformationRequiredEventPayload

func (*CancelServiceOrderInformationRequiredEventPayload) ContextValidate 

func (m *CancelServiceOrderInformationRequiredEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order information required event payload based on the context it is used

func (*CancelServiceOrderInformationRequiredEventPayload) MarshalBinary 

func (m *CancelServiceOrderInformationRequiredEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderInformationRequiredEventPayload) UnmarshalBinary 

func (m *CancelServiceOrderInformationRequiredEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderInformationRequiredEventPayload) Validate 

func (m *CancelServiceOrderInformationRequiredEventPayload) Validate(formats strfmt.Registry) error

Validate validates this cancel service order information required event payload

type CancelServiceOrderStateChangeEvent 

type CancelServiceOrderStateChangeEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *CancelServiceOrderStateChangeEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

CancelServiceOrderStateChangeEvent The notification data structure

swagger:model CancelServiceOrderStateChangeEvent

func (*CancelServiceOrderStateChangeEvent) ContextValidate 

func (m *CancelServiceOrderStateChangeEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order state change event based on the context it is used

func (*CancelServiceOrderStateChangeEvent) MarshalBinary 

func (m *CancelServiceOrderStateChangeEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderStateChangeEvent) UnmarshalBinary 

func (m *CancelServiceOrderStateChangeEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderStateChangeEvent) Validate 

func (m *CancelServiceOrderStateChangeEvent) Validate(formats strfmt.Registry) error

Validate validates this cancel service order state change event

type CancelServiceOrderStateChangeEventPayload 

type CancelServiceOrderStateChangeEventPayload struct {

	// The involved resource data for the event
	CancelServiceOrder *CancelServiceOrder `json:"cancelServiceOrder,omitempty"`
}

CancelServiceOrderStateChangeEventPayload The event data structure

swagger:model CancelServiceOrderStateChangeEventPayload

func (*CancelServiceOrderStateChangeEventPayload) ContextValidate 

func (m *CancelServiceOrderStateChangeEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this cancel service order state change event payload based on the context it is used

func (*CancelServiceOrderStateChangeEventPayload) MarshalBinary 

func (m *CancelServiceOrderStateChangeEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CancelServiceOrderStateChangeEventPayload) UnmarshalBinary 

func (m *CancelServiceOrderStateChangeEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CancelServiceOrderStateChangeEventPayload) Validate 

func (m *CancelServiceOrderStateChangeEventPayload) Validate(formats strfmt.Registry) error

Validate validates this cancel service order state change event payload

type Characteristic 

type Characteristic struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// characteristic relationship
	CharacteristicRelationship []*CharacteristicRelationship `json:"characteristicRelationship"`

	// Unique identifier of the characteristic
	ID string `json:"id,omitempty"`

	// Name of the characteristic
	// Required: true
	Name *string `json:"name"`

	// The value of the characteristic
	// Required: true
	Value Any `json:"value"`

	// Data type of the value of the characteristic
	ValueType string `json:"valueType,omitempty"`
}

Characteristic Describes a given characteristic of an object or entity through a name/value pair.

swagger:model Characteristic

func (*Characteristic) ContextValidate 

func (m *Characteristic) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this characteristic based on the context it is used

func (*Characteristic) MarshalBinary 

func (m *Characteristic) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Characteristic) UnmarshalBinary 

func (m *Characteristic) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Characteristic) Validate 

func (m *Characteristic) Validate(formats strfmt.Registry) error

Validate validates this characteristic

type CharacteristicRelationship 

type CharacteristicRelationship struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Unique identifier of the characteristic
	ID string `json:"id,omitempty"`

	// The type of relationship
	RelationshipType string `json:"relationshipType,omitempty"`
}

CharacteristicRelationship Another Characteristic that is related to the current Characteristic.

swagger:model CharacteristicRelationship

func (*CharacteristicRelationship) ContextValidate 

func (m *CharacteristicRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this characteristic relationship based on context it is used

func (*CharacteristicRelationship) MarshalBinary 

func (m *CharacteristicRelationship) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CharacteristicRelationship) UnmarshalBinary 

func (m *CharacteristicRelationship) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CharacteristicRelationship) Validate 

func (m *CharacteristicRelationship) Validate(formats strfmt.Registry) error

Validate validates this characteristic relationship

type ConstraintRef 

type ConstraintRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`

	// constraint version
	Version string `json:"version,omitempty"`
}

ConstraintRef Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.

swagger:model ConstraintRef

func (*ConstraintRef) ContextValidate 

func (m *ConstraintRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this constraint ref based on context it is used

func (*ConstraintRef) MarshalBinary 

func (m *ConstraintRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ConstraintRef) UnmarshalBinary 

func (m *ConstraintRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ConstraintRef) Validate 

func (m *ConstraintRef) Validate(formats strfmt.Registry) error

Validate validates this constraint ref

type ContextUpdate 

type ContextUpdate struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Identifier of the context update
	ID string `json:"id,omitempty"`

	// The date and time the status/state last changed.
	// Format: date-time
	LastUpdate strfmt.DateTime `json:"lastUpdate,omitempty"`

	// The reason/context for the current value of the status/state.
	Reason string `json:"reason,omitempty"`

	// A list of entities that represent observations, anomalies or managing entities etc associated to the current status/state value.
	RelatedEntity []*EntityRef `json:"relatedEntity"`

	// List of parties associated to the current status/state value.
	RelatedParty []*RelatedParty `json:"relatedParty"`
}

ContextUpdate Holds the date when the status/state last changed and provides a reason/context to the current value of the status/state. It has the relatedEntity and relatedParty in relation to the status/state value.

swagger:model ContextUpdate

func (*ContextUpdate) ContextValidate 

func (m *ContextUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this context update based on the context it is used

func (*ContextUpdate) MarshalBinary 

func (m *ContextUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ContextUpdate) UnmarshalBinary 

func (m *ContextUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ContextUpdate) Validate 

func (m *ContextUpdate) Validate(formats strfmt.Registry) error

Validate validates this context update

type Entity 

type Entity struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	ID string `json:"id,omitempty"`
}

Entity Base entity schema for use in TMForum Open-APIs

swagger:model Entity

func (*Entity) ContextValidate 

func (m *Entity) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this entity based on context it is used

func (*Entity) MarshalBinary 

func (m *Entity) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Entity) UnmarshalBinary 

func (m *Entity) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Entity) Validate 

func (m *Entity) Validate(formats strfmt.Registry) error

Validate validates this entity

type EntityRef 

type EntityRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`
}

EntityRef Entity reference schema to be use for all entityRef class.

swagger:model EntityRef

func (*EntityRef) ContextValidate 

func (m *EntityRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this entity ref based on context it is used

func (*EntityRef) MarshalBinary 

func (m *EntityRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EntityRef) UnmarshalBinary 

func (m *EntityRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EntityRef) Validate 

func (m *EntityRef) Validate(formats strfmt.Registry) error

Validate validates this entity ref

type EntityValue 

type EntityValue struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Reference of the related entity.
	Href string `json:"href,omitempty"`

	// Unique identifier of a related entity.
	ID string `json:"id,omitempty"`
}

EntityValue Base entity value schema for use in TMForum Open-APIs

swagger:model EntityValue

func (*EntityValue) ContextValidate 

func (m *EntityValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this entity value based on context it is used

func (*EntityValue) MarshalBinary 

func (m *EntityValue) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EntityValue) UnmarshalBinary 

func (m *EntityValue) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EntityValue) Validate 

func (m *EntityValue) Validate(formats strfmt.Registry) error

Validate validates this entity value

type Error 

type Error struct {

	// When sub-classing, this defines the super-class.
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class entity name.
	AtType string `json:"@type,omitempty"`

	// Application relevant detail, defined in the API or a common list.
	// Required: true
	Code *string `json:"code"`

	// More details and corrective actions related to the error which can be shown to a client user.
	Message string `json:"message,omitempty"`

	// Explanation of the reason for the error which can be shown to a client user.
	// Required: true
	Reason *string `json:"reason"`

	// URI of documentation describing the error.
	// Format: uri
	ReferenceError strfmt.URI `json:"referenceError,omitempty"`

	// HTTP Error code extension
	Status string `json:"status,omitempty"`
}

Error Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)

swagger:model Error

func (*Error) ContextValidate 

func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error based on context it is used

func (*Error) MarshalBinary 

func (m *Error) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Error) UnmarshalBinary 

func (m *Error) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Error) Validate 

func (m *Error) Validate(formats strfmt.Registry) error

Validate validates this error

type ErrorMessage 

type ErrorMessage struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// error code
	Code int64 `json:"code,omitempty"`

	// More details and corrective actions related to the error
	Message string `json:"message,omitempty"`

	// Explanation of the reason for the error
	Reason string `json:"reason,omitempty"`

	// URI of documentation describing the error
	// Format: uri
	ReferenceError strfmt.URI `json:"referenceError,omitempty"`
}

ErrorMessage represents an Error

swagger:model ErrorMessage

func (*ErrorMessage) ContextValidate 

func (m *ErrorMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error message based on context it is used

func (*ErrorMessage) MarshalBinary 

func (m *ErrorMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorMessage) UnmarshalBinary 

func (m *ErrorMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorMessage) Validate 

func (m *ErrorMessage) Validate(formats strfmt.Registry) error

Validate validates this error message

type EventSubscription 

type EventSubscription struct {

	// The callback being registered.
	// Required: true
	Callback *string `json:"callback"`

	// Id of the listener
	// Required: true
	ID *string `json:"id"`

	// additional data to be passed
	Query string `json:"query,omitempty"`
}

EventSubscription Sets the communication endpoint address the service instance must use to deliver notification information

swagger:model EventSubscription

func (*EventSubscription) ContextValidate 

func (m *EventSubscription) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this event subscription based on context it is used

func (*EventSubscription) MarshalBinary 

func (m *EventSubscription) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EventSubscription) UnmarshalBinary 

func (m *EventSubscription) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EventSubscription) Validate 

func (m *EventSubscription) Validate(formats strfmt.Registry) error

Validate validates this event subscription

type EventSubscriptionInput 

type EventSubscriptionInput struct {

	// The callback being registered.
	// Required: true
	Callback *string `json:"callback"`

	// additional data to be passed
	Query string `json:"query,omitempty"`
}

EventSubscriptionInput Sets the communication endpoint address the service instance must use to deliver notification information

swagger:model EventSubscriptionInput

func (*EventSubscriptionInput) ContextValidate 

func (m *EventSubscriptionInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this event subscription input based on context it is used

func (*EventSubscriptionInput) MarshalBinary 

func (m *EventSubscriptionInput) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*EventSubscriptionInput) UnmarshalBinary 

func (m *EventSubscriptionInput) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*EventSubscriptionInput) Validate 

func (m *EventSubscriptionInput) Validate(formats strfmt.Registry) error

Validate validates this event subscription input

type Extensible 

type Extensible struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`
}

Extensible Base Extensible schema for use in TMForum Open-APIs

swagger:model Extensible

func (*Extensible) ContextValidate 

func (m *Extensible) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this extensible based on context it is used

func (*Extensible) MarshalBinary 

func (m *Extensible) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Extensible) UnmarshalBinary 

func (m *Extensible) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Extensible) Validate 

func (m *Extensible) Validate(formats strfmt.Registry) error

Validate validates this extensible

type ExternalIdentifier 

type ExternalIdentifier struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Type of the identification, typically would be the type of the entity within the external system
	// Example: ProductOrder
	ExternalIdentifierType string `json:"externalIdentifierType,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// identification of the entity within the external system.
	// Example: MC2255771199555
	// Required: true
	ID *string `json:"id"`

	// Name of the external system that owns the entity.
	// Example: MagentoCommerce
	Owner string `json:"owner,omitempty"`
}

ExternalIdentifier An identification of an entity that is owned by or originates in a software system different from the current system, for example a ProductOrder handed off from a commerce platform into an order handling system. The structure identifies the system itself, the nature of the entity within the system (e.g. class name) and the unique ID of the entity within the system. It is anticipated that multiple external IDs can be held for a single entity, e.g. if the entity passed through multiple systems on the way to the current system. In this case the consumer is expected to sequence the IDs in the array in reverse order of provenance, i.e. most recent system first in the list.

swagger:model ExternalIdentifier

func (*ExternalIdentifier) ContextValidate 

func (m *ExternalIdentifier) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this external identifier based on context it is used

func (*ExternalIdentifier) MarshalBinary 

func (m *ExternalIdentifier) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExternalIdentifier) UnmarshalBinary 

func (m *ExternalIdentifier) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExternalIdentifier) Validate 

func (m *ExternalIdentifier) Validate(formats strfmt.Registry) error

Validate validates this external identifier

type ExternalReference 

type ExternalReference struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Type of the external reference
	ExternalReferenceType string `json:"externalReferenceType,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	ID string `json:"id,omitempty"`

	// External reference name
	// Required: true
	Name *string `json:"name"`
}

ExternalReference External reference of the individual or reference in other system

swagger:model ExternalReference

func (*ExternalReference) ContextValidate 

func (m *ExternalReference) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this external reference based on context it is used

func (*ExternalReference) MarshalBinary 

func (m *ExternalReference) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ExternalReference) UnmarshalBinary 

func (m *ExternalReference) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ExternalReference) Validate 

func (m *ExternalReference) Validate(formats strfmt.Registry) error

Validate validates this external reference

type Feature 

type Feature struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// This is a list of feature constraints.
	Constraint []*ConstraintRef `json:"constraint"`

	// This is a list of Characteristics for a particular feature.
	FeatureCharacteristic []*Characteristic `json:"featureCharacteristic"`

	// feature relationship
	FeatureRelationship []*FeatureRelationship `json:"featureRelationship"`

	// Unique identifier of the feature.
	ID string `json:"id,omitempty"`

	// True if this is a feature group. Default is false.
	IsBundle bool `json:"isBundle,omitempty"`

	// True if this feature is enabled. Default is true.
	IsEnabled bool `json:"isEnabled,omitempty"`

	// This is the name for the feature.
	// Required: true
	Name *string `json:"name"`
}

Feature Configuration feature.

swagger:model Feature

func (*Feature) ContextValidate 

func (m *Feature) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this feature based on the context it is used

func (*Feature) MarshalBinary 

func (m *Feature) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Feature) UnmarshalBinary 

func (m *Feature) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Feature) Validate 

func (m *Feature) Validate(formats strfmt.Registry) error

Validate validates this feature

type FeatureRelationship 

type FeatureRelationship struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Unique identifier of the target feature.
	ID string `json:"id,omitempty"`

	// This is the name of the target feature.
	// Required: true
	Name *string `json:"name"`

	// This is the type of the feature relationship.
	// Required: true
	RelationshipType *string `json:"relationshipType"`

	// The period for which this feature relationship is valid.
	ValidFor *TimePeriod `json:"validFor,omitempty"`
}

FeatureRelationship Configuration feature

swagger:model FeatureRelationship

func (*FeatureRelationship) ContextValidate 

func (m *FeatureRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this feature relationship based on the context it is used

func (*FeatureRelationship) MarshalBinary 

func (m *FeatureRelationship) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*FeatureRelationship) UnmarshalBinary 

func (m *FeatureRelationship) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*FeatureRelationship) Validate 

func (m *FeatureRelationship) Validate(formats strfmt.Registry) error

Validate validates this feature relationship

type JSONPatch 

type JSONPatch struct {

	// A string containing a JSON Pointer value.
	From string `json:"from,omitempty"`

	// The operation to be performed
	// Required: true
	Op *string `json:"op"`

	// A JSON-Pointer
	// Required: true
	Path *string `json:"path"`

	// The value to be used within the operations.
	Value interface{} `json:"value,omitempty"`
}

JSONPatch Path structure

swagger:model JsonPatch

func (*JSONPatch) ContextValidate 

func (m *JSONPatch) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this Json patch based on context it is used

func (*JSONPatch) MarshalBinary 

func (m *JSONPatch) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JSONPatch) UnmarshalBinary 

func (m *JSONPatch) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JSONPatch) Validate 

func (m *JSONPatch) Validate(formats strfmt.Registry) error

Validate validates this Json patch

type JeopardyAlert 

type JeopardyAlert struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// A date time( DateTime). The date that the alert issued
	// Format: date-time
	AlertDate strfmt.DateTime `json:"alertDate,omitempty"`

	//  The exception associated with this jeopardy alert
	Exception string `json:"exception,omitempty"`

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

	// A string represents the type of jeopardy/risk like Normal, Hazard, Critical, ...
	JeopardyType string `json:"jeopardyType,omitempty"`

	// A string represents the message of the alert
	Message string `json:"message,omitempty"`

	// A string used to give a name to the jeopardy alert
	Name string `json:"name,omitempty"`
}

JeopardyAlert A JeopardyAlert represents a predicted exception during a process that may cause a risk to complete successfully the process.

swagger:model JeopardyAlert

func (*JeopardyAlert) ContextValidate 

func (m *JeopardyAlert) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this jeopardy alert based on context it is used

func (*JeopardyAlert) MarshalBinary 

func (m *JeopardyAlert) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*JeopardyAlert) UnmarshalBinary 

func (m *JeopardyAlert) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*JeopardyAlert) Validate 

func (m *JeopardyAlert) Validate(formats strfmt.Registry) error

Validate validates this jeopardy alert

type Milestone 

type Milestone struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// free-text description of the Milestone
	Description string `json:"description,omitempty"`

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

	// A string represents the message of the milestone
	Message string `json:"message,omitempty"`

	// A date time( DateTime). The date that the milestone happens
	// Format: date-time
	MilestoneDate strfmt.DateTime `json:"milestoneDate,omitempty"`

	// A string used to give a name to the milestone
	Name string `json:"name,omitempty"`

	// The milestone status
	Status string `json:"status,omitempty"`
}

Milestone Milestone represents an action or event marking a significant change or stage in a process like an order process.

swagger:model Milestone

func (*Milestone) ContextValidate 

func (m *Milestone) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this milestone based on context it is used

func (*Milestone) MarshalBinary 

func (m *Milestone) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Milestone) UnmarshalBinary 

func (m *Milestone) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Milestone) Validate 

func (m *Milestone) Validate(formats strfmt.Registry) error

Validate validates this milestone

type Note 

type Note struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Author of the note
	// Example: ["Mr. N. Bene"]
	Author string `json:"author,omitempty"`

	// Date of the note
	// Example: ["2020-11-20T08:00:00Z"]
	// Format: date-time
	Date strfmt.DateTime `json:"date,omitempty"`

	// Identifier of the note within its containing entity
	// Example: ["afa9-3d90aaa8da0f"]
	ID string `json:"id,omitempty"`

	// Text of the note
	// Example: ["This is important"]
	// Required: true
	Text *string `json:"text"`
}

Note Extra information about a given entity

swagger:model Note

func (*Note) ContextValidate 

func (m *Note) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this note based on context it is used

func (*Note) MarshalBinary 

func (m *Note) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Note) UnmarshalBinary 

func (m *Note) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Note) Validate 

func (m *Note) Validate(formats strfmt.Registry) error

Validate validates this note

type OrderItemActionType 

type OrderItemActionType string

OrderItemActionType action to be performed on the product

swagger:model OrderItemActionType 

const (

	// OrderItemActionTypeAdd captures enum value "add"
	OrderItemActionTypeAdd OrderItemActionType = "add"

	// OrderItemActionTypeModify captures enum value "modify"
	OrderItemActionTypeModify OrderItemActionType = "modify"

	// OrderItemActionTypeDelete captures enum value "delete"
	OrderItemActionTypeDelete OrderItemActionType = "delete"

	// OrderItemActionTypeNoChange captures enum value "noChange"
	OrderItemActionTypeNoChange OrderItemActionType = "noChange"
)

func NewOrderItemActionType 

func NewOrderItemActionType(value OrderItemActionType) *OrderItemActionType

func (OrderItemActionType) ContextValidate 

func (m OrderItemActionType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this order item action type based on context it is used

func (OrderItemActionType) Pointer 

func (m OrderItemActionType) Pointer() *OrderItemActionType

Pointer returns a pointer to a freshly-allocated OrderItemActionType.

func (OrderItemActionType) Validate 

func (m OrderItemActionType) Validate(formats strfmt.Registry) error

Validate validates this order item action type

type Place 

type Place struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Unique reference of the place
	Href string `json:"href,omitempty"`

	// Unique identifier of the place
	ID string `json:"id,omitempty"`

	// A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
	Name string `json:"name,omitempty"`
}

Place Place reference. Place defines the places where the products are sold or delivered.

swagger:model Place

func (*Place) ContextValidate 

func (m *Place) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this place based on context it is used

func (*Place) MarshalBinary 

func (m *Place) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Place) UnmarshalBinary 

func (m *Place) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Place) Validate 

func (m *Place) Validate(formats strfmt.Registry) error

Validate validates this place

type PlaceRef 

type PlaceRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`
}

PlaceRef Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.

swagger:model PlaceRef

func (*PlaceRef) ContextValidate 

func (m *PlaceRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this place ref based on context it is used

func (*PlaceRef) MarshalBinary 

func (m *PlaceRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PlaceRef) UnmarshalBinary 

func (m *PlaceRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PlaceRef) Validate 

func (m *PlaceRef) Validate(formats strfmt.Registry) error

Validate validates this place ref

type RelatedEntityRefOrValue 

type RelatedEntityRefOrValue struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Reference of the related entity.
	Href string `json:"href,omitempty"`

	// Unique identifier of a related entity.
	ID string `json:"id,omitempty"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`

	// role
	// Required: true
	Role *string `json:"role"`
}

RelatedEntityRefOrValue A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself

swagger:model RelatedEntityRefOrValue

func (*RelatedEntityRefOrValue) ContextValidate 

func (m *RelatedEntityRefOrValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this related entity ref or value based on context it is used

func (*RelatedEntityRefOrValue) MarshalBinary 

func (m *RelatedEntityRefOrValue) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RelatedEntityRefOrValue) UnmarshalBinary 

func (m *RelatedEntityRefOrValue) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RelatedEntityRefOrValue) Validate 

func (m *RelatedEntityRefOrValue) Validate(formats strfmt.Registry) error

Validate validates this related entity ref or value

type RelatedParty 

type RelatedParty struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	// Required: true
	AtReferredType *string `json:"@referredType"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`

	// Role played by the related party
	Role string `json:"role,omitempty"`
}

RelatedParty Related Entity reference. A related party defines party or party role linked to a specific entity.

swagger:model RelatedParty

func (*RelatedParty) ContextValidate 

func (m *RelatedParty) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this related party based on context it is used

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

func (*RelatedParty) Validate 

func (m *RelatedParty) Validate(formats strfmt.Registry) error

Validate validates this related party

type RelatedPlaceRefOrValue 

type RelatedPlaceRefOrValue struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Unique reference of the place
	Href string `json:"href,omitempty"`

	// Unique identifier of the place
	ID string `json:"id,omitempty"`

	// A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
	Name string `json:"name,omitempty"`

	// role
	// Required: true
	Role *string `json:"role"`
}

RelatedPlaceRefOrValue Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself

swagger:model RelatedPlaceRefOrValue

func (*RelatedPlaceRefOrValue) ContextValidate 

func (m *RelatedPlaceRefOrValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this related place ref or value based on context it is used

func (*RelatedPlaceRefOrValue) MarshalBinary 

func (m *RelatedPlaceRefOrValue) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RelatedPlaceRefOrValue) UnmarshalBinary 

func (m *RelatedPlaceRefOrValue) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RelatedPlaceRefOrValue) Validate 

func (m *RelatedPlaceRefOrValue) Validate(formats strfmt.Registry) error

Validate validates this related place ref or value

type RelatedServiceOrderItem 

type RelatedServiceOrderItem struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Action of the order item for this service
	ItemAction OrderItemActionType `json:"itemAction,omitempty"`

	// Identifier of the order item where the service was managed
	// Required: true
	ItemID *string `json:"itemId"`

	// role of the service order item for this service
	Role string `json:"role,omitempty"`

	// Reference of the related entity.
	ServiceOrderHref string `json:"serviceOrderHref,omitempty"`

	// Unique identifier of a related entity.
	ServiceOrderID string `json:"serviceOrderId,omitempty"`
}

RelatedServiceOrderItem RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.

swagger:model RelatedServiceOrderItem

func (*RelatedServiceOrderItem) ContextValidate 

func (m *RelatedServiceOrderItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this related service order item based on the context it is used

func (*RelatedServiceOrderItem) MarshalBinary 

func (m *RelatedServiceOrderItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*RelatedServiceOrderItem) UnmarshalBinary 

func (m *RelatedServiceOrderItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*RelatedServiceOrderItem) Validate 

func (m *RelatedServiceOrderItem) Validate(formats strfmt.Registry) error

Validate validates this related service order item

type ResourceRef 

type ResourceRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`
}

ResourceRef resource ref

swagger:model ResourceRef

func (*ResourceRef) ContextValidate 

func (m *ResourceRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this resource ref based on context it is used

func (*ResourceRef) MarshalBinary 

func (m *ResourceRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ResourceRef) UnmarshalBinary 

func (m *ResourceRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ResourceRef) Validate 

func (m *ResourceRef) Validate(formats strfmt.Registry) error

Validate validates this resource ref

type Service 

type Service struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Is it a customer facing or resource facing service
	Category string `json:"category,omitempty"`

	// Free-text description of the service
	Description string `json:"description,omitempty"`

	// Date when the service ends
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// A list of external identifiers assoicated with this service
	ExternalIdentifier []*ExternalIdentifier `json:"externalIdentifier"`

	// A list of feature associated with this service
	Feature []*Feature `json:"feature"`

	// If TRUE, this Service has already been started
	HasStarted bool `json:"hasStarted,omitempty"`

	// Reference of the service
	Href string `json:"href,omitempty"`

	// Unique identifier of the service
	ID string `json:"id,omitempty"`

	// If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
	IsBundle bool `json:"isBundle,omitempty"`

	// If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
	IsServiceEnabled bool `json:"isServiceEnabled,omitempty"`

	// If TRUE, this Service can be changed without affecting any other services
	IsStateful bool `json:"isStateful,omitempty"`

	// Name of the service
	Name string `json:"name,omitempty"`

	// A list of notes made on this service
	Note []*Note `json:"note"`

	// Indicates how a service is currently performing or operating. It is a logical representation of the service operating behaviour and is determined/managed by the service provider.
	OperatingStatus ServiceOperatingStatusType `json:"operatingStatus,omitempty"`

	// Additional information describing the context of operatingStatus and is determined/managed by the service provider.
	OperatingStatusContextUpdate *ContextUpdate `json:"operatingStatusContextUpdate,omitempty"`

	// A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
	Place []*RelatedPlaceRefOrValue `json:"place"`

	// A list of related  entity in relationship with this service
	RelatedEntity []*RelatedEntityRefOrValue `json:"relatedEntity"`

	// A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// A list of characteristics that characterize this service (ServiceCharacteristic [*])
	ServiceCharacteristic []*Characteristic `json:"serviceCharacteristic"`

	// Date when the service was created (whatever its status).
	ServiceDate string `json:"serviceDate,omitempty"`

	// A list of service order items related to this service
	ServiceOrderItem []*RelatedServiceOrderItem `json:"serviceOrderItem"`

	// A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
	ServiceRelationship []*ServiceRelationship `json:"serviceRelationship"`

	// The specification from which this service was instantiated
	ServiceSpecification *ServiceSpecificationRef `json:"serviceSpecification,omitempty"`

	// Business type of the service
	ServiceType string `json:"serviceType,omitempty"`

	// Date when the service starts
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above
	StartMode string `json:"startMode,omitempty"`

	// The life cycle state of the service, such as designed, reserved, active, etc...
	State ServiceStateType `json:"state,omitempty"`

	// A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
	SupportingResource []*ResourceRef `json:"supportingResource"`

	// A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
	SupportingService []*ServiceRefOrValue `json:"supportingService"`
}

Service Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.

swagger:model Service

func (*Service) ContextValidate 

func (m *Service) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service based on the context it is used

func (*Service) MarshalBinary 

func (m *Service) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Service) UnmarshalBinary 

func (m *Service) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Service) Validate 

func (m *Service) Validate(formats strfmt.Registry) error

Validate validates this service

type ServiceOperatingStatusType 

type ServiceOperatingStatusType string

ServiceOperatingStatusType Valid values for the Operating status of the service

swagger:model ServiceOperatingStatusType 

const (

	// ServiceOperatingStatusTypePending captures enum value "pending"
	ServiceOperatingStatusTypePending ServiceOperatingStatusType = "pending"

	// ServiceOperatingStatusTypeConfigured captures enum value "configured"
	ServiceOperatingStatusTypeConfigured ServiceOperatingStatusType = "configured"

	// ServiceOperatingStatusTypeStarting captures enum value "starting"
	ServiceOperatingStatusTypeStarting ServiceOperatingStatusType = "starting"

	// ServiceOperatingStatusTypeRunning captures enum value "running"
	ServiceOperatingStatusTypeRunning ServiceOperatingStatusType = "running"

	// ServiceOperatingStatusTypeDegraded captures enum value "degraded"
	ServiceOperatingStatusTypeDegraded ServiceOperatingStatusType = "degraded"

	// ServiceOperatingStatusTypeFailed captures enum value "failed"
	ServiceOperatingStatusTypeFailed ServiceOperatingStatusType = "failed"

	// ServiceOperatingStatusTypeLimited captures enum value "limited"
	ServiceOperatingStatusTypeLimited ServiceOperatingStatusType = "limited"

	// ServiceOperatingStatusTypeStopping captures enum value "stopping"
	ServiceOperatingStatusTypeStopping ServiceOperatingStatusType = "stopping"

	// ServiceOperatingStatusTypeStopped captures enum value "stopped"
	ServiceOperatingStatusTypeStopped ServiceOperatingStatusType = "stopped"

	// ServiceOperatingStatusTypeUnknown captures enum value "unknown"
	ServiceOperatingStatusTypeUnknown ServiceOperatingStatusType = "unknown"
)

func NewServiceOperatingStatusType 

func NewServiceOperatingStatusType(value ServiceOperatingStatusType) *ServiceOperatingStatusType

func (ServiceOperatingStatusType) ContextValidate 

func (m ServiceOperatingStatusType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service operating status type based on context it is used

func (ServiceOperatingStatusType) Pointer 

func (m ServiceOperatingStatusType) Pointer() *ServiceOperatingStatusType

Pointer returns a pointer to a freshly-allocated ServiceOperatingStatusType.

func (ServiceOperatingStatusType) Validate 

func (m ServiceOperatingStatusType) Validate(formats strfmt.Registry) error

Validate validates this service operating status type

type ServiceOrder 

type ServiceOrder struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Date when the order is cancelled. This is used when order is cancelled.
	// Format: date-time
	CancellationDate strfmt.DateTime `json:"cancellationDate,omitempty"`

	// Reason why the order is cancelled. This is used when order is cancelled.
	CancellationReason string `json:"cancellationReason,omitempty"`

	// Used to categorize the order, useful for the OM system, such as: Broadband, TVOption
	Category string `json:"category,omitempty"`

	// Effective delivery date amended by the provider
	// Format: date-time
	CompletionDate strfmt.DateTime `json:"completionDate,omitempty"`

	// A free-text description of the service order
	Description string `json:"description,omitempty"`

	// the error message if the order closed by an error
	ErrorMessage *ServiceOrderErrorMessage `json:"errorMessage,omitempty"`

	// Expected delivery date amended by the provider
	// Format: date-time
	ExpectedCompletionDate strfmt.DateTime `json:"expectedCompletionDate,omitempty"`

	// ID given by the consumer to facilitate searches
	ExternalID string `json:"externalId,omitempty"`

	// external reference
	ExternalReference []*ExternalReference `json:"externalReference"`

	// Hyperlink to access the order
	Href string `json:"href,omitempty"`

	// ID created on repository side
	ID string `json:"id,omitempty"`

	// A list of jeopardy alerts related to this order
	JeopardyAlert []*ServiceOrderJeopardyAlert `json:"jeopardyAlert"`

	// A list of milestones related to this order
	Milestone []*ServiceOrderMilestone `json:"milestone"`

	// Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
	Note []*Note `json:"note"`

	// Contact attached to the order to send back information regarding this order
	NotificationContact string `json:"notificationContact,omitempty"`

	// order date
	// Format: date-time
	OrderDate strfmt.DateTime `json:"orderDate,omitempty"`

	// A list of service orders related to this order (e.g. prerequisite, dependent on)
	OrderRelationship []*ServiceOrderRelationship `json:"orderRelationship"`

	// Can be used by consumers to prioritize orders in a Service Order Management system
	Priority string `json:"priority,omitempty"`

	// A list of parties which are involved in this order and the role they are playing
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// Requested delivery date from the requestors perspective
	// Format: date-time
	RequestedCompletionDate strfmt.DateTime `json:"requestedCompletionDate,omitempty"`

	// Order start date wished by the requestor
	// Format: date-time
	RequestedStartDate strfmt.DateTime `json:"requestedStartDate,omitempty"`

	// A list of service order items to be processed by this order
	ServiceOrderItem []*ServiceOrderItem `json:"serviceOrderItem"`

	// Date when the order was started for processing
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// State of the order: described in the state-machine diagram
	State ServiceOrderStateType `json:"state,omitempty"`
}

ServiceOrder service order

swagger:model ServiceOrder

func (*ServiceOrder) ContextValidate 

func (m *ServiceOrder) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order based on the context it is used

func (*ServiceOrder) MarshalBinary 

func (m *ServiceOrder) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrder) UnmarshalBinary 

func (m *ServiceOrder) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrder) Validate 

func (m *ServiceOrder) Validate(formats strfmt.Registry) error

Validate validates this service order

type ServiceOrderAttributeValueChangeEvent 

type ServiceOrderAttributeValueChangeEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderAttributeValueChangeEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// The path identifying the object field concerned by this notification.
	FieldPath string `json:"fieldPath,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderAttributeValueChangeEvent The notification data structure

swagger:model ServiceOrderAttributeValueChangeEvent

func (*ServiceOrderAttributeValueChangeEvent) ContextValidate 

func (m *ServiceOrderAttributeValueChangeEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order attribute value change event based on the context it is used

func (*ServiceOrderAttributeValueChangeEvent) MarshalBinary 

func (m *ServiceOrderAttributeValueChangeEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderAttributeValueChangeEvent) UnmarshalBinary 

func (m *ServiceOrderAttributeValueChangeEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderAttributeValueChangeEvent) Validate 

func (m *ServiceOrderAttributeValueChangeEvent) Validate(formats strfmt.Registry) error

Validate validates this service order attribute value change event

type ServiceOrderAttributeValueChangeEventPayload 

type ServiceOrderAttributeValueChangeEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderAttributeValueChangeEventPayload The event data structure

swagger:model ServiceOrderAttributeValueChangeEventPayload

func (*ServiceOrderAttributeValueChangeEventPayload) ContextValidate 

func (m *ServiceOrderAttributeValueChangeEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order attribute value change event payload based on the context it is used

func (*ServiceOrderAttributeValueChangeEventPayload) MarshalBinary 

func (m *ServiceOrderAttributeValueChangeEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderAttributeValueChangeEventPayload) UnmarshalBinary 

func (m *ServiceOrderAttributeValueChangeEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderAttributeValueChangeEventPayload) Validate 

func (m *ServiceOrderAttributeValueChangeEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order attribute value change event payload

type ServiceOrderCreate 

type ServiceOrderCreate struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Date when the order is cancelled. This is used when order is cancelled.
	// Format: date-time
	CancellationDate strfmt.DateTime `json:"cancellationDate,omitempty"`

	// Reason why the order is cancelled. This is used when order is cancelled.
	CancellationReason string `json:"cancellationReason,omitempty"`

	// Used to categorize the order, useful for the OM system, such as: Broadband, TVOption
	Category string `json:"category,omitempty"`

	// A free-text description of the service order
	Description string `json:"description,omitempty"`

	// ID given by the consumer to facilitate searches
	ExternalID string `json:"externalId,omitempty"`

	// external reference
	ExternalReference []*ExternalReference `json:"externalReference"`

	// Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
	Note []*Note `json:"note"`

	// Contact attached to the order to send back information regarding this order
	NotificationContact string `json:"notificationContact,omitempty"`

	// A list of service orders related to this order (e.g. prerequisite, dependent on)
	OrderRelationship []*ServiceOrderRelationship `json:"orderRelationship"`

	// Can be used by consumers to prioritize orders in a Service Order Management system
	Priority string `json:"priority,omitempty"`

	// A list of parties which are involved in this order and the role they are playing
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// Requested delivery date from the requestors perspective
	// Format: date-time
	RequestedCompletionDate strfmt.DateTime `json:"requestedCompletionDate,omitempty"`

	// Order start date wished by the requestor
	// Format: date-time
	RequestedStartDate strfmt.DateTime `json:"requestedStartDate,omitempty"`

	// A list of service order items to be processed by this order
	// Required: true
	// Min Items: 1
	ServiceOrderItem []*ServiceOrderItem `json:"serviceOrderItem"`
}

ServiceOrderCreate Skipped properties: id,href,orderDate,completionDate,expectedCompletionDate,startDate,state,jeopardyAlert,errorMessage,milestone

swagger:model ServiceOrder_Create

func (*ServiceOrderCreate) ContextValidate 

func (m *ServiceOrderCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order create based on the context it is used

func (*ServiceOrderCreate) MarshalBinary 

func (m *ServiceOrderCreate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderCreate) UnmarshalBinary 

func (m *ServiceOrderCreate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderCreate) Validate 

func (m *ServiceOrderCreate) Validate(formats strfmt.Registry) error

Validate validates this service order create

type ServiceOrderCreateEvent 

type ServiceOrderCreateEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderCreateEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderCreateEvent The notification data structure

swagger:model ServiceOrderCreateEvent

func (*ServiceOrderCreateEvent) ContextValidate 

func (m *ServiceOrderCreateEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order create event based on the context it is used

func (*ServiceOrderCreateEvent) MarshalBinary 

func (m *ServiceOrderCreateEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderCreateEvent) UnmarshalBinary 

func (m *ServiceOrderCreateEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderCreateEvent) Validate 

func (m *ServiceOrderCreateEvent) Validate(formats strfmt.Registry) error

Validate validates this service order create event

type ServiceOrderCreateEventPayload 

type ServiceOrderCreateEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderCreateEventPayload The event data structure

swagger:model ServiceOrderCreateEventPayload

func (*ServiceOrderCreateEventPayload) ContextValidate 

func (m *ServiceOrderCreateEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order create event payload based on the context it is used

func (*ServiceOrderCreateEventPayload) MarshalBinary 

func (m *ServiceOrderCreateEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderCreateEventPayload) UnmarshalBinary 

func (m *ServiceOrderCreateEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderCreateEventPayload) Validate 

func (m *ServiceOrderCreateEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order create event payload

type ServiceOrderDeleteEvent 

type ServiceOrderDeleteEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderDeleteEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderDeleteEvent The notification data structure

swagger:model ServiceOrderDeleteEvent

func (*ServiceOrderDeleteEvent) ContextValidate 

func (m *ServiceOrderDeleteEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order delete event based on the context it is used

func (*ServiceOrderDeleteEvent) MarshalBinary 

func (m *ServiceOrderDeleteEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderDeleteEvent) UnmarshalBinary 

func (m *ServiceOrderDeleteEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderDeleteEvent) Validate 

func (m *ServiceOrderDeleteEvent) Validate(formats strfmt.Registry) error

Validate validates this service order delete event

type ServiceOrderDeleteEventPayload 

type ServiceOrderDeleteEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderDeleteEventPayload The event data structure

swagger:model ServiceOrderDeleteEventPayload

func (*ServiceOrderDeleteEventPayload) ContextValidate 

func (m *ServiceOrderDeleteEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order delete event payload based on the context it is used

func (*ServiceOrderDeleteEventPayload) MarshalBinary 

func (m *ServiceOrderDeleteEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderDeleteEventPayload) UnmarshalBinary 

func (m *ServiceOrderDeleteEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderDeleteEventPayload) Validate 

func (m *ServiceOrderDeleteEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order delete event payload

type ServiceOrderErrorMessage 

type ServiceOrderErrorMessage struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// error code
	Code int64 `json:"code,omitempty"`

	// More details and corrective actions related to the error
	Message string `json:"message,omitempty"`

	// Explanation of the reason for the error
	Reason string `json:"reason,omitempty"`

	// URI of documentation describing the error
	// Format: uri
	ReferenceError strfmt.URI `json:"referenceError,omitempty"`

	// A list of order items corresponded to this error
	ServiceOrderItem []*ServiceOrderItemRef `json:"serviceOrderItem"`

	// error code extension like sys-ABC-2001
	Status string `json:"status,omitempty"`

	// Date when the error happened
	// Format: date-time
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
}

ServiceOrderErrorMessage A ServiceOrderErrorMessage represents an error that causes a status change in a service order.

swagger:model ServiceOrderErrorMessage

func (*ServiceOrderErrorMessage) ContextValidate 

func (m *ServiceOrderErrorMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order error message based on the context it is used

func (*ServiceOrderErrorMessage) MarshalBinary 

func (m *ServiceOrderErrorMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderErrorMessage) UnmarshalBinary 

func (m *ServiceOrderErrorMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderErrorMessage) Validate 

func (m *ServiceOrderErrorMessage) Validate(formats strfmt.Registry) error

Validate validates this service order error message

type ServiceOrderInformationRequiredEvent 

type ServiceOrderInformationRequiredEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderInformationRequiredEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// The path identifying the object field concerned by this notification.
	FieldPath string `json:"fieldPath,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderInformationRequiredEvent The notification data structure

swagger:model ServiceOrderInformationRequiredEvent

func (*ServiceOrderInformationRequiredEvent) ContextValidate 

func (m *ServiceOrderInformationRequiredEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order information required event based on the context it is used

func (*ServiceOrderInformationRequiredEvent) MarshalBinary 

func (m *ServiceOrderInformationRequiredEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderInformationRequiredEvent) UnmarshalBinary 

func (m *ServiceOrderInformationRequiredEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderInformationRequiredEvent) Validate 

func (m *ServiceOrderInformationRequiredEvent) Validate(formats strfmt.Registry) error

Validate validates this service order information required event

type ServiceOrderInformationRequiredEventPayload 

type ServiceOrderInformationRequiredEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderInformationRequiredEventPayload The event data structure

swagger:model ServiceOrderInformationRequiredEventPayload

func (*ServiceOrderInformationRequiredEventPayload) ContextValidate 

func (m *ServiceOrderInformationRequiredEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order information required event payload based on the context it is used

func (*ServiceOrderInformationRequiredEventPayload) MarshalBinary 

func (m *ServiceOrderInformationRequiredEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderInformationRequiredEventPayload) UnmarshalBinary 

func (m *ServiceOrderInformationRequiredEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderInformationRequiredEventPayload) Validate 

func (m *ServiceOrderInformationRequiredEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order information required event payload

type ServiceOrderItem 

type ServiceOrderItem struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// The action to be carried out on the Service. Can be: add, modify, delete, noChange
	// Required: true
	Action *OrderItemActionType `json:"action"`

	// An appointment that was set up with a related party for this order item
	Appointment *AppointmentRef `json:"appointment,omitempty"`

	// the error(s) cause an order item status change
	ErrorMessage []*ServiceOrderItemErrorMessage `json:"errorMessage"`

	// Identifier of the individual line item
	// Required: true
	ID *string `json:"id"`

	// A list of modification items provided for the service update when serviceOrderItem action is modify
	ModifyPath []*JSONPatch `json:"modifyPath"`

	// Quantity ordered
	Quantity int64 `json:"quantity,omitempty"`

	// The Service to be acted on by the order item
	// Required: true
	Service *ServiceRefOrValue `json:"service"`

	// A list of order items embedded to this order item
	ServiceOrderItem []*ServiceOrderItem `json:"serviceOrderItem"`

	// A list of order items related to this order item
	ServiceOrderItemRelationship []*ServiceOrderItemRelationship `json:"serviceOrderItemRelationship"`

	// State of the order item: described in the state machine diagram. This is the requested state.
	State ServiceOrderItemStateType `json:"state,omitempty"`
}

ServiceOrderItem service order item

swagger:model ServiceOrderItem

func (*ServiceOrderItem) ContextValidate 

func (m *ServiceOrderItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order item based on the context it is used

func (*ServiceOrderItem) MarshalBinary 

func (m *ServiceOrderItem) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderItem) UnmarshalBinary 

func (m *ServiceOrderItem) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderItem) Validate 

func (m *ServiceOrderItem) Validate(formats strfmt.Registry) error

Validate validates this service order item

type ServiceOrderItemErrorMessage 

type ServiceOrderItemErrorMessage struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// error code
	Code int64 `json:"code,omitempty"`

	// More details and corrective actions related to the error
	Message string `json:"message,omitempty"`

	// Explanation of the reason for the error
	Reason string `json:"reason,omitempty"`

	// URI of documentation describing the error
	// Format: uri
	ReferenceError strfmt.URI `json:"referenceError,omitempty"`

	// error code extension like sys-ABC-2001
	Status string `json:"status,omitempty"`

	// Date when the error happened
	// Format: date-time
	Timestamp strfmt.DateTime `json:"timestamp,omitempty"`
}

ServiceOrderItemErrorMessage AServiceOrderItemErrorMessage represents an error that causes a status change in a service order item.

swagger:model ServiceOrderItemErrorMessage

func (*ServiceOrderItemErrorMessage) ContextValidate 

func (m *ServiceOrderItemErrorMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order item error message based on context it is used

func (*ServiceOrderItemErrorMessage) MarshalBinary 

func (m *ServiceOrderItemErrorMessage) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderItemErrorMessage) UnmarshalBinary 

func (m *ServiceOrderItemErrorMessage) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderItemErrorMessage) Validate 

func (m *ServiceOrderItemErrorMessage) Validate(formats strfmt.Registry) error

Validate validates this service order item error message

type ServiceOrderItemRef 

type ServiceOrderItemRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Identifier of the line item
	ItemID string `json:"itemId,omitempty"`

	// Link to the order to which this item belongs to
	// Format: uri
	ServiceOrderHref strfmt.URI `json:"serviceOrderHref,omitempty"`

	// Identifier of the order that this item belongs to
	ServiceOrderID string `json:"serviceOrderId,omitempty"`
}

ServiceOrderItemRef service order item ref

swagger:model ServiceOrderItemRef

func (*ServiceOrderItemRef) ContextValidate 

func (m *ServiceOrderItemRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order item ref based on context it is used

func (*ServiceOrderItemRef) MarshalBinary 

func (m *ServiceOrderItemRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderItemRef) UnmarshalBinary 

func (m *ServiceOrderItemRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderItemRef) Validate 

func (m *ServiceOrderItemRef) Validate(formats strfmt.Registry) error

Validate validates this service order item ref

type ServiceOrderItemRelationship 

type ServiceOrderItemRelationship struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// A service order item in relationship with this order item
	OrderItem *ServiceOrderItemRef `json:"orderItem,omitempty"`

	// The type of related order item, can be: dependency if the order item needs to be not started until another order item is complete
	RelationshipType string `json:"relationshipType,omitempty"`
}

ServiceOrderItemRelationship Linked service order item to the one containing this attribute

swagger:model ServiceOrderItemRelationship

func (*ServiceOrderItemRelationship) ContextValidate 

func (m *ServiceOrderItemRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order item relationship based on the context it is used

func (*ServiceOrderItemRelationship) MarshalBinary 

func (m *ServiceOrderItemRelationship) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderItemRelationship) UnmarshalBinary 

func (m *ServiceOrderItemRelationship) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderItemRelationship) Validate 

func (m *ServiceOrderItemRelationship) Validate(formats strfmt.Registry) error

Validate validates this service order item relationship

type ServiceOrderItemStateType 

type ServiceOrderItemStateType string

ServiceOrderItemStateType Possible values for the state of the order item

swagger:model ServiceOrderItemStateType 

const (

	// ServiceOrderItemStateTypeAcknowledged captures enum value "acknowledged"
	ServiceOrderItemStateTypeAcknowledged ServiceOrderItemStateType = "acknowledged"

	// ServiceOrderItemStateTypeRejected captures enum value "rejected"
	ServiceOrderItemStateTypeRejected ServiceOrderItemStateType = "rejected"

	// ServiceOrderItemStateTypePending captures enum value "pending"
	ServiceOrderItemStateTypePending ServiceOrderItemStateType = "pending"

	// ServiceOrderItemStateTypeHeld captures enum value "held"
	ServiceOrderItemStateTypeHeld ServiceOrderItemStateType = "held"

	// ServiceOrderItemStateTypeInProgress captures enum value "inProgress"
	ServiceOrderItemStateTypeInProgress ServiceOrderItemStateType = "inProgress"

	// ServiceOrderItemStateTypeCancelled captures enum value "cancelled"
	ServiceOrderItemStateTypeCancelled ServiceOrderItemStateType = "cancelled"

	// ServiceOrderItemStateTypeCompleted captures enum value "completed"
	ServiceOrderItemStateTypeCompleted ServiceOrderItemStateType = "completed"

	// ServiceOrderItemStateTypeFailed captures enum value "failed"
	ServiceOrderItemStateTypeFailed ServiceOrderItemStateType = "failed"

	// ServiceOrderItemStateTypeAssessingCancellation captures enum value "assessingCancellation"
	ServiceOrderItemStateTypeAssessingCancellation ServiceOrderItemStateType = "assessingCancellation"

	// ServiceOrderItemStateTypePendingCancellation captures enum value "pendingCancellation"
	ServiceOrderItemStateTypePendingCancellation ServiceOrderItemStateType = "pendingCancellation"

	// ServiceOrderItemStateTypePartial captures enum value "partial"
	ServiceOrderItemStateTypePartial ServiceOrderItemStateType = "partial"
)

func NewServiceOrderItemStateType 

func NewServiceOrderItemStateType(value ServiceOrderItemStateType) *ServiceOrderItemStateType

func (ServiceOrderItemStateType) ContextValidate 

func (m ServiceOrderItemStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order item state type based on context it is used

func (ServiceOrderItemStateType) Pointer 

func (m ServiceOrderItemStateType) Pointer() *ServiceOrderItemStateType

Pointer returns a pointer to a freshly-allocated ServiceOrderItemStateType.

func (ServiceOrderItemStateType) Validate 

func (m ServiceOrderItemStateType) Validate(formats strfmt.Registry) error

Validate validates this service order item state type

type ServiceOrderJeopardyAlert 

type ServiceOrderJeopardyAlert struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// A date time( DateTime). The date that the alert issued
	// Format: date-time
	AlertDate strfmt.DateTime `json:"alertDate,omitempty"`

	//  The exception associated with this jeopardy alert
	Exception string `json:"exception,omitempty"`

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

	// A string represents the type of jeopardy/risk like Normal, Hazard, Critical, ...
	JeopardyType string `json:"jeopardyType,omitempty"`

	// A string represents the message of the alert
	Message string `json:"message,omitempty"`

	// A string used to give a name to the jeopardy alert
	Name string `json:"name,omitempty"`

	// A list of order items corresponded to this alert
	ServiceOrderItem []*ServiceOrderItemRef `json:"serviceOrderItem"`
}

ServiceOrderJeopardyAlert A ServiceOrderJeopardyAlert represents a predicted exception during a service order processing that would brings risk to complete successfully the ordetr.

swagger:model ServiceOrderJeopardyAlert

func (*ServiceOrderJeopardyAlert) ContextValidate 

func (m *ServiceOrderJeopardyAlert) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order jeopardy alert based on the context it is used

func (*ServiceOrderJeopardyAlert) MarshalBinary 

func (m *ServiceOrderJeopardyAlert) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderJeopardyAlert) UnmarshalBinary 

func (m *ServiceOrderJeopardyAlert) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderJeopardyAlert) Validate 

func (m *ServiceOrderJeopardyAlert) Validate(formats strfmt.Registry) error

Validate validates this service order jeopardy alert

type ServiceOrderJeopardyEvent 

type ServiceOrderJeopardyEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderJeopardyEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderJeopardyEvent The notification data structure

swagger:model ServiceOrderJeopardyEvent

func (*ServiceOrderJeopardyEvent) ContextValidate 

func (m *ServiceOrderJeopardyEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order jeopardy event based on the context it is used

func (*ServiceOrderJeopardyEvent) MarshalBinary 

func (m *ServiceOrderJeopardyEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderJeopardyEvent) UnmarshalBinary 

func (m *ServiceOrderJeopardyEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderJeopardyEvent) Validate 

func (m *ServiceOrderJeopardyEvent) Validate(formats strfmt.Registry) error

Validate validates this service order jeopardy event

type ServiceOrderJeopardyEventPayload 

type ServiceOrderJeopardyEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderJeopardyEventPayload The event data structure

swagger:model ServiceOrderJeopardyEventPayload

func (*ServiceOrderJeopardyEventPayload) ContextValidate 

func (m *ServiceOrderJeopardyEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order jeopardy event payload based on the context it is used

func (*ServiceOrderJeopardyEventPayload) MarshalBinary 

func (m *ServiceOrderJeopardyEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderJeopardyEventPayload) UnmarshalBinary 

func (m *ServiceOrderJeopardyEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderJeopardyEventPayload) Validate 

func (m *ServiceOrderJeopardyEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order jeopardy event payload

type ServiceOrderMilestone 

type ServiceOrderMilestone struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// free-text description of the Milestone
	Description string `json:"description,omitempty"`

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

	// A string represents the message of the milestone
	Message string `json:"message,omitempty"`

	// A date time( DateTime). The date that the milestone happens
	// Format: date-time
	MilestoneDate strfmt.DateTime `json:"milestoneDate,omitempty"`

	// A string used to give a name to the milestone
	Name string `json:"name,omitempty"`

	// A list of order items corresponded to this milestone
	ServiceOrderItem []*ServiceOrderItemRef `json:"serviceOrderItem"`

	// The milestone status
	Status string `json:"status,omitempty"`
}

ServiceOrderMilestone ServiceOrderMilestone represents an action or event marking a significant change or stage in processing of a service order.

swagger:model ServiceOrderMilestone

func (*ServiceOrderMilestone) ContextValidate 

func (m *ServiceOrderMilestone) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order milestone based on the context it is used

func (*ServiceOrderMilestone) MarshalBinary 

func (m *ServiceOrderMilestone) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderMilestone) UnmarshalBinary 

func (m *ServiceOrderMilestone) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderMilestone) Validate 

func (m *ServiceOrderMilestone) Validate(formats strfmt.Registry) error

Validate validates this service order milestone

type ServiceOrderMilestoneEvent 

type ServiceOrderMilestoneEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderMilestoneEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderMilestoneEvent The notification data structure

swagger:model ServiceOrderMilestoneEvent

func (*ServiceOrderMilestoneEvent) ContextValidate 

func (m *ServiceOrderMilestoneEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order milestone event based on the context it is used

func (*ServiceOrderMilestoneEvent) MarshalBinary 

func (m *ServiceOrderMilestoneEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderMilestoneEvent) UnmarshalBinary 

func (m *ServiceOrderMilestoneEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderMilestoneEvent) Validate 

func (m *ServiceOrderMilestoneEvent) Validate(formats strfmt.Registry) error

Validate validates this service order milestone event

type ServiceOrderMilestoneEventPayload 

type ServiceOrderMilestoneEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderMilestoneEventPayload The event data structure

swagger:model ServiceOrderMilestoneEventPayload

func (*ServiceOrderMilestoneEventPayload) ContextValidate 

func (m *ServiceOrderMilestoneEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order milestone event payload based on the context it is used

func (*ServiceOrderMilestoneEventPayload) MarshalBinary 

func (m *ServiceOrderMilestoneEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderMilestoneEventPayload) UnmarshalBinary 

func (m *ServiceOrderMilestoneEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderMilestoneEventPayload) Validate 

func (m *ServiceOrderMilestoneEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order milestone event payload

type ServiceOrderRef 

type ServiceOrderRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related service order
	Name string `json:"name,omitempty"`
}

ServiceOrderRef Service Order reference. Useful to understand the which was the Service order through which the service was instantiated in the service inventory

swagger:model ServiceOrderRef

func (*ServiceOrderRef) ContextValidate 

func (m *ServiceOrderRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order ref based on context it is used

func (*ServiceOrderRef) MarshalBinary 

func (m *ServiceOrderRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderRef) UnmarshalBinary 

func (m *ServiceOrderRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderRef) Validate 

func (m *ServiceOrderRef) Validate(formats strfmt.Registry) error

Validate validates this service order ref

type ServiceOrderRelationship 

type ServiceOrderRelationship struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The entity type of the related order
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// A hyperlink to the related order
	Href string `json:"href,omitempty"`

	// The id of the related order
	// Required: true
	ID *string `json:"id"`

	// The type of related order, such as: [dependency] if the order needs to be [not started] until another order item is complete (a service order in this case) or [cross-ref] to keep track of the source order (a productOrder)
	// Required: true
	RelationshipType *string `json:"relationshipType"`
}

ServiceOrderRelationship Linked service order to the one containing this attribute

swagger:model ServiceOrderRelationship

func (*ServiceOrderRelationship) ContextValidate 

func (m *ServiceOrderRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order relationship based on context it is used

func (*ServiceOrderRelationship) MarshalBinary 

func (m *ServiceOrderRelationship) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderRelationship) UnmarshalBinary 

func (m *ServiceOrderRelationship) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderRelationship) Validate 

func (m *ServiceOrderRelationship) Validate(formats strfmt.Registry) error

Validate validates this service order relationship

type ServiceOrderStateChangeEvent 

type ServiceOrderStateChangeEvent struct {

	// The correlation id for this event.
	CorrelationID string `json:"correlationId,omitempty"`

	// An explnatory of the event.
	Description string `json:"description,omitempty"`

	// The domain of the event.
	Domain string `json:"domain,omitempty"`

	// The event payload linked to the involved resource object
	Event *ServiceOrderStateChangeEventPayload `json:"event,omitempty"`

	// The identifier of the notification.
	EventID string `json:"eventId,omitempty"`

	// Time of the event occurrence.
	// Format: date-time
	EventTime strfmt.DateTime `json:"eventTime,omitempty"`

	// The type of the notification.
	EventType string `json:"eventType,omitempty"`

	// A priority.
	Priority string `json:"priority,omitempty"`

	// The time the event occured.
	// Format: date-time
	TimeOcurred strfmt.DateTime `json:"timeOcurred,omitempty"`

	// The title of the event.
	Title string `json:"title,omitempty"`
}

ServiceOrderStateChangeEvent The notification data structure

swagger:model ServiceOrderStateChangeEvent

func (*ServiceOrderStateChangeEvent) ContextValidate 

func (m *ServiceOrderStateChangeEvent) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order state change event based on the context it is used

func (*ServiceOrderStateChangeEvent) MarshalBinary 

func (m *ServiceOrderStateChangeEvent) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderStateChangeEvent) UnmarshalBinary 

func (m *ServiceOrderStateChangeEvent) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderStateChangeEvent) Validate 

func (m *ServiceOrderStateChangeEvent) Validate(formats strfmt.Registry) error

Validate validates this service order state change event

type ServiceOrderStateChangeEventPayload 

type ServiceOrderStateChangeEventPayload struct {

	// The involved resource data for the event
	ServiceOrder *ServiceOrder `json:"serviceOrder,omitempty"`
}

ServiceOrderStateChangeEventPayload The event data structure

swagger:model ServiceOrderStateChangeEventPayload

func (*ServiceOrderStateChangeEventPayload) ContextValidate 

func (m *ServiceOrderStateChangeEventPayload) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order state change event payload based on the context it is used

func (*ServiceOrderStateChangeEventPayload) MarshalBinary 

func (m *ServiceOrderStateChangeEventPayload) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderStateChangeEventPayload) UnmarshalBinary 

func (m *ServiceOrderStateChangeEventPayload) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderStateChangeEventPayload) Validate 

func (m *ServiceOrderStateChangeEventPayload) Validate(formats strfmt.Registry) error

Validate validates this service order state change event payload

type ServiceOrderStateType 

type ServiceOrderStateType string

ServiceOrderStateType Possible values for the state of the order

swagger:model ServiceOrderStateType 

const (

	// ServiceOrderStateTypeAcknowledged captures enum value "acknowledged"
	ServiceOrderStateTypeAcknowledged ServiceOrderStateType = "acknowledged"

	// ServiceOrderStateTypeRejected captures enum value "rejected"
	ServiceOrderStateTypeRejected ServiceOrderStateType = "rejected"

	// ServiceOrderStateTypePending captures enum value "pending"
	ServiceOrderStateTypePending ServiceOrderStateType = "pending"

	// ServiceOrderStateTypeHeld captures enum value "held"
	ServiceOrderStateTypeHeld ServiceOrderStateType = "held"

	// ServiceOrderStateTypeInProgress captures enum value "inProgress"
	ServiceOrderStateTypeInProgress ServiceOrderStateType = "inProgress"

	// ServiceOrderStateTypeCancelled captures enum value "cancelled"
	ServiceOrderStateTypeCancelled ServiceOrderStateType = "cancelled"

	// ServiceOrderStateTypeCompleted captures enum value "completed"
	ServiceOrderStateTypeCompleted ServiceOrderStateType = "completed"

	// ServiceOrderStateTypeFailed captures enum value "failed"
	ServiceOrderStateTypeFailed ServiceOrderStateType = "failed"

	// ServiceOrderStateTypePartial captures enum value "partial"
	ServiceOrderStateTypePartial ServiceOrderStateType = "partial"

	// ServiceOrderStateTypeAssessingCancellation captures enum value "assessingCancellation"
	ServiceOrderStateTypeAssessingCancellation ServiceOrderStateType = "assessingCancellation"

	// ServiceOrderStateTypePendingCancellation captures enum value "pendingCancellation"
	ServiceOrderStateTypePendingCancellation ServiceOrderStateType = "pendingCancellation"
)

func NewServiceOrderStateType 

func NewServiceOrderStateType(value ServiceOrderStateType) *ServiceOrderStateType

func (ServiceOrderStateType) ContextValidate 

func (m ServiceOrderStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service order state type based on context it is used

func (ServiceOrderStateType) Pointer 

func (m ServiceOrderStateType) Pointer() *ServiceOrderStateType

Pointer returns a pointer to a freshly-allocated ServiceOrderStateType.

func (ServiceOrderStateType) Validate 

func (m ServiceOrderStateType) Validate(formats strfmt.Registry) error

Validate validates this service order state type

type ServiceOrderUpdate 

type ServiceOrderUpdate struct {

	// A free-text description of the service order
	Description string `json:"description,omitempty"`

	// Expected delivery date amended by the provider
	// Format: date-time
	ExpectedCompletionDate strfmt.DateTime `json:"expectedCompletionDate,omitempty"`

	// ID given by the consumer to facilitate searches
	ExternalID string `json:"externalId,omitempty"`

	// external reference
	ExternalReference []*ExternalReference `json:"externalReference"`

	// Extra-information about the order; e.g. useful to add extra delivery information that could be useful for a human process
	Note []*Note `json:"note"`

	// Contact attached to the order to send back information regarding this order
	NotificationContact string `json:"notificationContact,omitempty"`

	// A list of service orders related to this order (e.g. prerequisite, dependent on)
	OrderRelationship []*ServiceOrderRelationship `json:"orderRelationship"`

	// Can be used by consumers to prioritize orders in a Service Order Management system
	Priority string `json:"priority,omitempty"`

	// A list of parties which are involved in this order and the role they are playing
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// Requested delivery date from the requestors perspective
	// Format: date-time
	RequestedCompletionDate strfmt.DateTime `json:"requestedCompletionDate,omitempty"`

	// Order start date wished by the requestor
	// Format: date-time
	RequestedStartDate strfmt.DateTime `json:"requestedStartDate,omitempty"`

	// A list of service order items to be processed by this order
	ServiceOrderItem []*ServiceOrderItem `json:"serviceOrderItem"`

	// State of the order: described in the state-machine diagram
	State ServiceOrderStateType `json:"state,omitempty"`
}

ServiceOrderUpdate Skipped properties: id,href,orderDate,jeopardyAlert,errorMessage,milestone,@baseType,@schemaLocation,@type,cancellationDate,cancellationReason,category,completionDate,startDate

swagger:model ServiceOrder_Update

func (*ServiceOrderUpdate) ContextValidate 

func (m *ServiceOrderUpdate) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service order update based on the context it is used

func (*ServiceOrderUpdate) MarshalBinary 

func (m *ServiceOrderUpdate) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceOrderUpdate) UnmarshalBinary 

func (m *ServiceOrderUpdate) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceOrderUpdate) Validate 

func (m *ServiceOrderUpdate) Validate(formats strfmt.Registry) error

Validate validates this service order update

type ServiceRef 

type ServiceRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`
}

ServiceRef Service reference, for when Service is used by other entities

swagger:model ServiceRef

func (*ServiceRef) ContextValidate 

func (m *ServiceRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service ref based on context it is used

func (*ServiceRef) MarshalBinary 

func (m *ServiceRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceRef) UnmarshalBinary 

func (m *ServiceRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceRef) Validate 

func (m *ServiceRef) Validate(formats strfmt.Registry) error

Validate validates this service ref

type ServiceRefOrValue 

type ServiceRefOrValue struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Is it a customer facing or resource facing service
	Category string `json:"category,omitempty"`

	// Free-text description of the service
	Description string `json:"description,omitempty"`

	// Date when the service ends
	// Format: date-time
	EndDate strfmt.DateTime `json:"endDate,omitempty"`

	// A list of external identifiers assoicated with this service
	ExternalIdentifier []*ExternalIdentifier `json:"externalIdentifier"`

	// A list of feature associated with this service
	Feature []*Feature `json:"feature"`

	// If TRUE, this Service has already been started
	HasStarted bool `json:"hasStarted,omitempty"`

	// Reference of the service
	Href string `json:"href,omitempty"`

	// Unique identifier of the service
	ID string `json:"id,omitempty"`

	// If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
	IsBundle bool `json:"isBundle,omitempty"`

	// If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
	IsServiceEnabled bool `json:"isServiceEnabled,omitempty"`

	// If TRUE, this Service can be changed without affecting any other services
	IsStateful bool `json:"isStateful,omitempty"`

	// Name of the service
	Name string `json:"name,omitempty"`

	// A list of notes made on this service
	Note []*Note `json:"note"`

	// Indicates how a service is currently performing or operating. It is a logical representation of the service operating behaviour and is determined/managed by the service provider.
	OperatingStatus ServiceOperatingStatusType `json:"operatingStatus,omitempty"`

	// Additional information describing the context of operatingStatus and is determined/managed by the service provider.
	OperatingStatusContextUpdate *ContextUpdate `json:"operatingStatusContextUpdate,omitempty"`

	// A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
	Place []*RelatedPlaceRefOrValue `json:"place"`

	// A list of related  entity in relationship with this service
	RelatedEntity []*RelatedEntityRefOrValue `json:"relatedEntity"`

	// A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
	RelatedParty []*RelatedParty `json:"relatedParty"`

	// A list of characteristics that characterize this service (ServiceCharacteristic [*])
	ServiceCharacteristic []*Characteristic `json:"serviceCharacteristic"`

	// Date when the service was created (whatever its status).
	ServiceDate string `json:"serviceDate,omitempty"`

	// A list of service order items related to this service
	ServiceOrderItem []*RelatedServiceOrderItem `json:"serviceOrderItem"`

	// A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
	ServiceRelationship []*ServiceRelationship `json:"serviceRelationship"`

	// The specification from which this service was instantiated
	ServiceSpecification *ServiceSpecificationRef `json:"serviceSpecification,omitempty"`

	// Business type of the service
	ServiceType string `json:"serviceType,omitempty"`

	// Date when the service starts
	// Format: date-time
	StartDate strfmt.DateTime `json:"startDate,omitempty"`

	// This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above
	StartMode string `json:"startMode,omitempty"`

	// The life cycle state of the service, such as designed, reserved, active, etc...
	State ServiceStateType `json:"state,omitempty"`

	// A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources
	SupportingResource []*ResourceRef `json:"supportingResource"`

	// A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
	SupportingService []*ServiceRefOrValue `json:"supportingService"`
}

ServiceRefOrValue A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself

swagger:model ServiceRefOrValue

func (*ServiceRefOrValue) ContextValidate 

func (m *ServiceRefOrValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service ref or value based on the context it is used

func (*ServiceRefOrValue) MarshalBinary 

func (m *ServiceRefOrValue) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceRefOrValue) UnmarshalBinary 

func (m *ServiceRefOrValue) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceRefOrValue) Validate 

func (m *ServiceRefOrValue) Validate(formats strfmt.Registry) error

Validate validates this service ref or value

type ServiceRelationship 

type ServiceRelationship struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// relationship type
	// Required: true
	RelationshipType *string `json:"relationshipType"`

	// service
	Service *ServiceRefOrValue `json:"service,omitempty"`

	// service relationship characteristic
	ServiceRelationshipCharacteristic []*Characteristic `json:"serviceRelationshipCharacteristic"`
}

ServiceRelationship service relationship

swagger:model ServiceRelationship

func (*ServiceRelationship) ContextValidate 

func (m *ServiceRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this service relationship based on the context it is used

func (*ServiceRelationship) MarshalBinary 

func (m *ServiceRelationship) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceRelationship) UnmarshalBinary 

func (m *ServiceRelationship) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceRelationship) Validate 

func (m *ServiceRelationship) Validate(formats strfmt.Registry) error

Validate validates this service relationship

type ServiceSpecificationRef 

type ServiceSpecificationRef struct {

	// When sub-classing, this defines the super-class
	AtBaseType string `json:"@baseType,omitempty"`

	// The actual type of the target instance when needed for disambiguation.
	AtReferredType string `json:"@referredType,omitempty"`

	// A URI to a JSON-Schema file that defines additional attributes and relationships
	// Format: uri
	AtSchemaLocation strfmt.URI `json:"@schemaLocation,omitempty"`

	// When sub-classing, this defines the sub-class Extensible name
	AtType string `json:"@type,omitempty"`

	// Hyperlink reference
	// Format: uri
	Href strfmt.URI `json:"href,omitempty"`

	// unique identifier
	// Required: true
	ID *string `json:"id"`

	// Name of the related entity.
	Name string `json:"name,omitempty"`

	// Service specification version
	Version string `json:"version,omitempty"`
}

ServiceSpecificationRef Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.

swagger:model ServiceSpecificationRef

func (*ServiceSpecificationRef) ContextValidate 

func (m *ServiceSpecificationRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service specification ref based on context it is used

func (*ServiceSpecificationRef) MarshalBinary 

func (m *ServiceSpecificationRef) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ServiceSpecificationRef) UnmarshalBinary 

func (m *ServiceSpecificationRef) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ServiceSpecificationRef) Validate 

func (m *ServiceSpecificationRef) Validate(formats strfmt.Registry) error

Validate validates this service specification ref

type ServiceStateType 

type ServiceStateType string

ServiceStateType Valid values for the lifecycle state of the service

swagger:model ServiceStateType 

const (

	// ServiceStateTypeFeasibilityChecked captures enum value "feasibilityChecked"
	ServiceStateTypeFeasibilityChecked ServiceStateType = "feasibilityChecked"

	// ServiceStateTypeDesigned captures enum value "designed"
	ServiceStateTypeDesigned ServiceStateType = "designed"

	// ServiceStateTypeReserved captures enum value "reserved"
	ServiceStateTypeReserved ServiceStateType = "reserved"

	// ServiceStateTypeInactive captures enum value "inactive"
	ServiceStateTypeInactive ServiceStateType = "inactive"

	// ServiceStateTypeActive captures enum value "active"
	ServiceStateTypeActive ServiceStateType = "active"

	// ServiceStateTypeSuspended captures enum value "suspended"
	ServiceStateTypeSuspended ServiceStateType = "suspended"

	// ServiceStateTypeTerminated captures enum value "terminated"
	ServiceStateTypeTerminated ServiceStateType = "terminated"
)

func NewServiceStateType 

func NewServiceStateType(value ServiceStateType) *ServiceStateType

func (ServiceStateType) ContextValidate 

func (m ServiceStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this service state type based on context it is used

func (ServiceStateType) Pointer 

func (m ServiceStateType) Pointer() *ServiceStateType

Pointer returns a pointer to a freshly-allocated ServiceStateType.

func (ServiceStateType) Validate 

func (m ServiceStateType) Validate(formats strfmt.Registry) error

Validate validates this service state type

type TaskStateType 

type TaskStateType string

TaskStateType Possible values for the state of a task

swagger:model TaskStateType 

const (

	// TaskStateTypeAccepted captures enum value "accepted"
	TaskStateTypeAccepted TaskStateType = "accepted"

	// TaskStateTypeTerminatedWithError captures enum value "terminatedWithError"
	TaskStateTypeTerminatedWithError TaskStateType = "terminatedWithError"

	// TaskStateTypeInProgress captures enum value "inProgress"
	TaskStateTypeInProgress TaskStateType = "inProgress"

	// TaskStateTypeDone captures enum value "done"
	TaskStateTypeDone TaskStateType = "done"
)

func NewTaskStateType 

func NewTaskStateType(value TaskStateType) *TaskStateType

func (TaskStateType) ContextValidate 

func (m TaskStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this task state type based on context it is used

func (TaskStateType) Pointer 

func (m TaskStateType) Pointer() *TaskStateType

Pointer returns a pointer to a freshly-allocated TaskStateType.

func (TaskStateType) Validate 

func (m TaskStateType) Validate(formats strfmt.Registry) error

Validate validates this task state type

type TimePeriod 

type TimePeriod struct {

	// End of the time period, using IETC-RFC-3339 format
	// Example: 1985-04-12T23:20:50.52Z
	// Format: date-time
	EndDateTime strfmt.DateTime `json:"endDateTime,omitempty"`

	// Start of the time period, using IETC-RFC-3339 format
	// Example: 1985-04-12T23:20:50.52Z
	// Format: date-time
	StartDateTime strfmt.DateTime `json:"startDateTime,omitempty"`
}

TimePeriod A period of time, either as a deadline (endDateTime only) a startDateTime only, or both

swagger:model TimePeriod

func (*TimePeriod) ContextValidate 

func (m *TimePeriod) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this time period based on context it is used

func (*TimePeriod) MarshalBinary 

func (m *TimePeriod) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TimePeriod) UnmarshalBinary 

func (m *TimePeriod) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TimePeriod) Validate 

func (m *TimePeriod) Validate(formats strfmt.Registry) error

Validate validates this time period

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.