models

package
v0.0.0-...-c4e9093 Latest Latest
Warning

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

 Go to latest Published: May 19, 2020 License: MIT Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type BillingAccountRef 

type BillingAccountRef struct {

	// Identifies the buyer's billing account to which the recurring and non-recurring charges for this order item will be billed.
	// If the value 'NEW' is provided it means that buyer request a new BAN.
	// Required: true
	ID *string `json:"id"`
}

BillingAccountRef An arrangement that a customer has with an enterprise that provides products to the customer.

swagger:model BillingAccountRef

func (*BillingAccountRef) MarshalBinary 

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

MarshalBinary interface implementation

func (*BillingAccountRef) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*BillingAccountRef) Validate 

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

Validate validates this billing account ref

type Describing 

type Describing struct {

	// at schema location
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// at type
	AtType string `json:"@type,omitempty"`
}

Describing describing

swagger:model Describing

func (*Describing) MarshalBinary 

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

MarshalBinary interface implementation

func (*Describing) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*Describing) Validate 

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

Validate validates this describing

type ErrorRepresentation 

type ErrorRepresentation struct {

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

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

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

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

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

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

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

ErrorRepresentation Representation of an error.

swagger:model ErrorRepresentation

func (*ErrorRepresentation) MarshalBinary 

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

MarshalBinary interface implementation

func (*ErrorRepresentation) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ErrorRepresentation) Validate 

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

Validate validates this error representation

type Event 

type Event interface {
	runtime.Validatable

	// event
	// Required: true
	Event() *ProductOrderEvent
	SetEvent(*ProductOrderEvent)

	// event Id
	// Required: true
	EventID() string
	SetEventID(string)

	// event time
	// Required: true
	// Format: date-time
	EventTime() *strfmt.DateTime
	SetEventTime(*strfmt.DateTime)

	// event type
	// Required: true
	EventType() ProductOrderEventType
	SetEventType(ProductOrderEventType)
}

Event Event class is used to describe information structure used for notification.

swagger:discriminator Event eventId

func UnmarshalEvent 

func UnmarshalEvent(reader io.Reader, consumer runtime.Consumer) (Event, error)

UnmarshalEvent unmarshals polymorphic Event

func UnmarshalEventSlice 

func UnmarshalEventSlice(reader io.Reader, consumer runtime.Consumer) ([]Event, error)

UnmarshalEventSlice unmarshals polymorphic slices of Event

type EventPlus 

type EventPlus struct {

	// field path
	// Required: true
	FieldPath []string `json:"fieldPath"`

	// resource path
	// Required: true
	ResourcePath *string `json:"resourcePath"`
	// contains filtered or unexported fields
}

EventPlus event plus

swagger:model EventPlus

func (*EventPlus) Event 

func (m *EventPlus) Event() *ProductOrderEvent

Event gets the event of this subtype

func (*EventPlus) EventID 

func (m *EventPlus) EventID() string

EventID gets the event Id of this subtype

func (*EventPlus) EventTime 

func (m *EventPlus) EventTime() *strfmt.DateTime

EventTime gets the event time of this subtype

func (*EventPlus) EventType 

func (m *EventPlus) EventType() ProductOrderEventType

EventType gets the event type of this subtype

func (*EventPlus) MarshalBinary 

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

MarshalBinary interface implementation

func (EventPlus) MarshalJSON 

func (m EventPlus) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object with a polymorphic type to a JSON structure

func (*EventPlus) SetEvent 

func (m *EventPlus) SetEvent(val *ProductOrderEvent)

SetEvent sets the event of this subtype

func (*EventPlus) SetEventID 

func (m *EventPlus) SetEventID(val string)

SetEventID sets the event Id of this subtype

func (*EventPlus) SetEventTime 

func (m *EventPlus) SetEventTime(val *strfmt.DateTime)

SetEventTime sets the event time of this subtype

func (*EventPlus) SetEventType 

func (m *EventPlus) SetEventType(val ProductOrderEventType)

SetEventType sets the event type of this subtype

func (*EventPlus) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*EventPlus) UnmarshalJSON 

func (m *EventPlus) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object with a polymorphic type from a JSON structure

func (*EventPlus) Validate 

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

Validate validates this event plus

type Note 

type Note struct {

	// The author of the note
	// Required: true
	Author *string `json:"author"`

	// The date of the note. Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00).
	// Required: true
	// Format: date-time
	Date *strfmt.DateTime `json:"date"`

	// The text of the note
	// Required: true
	Text *string `json:"text"`
}

Note A note, or set of notes, to be associated to the product order.

swagger:model Note

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 Notification 

type Notification interface{}

