models

package
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Jun 20, 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 Describing

type Describing interface {
	runtime.Validatable

	// This field provided a link to the schema describing this REST resource.
	AtSchemaLocation() string
	SetAtSchemaLocation(string)

	// Indicates the (class) type of resource
	AtType() string
	SetAtType(string)
}

Describing Target to the schema describing the product spec resource (and type)

swagger:discriminator Describing @type

func UnmarshalDescribing

func UnmarshalDescribing(reader io.Reader, consumer runtime.Consumer) (Describing, error)

UnmarshalDescribing unmarshals polymorphic Describing

func UnmarshalDescribingSlice

func UnmarshalDescribingSlice(reader io.Reader, consumer runtime.Consumer) ([]Describing, error)

UnmarshalDescribingSlice unmarshals polymorphic slices of Describing

type Duration

type Duration struct {

	// duration
	// Required: true
	Duration DurationUnit `json:"duration"`

	// unit
	// Required: true
	Unit *int32 `json:"unit"`
}

Duration Duration of a term (value + unit)

swagger:model Duration

func (*Duration) MarshalBinary

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

MarshalBinary interface implementation

func (*Duration) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Duration) Validate

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

Validate validates this duration

type DurationUnit

type DurationUnit string

DurationUnit Definition of duration unit

swagger:model DurationUnit

const (

	// DurationUnitDAY captures enum value "DAY"
	DurationUnitDAY DurationUnit = "DAY"

	// DurationUnitWEEK captures enum value "WEEK"
	DurationUnitWEEK DurationUnit = "WEEK"

	// DurationUnitMONTH captures enum value "MONTH"
	DurationUnitMONTH DurationUnit = "MONTH"

	// DurationUnitYEAR captures enum value "YEAR"
	DurationUnitYEAR DurationUnit = "YEAR"
)

func (DurationUnit) Validate

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

Validate validates this duration unit

type ErrorRepresentation

type ErrorRepresentation struct {

	// Link to the schema describing the REST resource
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Type of the 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 mode 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 for example
	Status string `json:"status,omitempty"`
}

ErrorRepresentation Class used to describe API response error

swagger:model ErrorRepresentation

func (*ErrorRepresentation) MarshalBinary

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

MarshalBinary interface implementation

func (*ErrorRepresentation) UnmarshalBinary

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

UnmarshalBinary interface implementation

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() *QuoteSummaryView
	SetEvent(*QuoteSummaryView)

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

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

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

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 {

	// Path to the field which has value changed or information required
	// Required: true
	FieldPath []string `json:"fieldPath"`

	// Path to the resource (where an information is required or an attribute changed value)
	// Required: true
	ResourcePath *string `json:"resourcePath"`
	// contains filtered or unexported fields
}

EventPlus EventPlus class is used to extend information structure used for notification (adding resource & field paths)

swagger:model EventPlus

func (*EventPlus) Event

func (m *EventPlus) Event() *QuoteSummaryView

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() QuoteEventType

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 *QuoteSummaryView)

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 QuoteEventType)

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 ItemTerm

type ItemTerm struct {

	// Description of the Term
	Description string `json:"description,omitempty"`

	// duration
	// Required: true
	Duration *Duration `json:"duration"`

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

ItemTerm Used to describe a term (also know as commitment) for a quote item

swagger:model ItemTerm

func (*ItemTerm) MarshalBinary

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

MarshalBinary interface implementation

func (*ItemTerm) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ItemTerm) Validate

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

Validate validates this item term

type Money

type Money struct {

	// Currency (ISO4217 norm uses 3 letters to define the currency
	// Required: true
	Unit *string `json:"unit"`

	// A positive floating point number
	// Required: true
	Value *float32 `json:"value"`
}

Money A base / value business entity used to represent money

swagger:model Money

func (*Money) MarshalBinary

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

MarshalBinary interface implementation

func (*Money) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Money) Validate

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

Validate validates this money

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 Price

type Price struct {

	// Link to the schema describing this REST resource
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Indicates the (class) type of the price
	AtType string `json:"@type,omitempty"`

	// duty free amount
	DutyFreeAmount *Money `json:"dutyFreeAmount,omitempty"`

	// Percentage to apply only for ProdOfferPriceAlteration
	Percentage float32 `json:"percentage,omitempty"`

	// price range
	PriceRange *PriceRange `json:"priceRange,omitempty"`

	// priceVariation allows to describe a variation on the price for budgetary or indicative quote.
	// It is understood as a percentage.
	// A 25 here means that Amount provided could be +/- 25% less or more.
	PriceVariation float32 `json:"priceVariation,omitempty"`

	// tax included amount
	TaxIncludedAmount *Money `json:"taxIncludedAmount,omitempty"`

	// Tax rate
	TaxRate float32 `json:"taxRate,omitempty"`
}

Price Provides all amounts (tax included, duty free, tax rate), used Money structure for currency

swagger:model Price

func (*Price) MarshalBinary

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

MarshalBinary interface implementation

func (*Price) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Price) Validate

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

Validate validates this price

type PriceAlteration

type PriceAlteration struct {

	// Link to the schema describing this REST resource
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Indicates the (class) type of the price alteration
	AtType string `json:"@type,omitempty"`

	// Duration during which the alteration applies on the order item price (for instance 2 months free of charge for the recurring charge).
	ApplicationDuration int32 `json:"applicationDuration,omitempty"`

	// A narrative that explains in detail the semantics of this order item price alteration.
	Description string `json:"description,omitempty"`

	// A short descriptive name such as "Monthly discount".
	Name string `json:"name,omitempty"`

	// percentage
	Percentage float32 `json:"percentage,omitempty"`

	// price
	Price *Price `json:"price,omitempty"`

	// A category that describes the price such as recurring, one time and usage.
	// Required: true
	PriceType *string `json:"priceType"`

	// Priority level for applying this alteration among all the defined alterations on the order item price
	Priority int32 `json:"priority,omitempty"`

	// Could be month, week...
	RecurringChargePeriod string `json:"recurringChargePeriod,omitempty"`

	// Could be minutes, GB...
	UnitOfMeasure string `json:"unitOfMeasure,omitempty"`
}

PriceAlteration Is an amount, usually of money, that modifies the price charged for an order item

swagger:model PriceAlteration

func (*PriceAlteration) MarshalBinary

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

MarshalBinary interface implementation

func (*PriceAlteration) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PriceAlteration) Validate

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

Validate validates this price alteration

type PriceRange

type PriceRange struct {

	// max duty free amount
	MaxDutyFreeAmount *Money `json:"maxDutyFreeAmount,omitempty"`

	// max tax included amount
	MaxTaxIncludedAmount *Money `json:"maxTaxIncludedAmount,omitempty"`

	// min duty free amount
	MinDutyFreeAmount *Money `json:"minDutyFreeAmount,omitempty"`

	// min tax included amount
	MinTaxIncludedAmount *Money `json:"minTaxIncludedAmount,omitempty"`
}

PriceRange PriceRange class allows to describe a range of price (Min/Max) for budgetary or indicative quote.

swagger:model PriceRange

func (*PriceRange) MarshalBinary

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

MarshalBinary interface implementation

func (*PriceRange) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*PriceRange) Validate

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

Validate validates this price range

type Product

type Product struct {

	// Reference of the product
	// Required: true
	Href *string `json:"href"`

	// Unique identifier of the product
	// Required: true
	ID *string `json:"id"`

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

Product Configure the product characteristics (only configurable characteristics and necessary only if a non default value is selected) and/or identify the product that needs to be modified/deleted

swagger:model Product

func (*Product) MarshalBinary

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

MarshalBinary interface implementation

func (*Product) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*Product) Validate

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

Validate validates this product

type ProductOfferingRef

type ProductOfferingRef struct {

	// Indicate the class (type) of product offering.
	AtReferredType string `json:"@referredType,omitempty"`

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

	// Unique identifier of the product offering
	// Required: true
	ID *string `json:"id"`

	// Name of the product offering.
	Name string `json:"name,omitempty"`
}

ProductOfferingRef A product offering represents entities that are orderable from the provider of the catalog, this resource includes pricing information

swagger:model ProductOfferingRef

func (*ProductOfferingRef) MarshalBinary

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

MarshalBinary interface implementation

func (*ProductOfferingRef) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ProductOfferingRef) Validate

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

Validate validates this product offering ref

type ProductSpecificationRef

type ProductSpecificationRef struct {

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

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

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

	// Version of the product specification
	Version string `json:"version,omitempty"`
	// contains filtered or unexported fields
}

ProductSpecificationRef A ProductSpecification is a detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to customers or other parties playing a party role.

swagger:model ProductSpecificationRef

func (*ProductSpecificationRef) Describing