Notification This class is created only to gather Notification data structure. This structure must be send to the callback url provided in the HUB resource.

swagger:model Notification

type OrderItemEvent 

type OrderItemEvent struct {

	// Target a description file of productOrder extension
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Type of productOrder
	AtType string `json:"@type,omitempty"`

	// action
	// Required: true
	Action ProductActionType `json:"action"`

	// billing account
	BillingAccount *BillingAccountRef `json:"billingAccount,omitempty"`

	// Identifier of the line item (generally it is a sequence number 01, 02, 03, ...)
	// Required: true
	ID *string `json:"id"`

	// product
	Product *ProductEvent `json:"product,omitempty"`

	// state
	// Required: true
	State ProductOrderItemStateType `json:"state"`
}

OrderItemEvent order item event

swagger:model OrderItemEvent

func (*OrderItemEvent) MarshalBinary 

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

MarshalBinary interface implementation

func (*OrderItemEvent) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*OrderItemEvent) Validate 

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

Validate validates this order item event

type OrderMessage 

type OrderMessage struct {

	// The code associated with the Message
	Code string `json:"code,omitempty"`

	// Indicates whether the Buyer must submit an updated Order to resolve the Error/Jeopardy condition.
	CorrectionRequired bool `json:"correctionRequired,omitempty"`

	// The field/attribute on the Order associated with message
	Field string `json:"field,omitempty"`

	// A description of the error condition or information to be conveyed to the Buyer
	// Required: true
	MessageInformation *string `json:"messageInformation"`

	// severity
	// Required: true
	Severity Severity `json:"severity"`
}

OrderMessage An optional array of messages associated with the Order

swagger:model OrderMessage

func (*OrderMessage) MarshalBinary 

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

MarshalBinary interface implementation

func (*OrderMessage) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*OrderMessage) Validate 

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

Validate validates this order message

type ProductActionType 

type ProductActionType string

ProductActionType An enumeration of valid order item actions

swagger:model ProductActionType 

const (

	// ProductActionTypeAdd captures enum value "add"
	ProductActionTypeAdd ProductActionType = "add"

	// ProductActionTypeChange captures enum value "change"
	ProductActionTypeChange ProductActionType = "change"

	// ProductActionTypeRemove captures enum value "remove"
	ProductActionTypeRemove ProductActionType = "remove"

	// ProductActionTypeNoChange captures enum value "noChange"
	ProductActionTypeNoChange ProductActionType = "noChange"
)

func (ProductActionType) Validate 

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

Validate validates this product action type

type ProductEvent 

type ProductEvent struct {

	// Buyer product Id - informative information
	BuyerProductID string `json:"buyerProductId,omitempty"`

	// Unique (within the product domain) identifier for the product that is generated by the seller when the product is instantiated.
	ID string `json:"id,omitempty"`

	// product specification
	ProductSpecification *ProductSpecification `json:"productSpecification,omitempty"`

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

ProductEvent Product structure used for notification

swagger:model ProductEvent

func (*ProductEvent) MarshalBinary 

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

MarshalBinary interface implementation

func (*ProductEvent) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProductEvent) Validate 

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

Validate validates this product event

type ProductOrderEvent 

type ProductOrderEvent struct {

	// at base type
	AtBaseType string `json:"@baseType,omitempty"`

	// at schema location
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// at type
	AtType string `json:"@type,omitempty"`

	// The date the order is completed. Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00)
	// Format: date-time
	CompletionDate strfmt.DateTime `json:"completionDate,omitempty"`

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

	// A number that uniquely identifies an order within the buyer's enterprise.
	// Required: true
	ExternalID *string `json:"externalId"`

	// Unique (within the ordering domain) identifier for the order that is generated by the seller when the order is initially accepted.
	// Required: true
	ID *string `json:"id"`

	// note
	Note []*Note `json:"note"`

	// order item
	// Required: true
	OrderItem []*OrderItemEvent `json:"orderItem"`

	// order message
	OrderMessage []*OrderMessage `json:"orderMessage"`

	// The version number that the Buyer uses to refer to this particular version of the order
	// Required: true
	OrderVersion *string `json:"orderVersion"`

	// An identifier that is used to group Orders that represent a unit of functionality that is important to a Buyer.  A Project can be used to relate multiple Orders together.
	ProjectID string `json:"projectId,omitempty"`

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

	// Identifies the buyer's desired due date (requested delivery date). Cannot be requested on cancelled orders.  Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00).
	// Required: true
	// Format: date-time
	RequestedCompletionDate *strfmt.DateTime `json:"requestedCompletionDate"`

	// The buyer's requested date that order processing should start. Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00).
	// Format: date-time
	RequestedStartDate strfmt.DateTime `json:"requestedStartDate,omitempty"`

	// state
	// Required: true
	State ProductOrderStateType `json:"state"`
}

ProductOrderEvent ProductOrder structure used for notification

swagger:model ProductOrderEvent

func (*ProductOrderEvent) MarshalBinary 

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

MarshalBinary interface implementation

func (*ProductOrderEvent) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProductOrderEvent) Validate 

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

Validate validates this product order event

type ProductOrderEventType 

type ProductOrderEventType string

ProductOrderEventType Product Order event type

swagger:model ProductOrderEventType 

const (

	// ProductOrderEventTypeProductOrderCreationNotification captures enum value "productOrderCreationNotification"
	ProductOrderEventTypeProductOrderCreationNotification ProductOrderEventType = "productOrderCreationNotification"

	// ProductOrderEventTypeProductOrderAttributeValueChangeNotification captures enum value "productOrderAttributeValueChangeNotification"
	ProductOrderEventTypeProductOrderAttributeValueChangeNotification ProductOrderEventType = "productOrderAttributeValueChangeNotification"

	// ProductOrderEventTypeProductOrderStateChangeNotification captures enum value "productOrderStateChangeNotification"
	ProductOrderEventTypeProductOrderStateChangeNotification ProductOrderEventType = "productOrderStateChangeNotification"

	// ProductOrderEventTypeProductOrderInformationRequiredNotification captures enum value "productOrderInformationRequiredNotification"
	ProductOrderEventTypeProductOrderInformationRequiredNotification ProductOrderEventType = "productOrderInformationRequiredNotification"
)

func (ProductOrderEventType) Validate 

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

Validate validates this product order event type

type ProductOrderItemStateType 

type ProductOrderItemStateType string

ProductOrderItemStateType An enumeration of valid order item states.

swagger:model ProductOrderItemStateType 

const (

	// ProductOrderItemStateTypeAcknowledged captures enum value "acknowledged"
	ProductOrderItemStateTypeAcknowledged ProductOrderItemStateType = "acknowledged"

	// ProductOrderItemStateTypeRejected captures enum value "rejected"
	ProductOrderItemStateTypeRejected ProductOrderItemStateType = "rejected"

	// ProductOrderItemStateTypeInProgress captures enum value "inProgress"
	ProductOrderItemStateTypeInProgress ProductOrderItemStateType = "inProgress"

	// ProductOrderItemStateTypePending captures enum value "pending"
	ProductOrderItemStateTypePending ProductOrderItemStateType = "pending"

	// ProductOrderItemStateTypeHeld captures enum value "held"
	ProductOrderItemStateTypeHeld ProductOrderItemStateType = "held"

	// ProductOrderItemStateTypeAssessingCancellation captures enum value "assessingCancellation"
	ProductOrderItemStateTypeAssessingCancellation ProductOrderItemStateType = "assessingCancellation"

	// ProductOrderItemStateTypePendingCancellation captures enum value "pendingCancellation"
	ProductOrderItemStateTypePendingCancellation ProductOrderItemStateType = "pendingCancellation"

	// ProductOrderItemStateTypeCancelled captures enum value "cancelled"
	ProductOrderItemStateTypeCancelled ProductOrderItemStateType = "cancelled"

	// ProductOrderItemStateTypeInProgressConfigured captures enum value "inProgress.configured"
	ProductOrderItemStateTypeInProgressConfigured ProductOrderItemStateType = "inProgress.configured"

	// ProductOrderItemStateTypeFailed captures enum value "failed"
	ProductOrderItemStateTypeFailed ProductOrderItemStateType = "failed"

	// ProductOrderItemStateTypeCompleted captures enum value "completed"
	ProductOrderItemStateTypeCompleted ProductOrderItemStateType = "completed"
)

func (ProductOrderItemStateType) Validate 

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

Validate validates this product order item state type

type ProductOrderStateType 

type ProductOrderStateType string

ProductOrderStateType An enumeration of valid order states

swagger:model ProductOrderStateType 