func (m *ProductSpecificationRef) Describing() Describing

Describing gets the describing of this base type

func (*ProductSpecificationRef) MarshalBinary

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

MarshalBinary interface implementation

func (ProductSpecificationRef) MarshalJSON

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

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

func (*ProductSpecificationRef) SetDescribing

func (m *ProductSpecificationRef) SetDescribing(val Describing)

SetDescribing sets the describing of this base type

func (*ProductSpecificationRef) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*ProductSpecificationRef) UnmarshalJSON

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

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

func (*ProductSpecificationRef) Validate

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

Validate validates this product specification ref

type QuoteEventType

type QuoteEventType string

QuoteEventType Type of the Event

swagger:model QuoteEventType

const (

	// QuoteEventTypeQUOTECREATIONNOTIFICATION captures enum value "QUOTE_CREATION_NOTIFICATION"
	QuoteEventTypeQUOTECREATIONNOTIFICATION QuoteEventType = "QUOTE_CREATION_NOTIFICATION"

	// QuoteEventTypeQUOTESTATECHANGENOTIFICATION captures enum value "QUOTE_STATE_CHANGE_NOTIFICATION"
	QuoteEventTypeQUOTESTATECHANGENOTIFICATION QuoteEventType = "QUOTE_STATE_CHANGE_NOTIFICATION"

	// QuoteEventTypeQUOTEINFORMATIONREQUIREDNOTIFICATION captures enum value "QUOTE_INFORMATION_REQUIRED_NOTIFICATION"
	QuoteEventTypeQUOTEINFORMATIONREQUIREDNOTIFICATION QuoteEventType = "QUOTE_INFORMATION_REQUIRED_NOTIFICATION"

	// QuoteEventTypeQUOTEATTRIBUTEVALUECHANGENOTIFICATION captures enum value "QUOTE_ATTRIBUTE_VALUE_CHANGE_NOTIFICATION"
	QuoteEventTypeQUOTEATTRIBUTEVALUECHANGENOTIFICATION QuoteEventType = "QUOTE_ATTRIBUTE_VALUE_CHANGE_NOTIFICATION"
)

func (QuoteEventType) Validate

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

Validate validates this quote event type

type QuoteItem

type QuoteItem struct {

	// Link to the schema describing this REST resource
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Indicates the base (class) type of the quote Item.
	AtType string `json:"@type,omitempty"`

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

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

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

	// product offering
	ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"`

	// quote item price
	QuoteItemPrice []*QuotePrice `json:"quoteItemPrice"`

	// quote item relationship
	QuoteItemRelationship []*QuoteItemRelationship `json:"quoteItemRelationship"`

	// quote item term
	QuoteItemTerm *ItemTerm `json:"quoteItemTerm,omitempty"`

	// related party role
	RelatedPartyRole []*RelatedPartyRole `json:"relatedPartyRole"`

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

QuoteItem A quote items describe an action to be performed on a productOffering or a product in order to get pricing elements and condition

swagger:model QuoteItem

func (*QuoteItem) MarshalBinary

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

MarshalBinary interface implementation

func (*QuoteItem) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*QuoteItem) Validate

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

Validate validates this quote item

type QuoteItemAction

type QuoteItemAction string

QuoteItemAction Quote Item Action

swagger:model QuoteItemAction

const (

	// QuoteItemActionINSTALL captures enum value "INSTALL"
	QuoteItemActionINSTALL QuoteItemAction = "INSTALL"

	// QuoteItemActionCHANGE captures enum value "CHANGE"
	QuoteItemActionCHANGE QuoteItemAction = "CHANGE"

	// QuoteItemActionDISCONNECT captures enum value "DISCONNECT"
	QuoteItemActionDISCONNECT QuoteItemAction = "DISCONNECT"

	// QuoteItemActionNOCHANGE captures enum value "NO_CHANGE"
	QuoteItemActionNOCHANGE QuoteItemAction = "NO_CHANGE"
)

func (QuoteItemAction) Validate

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

Validate validates this quote item action

type QuoteItemRelationship

type QuoteItemRelationship struct {

	// ID of the related order item (must be in the same quote).
	// Required: true
	ID *string `json:"id"`

	// type
	// Required: true
	Type RelationshipType `json:"type"`
}

QuoteItemRelationship Used to describe relationship between quote item. These relationships could have an impact on pricing and conditions.

swagger:model QuoteItemRelationship

func (*QuoteItemRelationship) MarshalBinary

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

MarshalBinary interface implementation

func (*QuoteItemRelationship) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*QuoteItemRelationship) Validate

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

Validate validates this quote item relationship

type QuoteItemState

type QuoteItemState string

QuoteItemState quote item state

swagger:model QuoteItemState

const (

	// QuoteItemStateINPROGRESS captures enum value "IN_PROGRESS"
	QuoteItemStateINPROGRESS QuoteItemState = "IN_PROGRESS"

	// QuoteItemStateUNABLETOPROVIDE captures enum value "UNABLE_TO_PROVIDE"
	QuoteItemStateUNABLETOPROVIDE QuoteItemState = "UNABLE_TO_PROVIDE"

	// QuoteItemStateREADY captures enum value "READY"
	QuoteItemStateREADY QuoteItemState = "READY"

	// QuoteItemStateABANDONED captures enum value "ABANDONED"
	QuoteItemStateABANDONED QuoteItemState = "ABANDONED"
)

func (QuoteItemState) Validate

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

Validate validates this quote item state

type QuoteLevel

type QuoteLevel string

QuoteLevel quote level

swagger:model QuoteLevel

const (

	// QuoteLevelBUDGETARY captures enum value "BUDGETARY"
	QuoteLevelBUDGETARY QuoteLevel = "BUDGETARY"

	// QuoteLevelINDICATIVE captures enum value "INDICATIVE"
	QuoteLevelINDICATIVE QuoteLevel = "INDICATIVE"

	// QuoteLevelFIRM captures enum value "FIRM"
	QuoteLevelFIRM QuoteLevel = "FIRM"
)

func (QuoteLevel) Validate

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

Validate validates this quote level

type QuotePrice

type QuotePrice struct {

	// link to the schema describing this REST resource
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Indicates the base (class) type of the quote price
	AtType string `json:"@type,omitempty"`

	// Description of the quote/quote item price.
	Description string `json:"description,omitempty"`

	// Name of the quote /quote item price
	Name string `json:"name,omitempty"`

	// price
	Price *Price `json:"price,omitempty"`

	// price alteration
	PriceAlteration []*PriceAlteration `json:"priceAlteration"`

	// indicate if the price is for recurrent or no-recurrent charge
	// Required: true
	PriceType *string `json:"priceType"`

	// Used for recurring charge to indicate period (month, week, etc..)
	RecurringChargePeriod string `json:"recurringChargePeriod,omitempty"`

	// Unit of Measure if price depending on it (Gb, SMS volume, etc..).
	UnitOfMeasure string `json:"unitOfMeasure,omitempty"`
}

QuotePrice Description of price and discount awarded.

swagger:model QuotePrice

func (*QuotePrice) MarshalBinary

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

MarshalBinary interface implementation

func (*QuotePrice) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*QuotePrice) Validate

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

Validate validates this quote price

type QuoteState

type QuoteState string

QuoteState quote state

swagger:model QuoteState

const (

	// QuoteStateINPROGRESS captures enum value "IN_PROGRESS"
	QuoteStateINPROGRESS QuoteState = "IN_PROGRESS"

	// QuoteStateREADY captures enum value "READY"
	QuoteStateREADY QuoteState = "READY"

	// QuoteStateCANCELLED captures enum value "CANCELLED"
	QuoteStateCANCELLED QuoteState = "CANCELLED"

	// QuoteStateREJECTED captures enum value "REJECTED"
	QuoteStateREJECTED QuoteState = "REJECTED"

	// QuoteStateACCEPTED captures enum value "ACCEPTED"
	QuoteStateACCEPTED QuoteState = "ACCEPTED"

	// QuoteStateEXPIRED captures enum value "EXPIRED"
	QuoteStateEXPIRED QuoteState = "EXPIRED"

	// QuoteStateUNABLETOPROVIDE captures enum value "UNABLE_TO_PROVIDE"
	QuoteStateUNABLETOPROVIDE QuoteState = "UNABLE_TO_PROVIDE"
)

func (QuoteState) Validate

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

Validate validates this quote state

type QuoteSummaryView