const (

	// ProductOrderStateTypeCompleted captures enum value "completed"
	ProductOrderStateTypeCompleted ProductOrderStateType = "completed"

	// ProductOrderStateTypePartial captures enum value "partial"
	ProductOrderStateTypePartial ProductOrderStateType = "partial"

	// ProductOrderStateTypeFailed captures enum value "failed"
	ProductOrderStateTypeFailed ProductOrderStateType = "failed"

	// ProductOrderStateTypeInProgressJeopardy captures enum value "inProgress.jeopardy"
	ProductOrderStateTypeInProgressJeopardy ProductOrderStateType = "inProgress.jeopardy"

	// ProductOrderStateTypeInProgressConfirmed captures enum value "inProgress.confirmed"
	ProductOrderStateTypeInProgressConfirmed ProductOrderStateType = "inProgress.confirmed"

	// ProductOrderStateTypeInProgressConfigured captures enum value "inProgress.configured"
	ProductOrderStateTypeInProgressConfigured ProductOrderStateType = "inProgress.configured"

	// ProductOrderStateTypeCancelled captures enum value "cancelled"
	ProductOrderStateTypeCancelled ProductOrderStateType = "cancelled"

	// ProductOrderStateTypePendingCancellation captures enum value "pendingCancellation"
	ProductOrderStateTypePendingCancellation ProductOrderStateType = "pendingCancellation"

	// ProductOrderStateTypeAssessingCancellation captures enum value "assessingCancellation"
	ProductOrderStateTypeAssessingCancellation ProductOrderStateType = "assessingCancellation"

	// ProductOrderStateTypeHeld captures enum value "held"
	ProductOrderStateTypeHeld ProductOrderStateType = "held"

	// ProductOrderStateTypePending captures enum value "pending"
	ProductOrderStateTypePending ProductOrderStateType = "pending"

	// ProductOrderStateTypeInProgress captures enum value "inProgress"
	ProductOrderStateTypeInProgress ProductOrderStateType = "inProgress"

	// ProductOrderStateTypeRejected captures enum value "rejected"
	ProductOrderStateTypeRejected ProductOrderStateType = "rejected"

	// ProductOrderStateTypeAcknowledged captures enum value "acknowledged"
	ProductOrderStateTypeAcknowledged ProductOrderStateType = "acknowledged"
)

func (ProductOrderStateType) Validate 

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

Validate validates this product order state type

type ProductSpecification 

type ProductSpecification struct {

	// describing
	Describing *Describing `json:"describing,omitempty"`

	// A unique identifier for the product spec, within the product spec domain. It is assigned by the seller and communicated to the buyer at on-boarding time.
	ID string `json:"id,omitempty"`
}

ProductSpecification A ProductSpec describes the invariant properties (i.e., features) that a given set of Products MAY have. These properties provide the information needed to plan, construct, allocate, and/or retire the Services and Resources from the operator environment needed to deliver the Product

swagger:model ProductSpecification

func (*ProductSpecification) MarshalBinary 

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

MarshalBinary interface implementation

func (*ProductSpecification) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*ProductSpecification) Validate 

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

Validate validates this product specification

type RelatedParty 

type RelatedParty struct {

	// at referred type
	AtReferredType string `json:"@referredType,omitempty"`

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

	// Reference link to the party
	Href string `json:"href,omitempty"`

	// An identifier of the related party. For the "buyer" and "seller" id, this is a  Carrier ID number provided by local regulatory entity.  Unique in the local jurisdiction.
	// Required: true
	ID *string `json:"id"`

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

	// The telephone number of the related party.
	// Required: true
	Number *string `json:"number"`

	// MEF Extension
	NumberExtension string `json:"numberExtension,omitempty"`

	// MEF: could be "Buyer", "Seller", "Billing Contact", "Order Contact", "Implementation Contact", "Technical Contact", "UNI Site Contact", "UNI Alt Site Contact", "ENNI Site Contact", "ENNI Alt Site Contact"
	// Required: true
	Role *string `json:"role"`
}

RelatedParty An entity or organization that is involved in the product order, such as the buyer, the seller, the order contact, etc.

swagger:model RelatedParty

func (*RelatedParty) MarshalBinary 

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

MarshalBinary interface implementation

func (*RelatedParty) UnmarshalBinary 

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

UnmarshalBinary interface implementation

func (*RelatedParty) Validate 

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

Validate validates this related party

type RelationshipType 

type RelationshipType string

RelationshipType Indicates the type of relationship between products.

swagger:model RelationshipType 

const (

	// RelationshipTypeReliesOn captures enum value "reliesOn"
	RelationshipTypeReliesOn RelationshipType = "reliesOn"

	// RelationshipTypeBundled captures enum value "bundled"
	RelationshipTypeBundled RelationshipType = "bundled"

	// RelationshipTypeComesFrom captures enum value "comesFrom"
	RelationshipTypeComesFrom RelationshipType = "comesFrom"
)

func (RelationshipType) Validate 

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

Validate validates this relationship type

type Severity 

type Severity string

Severity Severity of the order message

swagger:model Severity 

const (

	// SeverityError captures enum value "error"
	SeverityError Severity = "error"

	// SeverityInformation captures enum value "information"
	SeverityInformation Severity = "information"
)

func (Severity) Validate 

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

Validate validates this severity

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.