type QuoteSummaryView struct {

	// Indicates the base (class) type of the quote.
	AtBaseType string `json:"@baseType,omitempty"`

	// Link to the schema describing the REST resource.
	AtSchemaLocation string `json:"@schemaLocation,omitempty"`

	// Indicates the (class) type of the quote.
	AtType string `json:"@type,omitempty"`

	// Used to categorize the quote from a business perspective that can be useful for the CRM system (e.g. “enterprise”, “residential”, ...)
	Category string `json:"category,omitempty"`

	// Date when the quoted was Cancelled or Rejected or Accepted
	// Format: date-time
	EffectiveQuoteCompletionDate strfmt.DateTime `json:"effectiveQuoteCompletionDate,omitempty"`

	// This is the date wished by the requester to have the requested quote item(s) delivered
	// Format: date
	ExpectedFulfillmentStartDate strfmt.Date `json:"expectedFulfillmentStartDate,omitempty"`

	// This is the date filled by the seller to indicate expected quote completion date.
	// Format: date
	ExpectedQuoteCompletionDate strfmt.Date `json:"expectedQuoteCompletionDate,omitempty"`

	// ID given by the consumer and only understandable by him (to facilitate his searches afterwards)
	ExternalID string `json:"externalId,omitempty"`

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

	// ID attributed by quoting system
	ID string `json:"id,omitempty"`

	// Date when the quote was created
	// Format: date-time
	QuoteDate strfmt.DateTime `json:"quoteDate,omitempty"`

	// quote item
	// Required: true
	QuoteItem []*QuoteItem `json:"quoteItem"`

	// quote level
	QuoteLevel QuoteLevel `json:"quoteLevel,omitempty"`

	// related party role
	// Required: true
	RelatedPartyRole []*RelatedPartyRole `json:"relatedPartyRole"`

	// This is the date wished by the requester to have the quote completed (meaning priced)
	// Required: true
	// Format: date-time
	RequestedQuoteCompletionDate *strfmt.DateTime `json:"requestedQuoteCompletionDate"`

	// state
	State QuoteState `json:"state,omitempty"`

	// valid for
	ValidFor *TimePeriod `json:"validFor,omitempty"`
}

QuoteSummaryView Quote Summary view is provided in the response of the GET(LIST) quote. Only a subset of information are provided.

swagger:model QuoteSummaryView

func (*QuoteSummaryView) MarshalBinary

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

MarshalBinary interface implementation

func (*QuoteSummaryView) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*QuoteSummaryView) Validate

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

Validate validates this quote summary view

type RelatedParty

type RelatedParty struct {

	// Indicates the base (class) type of the party.
	AtReferredType string `json:"@referredType,omitempty"`

	// email Address
	EmailAddress string `json:"emailAddress,omitempty"`

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

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

	// Telephone number
	Number string `json:"number,omitempty"`

	// Telephone number extension
	NumberExtension string `json:"numberExtension,omitempty"`
}

RelatedParty A related party defines party linked to a quote.

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 RelatedPartyRole

type RelatedPartyRole struct {

	// Referred type for this party role
	// Technical attribute
	AtReferredType string `json:"@referredType,omitempty"`

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

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

	// Role played for this party role. Could be 'buyer’, ‘seller’ for example.
	// Required: true
	Role *string `json:"role"`
}

RelatedPartyRole A party role (not a party) playing a role for this quote or quote Item.

swagger:model RelatedPartyRole

func (*RelatedPartyRole) MarshalBinary

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

MarshalBinary interface implementation

func (*RelatedPartyRole) UnmarshalBinary

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

UnmarshalBinary interface implementation

func (*RelatedPartyRole) Validate

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

Validate validates this related party role

type RelationshipType

type RelationshipType string

RelationshipType Relationship type to be used between quote item or product

swagger:model RelationshipType

const (

	// RelationshipTypeRELIESON captures enum value "RELIES_ON"
	RelationshipTypeRELIESON RelationshipType = "RELIES_ON"

	// RelationshipTypeBUNDLED captures enum value "BUNDLED"
	RelationshipTypeBUNDLED RelationshipType = "BUNDLED"

	// RelationshipTypeCOMESFROM captures enum value "COMES_FROM"
	RelationshipTypeCOMESFROM RelationshipType = "COMES_FROM"
)

func (RelationshipType) Validate

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

Validate validates this relationship type

type TimePeriod

type TimePeriod struct {

	// Quote valid to
	// Required: true
	// Format: date-time
	EndDate *strfmt.DateTime `json:"endDate"`

	// Quote valid from
	// Required: true
	// Format: date-time
	StartDate *strfmt.DateTime `json:"startDate"`
}

TimePeriod Indicates a time period for validity.

swagger:model TimePeriod

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL