Documentation
¶
Index ¶
- type Agreement
- type AgreementRef
- type AlternateProductProposal
- func (m *AlternateProductProposal) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *AlternateProductProposal) MarshalBinary() ([]byte, error)
- func (m *AlternateProductProposal) UnmarshalBinary(b []byte) error
- func (m *AlternateProductProposal) Validate(formats strfmt.Registry) error
- type BillingAccountRef
- type CancelProductOrder
- type CancelProductOrderCreate
- func (m *CancelProductOrderCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *CancelProductOrderCreate) MarshalBinary() ([]byte, error)
- func (m *CancelProductOrderCreate) UnmarshalBinary(b []byte) error
- func (m *CancelProductOrderCreate) Validate(formats strfmt.Registry) error
- type ChangeQuoteStateResponse
- func (m *ChangeQuoteStateResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ChangeQuoteStateResponse) MarshalBinary() ([]byte, error)
- func (m *ChangeQuoteStateResponse) UnmarshalBinary(b []byte) error
- func (m *ChangeQuoteStateResponse) Validate(formats strfmt.Registry) error
- type ChangelQuoteStateRequest
- func (m *ChangelQuoteStateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ChangelQuoteStateRequest) MarshalBinary() ([]byte, error)
- func (m *ChangelQuoteStateRequest) UnmarshalBinary(b []byte) error
- func (m *ChangelQuoteStateRequest) Validate(formats strfmt.Registry) error
- type ChargePeriod
- type Contact
- type Describing
- type DesiredOrderResponses
- type Duration
- type DurationUnit
- type ErrorRepresentation
- type FieldedAddress
- type FieldedAddressRequest
- type FormattedAddress
- type FormattedAddressRequest
- func (m *FormattedAddressRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *FormattedAddressRequest) MarshalBinary() ([]byte, error)
- func (m *FormattedAddressRequest) UnmarshalBinary(b []byte) error
- func (m *FormattedAddressRequest) Validate(formats strfmt.Registry) error
- type GeographicAddress
- type GeographicAddressFindResp
- func (m *GeographicAddressFindResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicAddressFindResp) MarshalBinary() ([]byte, error)
- func (m *GeographicAddressFindResp) UnmarshalBinary(b []byte) error
- func (m *GeographicAddressFindResp) Validate(formats strfmt.Registry) error
- type GeographicAddressRequestBuyerInput
- func (m *GeographicAddressRequestBuyerInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicAddressRequestBuyerInput) MarshalBinary() ([]byte, error)
- func (m *GeographicAddressRequestBuyerInput) UnmarshalBinary(b []byte) error
- func (m *GeographicAddressRequestBuyerInput) Validate(formats strfmt.Registry) error
- type GeographicAddressSellerResponse
- func (m *GeographicAddressSellerResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicAddressSellerResponse) MarshalBinary() ([]byte, error)
- func (m *GeographicAddressSellerResponse) UnmarshalBinary(b []byte) error
- func (m *GeographicAddressSellerResponse) Validate(formats strfmt.Registry) error
- type GeographicAddressValidation
- func (m *GeographicAddressValidation) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicAddressValidation) MarshalBinary() ([]byte, error)
- func (m *GeographicAddressValidation) UnmarshalBinary(b []byte) error
- func (m *GeographicAddressValidation) Validate(formats strfmt.Registry) error
- type GeographicAddressValidationCreate
- func (m *GeographicAddressValidationCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicAddressValidationCreate) MarshalBinary() ([]byte, error)
- func (m *GeographicAddressValidationCreate) UnmarshalBinary(b []byte) error
- func (m *GeographicAddressValidationCreate) Validate(formats strfmt.Registry) error
- type GeographicLocation
- type GeographicPoint
- type GeographicSite
- type GeographicSiteFindResp
- func (m *GeographicSiteFindResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicSiteFindResp) MarshalBinary() ([]byte, error)
- func (m *GeographicSiteFindResp) UnmarshalBinary(b []byte) error
- func (m *GeographicSiteFindResp) Validate(formats strfmt.Registry) error
- type GeographicSubAddress
- type GeographicSubAddressRequest
- func (m *GeographicSubAddressRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *GeographicSubAddressRequest) MarshalBinary() ([]byte, error)
- func (m *GeographicSubAddressRequest) UnmarshalBinary(b []byte) error
- func (m *GeographicSubAddressRequest) Validate(formats strfmt.Registry) error
- type Hub
- type HubInput
- type ItemTerm
- type Money
- type Note
- type Notification
- type OrderActivity
- type OrderItem
- type OrderItemEvent
- type OrderItemPrice
- type OrderItemRelationShip
- type OrderMessage
- type PoEvent
- type PoEventPlus
- func (m *PoEventPlus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *PoEventPlus) MarshalBinary() ([]byte, error)
- func (m PoEventPlus) MarshalJSON() ([]byte, error)
- func (m *PoEventPlus) UnmarshalBinary(b []byte) error
- func (m *PoEventPlus) UnmarshalJSON(raw []byte) error
- func (m *PoEventPlus) Validate(formats strfmt.Registry) error
- type PoQEventContainer
- type PoqEvent
- type PoqEventType
- type PoqItemEvent
- type Price
- type PriceAlteration
- type PriceRange
- type PriceType
- type PricingMethod
- type Principal
- type Product
- type ProductActionType
- type ProductEvent
- type ProductOfferingQualification
- func (m *ProductOfferingQualification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualification) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualification) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualification) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationCreate
- func (m *ProductOfferingQualificationCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationCreate) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationCreate) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationCreate) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationFind
- func (m *ProductOfferingQualificationFind) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationFind) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationFind) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationFind) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationItem
- func (m *ProductOfferingQualificationItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationItem) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationItem) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationItem) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationItemCreate
- func (m *ProductOfferingQualificationItemCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationItemCreate) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationItemCreate) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationItemCreate) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationItemRelationship
- func (m *ProductOfferingQualificationItemRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationItemRelationship) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationItemRelationship) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationItemRelationship) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationItemStateType
- type ProductOfferingQualificationRef
- func (m *ProductOfferingQualificationRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOfferingQualificationRef) MarshalBinary() ([]byte, error)
- func (m *ProductOfferingQualificationRef) UnmarshalBinary(b []byte) error
- func (m *ProductOfferingQualificationRef) Validate(formats strfmt.Registry) error
- type ProductOfferingQualificationStateType
- type ProductOfferingRef
- type ProductOrder
- type ProductOrderCreate
- type ProductOrderEvent
- type ProductOrderEventType
- type ProductOrderItemCreate
- func (m *ProductOrderItemCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductOrderItemCreate) MarshalBinary() ([]byte, error)
- func (m *ProductOrderItemCreate) UnmarshalBinary(b []byte) error
- func (m *ProductOrderItemCreate) Validate(formats strfmt.Registry) error
- type ProductOrderItemStateType
- type ProductOrderRef
- type ProductOrderRefCancel
- type ProductOrderStateType
- type ProductOrderSummary
- type ProductPrice
- type ProductRef
- type ProductRelationship
- type ProductSpecification
- type ProductSpecificationRef
- func (m *ProductSpecificationRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductSpecificationRef) MarshalBinary() ([]byte, error)
- func (m *ProductSpecificationRef) UnmarshalBinary(b []byte) error
- func (m *ProductSpecificationRef) Validate(formats strfmt.Registry) error
- type ProductSpecificationSummary
- func (m *ProductSpecificationSummary) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ProductSpecificationSummary) MarshalBinary() ([]byte, error)
- func (m *ProductSpecificationSummary) UnmarshalBinary(b []byte) error
- func (m *ProductSpecificationSummary) Validate(formats strfmt.Registry) error
- type ProductStatus
- type ProductSummary
- type ProductTerm
- type QualificationRef
- type QualificationState
- type Quantity
- type Quote
- type QuoteChangeState
- type QuoteCreate
- type QuoteEvent
- type QuoteEventPlus
- func (m *QuoteEventPlus) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *QuoteEventPlus) MarshalBinary() ([]byte, error)
- func (m QuoteEventPlus) MarshalJSON() ([]byte, error)
- func (m *QuoteEventPlus) UnmarshalBinary(b []byte) error
- func (m *QuoteEventPlus) UnmarshalJSON(raw []byte) error
- func (m *QuoteEventPlus) Validate(formats strfmt.Registry) error
- type QuoteEventType
- type QuoteFind
- type QuoteItem
- type QuoteItemAction
- type QuoteItemCreate
- type QuoteItemRelationship
- type QuoteItemState
- type QuoteItemStateType
- type QuoteLevel
- type QuotePrice
- type QuoteRef
- type QuoteState
- type QuoteStateType
- type QuoteSummaryView
- type ReferencedAddress
- type RelatedParty
- type RelatedPartyRole
- type RelatedPlaceRefOrValue
- type RelatedPlaceReforValue
- type RelationshipType
- type ServiceabilityColor
- type Severity
- type StateChange
- type Status
- type StatusChange
- type SubUnit
- type TaskStateType
- type TerminationError
- type TimeInterval
- type TimePeriod
- type TimeUnit
- type ValidationResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Agreement ¶
type Agreement struct { // Unique identifier of the agreement // Required: true ID *string `json:"id"` // Name of the agreement Name string `json:"name,omitempty"` // A URI/URL to where the agreement resides. Path string `json:"path,omitempty"` }
Agreement Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement.
swagger:model Agreement
func (*Agreement) ContextValidate ¶
ContextValidate validates this agreement based on context it is used
func (*Agreement) MarshalBinary ¶
MarshalBinary interface implementation
func (*Agreement) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AgreementRef ¶
type AgreementRef struct { // Reference of the agreement Href string `json:"href,omitempty"` // Id of the agreement // Required: true ID *string `json:"id"` // Name of the agreement // Required: true Name *string `json:"name"` // A URI/URL providing the path to where an agreement resides. // Required: true Path *string `json:"path"` }
AgreementRef An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
swagger:model AgreementRef
func (*AgreementRef) ContextValidate ¶
ContextValidate validates this agreement ref based on context it is used
func (*AgreementRef) MarshalBinary ¶
func (m *AgreementRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AgreementRef) UnmarshalBinary ¶
func (m *AgreementRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AlternateProductProposal ¶
type AlternateProductProposal struct { // Technical attribute to extend the class. AtType string `json:"@type,omitempty"` // eligible product offering EligibleProductOffering []*ProductOfferingRef `json:"eligibleProductOffering"` // Identifier of the Product Offering Qualification alternate proposal // Required: true ID *string `json:"id"` // installation interval InstallationInterval *TimeInterval `json:"installationInterval,omitempty"` // product specification ProductSpecification *ProductSpecificationRef `json:"productSpecification,omitempty"` }
AlternateProductProposal If in the request the buyer has requested to have alternate product proposals, then this class represents these proposals.
swagger:model AlternateProductProposal
func (*AlternateProductProposal) ContextValidate ¶
func (m *AlternateProductProposal) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this alternate product proposal based on the context it is used
func (*AlternateProductProposal) MarshalBinary ¶
func (m *AlternateProductProposal) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AlternateProductProposal) UnmarshalBinary ¶
func (m *AlternateProductProposal) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BillingAccountRef ¶
type BillingAccountRef struct { // An unique identifier of the billing account // 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) ContextValidate ¶
ContextValidate validates this billing account ref based on context it is used
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
type CancelProductOrder ¶
type CancelProductOrder struct { // Technical attribute to extend this class. AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class. AtType string `json:"@type,omitempty"` // If seller denied cancellation request he could here provide reason for this denial CancellationDeniedReason string `json:"cancellationDeniedReason,omitempty"` // An optional free-form text field for the Seller to provide additional information regarding the reason for the cancellation. CancellationReason string `json:"cancellationReason,omitempty"` // Hyperlink to access order cancellation request.This is not a product order href. Href string `json:"href,omitempty"` // Unique identifier for the order cancellation request that is generated by the Seller when the order cancellation is accepted via an API. This is not the order id. // Required: true ID *string `json:"id"` // product order // Required: true ProductOrder *ProductOrderRefCancel `json:"productOrder"` // Identifies the date the Seller cancelled the Order. // Required: true // Format: date-time RequestedCancellationDate *strfmt.DateTime `json:"requestedCancellationDate"` // state // Required: true State *TaskStateType `json:"state"` }
CancelProductOrder Structure to allow Seller to answer to a cancel order request
swagger:model CancelProductOrder
func (*CancelProductOrder) ContextValidate ¶
ContextValidate validate this cancel product order based on the context it is used
func (*CancelProductOrder) MarshalBinary ¶
func (m *CancelProductOrder) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CancelProductOrder) UnmarshalBinary ¶
func (m *CancelProductOrder) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CancelProductOrderCreate ¶
type CancelProductOrderCreate struct { // Technical attribute to extend this class. AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class. AtType string `json:"@type,omitempty"` // An optional free-form text field for the Seller to provide additional information regarding the reason for the cancellation. CancellationReason string `json:"cancellationReason,omitempty"` // product order // Required: true ProductOrder *ProductOrderRefCancel `json:"productOrder"` // Identifies the date the Seller cancelled the Order. // Required: true // Format: date-time RequestedCancellationDate *strfmt.DateTime `json:"requestedCancellationDate"` }
CancelProductOrderCreate cancel product order create
swagger:model CancelProductOrder_Create
func (*CancelProductOrderCreate) ContextValidate ¶
func (m *CancelProductOrderCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this cancel product order create based on the context it is used
func (*CancelProductOrderCreate) MarshalBinary ¶
func (m *CancelProductOrderCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CancelProductOrderCreate) UnmarshalBinary ¶
func (m *CancelProductOrderCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChangeQuoteStateResponse ¶
type ChangeQuoteStateResponse struct { // External Id of the quote (buyer quote id). If provided by seller this information is send back in the response. ExternalID string `json:"externalId,omitempty"` // id of the quote to be cancelled // Required: true ID *string `json:"id"` // Cancellation or rejection date (effective) // Required: true // Format: date-time QuoteEffectiveStateChangeDate *strfmt.DateTime `json:"quoteEffectiveStateChangeDate"` // state // Required: true State *QuoteStateType `json:"state"` }
ChangeQuoteStateResponse Structure to response for a quote cancellation/rejection request
swagger:model ChangeQuoteStateResponse
func (*ChangeQuoteStateResponse) ContextValidate ¶
func (m *ChangeQuoteStateResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this change quote state response based on the context it is used
func (*ChangeQuoteStateResponse) MarshalBinary ¶
func (m *ChangeQuoteStateResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangeQuoteStateResponse) UnmarshalBinary ¶
func (m *ChangeQuoteStateResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChangelQuoteStateRequest ¶
type ChangelQuoteStateRequest struct { // External Id of the quote (buyer quote id). If provided seller will check consistence. ExternalID string `json:"externalId,omitempty"` // id of the quote to be cancelled // Required: true ID *string `json:"id"` // Cancellation reason // Required: true QuoteChangeStateReason *string `json:"quoteChangeStateReason"` // state // Required: true State *QuoteChangeState `json:"state"` }
ChangelQuoteStateRequest Structure used to request quote cancellation/rejection
swagger:model ChangelQuoteStateRequest
func (*ChangelQuoteStateRequest) ContextValidate ¶
func (m *ChangelQuoteStateRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this changel quote state request based on the context it is used
func (*ChangelQuoteStateRequest) MarshalBinary ¶
func (m *ChangelQuoteStateRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ChangelQuoteStateRequest) UnmarshalBinary ¶
func (m *ChangelQuoteStateRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ChargePeriod ¶
type ChargePeriod string
ChargePeriod charge period
swagger:model ChargePeriod
const ( // ChargePeriodDay captures enum value "day" ChargePeriodDay ChargePeriod = "day" // ChargePeriodWeek captures enum value "week" ChargePeriodWeek ChargePeriod = "week" // ChargePeriodMonth captures enum value "month" ChargePeriodMonth ChargePeriod = "month" // ChargePeriodYear captures enum value "year" ChargePeriodYear ChargePeriod = "year" )
func NewChargePeriod ¶
func NewChargePeriod(value ChargePeriod) *ChargePeriod
func (ChargePeriod) ContextValidate ¶
ContextValidate validates this charge period based on context it is used
type Contact ¶
type Contact struct { // Technical attribut to extend API AtReferredType string `json:"@referredType,omitempty"` // Identifies the name of the person or office to be contacted on billing matters. // Required: true ContactName *string `json:"contactName"` // Identifies the electronic mail address of the Billing Contact when a Buyer profile does not already exist. // Required: true EmailAddress *string `json:"emailAddress"` // Identifies the telephone number (excluding extension) of the billing contact // Required: true PhoneNumber *string `json:"phoneNumber"` // Identifies the telephone number extension of the billing contact PhoneNumberExtension string `json:"phoneNumberExtension,omitempty"` // Identifies the address of the person or office to be contacted on billing matters. // Required: true StreetAddress *string `json:"streetAddress"` }
Contact Contact allow to capture contact information. It is used to capture billing account contact information
swagger:model Contact
func (*Contact) ContextValidate ¶
ContextValidate validates this contact based on context it is used
func (*Contact) MarshalBinary ¶
MarshalBinary interface implementation
func (*Contact) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Describing ¶
type Describing struct { // An URL to target a description file // Required: true AtSchemaLocation *string `json:"@schemaLocation"` // Type of the resource // Required: true AtType *string `json:"@type"` }
Describing Technical structure to describe productSpecification
swagger:model Describing
func (*Describing) ContextValidate ¶
ContextValidate validates this describing based on context it is used
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
type DesiredOrderResponses ¶
type DesiredOrderResponses string
DesiredOrderResponses The kind of responses that the buyer expects to receive from the seller.
swagger:model DesiredOrderResponses
const ( // DesiredOrderResponsesConfirmationAndEngineeringDesign captures enum value "confirmationAndEngineeringDesign" DesiredOrderResponsesConfirmationAndEngineeringDesign DesiredOrderResponses = "confirmationAndEngineeringDesign" // DesiredOrderResponsesConfirmationOnly captures enum value "confirmationOnly" DesiredOrderResponsesConfirmationOnly DesiredOrderResponses = "confirmationOnly" // DesiredOrderResponsesNone captures enum value "none" DesiredOrderResponsesNone DesiredOrderResponses = "none" )
func NewDesiredOrderResponses ¶
func NewDesiredOrderResponses(value DesiredOrderResponses) *DesiredOrderResponses
func (DesiredOrderResponses) ContextValidate ¶
ContextValidate validates this desired order responses based on context it is used
type Duration ¶
type Duration struct { // unit // Required: true Unit *DurationUnit `json:"unit"` // value of the duration // Required: true Value *int32 `json:"value"` }
Duration To describe a duration (period of time) with a value and an unit (day, month, etc...)
swagger:model Duration
func (*Duration) ContextValidate ¶
ContextValidate validate this duration based on the context it is used
func (*Duration) MarshalBinary ¶
MarshalBinary interface implementation
func (*Duration) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type DurationUnit ¶
type DurationUnit string
DurationUnit 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 NewDurationUnit ¶
func NewDurationUnit(value DurationUnit) *DurationUnit
func (DurationUnit) ContextValidate ¶
ContextValidate validates this duration unit based on context it is used
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 string `json:"status,omitempty"` }
ErrorRepresentation Class used to describe API response error
swagger:model ErrorRepresentation
func (*ErrorRepresentation) ContextValidate ¶
ContextValidate validates this error representation based on context it is used
func (*ErrorRepresentation) MarshalBinary ¶
func (m *ErrorRepresentation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ErrorRepresentation) UnmarshalBinary ¶
func (m *ErrorRepresentation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldedAddress ¶
type FieldedAddress struct { // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // geographic sub address GeographicSubAddress []*GeographicSubAddress `json:"geographicSubAddress"` // Unique identifier of the address ID string `json:"id,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` // Name of the street or other street type StreetName string `json:"streetName,omitempty"` // Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses StreetNr string `json:"streetNr,omitempty"` // Last number in a range of street numbers allocated to a property StreetNrLast string `json:"streetNrLast,omitempty"` // Last street number suffix for a ranged address StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"` // The first street number suffix StreetNrSuffix string `json:"streetNrSuffix,omitempty"` // A modifier denoting a relative direction StreetSuffix string `json:"streetSuffix,omitempty"` // Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf StreetType string `json:"streetType,omitempty"` }
FieldedAddress A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example “street number” is one field, “street name” is another field, etc.
swagger:model FieldedAddress
func (*FieldedAddress) ContextValidate ¶
ContextValidate validate this fielded address based on the context it is used
func (*FieldedAddress) MarshalBinary ¶
func (m *FieldedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FieldedAddress) UnmarshalBinary ¶
func (m *FieldedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FieldedAddressRequest ¶
type FieldedAddressRequest struct { // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // geographic sub address GeographicSubAddress *GeographicSubAddressRequest `json:"geographicSubAddress,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` // Name of the street or other street type StreetName string `json:"streetName,omitempty"` // Number identifying a specific property on a public street. It may be combined with streetNrLast for ranged addresses StreetNr string `json:"streetNr,omitempty"` // Last number in a range of street numbers allocated to a property StreetNrLast string `json:"streetNrLast,omitempty"` // Last street number suffix for a ranged address StreetNrLastSuffix string `json:"streetNrLastSuffix,omitempty"` // The first street number suffix StreetNrSuffix string `json:"streetNrSuffix,omitempty"` // A modifier denoting a relative direction StreetSuffix string `json:"streetSuffix,omitempty"` // Alley, avenue, boulevard, brae, crescent, drive, highway, lane, terrace, parade, place, tarn, way, wharf StreetType string `json:"streetType,omitempty"` }
FieldedAddressRequest A type of Address that has a discrete field and value for each type of boundary or identifier down to the lowest level of detail. For example “street number” is one field, “street name” is another field, etc. This structure is used in the request addressValidation only
swagger:model FieldedAddressRequest
func (*FieldedAddressRequest) ContextValidate ¶
ContextValidate validate this fielded address request based on the context it is used
func (*FieldedAddressRequest) MarshalBinary ¶
func (m *FieldedAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FieldedAddressRequest) UnmarshalBinary ¶
func (m *FieldedAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FormattedAddress ¶
type FormattedAddress struct { // The first address line in a formatted address // Required: true AddrLine1 *string `json:"addrLine1"` // The second address line in a formatted address AddrLine2 string `json:"addrLine2,omitempty"` // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` }
FormattedAddress A type of Address that has discrete fields for each type of boundary or identifier with the exception of street and more specific location details, which are combined into a maximum of two strings based on local postal addressing conventions
swagger:model FormattedAddress
func (*FormattedAddress) ContextValidate ¶
ContextValidate validates this formatted address based on context it is used
func (*FormattedAddress) MarshalBinary ¶
func (m *FormattedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FormattedAddress) UnmarshalBinary ¶
func (m *FormattedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type FormattedAddressRequest ¶
type FormattedAddressRequest struct { // The first address line in a formatted address // Required: true AddrLine1 *string `json:"addrLine1"` // The second address line in a formatted address AddrLine2 string `json:"addrLine2,omitempty"` // City that the address is in City string `json:"city,omitempty"` // Country that the address is in Country string `json:"country,omitempty"` // "An area of defined or undefined boundaries within a local authority or other legislatively defined area, usually rural or semi-rural in nature." [ANZLIC-STREET], or a suburb "a bounded locality within a city, town or shire principally of urban character " [ANZLICSTREET]. Locality string `json:"locality,omitempty"` // The four-digit extension on an American postal code, what comes after the hyphen when specified. PostCodeExtension string `json:"postCodeExtension,omitempty"` // Descriptor for a postal delivery area, used to speed and simplify the delivery of mail (also known as zipcode) Postcode string `json:"postcode,omitempty"` // The State or Province that the address is in StateOrProvince string `json:"stateOrProvince,omitempty"` }
FormattedAddressRequest A type of Address that has discrete fields for each type of boundary or identifier with the exception of street and more specific location details, which are combined into a maximum of two strings based on local postal addressing conventions
swagger:model FormattedAddressRequest
func (*FormattedAddressRequest) ContextValidate ¶
func (m *FormattedAddressRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this formatted address request based on context it is used
func (*FormattedAddressRequest) MarshalBinary ¶
func (m *FormattedAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FormattedAddressRequest) UnmarshalBinary ¶
func (m *FormattedAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddress ¶
type GeographicAddress struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // This attribute specifies if a Buyer must use one of the known existing Service Sites at this location for any Products delivered to this Address. For example, if a particular building owner mandated that all interconnects be done in a shared Public Meet-Me-Room, this attribute would be set to False for that Address. AllowsNewSite bool `json:"allowsNewSite,omitempty"` // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` // geographic location GeographicLocation *GeographicLocation `json:"geographicLocation,omitempty"` // This attribute specifies if that Address contains Service Sites that are public such as Meet-Me-Rooms at an interconnect location or a shared telecom room in the basement of a multi-tenant building. HasPublicSite bool `json:"hasPublicSite,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // referenced address ReferencedAddress *ReferencedAddress `json:"referencedAddress,omitempty"` }
GeographicAddress An address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
swagger:model GeographicAddress
func (*GeographicAddress) ContextValidate ¶
ContextValidate validate this geographic address based on the context it is used
func (*GeographicAddress) MarshalBinary ¶
func (m *GeographicAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddress) UnmarshalBinary ¶
func (m *GeographicAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressFindResp ¶
type GeographicAddressFindResp struct { // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` }
GeographicAddressFindResp Structure used to describe geographic address in response to GET geographicalSite
swagger:model GeographicAddressFindResp
func (*GeographicAddressFindResp) ContextValidate ¶
func (m *GeographicAddressFindResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic address find resp based on the context it is used
func (*GeographicAddressFindResp) MarshalBinary ¶
func (m *GeographicAddressFindResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressFindResp) UnmarshalBinary ¶
func (m *GeographicAddressFindResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressRequestBuyerInput ¶
type GeographicAddressRequestBuyerInput struct { // fielded address FieldedAddress *FieldedAddressRequest `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddressRequest `json:"formattedAddress,omitempty"` }
GeographicAddressRequestBuyerInput Structure used by the buyer to request geographic address validation
swagger:model GeographicAddressRequestBuyerInput
func (*GeographicAddressRequestBuyerInput) ContextValidate ¶
func (m *GeographicAddressRequestBuyerInput) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic address request buyer input based on the context it is used
func (*GeographicAddressRequestBuyerInput) MarshalBinary ¶
func (m *GeographicAddressRequestBuyerInput) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressRequestBuyerInput) UnmarshalBinary ¶
func (m *GeographicAddressRequestBuyerInput) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressSellerResponse ¶
type GeographicAddressSellerResponse struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // This attribute specifies if a Buyer must use one of the known existing Service Sites at this location for any Products delivered to this Address. For example, if a particular building owner mandated that all interconnects be done in a shared Public Meet-Me-Room, this attribute would be set to False for that Address. AllowsNewSite bool `json:"allowsNewSite,omitempty"` // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` // This attribute specifies if that Address contains Service Sites that are public such as Meet-Me-Rooms at an interconnect location or a shared telecom room in the basement of a multi-tenant building HasPublicSite bool `json:"hasPublicSite,omitempty"` // Unique identifier of the address ID string `json:"id,omitempty"` // For each Address returned, this attribute specifies if the Seller believes this is the best match to the Buyer specified Address. Setting this to TRUE also represents that the Seller believes this is likely a direct match to the Buyer Specified Address. // Required: true IsBestMatch *bool `json:"isBestMatch"` }
GeographicAddressSellerResponse An address is a structured textual way of describing how to find a Property in an urban area (country properties are often defined differently)
swagger:model GeographicAddressSellerResponse
func (*GeographicAddressSellerResponse) ContextValidate ¶
func (m *GeographicAddressSellerResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic address seller response based on the context it is used
func (*GeographicAddressSellerResponse) MarshalBinary ¶
func (m *GeographicAddressSellerResponse) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressSellerResponse) UnmarshalBinary ¶
func (m *GeographicAddressSellerResponse) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressValidation ¶
type GeographicAddressValidation struct { // Unique identifier of the Address Validation (Not an address id !!) ID string `json:"id,omitempty"` // requested address // Required: true RequestedAddress *GeographicAddressRequestBuyerInput `json:"requestedAddress"` // Date when the address validation is performed // Format: date-time ValidationDate strfmt.DateTime `json:"validationDate,omitempty"` // validation result ValidationResult ValidationResult `json:"validationResult,omitempty"` // verified address VerifiedAddress []*GeographicAddressSellerResponse `json:"verifiedAddress"` }
GeographicAddressValidation Resource used to support a request for a validation address : check if a geographic address described by values attributes exists) If exist, id is provided if not, alternate address(es) could be provided
swagger:model GeographicAddressValidation
func (*GeographicAddressValidation) ContextValidate ¶
func (m *GeographicAddressValidation) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic address validation based on the context it is used
func (*GeographicAddressValidation) MarshalBinary ¶
func (m *GeographicAddressValidation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressValidation) UnmarshalBinary ¶
func (m *GeographicAddressValidation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicAddressValidationCreate ¶
type GeographicAddressValidationCreate struct { // requested address // Required: true RequestedAddress *GeographicAddressRequestBuyerInput `json:"requestedAddress"` }
GeographicAddressValidationCreate Structure used to describe a geographic address validation request
swagger:model GeographicAddressValidation_Create
func (*GeographicAddressValidationCreate) ContextValidate ¶
func (m *GeographicAddressValidationCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic address validation create based on the context it is used
func (*GeographicAddressValidationCreate) MarshalBinary ¶
func (m *GeographicAddressValidationCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicAddressValidationCreate) UnmarshalBinary ¶
func (m *GeographicAddressValidationCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicLocation ¶
type GeographicLocation struct { // geographic point // Required: true GeographicPoint []*GeographicPoint `json:"geographicPoint"` // Unique Identifier of a GeographicLocation ID string `json:"id,omitempty"` // The spatial reference system used to determine the coordinates // Required: true SpatialRef *string `json:"spatialRef"` }
GeographicLocation A set of coordinates (typically including latitude and longitude) that describes a particular location on earth.
swagger:model GeographicLocation
func (*GeographicLocation) ContextValidate ¶
ContextValidate validate this geographic location based on the context it is used
func (*GeographicLocation) MarshalBinary ¶
func (m *GeographicLocation) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicLocation) UnmarshalBinary ¶
func (m *GeographicLocation) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicPoint ¶
type GeographicPoint struct { // A unique identifier for the geographic point. ID string `json:"id,omitempty"` // The latitude expressed in decimal degrees format // Required: true Latitude *string `json:"latitude"` // The longitude expressed in decimal degrees format // Required: true Longitude *string `json:"longitude"` }
GeographicPoint A geometric point on earth, which can include a latitude, longitude, and elevation in “decimal degrees” format.
swagger:model GeographicPoint
func (*GeographicPoint) ContextValidate ¶
ContextValidate validates this geographic point based on context it is used
func (*GeographicPoint) MarshalBinary ¶
func (m *GeographicPoint) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicPoint) UnmarshalBinary ¶
func (m *GeographicPoint) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSite ¶
type GeographicSite struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // Additional site information AdditionalSiteInformation string `json:"additionalSiteInformation,omitempty"` // A textual description of the Service Site. Description string `json:"description,omitempty"` // fielded address FieldedAddress *FieldedAddress `json:"fieldedAddress,omitempty"` // formatted address FormattedAddress *FormattedAddress `json:"formattedAddress,omitempty"` // geographic location GeographicLocation *GeographicLocation `json:"geographicLocation,omitempty"` // Identifier of the Service Site unique within the Seller. ID string `json:"id,omitempty"` // referenced address ReferencedAddress *ReferencedAddress `json:"referencedAddress,omitempty"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // The name of the company that is the administrative authority (e.g. controls access) for this Service Site. (For example, the building owner) SiteCompanyName string `json:"siteCompanyName,omitempty"` // The name of the company that is the administrative authority for the space within this Service Site. (For example, the company leasing space in a multi-tenant building). SiteCustomerName string `json:"siteCustomerName,omitempty"` // A name commonly used by people to refer to this Service Site. SiteName string `json:"siteName,omitempty"` // This defines whether a Service Site is public or private. “PUBLIC” means that the existence of this Service Site is public information. A meet-me-room in a hosted data center facility (where all interconnects between parties take place) is an example of a public Service Site. A shared facility in the basement of a multi-tenant business building where all interconnects between parties take place is another example of a public Service Site. “PRIVATE” means that the existence of this Service Site is on a need-to-know basis. A wiring closet set up inside a customer facility just to connect two parties is an example of a private Service Site. For “PRIVATE” sites, the Seller does not return any information regarding the existence of this Service Site unless it has been established that this Buyer is authorized to obtain this information. SiteType string `json:"siteType,omitempty"` // status Status Status `json:"status,omitempty"` }
GeographicSite Designated as Service Site in TS. A fixed physical location at which a Product can be installed. Its location can be described either with geocodes (Lat/Long information) or by association with an Address or Address Reference. This association may include a Sub-address describing where within that Address or Address Reference, this particular Service Site is located.
swagger:model GeographicSite
func (*GeographicSite) ContextValidate ¶
ContextValidate validate this geographic site based on the context it is used
func (*GeographicSite) MarshalBinary ¶
func (m *GeographicSite) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSite) UnmarshalBinary ¶
func (m *GeographicSite) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSiteFindResp ¶
type GeographicSiteFindResp struct { // geographic address GeographicAddress *GeographicAddressFindResp `json:"geographicAddress,omitempty"` // id of the site. This is coud be used in other API as a place ID string `json:"id,omitempty"` // The name of the company that is the administrative authority (e.g. controls access) for this Service Site. (For example, the building owner) SiteCompanyName string `json:"siteCompanyName,omitempty"` // Name of the relatedParty which has role 'Site Contact' in the Site record. SiteContactName string `json:"siteContactName,omitempty"` // The name of the company that is the administrative authority for the space within this Service Site. (For example, the company leasing space in a multi-tenant building). SiteCustomerName string `json:"siteCustomerName,omitempty"` // A textual description of the Service Site. SiteDescription string `json:"siteDescription,omitempty"` // A name commonly used by people to refer to this Service Site. SiteName string `json:"siteName,omitempty"` // This defines whether a Service Site is public or private. SiteType string `json:"siteType,omitempty"` // status Status Status `json:"status,omitempty"` }
GeographicSiteFindResp Technical structure to provide site list retrieve in the GET operation
swagger:model GeographicSiteFindResp
func (*GeographicSiteFindResp) ContextValidate ¶
func (m *GeographicSiteFindResp) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic site find resp based on the context it is used
func (*GeographicSiteFindResp) MarshalBinary ¶
func (m *GeographicSiteFindResp) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSiteFindResp) UnmarshalBinary ¶
func (m *GeographicSiteFindResp) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSubAddress ¶
type GeographicSubAddress struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // Allows for buildings that have well-known names BuildingName string `json:"buildingName,omitempty"` // Unique Identifier of the subAddress ID string `json:"id,omitempty"` // Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 LevelNumber string `json:"levelNumber,omitempty"` // Describes level types within a building LevelType string `json:"levelType,omitempty"` // Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office PrivateStreetName string `json:"privateStreetName,omitempty"` // Private streets numbers internal to a private street PrivateStreetNumber string `json:"privateStreetNumber,omitempty"` // sub unit SubUnit []*SubUnit `json:"subUnit"` }
GeographicSubAddress It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
swagger:model GeographicSubAddress
func (*GeographicSubAddress) ContextValidate ¶
ContextValidate validate this geographic sub address based on the context it is used
func (*GeographicSubAddress) MarshalBinary ¶
func (m *GeographicSubAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSubAddress) UnmarshalBinary ¶
func (m *GeographicSubAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GeographicSubAddressRequest ¶
type GeographicSubAddressRequest struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // Allows for buildings that have well-known names BuildingName string `json:"buildingName,omitempty"` // Used where a level type may be repeated e.g. BASEMENT 1, BASEMENT 2 LevelNumber string `json:"levelNumber,omitempty"` // Describes level types within a building LevelType string `json:"levelType,omitempty"` // Private streets internal to a property (e.g. a university) may have internal names that are not recorded by the land title office PrivateStreetName string `json:"privateStreetName,omitempty"` // Private streets numbers internal to a private street PrivateStreetNumber string `json:"privateStreetNumber,omitempty"` // sub unit SubUnit []*SubUnit `json:"subUnit"` }
GeographicSubAddressRequest It is used for addressing within a property in an urban area (country properties are often defined differently). It may refer to a building, a building cluster, or a floor of a multistory building.
swagger:model GeographicSubAddressRequest
func (*GeographicSubAddressRequest) ContextValidate ¶
func (m *GeographicSubAddressRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this geographic sub address request based on the context it is used
func (*GeographicSubAddressRequest) MarshalBinary ¶
func (m *GeographicSubAddressRequest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GeographicSubAddressRequest) UnmarshalBinary ¶
func (m *GeographicSubAddressRequest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Hub ¶
type Hub struct { // This callback address is an url. the norification will be sent to this url address // Required: true Callback *string `json:"callback"` // id of the Hub // Required: true ID *string `json:"id"` // This attribute is used to define notification type. Example: ","query":”eventType = ProductOfferingQualificationStateChangeNotification”} // Required: true Query *string `json:"query"` }
Hub This resource is used to manage notification subscription.
swagger:model Hub
func (*Hub) ContextValidate ¶
ContextValidate validates this hub based on context it is used
func (*Hub) MarshalBinary ¶
MarshalBinary interface implementation
func (*Hub) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HubInput ¶
type HubInput struct { // This attribute is the callback url where event will be sent when occurs, for instance an url http://yourdomain/listener/api/v1/event // Required: true Callback *string `json:"callback"` // This attribute is used to define notification type. Example: ","query":”eventType = ProductOfferingQualificationStateChangeNotification”} // Required: true Query *string `json:"query"` }
HubInput This class is used to request a HUB creation - Used in the POST operation.
swagger:model HubInput
func (*HubInput) ContextValidate ¶
ContextValidate validates this hub input based on context it is used
func (*HubInput) MarshalBinary ¶
MarshalBinary interface implementation
func (*HubInput) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this item term based on the context it is used
func (*ItemTerm) MarshalBinary ¶
MarshalBinary interface implementation
func (*ItemTerm) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 base / value business entity used to represent money
swagger:model Money
func (*Money) ContextValidate ¶
ContextValidate validates this money based on context it is used
func (*Money) MarshalBinary ¶
MarshalBinary interface implementation
func (*Money) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 Free form text to clarify or explain the order.
swagger:model Note
func (*Note) ContextValidate ¶
ContextValidate validates this note based on context it is used
func (*Note) MarshalBinary ¶
MarshalBinary interface implementation
func (*Note) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 OrderActivity ¶
type OrderActivity string
OrderActivity The type of order as defined by the business.
swagger:model OrderActivity
const ( // OrderActivityInstall captures enum value "install" OrderActivityInstall OrderActivity = "install" // OrderActivityChange captures enum value "change" OrderActivityChange OrderActivity = "change" // OrderActivityDisconnect captures enum value "disconnect" OrderActivityDisconnect OrderActivity = "disconnect" )
func NewOrderActivity ¶
func NewOrderActivity(value OrderActivity) *OrderActivity
func (OrderActivity) ContextValidate ¶
ContextValidate validates this order activity based on context it is used
type OrderItem ¶
type OrderItem 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"` // order item price OrderItemPrice []*OrderItemPrice `json:"orderItemPrice"` // order item relationship OrderItemRelationship []*OrderItemRelationShip `json:"orderItemRelationship"` // pricing method PricingMethod PricingMethod `json:"pricingMethod,omitempty"` // The identifier references the previously agreed upon pricing terms, as applicable, based on the pricingMethod (e.g. a contract id or tariff id. PricingReference string `json:"pricingReference,omitempty"` // The length of the contract in months PricingTerm int32 `json:"pricingTerm,omitempty"` // product Product *Product `json:"product,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // qualification Qualification *QualificationRef `json:"qualification,omitempty"` // quote Quote *QuoteRef `json:"quote,omitempty"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // state // Required: true State *ProductOrderItemStateType `json:"state"` // state change StateChange []*StateChange `json:"stateChange"` }
OrderItem An enumeration of the entities that are part of this order expressed in terms of a Product Offering or a Product (for a change order).
swagger:model OrderItem
func (*OrderItem) ContextValidate ¶
ContextValidate validate this order item based on the context it is used
func (*OrderItem) MarshalBinary ¶
MarshalBinary interface implementation
func (*OrderItem) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this order item event based on the context it is used
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
type OrderItemPrice ¶
type OrderItemPrice struct { // Technical attribute to extend the class AtType string `json:"@type,omitempty"` // A narrative that explains in detail the semantics of yhis order item price Description string `json:"description,omitempty"` // Name of the product price // Required: true Name *string `json:"name"` // price // Required: true Price *Price `json:"price"` // price type // Required: true PriceType *PriceType `json:"priceType"` // recurring charge period RecurringChargePeriod ChargePeriod `json:"recurringChargePeriod,omitempty"` }
OrderItemPrice Structure used to define a product price. An order item could have 0-* order item price.
swagger:model OrderItemPrice
func (*OrderItemPrice) ContextValidate ¶
ContextValidate validate this order item price based on the context it is used
func (*OrderItemPrice) MarshalBinary ¶
func (m *OrderItemPrice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemPrice) UnmarshalBinary ¶
func (m *OrderItemPrice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OrderItemRelationShip ¶
type OrderItemRelationShip struct { // The id of the targeted order item by the relationship // Required: true ID *string `json:"id"` // Id of another product order if this relationship is between two distinct orders. ProductOrderID string `json:"productOrderId,omitempty"` // Indicates the type of order item relationship // Required: true Type *string `json:"type"` }
OrderItemRelationShip This class allows the ability to associate one order item to another order item.
swagger:model OrderItemRelationShip
func (*OrderItemRelationShip) ContextValidate ¶
ContextValidate validates this order item relation ship based on context it is used
func (*OrderItemRelationShip) MarshalBinary ¶
func (m *OrderItemRelationShip) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OrderItemRelationShip) UnmarshalBinary ¶
func (m *OrderItemRelationShip) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this order message based on the context it is used
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
type PoEvent ¶
type PoEvent struct { // event // Required: true Event *ProductOrderEvent `json:"event"` // event Id // Required: true EventID *string `json:"eventId"` // event time // Required: true // Format: date-time EventTime *strfmt.DateTime `json:"eventTime"` // event type // Required: true EventType *ProductOrderEventType `json:"eventType"` }
PoEvent Event class is used to describe information structure used for notification.
swagger:model PoEvent
func (*PoEvent) ContextValidate ¶
ContextValidate validate this po event based on the context it is used
func (*PoEvent) MarshalBinary ¶
MarshalBinary interface implementation
func (*PoEvent) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PoEventPlus ¶
type PoEventPlus struct { PoEvent // field path // Required: true FieldPath []string `json:"fieldPath"` // resource path // Required: true ResourcePath *string `json:"resourcePath"` }
PoEventPlus po event plus
swagger:model PoEventPlus
func (*PoEventPlus) ContextValidate ¶
ContextValidate validate this po event plus based on the context it is used
func (*PoEventPlus) MarshalBinary ¶
func (m *PoEventPlus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (PoEventPlus) MarshalJSON ¶
func (m PoEventPlus) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*PoEventPlus) UnmarshalBinary ¶
func (m *PoEventPlus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*PoEventPlus) UnmarshalJSON ¶
func (m *PoEventPlus) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
type PoQEventContainer ¶
type PoQEventContainer struct { // event // Required: true Event *PoqEvent `json:"event"` // Id of the event // Required: true EventID *string `json:"eventId"` // Datetime when the event occurred // Required: true // Format: date-time EventTime *strfmt.DateTime `json:"eventTime"` // event type // Required: true EventType *PoqEventType `json:"eventType"` }
PoQEventContainer Event class is used to describe information structure used for notification.
swagger:model PoQEventContainer
func (*PoQEventContainer) ContextValidate ¶
ContextValidate validate this po q event container based on the context it is used
func (*PoQEventContainer) MarshalBinary ¶
func (m *PoQEventContainer) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PoQEventContainer) UnmarshalBinary ¶
func (m *PoQEventContainer) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type PoqEvent ¶
type PoqEvent struct { // Link to the POQ Href string `json:"href,omitempty"` // The Serviceability Request's unique identifier. ID string `json:"id,omitempty"` }
PoqEvent The product offering qualification passed as the "event" in a notification.
swagger:model PoqEvent
func (*PoqEvent) ContextValidate ¶
ContextValidate validates this poq event based on context it is used
func (*PoqEvent) MarshalBinary ¶
MarshalBinary interface implementation
func (*PoqEvent) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type PoqEventType ¶
type PoqEventType string
PoqEventType Indicates the type of product offering qualification event.
swagger:model PoqEventType
const ( // PoqEventTypeProductOfferingQualificationCreateEventNotification captures enum value "ProductOfferingQualificationCreateEventNotification" PoqEventTypeProductOfferingQualificationCreateEventNotification PoqEventType = "ProductOfferingQualificationCreateEventNotification" // PoqEventTypeProductOfferingQualificationStateChangeEventNotification captures enum value "ProductOfferingQualificationStateChangeEventNotification" PoqEventTypeProductOfferingQualificationStateChangeEventNotification PoqEventType = "ProductOfferingQualificationStateChangeEventNotification" )
func NewPoqEventType ¶
func NewPoqEventType(value PoqEventType) *PoqEventType
func (PoqEventType) ContextValidate ¶
ContextValidate validates this poq event type based on context it is used
type PoqItemEvent ¶
type PoqItemEvent struct { // Desired Activation Date for the product requested in this item // Format: date DesiredActivationDate strfmt.Date `json:"desiredActivationDate,omitempty"` // Id of this POQ item // Required: true ID *string `json:"id"` // serviceability confidence ServiceabilityConfidence ServiceabilityColor `json:"serviceabilityConfidence,omitempty"` // state State QualificationState `json:"state,omitempty"` }
PoqItemEvent The product offering qualification item event structure that gets passed in the "event" of a notification.
swagger:model PoqItemEvent
func (*PoqItemEvent) ContextValidate ¶
ContextValidate validate this poq item event based on the context it is used
func (*PoqItemEvent) MarshalBinary ¶
func (m *PoqItemEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*PoqItemEvent) UnmarshalBinary ¶
func (m *PoqItemEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Price ¶
type Price struct { // Technical attribute to extend this class AtType string `json:"@type,omitempty"` // duty free amount DutyFreeAmount *Money `json:"dutyFreeAmount,omitempty"` // tax included amount TaxIncludedAmount *Money `json:"taxIncludedAmount,omitempty"` // Applied tax rate on amount TaxRate float32 `json:"taxRate,omitempty"` }
Price Provides pre tax amount for a product
swagger:model Price
func (*Price) ContextValidate ¶
ContextValidate validate this price based on the context it is used
func (*Price) MarshalBinary ¶
MarshalBinary interface implementation
func (*Price) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this price alteration based on the context it is used
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
type PriceRange ¶
type PriceRange struct { // max pre tax amount // Required: true MaxPreTaxAmount *Money `json:"maxPreTaxAmount"` // min pre tax amount // Required: true MinPreTaxAmount *Money `json:"minPreTaxAmount"` }
PriceRange PriceRange class allows to describe a range of price (Min/Max) for budgetary or indicative quote.
swagger:model PriceRange
func (*PriceRange) ContextValidate ¶
ContextValidate validate this price range based on the context it is used
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
type PriceType ¶
type PriceType string
PriceType price type
swagger:model PriceType
func NewPriceType ¶
func (PriceType) ContextValidate ¶
ContextValidate validates this price type based on context it is used
type PricingMethod ¶
type PricingMethod string
PricingMethod An enumeration of valid pricing methods for ordered items
swagger:model PricingMethod
const ( // PricingMethodTariff captures enum value "tariff" PricingMethodTariff PricingMethod = "tariff" // PricingMethodContract captures enum value "contract" PricingMethodContract PricingMethod = "contract" // PricingMethodIndividualCaseBasis captures enum value "individualCaseBasis" PricingMethodIndividualCaseBasis PricingMethod = "individualCaseBasis" // PricingMethodOther captures enum value "other" PricingMethodOther PricingMethod = "other" )
func NewPricingMethod ¶
func NewPricingMethod(value PricingMethod) *PricingMethod
func (PricingMethod) ContextValidate ¶
ContextValidate validates this pricing method based on context it is used
type Principal ¶
type Principal struct { // code Code int32 `json:"code,omitempty"` // reason Reason string `json:"reason,omitempty"` // roles Roles []string `json:"roles"` }
Principal principal
swagger:model Principal
func (*Principal) ContextValidate ¶
ContextValidate validates this principal based on context it is used
func (*Principal) MarshalBinary ¶
MarshalBinary interface implementation
func (*Principal) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Product ¶
type Product struct { // the Base Type of the product if specialization. // This is a technical attribute to extend this class. AtBaseType string `json:"@baseType,omitempty"` // A pointer to a file describing extension attributes (if used). // This is a technical attribute to extend this class. AtSchemaLocation string `json:"@schemaLocation,omitempty"` // The type of product if specialization AtType string `json:"@type,omitempty"` // agreement Agreement []*Agreement `json:"agreement"` // billing account BillingAccount []*BillingAccountRef `json:"billingAccount"` // This identifier is optionally provided during the Product ordering and stored for informative purpose in the Seller inventory. BuyerProductID string `json:"buyerProductId,omitempty"` // Reference of the product (link) Href string `json:"href,omitempty"` // Unique identifier of the product in the product domain. // Required: true ID *string `json:"id"` // Latest date when the product has been updated // Format: date-time LastUpdateDate strfmt.DateTime `json:"lastUpdateDate,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product order ProductOrder []*ProductOrderRef `json:"productOrder"` // product price ProductPrice []*ProductPrice `json:"productPrice"` // product relationship ProductRelationship []*ProductRelationship `json:"productRelationship"` // product specification ProductSpecification *ProductSpecificationRef `json:"productSpecification,omitempty"` // product term ProductTerm []*ProductTerm `json:"productTerm"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // site Site []*GeographicSite `json:"site"` // Start date is when the product is active for the first time (when the install in the product order has been processed). // Required: true // Format: date-time StartDate *strfmt.DateTime `json:"startDate"` // status // Required: true Status *ProductStatus `json:"status"` // status change StatusChange []*StatusChange `json:"statusChange"` // Termination date (commercial) is when the product has been terminated (when the disconnect in the product order has been processed). // Format: date-time TerminationDate strfmt.DateTime `json:"terminationDate,omitempty"` }
Product One or more services sold to a Buyer by a Seller. A particular Product Offering defines the technical and commercial attributes and behav-iors of a Product.
swagger:model Product
func (*Product) ContextValidate ¶
ContextValidate validate this product based on the context it is used
func (*Product) MarshalBinary ¶
MarshalBinary interface implementation
func (*Product) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ProductActionType ¶
type ProductActionType string
ProductActionType Action to be performed on the Product
swagger:model ProductActionType
const ( // ProductActionTypeAdd captures enum value "add" ProductActionTypeAdd ProductActionType = "add" // ProductActionTypeChange captures enum value "change" ProductActionTypeChange ProductActionType = "change" // ProductActionTypeRemove captures enum value "remove" ProductActionTypeRemove ProductActionType = "remove" // ProductActionTypeNoChange captures enum value "noChange" ProductActionTypeNoChange ProductActionType = "noChange" )
func NewProductActionType ¶
func NewProductActionType(value ProductActionType) *ProductActionType
func (ProductActionType) ContextValidate ¶
ContextValidate validates this product action type based on context it is used
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) ContextValidate ¶
ContextValidate validate this product event based on the context it is used
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
type ProductOfferingQualification ¶
type ProductOfferingQualification struct { // Technical attribute to extend the class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // Effective date seller provides qualification result. // Format: date-time EffectiveQualificationCompletionDate strfmt.DateTime `json:"effectiveQualificationCompletionDate,omitempty"` // The date the seller is expected to provide qualification result. // Format: date-time ExpectedResponseDate strfmt.DateTime `json:"expectedResponseDate,omitempty"` // Link to this POQ resource Href string `json:"href,omitempty"` // The Serviceability Request's unique identifier. // Required: true ID *string `json:"id"` // If this flag is set to Yes, Buyer requests to have instant qualificationto be provided in operation POST response InstantSyncQualification *bool `json:"instantSyncQualification,omitempty"` // product offering qualification item // Required: true // Min Items: 1 ProductOfferingQualificationItem []*ProductOfferingQualificationItem `json:"productOfferingQualificationItem"` // This value MAY be assigned by the Buyer/Seller to identify a project the serviceability request is associated with. ProjectID string `json:"projectId,omitempty"` // This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available. ProvideAlternative bool `json:"provideAlternative,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date-time RequestedResponseDate strfmt.DateTime `json:"requestedResponseDate,omitempty"` // state // Required: true State *ProductOfferingQualificationStateType `json:"state"` // state change StateChange []*StateChange `json:"stateChange"` }
ProductOfferingQualification A grouping of POQ Items formulated into a request made by a Buyer to a Seller
swagger:model ProductOfferingQualification
func (*ProductOfferingQualification) ContextValidate ¶
func (m *ProductOfferingQualification) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification based on the context it is used
func (*ProductOfferingQualification) MarshalBinary ¶
func (m *ProductOfferingQualification) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualification) UnmarshalBinary ¶
func (m *ProductOfferingQualification) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationCreate ¶
type ProductOfferingQualificationCreate struct { // Technical attribute to extend this class AtSchemaLocation string `json:"@schemaLocation,omitempty"` // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // If this flag is set to Yes, Buyer requests to have instant qualification to be provided in operation POST response InstantSyncQualification *bool `json:"instantSyncQualification,omitempty"` // product offering qualification item // Required: true // Min Items: 1 ProductOfferingQualificationItem []*ProductOfferingQualificationItemCreate `json:"productOfferingQualificationItem"` // This value MAY be assigned by the Buyer/Seller to identify a project the qualification request is associated with. ProjectID string `json:"projectId,omitempty"` // This Boolean allows requester (buyer) to indicate if he is willing to get alternate proposal if requested product not available. ProvideAlternative *bool `json:"provideAlternative,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date RequestedResponseDate strfmt.Date `json:"requestedResponseDate,omitempty"` }
ProductOfferingQualificationCreate This structure serves as a request for a product offering qualification. A POQ is a grouping of POQ Items formulated into a request made by a Buyer to a Seller
swagger:model ProductOfferingQualification_Create
func (*ProductOfferingQualificationCreate) ContextValidate ¶
func (m *ProductOfferingQualificationCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification create based on the context it is used
func (*ProductOfferingQualificationCreate) MarshalBinary ¶
func (m *ProductOfferingQualificationCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationCreate) UnmarshalBinary ¶
func (m *ProductOfferingQualificationCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationFind ¶
type ProductOfferingQualificationFind struct { // The Serviceability Request's unique identifier. ID string `json:"id,omitempty"` // This value MAY be assigned by the Buyer/Seller to identify a project the serviceability request is associated with. ProjectID string `json:"projectId,omitempty"` // Corresponds to desiredResponseDate - The date a response for the service request is desired. // Format: date RequestedResponseDate strfmt.Date `json:"requestedResponseDate,omitempty"` // state State ProductOfferingQualificationStateType `json:"state,omitempty"` }
ProductOfferingQualificationFind This class is used to describe attribute to be used for requesting POQ list (used in the GET by list)
swagger:model ProductOfferingQualification_Find
func (*ProductOfferingQualificationFind) ContextValidate ¶
func (m *ProductOfferingQualificationFind) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification find based on the context it is used
func (*ProductOfferingQualificationFind) MarshalBinary ¶
func (m *ProductOfferingQualificationFind) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationFind) UnmarshalBinary ¶
func (m *ProductOfferingQualificationFind) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItem ¶
type ProductOfferingQualificationItem struct { // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // action // Required: true Action *ProductActionType `json:"action"` // alternate product proposal AlternateProductProposal []*AlternateProductProposal `json:"alternateProductProposal"` // eligible product offering EligibleProductOffering []*ProductOfferingRef `json:"eligibleProductOffering"` // Date until seller is guaranted the qualification result. // Format: date-time GuaranteedUntilDate strfmt.DateTime `json:"guaranteedUntilDate,omitempty"` // Id of this POQ item // Required: true ID *string `json:"id"` // installation interval InstallationInterval *TimeInterval `json:"installationInterval,omitempty"` // product Product *Product `json:"product,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product offering qualification item relationship ProductOfferingQualificationItemRelationship []*ProductOfferingQualificationItemRelationship `json:"productOfferingQualificationItemRelationship"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // A description of the reason a particular color is being provided. This may include a specific standard reason codes and descriptions. ServiceConfidenceReason string `json:"serviceConfidenceReason,omitempty"` // serviceability confidence ServiceabilityConfidence ServiceabilityColor `json:"serviceabilityConfidence,omitempty"` // state // Required: true State *ProductOfferingQualificationItemStateType `json:"state"` // state change StateChange []*StateChange `json:"stateChange"` // termination error TerminationError []*TerminationError `json:"terminationError"` }
ProductOfferingQualificationItem An individual article included in a POQ that describes a Product of a particular type (Product Offering) being delivered to a specific geographical location. The objective is to determine if it is feasible for the Seller to deliver this item as described and for the Seller to inform the Buyer of the estimated time interval to complete this delivery.
swagger:model ProductOfferingQualificationItem
func (*ProductOfferingQualificationItem) ContextValidate ¶
func (m *ProductOfferingQualificationItem) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification item based on the context it is used
func (*ProductOfferingQualificationItem) MarshalBinary ¶
func (m *ProductOfferingQualificationItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItem) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemCreate ¶
type ProductOfferingQualificationItemCreate struct { // When sub-classing, this defines the sub-class entity name AtType string `json:"@type,omitempty"` // action Action ProductActionType `json:"action,omitempty"` // Id of the productOfferingQualification item. // This id must be unique within POQ create request // Required: true ID *string `json:"id"` // product // Required: true Product *Product `json:"product"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product offering qualification item relationship ProductOfferingQualificationItemRelationship []*ProductOfferingQualificationItemRelationship `json:"productOfferingQualificationItemRelationship"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` }
ProductOfferingQualificationItemCreate This structure serves as a request for a product offering qualification item An individual article included in a POQ that describes a Product of a particular type (Product Offering) being delivered to a specific geographical location. The objective is to determine if it is feasible for the Seller to deliver this item as described and for the Seller to inform the Buyer of the estimated time interval to complete this delivery.
swagger:model ProductOfferingQualificationItem_Create
func (*ProductOfferingQualificationItemCreate) ContextValidate ¶
func (m *ProductOfferingQualificationItemCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification item create based on the context it is used
func (*ProductOfferingQualificationItemCreate) MarshalBinary ¶
func (m *ProductOfferingQualificationItemCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItemCreate) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItemCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemRelationship ¶
type ProductOfferingQualificationItemRelationship struct { // id of the targeted POQ item // Required: true ID *string `json:"id"` // type // Required: true Type *RelationshipType `json:"type"` }
ProductOfferingQualificationItemRelationship The relationship between product offering qualification items that can be used to validate business rules between POQ Items
swagger:model ProductOfferingQualificationItemRelationship
func (*ProductOfferingQualificationItemRelationship) ContextValidate ¶
func (m *ProductOfferingQualificationItemRelationship) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product offering qualification item relationship based on the context it is used
func (*ProductOfferingQualificationItemRelationship) MarshalBinary ¶
func (m *ProductOfferingQualificationItemRelationship) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationItemRelationship) UnmarshalBinary ¶
func (m *ProductOfferingQualificationItemRelationship) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationItemStateType ¶
type ProductOfferingQualificationItemStateType string
ProductOfferingQualificationItemStateType POQ item states - The specific states are managed by the Seller based on its processing and/or based on Buyer's action.
swagger:model ProductOfferingQualificationItemStateType
const ( // ProductOfferingQualificationItemStateTypeDone captures enum value "done" ProductOfferingQualificationItemStateTypeDone ProductOfferingQualificationItemStateType = "done" // ProductOfferingQualificationItemStateTypeTerminatedWithErrorDotUnableToProvide captures enum value "terminatedWithError.unableToProvide" ProductOfferingQualificationItemStateTypeTerminatedWithErrorDotUnableToProvide ProductOfferingQualificationItemStateType = "terminatedWithError.unableToProvide" // ProductOfferingQualificationItemStateTypeTerminatedWithErrorDotInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" ProductOfferingQualificationItemStateTypeTerminatedWithErrorDotInsufficientInformationProvided ProductOfferingQualificationItemStateType = "terminatedWithError.insufficientInformationProvided" // ProductOfferingQualificationItemStateTypeInProgress captures enum value "inProgress" ProductOfferingQualificationItemStateTypeInProgress ProductOfferingQualificationItemStateType = "inProgress" )
func NewProductOfferingQualificationItemStateType ¶
func NewProductOfferingQualificationItemStateType(value ProductOfferingQualificationItemStateType) *ProductOfferingQualificationItemStateType
func (ProductOfferingQualificationItemStateType) ContextValidate ¶
func (m ProductOfferingQualificationItemStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this product offering qualification item state type based on context it is used
type ProductOfferingQualificationRef ¶
type ProductOfferingQualificationRef struct { // Technical attribute to extend this class AtReferredType string `json:"@referredType,omitempty"` // Link to the productOfferingQualification Href string `json:"href,omitempty"` // Id of the productOfferingQualification // Required: true ID *string `json:"id"` // Id of the item of the productOfferingQualification // Required: true QualificationItem *string `json:"qualificationItem"` }
ProductOfferingQualificationRef Reference to productOfferingQualification previously done to check requested product serviceability
swagger:model ProductOfferingQualificationRef
func (*ProductOfferingQualificationRef) ContextValidate ¶
func (m *ProductOfferingQualificationRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this product offering qualification ref based on context it is used
func (*ProductOfferingQualificationRef) MarshalBinary ¶
func (m *ProductOfferingQualificationRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingQualificationRef) UnmarshalBinary ¶
func (m *ProductOfferingQualificationRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOfferingQualificationStateType ¶
type ProductOfferingQualificationStateType string
ProductOfferingQualificationStateType These values represent the valid states through which the product offering qualification can transition
swagger:model ProductOfferingQualificationStateType
const ( // ProductOfferingQualificationStateTypeDone captures enum value "done" ProductOfferingQualificationStateTypeDone ProductOfferingQualificationStateType = "done" // ProductOfferingQualificationStateTypeTerminatedWithErrorDotUnableToProvide captures enum value "terminatedWithError.unableToProvide" ProductOfferingQualificationStateTypeTerminatedWithErrorDotUnableToProvide ProductOfferingQualificationStateType = "terminatedWithError.unableToProvide" // ProductOfferingQualificationStateTypeTerminatedWithErrorDotInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" ProductOfferingQualificationStateTypeTerminatedWithErrorDotInsufficientInformationProvided ProductOfferingQualificationStateType = "terminatedWithError.insufficientInformationProvided" // ProductOfferingQualificationStateTypeInProgress captures enum value "inProgress" ProductOfferingQualificationStateTypeInProgress ProductOfferingQualificationStateType = "inProgress" )
func NewProductOfferingQualificationStateType ¶
func NewProductOfferingQualificationStateType(value ProductOfferingQualificationStateType) *ProductOfferingQualificationStateType
func (ProductOfferingQualificationStateType) ContextValidate ¶
func (m ProductOfferingQualificationStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this product offering qualification state type based on context it is used
type ProductOfferingRef ¶
type ProductOfferingRef struct { // A unique product offering identifier. This identifier is provided by the seller and communicated to the buyer during the on-boarding process. // Required: true ID *string `json:"id"` }
ProductOfferingRef The commercial and technical details of a Product sold by a particular Seller. A Product Offering defines all of the commercial terms and, through association with a particular Product Specification, defines all the technical attributes and behaviors of the Product. A Product Offering may constrain the allowable set of configurable technical attributes and/or behaviors specified in the associated Product Specification
swagger:model ProductOfferingRef
func (*ProductOfferingRef) ContextValidate ¶
ContextValidate validates this product offering ref based on context it is used
func (*ProductOfferingRef) MarshalBinary ¶
func (m *ProductOfferingRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOfferingRef) UnmarshalBinary ¶
func (m *ProductOfferingRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOrder ¶
type ProductOrder struct { // Technical attribute to extend the API AtBaseType string `json:"@baseType,omitempty"` // Technical attribute to extend the API AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend the API AtType string `json:"@type,omitempty"` // billing account BillingAccount *BillingAccountRef `json:"billingAccount,omitempty"` // Buyer order creation date. Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00) // Format: date-time BuyerRequestDate strfmt.DateTime `json:"buyerRequestDate,omitempty"` // Identifies the date the Seller canceled the Order // Format: date-time CancellationDate strfmt.DateTime `json:"cancellationDate,omitempty"` // Indicates reason why buyer requested cancellation CancellationReason string `json:"cancellationReason,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"` // desired responses // Required: true DesiredResponses *DesiredOrderResponses `json:"desiredResponses"` // Expected delivery date amended by the provider // Format: date-time ExpectedCompletionDate strfmt.DateTime `json:"expectedCompletionDate,omitempty"` // Indicates that expedited treatment is requested and any charges generated in provisioning this request (e.g., additional engineering charges or labor charges if applicable) will be accepted by the buyer. ExpeditePriority bool `json:"expeditePriority,omitempty"` // A number that uniquely identifies an order within the buyer's enterprise. // Required: true ExternalID *string `json:"externalId"` // Hyperlink to access the order // Required: true Href *string `json:"href"` // 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 activity // Required: true OrderActivity *OrderActivity `json:"orderActivity"` // Date when the order was created by seller. Format is YYYY-MM-DDThh:mmTZD (e.g. 1997-07-16T19:20+01:00) // Required: true // Format: date-time OrderDate *strfmt.DateTime `json:"orderDate"` // order item // Required: true // Min Items: 1 OrderItem []*OrderItem `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"` // pricing method PricingMethod PricingMethod `json:"pricingMethod,omitempty"` // The identifier references the previously agreed upon pricing terms, as applicable, based on the pricingMethod (e.g. a contract id or tariff id. PricingReference string `json:"pricingReference,omitempty"` // The length of the contract in months. PricingTerm int32 `json:"pricingTerm,omitempty"` // An integer that specifies that expedited treatment is to be provided in a specific priority. // This field will be ignored if the Expedite/Priority Indicator is False. // The valid values and the business/operational rules for this field will be defined by the Seller as part of the contracting or on-boarding process. Priority int32 `json:"priority,omitempty"` // An identifier that is used to group Orders that is important to the Buyer. A ProjectId can be used to relate multiple Orders together ProjectID string `json:"projectId,omitempty"` // Related Buyer Purchase Order Number (RPON) RelatedBuyerPON string `json:"relatedBuyerPON,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"` // state change StateChange []*StateChange `json:"stateChange"` // Within the United States, indicates the provisioning and restoration priority as defined under the TSP Service Vendor Handbook, The valid values are defined in ATIS OBF document: ATIS-0404001 TspRestorationPriority string `json:"tspRestorationPriority,omitempty"` }
ProductOrder A ProductOrder is a type of business interaction that is used to procure a Product based upon a Product Offering.
swagger:model ProductOrder
func (*ProductOrder) ContextValidate ¶
ContextValidate validate this product order based on the context it is used
func (*ProductOrder) MarshalBinary ¶
func (m *ProductOrder) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrder) UnmarshalBinary ¶
func (m *ProductOrder) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOrderCreate ¶
type ProductOrderCreate struct { // Technical attribute to extend API AtBaseType string `json:"@baseType,omitempty"` // Technical attribute to extend API AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend API AtType string `json:"@type,omitempty"` // billing account BillingAccount *BillingAccountRef `json:"billingAccount,omitempty"` // Date when the order was submitted by the Buyer to the Seller // Required: true // Format: date-time BuyerRequestDate *strfmt.DateTime `json:"buyerRequestDate"` // desired response // Required: true DesiredResponse *DesiredOrderResponses `json:"desiredResponse"` // Indicates that expedited treatment is requested and any charges generated in provisioning this request (e.g., additional engineering charges or labor charges if applicable) will be accepted by the buyer. ExpeditePriority bool `json:"expeditePriority,omitempty"` // Buyer Purchase Order Number: A number that uniquely identifies an order within the Buyer's enterprise // Required: true ExternalID *string `json:"externalId"` // note Note []*Note `json:"note"` // order activity // Required: true OrderActivity *OrderActivity `json:"orderActivity"` // order item // Required: true // Min Items: 1 OrderItem []*ProductOrderItemCreate `json:"orderItem"` // Buyer Order Version: The version number that the Buyer uses to refer to this particular version of the order. // Required: true OrderVersion *string `json:"orderVersion"` // pricing method PricingMethod PricingMethod `json:"pricingMethod,omitempty"` // The identifier references the previously agreed upon pricing terms, as applicable, based on the pricingMethod (e.g. a contract id or tariff id. PricingReference string `json:"pricingReference,omitempty"` // The length of the contract in months PricingTerm int32 `json:"pricingTerm,omitempty"` // An integer that specifies that expedited treatment is to be provided in a specific priority. Priority int32 `json:"priority,omitempty"` // An identifier that is used to group Orders that is important to the Buyer. A ProjectId can be used to relate multiple Orders together. ProjectID string `json:"projectId,omitempty"` // Related Buyer Purchase Order Number (RPON) - Identifies the Buyer Purchase Order Number that is related to this order. RelatedBuyerPON string `json:"relatedBuyerPON,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // Identifies the Buyer's desired due date (requested delivery date) // Required: true // Format: date-time RequestedCompletionDate *strfmt.DateTime `json:"requestedCompletionDate"` // If specified, identifies the Buyer's desired date for order processing to start // Format: date-time RequestedStartDate strfmt.DateTime `json:"requestedStartDate,omitempty"` // Within the United States, indicates the provisioning and restoration priority as defined under the TSP Service Vendor Handbook. TspRestorationPriority string `json:"tspRestorationPriority,omitempty"` }
ProductOrderCreate A CreateProductOrder object is provided as input to the product order create operation.
swagger:model ProductOrder_Create
func (*ProductOrderCreate) ContextValidate ¶
ContextValidate validate this product order create based on the context it is used
func (*ProductOrderCreate) MarshalBinary ¶
func (m *ProductOrderCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrderCreate) UnmarshalBinary ¶
func (m *ProductOrderCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this product order event based on the context it is used
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
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 NewProductOrderEventType ¶
func NewProductOrderEventType(value ProductOrderEventType) *ProductOrderEventType
func (ProductOrderEventType) ContextValidate ¶
ContextValidate validates this product order event type based on context it is used
type ProductOrderItemCreate ¶
type ProductOrderItemCreate struct { // Technical attribute to extend API AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Technical attribute to extend API 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"` // order item price // Min Items: 1 OrderItemPrice []*OrderItemPrice `json:"orderItemPrice"` // order item relationship OrderItemRelationship []*OrderItemRelationShip `json:"orderItemRelationship"` // pricing method PricingMethod PricingMethod `json:"pricingMethod,omitempty"` // The identifier references the previously agreed upon pricing terms, as applicable, based on the pricingMethod (e.g. a contract id or tariff id. PricingReference string `json:"pricingReference,omitempty"` // The length of the contract in months // Minimum: 0 PricingTerm *int32 `json:"pricingTerm,omitempty"` // product Product *Product `json:"product,omitempty"` // product offering // Required: true ProductOffering *ProductOfferingRef `json:"productOffering"` // qualification Qualification *QualificationRef `json:"qualification,omitempty"` // quote Quote *QuoteRef `json:"quote,omitempty"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` }
ProductOrderItemCreate A ProductOrderItem_Create object is provided as input to the product order item create operation.
swagger:model ProductOrderItem_Create
func (*ProductOrderItemCreate) ContextValidate ¶
func (m *ProductOrderItemCreate) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product order item create based on the context it is used
func (*ProductOrderItemCreate) MarshalBinary ¶
func (m *ProductOrderItemCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrderItemCreate) UnmarshalBinary ¶
func (m *ProductOrderItemCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOrderItemStateType ¶
type ProductOrderItemStateType string
ProductOrderItemStateType An enumeration of valid order item statuses.
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" // ProductOrderItemStateTypeAssesssingCancellation captures enum value "assesssingCancellation" ProductOrderItemStateTypeAssesssingCancellation ProductOrderItemStateType = "assesssingCancellation" // ProductOrderItemStateTypePendingCancellation captures enum value "pendingCancellation" ProductOrderItemStateTypePendingCancellation ProductOrderItemStateType = "pendingCancellation" // ProductOrderItemStateTypeCancelled captures enum value "cancelled" ProductOrderItemStateTypeCancelled ProductOrderItemStateType = "cancelled" // ProductOrderItemStateTypeInProgressDotConfigured captures enum value "inProgress.configured" ProductOrderItemStateTypeInProgressDotConfigured ProductOrderItemStateType = "inProgress.configured" // ProductOrderItemStateTypeFailed captures enum value "failed" ProductOrderItemStateTypeFailed ProductOrderItemStateType = "failed" // ProductOrderItemStateTypeCompleted captures enum value "completed" ProductOrderItemStateTypeCompleted ProductOrderItemStateType = "completed" )
func NewProductOrderItemStateType ¶
func NewProductOrderItemStateType(value ProductOrderItemStateType) *ProductOrderItemStateType
func (ProductOrderItemStateType) ContextValidate ¶
func (m ProductOrderItemStateType) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this product order item state type based on context it is used
type ProductOrderRef ¶
type ProductOrderRef struct { // Hyperlink to the productOrder Href string `json:"href,omitempty"` // Identifier of the productOrder(provided by the seller) // Required: true ID *string `json:"id"` // Identifier of the line item (generally it is a sequence number 01, 02, 03, ...) // Required: true OrderItemID *string `json:"orderItemId"` }
ProductOrderRef A reference to a productOrder and optionally to an order item.
swagger:model ProductOrderRef
func (*ProductOrderRef) ContextValidate ¶
ContextValidate validates this product order ref based on context it is used
func (*ProductOrderRef) MarshalBinary ¶
func (m *ProductOrderRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrderRef) UnmarshalBinary ¶
func (m *ProductOrderRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOrderRefCancel ¶
type ProductOrderRefCancel struct { // Technical attribute to extend the API AtReferredType string `json:"@referredType,omitempty"` // A number that uniquely identifies an order within the buyer's enterprise. // Must be provided if provided when the order was initially accepted ExternalID string `json:"externalId,omitempty"` // Hyperlink to access the order Href string `json:"href,omitempty"` // 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"` // state State ProductOrderStateType `json:"state,omitempty"` // The version number that the Buyer uses to refer to this particular version of the order. // This not checked for conformance (informative information) Version string `json:"version,omitempty"` }
ProductOrderRefCancel A reference to a product order used to perform cancellation request.
swagger:model ProductOrderRefCancel
func (*ProductOrderRefCancel) ContextValidate ¶
ContextValidate validate this product order ref cancel based on the context it is used
func (*ProductOrderRefCancel) MarshalBinary ¶
func (m *ProductOrderRefCancel) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrderRefCancel) UnmarshalBinary ¶
func (m *ProductOrderRefCancel) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductOrderStateType ¶
type ProductOrderStateType string
ProductOrderStateType An enumeration of valid order states
swagger:model ProductOrderStateType
const ( // ProductOrderStateTypeAcknowledged captures enum value "acknowledged" ProductOrderStateTypeAcknowledged ProductOrderStateType = "acknowledged" // ProductOrderStateTypeRejected captures enum value "rejected" ProductOrderStateTypeRejected ProductOrderStateType = "rejected" // ProductOrderStateTypeInProgress captures enum value "inProgress" ProductOrderStateTypeInProgress ProductOrderStateType = "inProgress" // ProductOrderStateTypePending captures enum value "pending" ProductOrderStateTypePending ProductOrderStateType = "pending" // ProductOrderStateTypeHeld captures enum value "held" ProductOrderStateTypeHeld ProductOrderStateType = "held" // ProductOrderStateTypeAssessingCancellation captures enum value "assessingCancellation" ProductOrderStateTypeAssessingCancellation ProductOrderStateType = "assessingCancellation" // ProductOrderStateTypePendingCancellation captures enum value "pendingCancellation" ProductOrderStateTypePendingCancellation ProductOrderStateType = "pendingCancellation" // ProductOrderStateTypeCancelled captures enum value "cancelled" ProductOrderStateTypeCancelled ProductOrderStateType = "cancelled" // ProductOrderStateTypeInProgressDotConfigured captures enum value "inProgress.configured" ProductOrderStateTypeInProgressDotConfigured ProductOrderStateType = "inProgress.configured" // ProductOrderStateTypeInProgressDotConfirmed captures enum value "inProgress.confirmed" ProductOrderStateTypeInProgressDotConfirmed ProductOrderStateType = "inProgress.confirmed" // ProductOrderStateTypeInProgressDotJeopardy captures enum value "inProgress.jeopardy" ProductOrderStateTypeInProgressDotJeopardy ProductOrderStateType = "inProgress.jeopardy" // ProductOrderStateTypeFailed captures enum value "failed" ProductOrderStateTypeFailed ProductOrderStateType = "failed" // ProductOrderStateTypePartial captures enum value "partial" ProductOrderStateTypePartial ProductOrderStateType = "partial" // ProductOrderStateTypeCompleted captures enum value "completed" ProductOrderStateTypeCompleted ProductOrderStateType = "completed" )
func NewProductOrderStateType ¶
func NewProductOrderStateType(value ProductOrderStateType) *ProductOrderStateType
func (ProductOrderStateType) ContextValidate ¶
ContextValidate validates this product order state type based on context it is used
type ProductOrderSummary ¶
type ProductOrderSummary struct { // ID given by the consumer and only understandable by him (to facilitate his searches afterwards). // MEF: Buyer Purchase Order Number // Required: true ExternalID *string `json:"externalId"` // ID created on repository side (OM system) // MEF: Unique identifier for the order that is generated by the Seller when the order is initially accepted via an API. // Required: true ID *string `json:"id"` // Date when the order was created // Required: true // Format: date-time OrderDate *strfmt.DateTime `json:"orderDate"` // state // Required: true State *ProductOrderStateType `json:"state"` }
ProductOrderSummary Structure to define GET without id response. A list of productOrder matching request criteria. Provides Product order summary view.
swagger:model ProductOrderSummary
func (*ProductOrderSummary) ContextValidate ¶
ContextValidate validate this product order summary based on the context it is used
func (*ProductOrderSummary) MarshalBinary ¶
func (m *ProductOrderSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductOrderSummary) UnmarshalBinary ¶
func (m *ProductOrderSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductPrice ¶
type ProductPrice struct { // A technical attribute to extend the class AtType string `json:"@type,omitempty"` // A narrative that explains in detail the semantics of this product price Description string `json:"description,omitempty"` // A short descriptive name such as "Subscription price" // Required: true Name *string `json:"name"` // price Price *Price `json:"price,omitempty"` // price type PriceType PriceType `json:"priceType,omitempty"` // recurring charge period RecurringChargePeriod ChargePeriod `json:"recurringChargePeriod,omitempty"` // Unit of Measure, if price depends on it (like Gb for example) UnitOfMeasure string `json:"unitOfMeasure,omitempty"` }
ProductPrice Price of the product
swagger:model ProductPrice
func (*ProductPrice) ContextValidate ¶
ContextValidate validate this product price based on the context it is used
func (*ProductPrice) MarshalBinary ¶
func (m *ProductPrice) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductPrice) UnmarshalBinary ¶
func (m *ProductPrice) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductRef ¶
type ProductRef struct { // Targeted Buyer product id - Informative BuyerProductID string `json:"buyerProductId,omitempty"` // Reference of the product Href string `json:"href,omitempty"` // Unique identifier of the product // Required: true ID *string `json:"id"` }
ProductRef Product reference used to describe product relationship.
swagger:model ProductRef
func (*ProductRef) ContextValidate ¶
ContextValidate validates this product ref based on context it is used
func (*ProductRef) MarshalBinary ¶
func (m *ProductRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductRef) UnmarshalBinary ¶
func (m *ProductRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductRelationship ¶
type ProductRelationship struct { // product // Required: true Product *ProductRef `json:"product"` // Indicates whether the type of relationship is "bundled", "reliesOn", or "comesFrom" // Required: true Type *string `json:"type"` }
ProductRelationship A product has relationships to other products.
swagger:model ProductRelationship
func (*ProductRelationship) ContextValidate ¶
ContextValidate validate this product relationship based on the context it is used
func (*ProductRelationship) MarshalBinary ¶
func (m *ProductRelationship) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductRelationship) UnmarshalBinary ¶
func (m *ProductRelationship) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type 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) ContextValidate ¶
ContextValidate validate this product specification based on the context it is used
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
type ProductSpecificationRef ¶
type ProductSpecificationRef struct { // describing Describing *Describing `json:"describing,omitempty"` // A unique identifier of the product spec. // Required: true ID *string `json:"id"` }
ProductSpecificationRef A structured set of well-defined technical attributes and/or behaviors that are used to construct a Product Offering for sale to a market.
swagger:model ProductSpecificationRef
func (*ProductSpecificationRef) ContextValidate ¶
func (m *ProductSpecificationRef) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this product specification ref based on the context it is used
func (*ProductSpecificationRef) MarshalBinary ¶
func (m *ProductSpecificationRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductSpecificationRef) UnmarshalBinary ¶
func (m *ProductSpecificationRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductSpecificationSummary ¶
type ProductSpecificationSummary struct { // Unique identifier of the product specification // Required: true ID *string `json:"id"` }
ProductSpecificationSummary Technical class to provide productSpecification id in the summary view
swagger:model ProductSpecificationSummary
func (*ProductSpecificationSummary) ContextValidate ¶
func (m *ProductSpecificationSummary) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this product specification summary based on context it is used
func (*ProductSpecificationSummary) MarshalBinary ¶
func (m *ProductSpecificationSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductSpecificationSummary) UnmarshalBinary ¶
func (m *ProductSpecificationSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductStatus ¶
type ProductStatus string
ProductStatus The state of the product in accordance with the product lifecycle.
swagger:model ProductStatus
const ( // ProductStatusActive captures enum value "active" ProductStatusActive ProductStatus = "active" // ProductStatusSuspended captures enum value "suspended" ProductStatusSuspended ProductStatus = "suspended" // ProductStatusActivePendingTerminate captures enum value "activePendingTerminate" ProductStatusActivePendingTerminate ProductStatus = "activePendingTerminate" // ProductStatusTerminated captures enum value "terminated" ProductStatusTerminated ProductStatus = "terminated" // ProductStatusPendingActive captures enum value "pendingActive" ProductStatusPendingActive ProductStatus = "pendingActive" // ProductStatusSuspendedPendingTerminate captures enum value "suspendedPendingTerminate" ProductStatusSuspendedPendingTerminate ProductStatus = "suspendedPendingTerminate" )
func NewProductStatus ¶
func NewProductStatus(value ProductStatus) *ProductStatus
func (ProductStatus) ContextValidate ¶
ContextValidate validates this product status based on context it is used
type ProductSummary ¶
type ProductSummary struct { // This identifier is optionally provided during the product ordering and stored for informative purpose in the seller inventory BuyerProductID string `json:"buyerProductId,omitempty"` // Reference of the product Href string `json:"href,omitempty"` // Unique identifier of the product // Required: true ID *string `json:"id"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // product specification ProductSpecification *ProductSpecificationSummary `json:"productSpecification,omitempty"` // The date from which the product starts // Format: date-time StartDate strfmt.DateTime `json:"startDate,omitempty"` // status // Required: true Status *ProductStatus `json:"status"` }
ProductSummary Class used to provide product overview retrieved in GET (by list) operation
swagger:model ProductSummary
func (*ProductSummary) ContextValidate ¶
ContextValidate validate this product summary based on the context it is used
func (*ProductSummary) MarshalBinary ¶
func (m *ProductSummary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductSummary) UnmarshalBinary ¶
func (m *ProductSummary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ProductTerm ¶
type ProductTerm struct { // Description of the commitment Description string `json:"description,omitempty"` // duration Duration *Quantity `json:"duration,omitempty"` // Name of the commitment Name string `json:"name,omitempty"` // valid for ValidFor *TimePeriod `json:"validFor,omitempty"` }
ProductTerm Indicate a commitment term associated to the product
swagger:model ProductTerm
func (*ProductTerm) ContextValidate ¶
ContextValidate validate this product term based on the context it is used
func (*ProductTerm) MarshalBinary ¶
func (m *ProductTerm) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ProductTerm) UnmarshalBinary ¶
func (m *ProductTerm) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QualificationRef ¶
type QualificationRef struct { // Technical attribute to extend the API AtReferredType string `json:"@referredType,omitempty"` // Hyperlink to the qualification previously done for this item Href string `json:"href,omitempty"` // id of the qualification previously done for this item ID string `json:"id,omitempty"` // item id of the qualification previously done for this item QualificationItem string `json:"qualificationItem,omitempty"` }
QualificationRef Using to refer a serviceability request previously done
swagger:model QualificationRef
func (*QualificationRef) ContextValidate ¶
ContextValidate validates this qualification ref based on context it is used
func (*QualificationRef) MarshalBinary ¶
func (m *QualificationRef) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QualificationRef) UnmarshalBinary ¶
func (m *QualificationRef) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QualificationState ¶
type QualificationState string
QualificationState These values represent the valid states through which the product offering qualification can transition
swagger:model QualificationState
const ( // QualificationStateInProgress captures enum value "inProgress" QualificationStateInProgress QualificationState = "inProgress" // QualificationStateDone captures enum value "done" QualificationStateDone QualificationState = "done" // QualificationStateTerminatedWithErrorDotUnableToProvide captures enum value "terminatedWithError.unableToProvide" QualificationStateTerminatedWithErrorDotUnableToProvide QualificationState = "terminatedWithError.unableToProvide" // QualificationStateTerminatedWithErrorDotInsufficientInformationProvided captures enum value "terminatedWithError.insufficientInformationProvided" QualificationStateTerminatedWithErrorDotInsufficientInformationProvided QualificationState = "terminatedWithError.insufficientInformationProvided" )
func NewQualificationState ¶
func NewQualificationState(value QualificationState) *QualificationState
func (QualificationState) ContextValidate ¶
ContextValidate validates this qualification state based on context it is used
type Quantity ¶
type Quantity struct { // Numeric value in a given unit Amount float32 `json:"amount,omitempty"` // Unit Units string `json:"units,omitempty"` }
Quantity An amount in a given unit
swagger:model Quantity
func (*Quantity) ContextValidate ¶
ContextValidate validates this quantity based on context it is used
func (*Quantity) MarshalBinary ¶
MarshalBinary interface implementation
func (*Quantity) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Quote ¶
type Quote 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"` // agreement Agreement []*AgreementRef `json:"agreement"` // Description of the quote Description string `json:"description,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"` // Unique (within the quoting domain) identifier for the quote, as attributed by the quoting system ID string `json:"id,omitempty"` // If this flag is set to Yes, Buyer requests to have instant quoting to be provided in operation POST response // Required: true InstantSyncQuoting bool `json:"instantSyncQuoting"` // note Note []*Note `json:"note"` // This value MAY be assigned by the Buyer/Seller to identify a project the quoting request is associated with. ProjectID string `json:"projectId,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 // Required: true QuoteLevel *QuoteLevel `json:"quoteLevel"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // 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 // Required: true State *QuoteStateType `json:"state"` // valid for ValidFor *TimePeriod `json:"validFor,omitempty"` }
Quote A quote which can be used to negotiate service and product acquisition or modification between a customer and a service provider
swagger:model Quote
func (*Quote) ContextValidate ¶
ContextValidate validate this quote based on the context it is used
func (*Quote) MarshalBinary ¶
MarshalBinary interface implementation
func (*Quote) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type QuoteChangeState ¶
type QuoteChangeState string
QuoteChangeState Quote state change 'request able' by buyer
swagger:model QuoteChangeState
const ( // QuoteChangeStateCANCELLED captures enum value "CANCELLED" QuoteChangeStateCANCELLED QuoteChangeState = "CANCELLED" // QuoteChangeStateREJECTED captures enum value "REJECTED" QuoteChangeStateREJECTED QuoteChangeState = "REJECTED" )
func NewQuoteChangeState ¶
func NewQuoteChangeState(value QuoteChangeState) *QuoteChangeState
func (QuoteChangeState) ContextValidate ¶
ContextValidate validates this quote change state based on context it is used
type QuoteCreate ¶
type QuoteCreate struct { // Indicates the base (class) type of the quote. AtBaseType string `json:"@baseType,omitempty"` // Link to the schema describing the REST resource. // Technical attribute to extend this class. AtSchemaLocation string `json:"@schemaLocation,omitempty"` // Indicates the (class) type of the quote. // Technical attribute to extend this class. AtType string `json:"@type,omitempty"` // agreement Agreement []*AgreementRef `json:"agreement"` // Description of the quote Description string `json:"description,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"` // ID given by the consumer and only understandable by him (to facilitate his searches afterwards) ExternalID string `json:"externalId,omitempty"` // If this flag is set to Yes, Buyer requests to have instant quoting to be provided in operation POST response InstantSyncQuoting *bool `json:"instantSyncQuoting,omitempty"` // note Note []*Note `json:"note"` // This value MAY be assigned by the Buyer/Seller to identify a project the quoting request is associated with. ProjectID string `json:"projectId,omitempty"` // quote item // Required: true QuoteItem []*QuoteItemCreate `json:"quoteItem"` // quote level QuoteLevel QuoteLevel `json:"quoteLevel,omitempty"` // related party // Required: true RelatedParty []*RelatedParty `json:"relatedParty"` // This is the date wished by the requester to have the quote completed (meaning priced). // This attribute is not considered when instantSyncQuoting is set to Yes. // Required: true // Format: date-time RequestedQuoteCompletionDate *strfmt.DateTime `json:"requestedQuoteCompletionDate"` }
QuoteCreate This structure is used only in the POST operation for the request.
swagger:model Quote_Create
func (*QuoteCreate) ContextValidate ¶
ContextValidate validate this quote create based on the context it is used
func (*QuoteCreate) MarshalBinary ¶
func (m *QuoteCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QuoteCreate) UnmarshalBinary ¶
func (m *QuoteCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QuoteEvent ¶
type QuoteEvent struct { // event // Required: true Event *QuoteSummaryView `json:"event"` // Id of the event // Required: true EventID *string `json:"eventId"` // Datetime when the event occurred // Required: true // Format: date-time EventTime *strfmt.DateTime `json:"eventTime"` // event type // Required: true EventType *QuoteEventType `json:"eventType"` }
QuoteEvent Event class is used to describe information structure used for notification.
swagger:model QuoteEvent
func (*QuoteEvent) ContextValidate ¶
ContextValidate validate this quote event based on the context it is used
func (*QuoteEvent) MarshalBinary ¶
func (m *QuoteEvent) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QuoteEvent) UnmarshalBinary ¶
func (m *QuoteEvent) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type QuoteEventPlus ¶
type QuoteEventPlus struct { QuoteEvent // field path // Required: true FieldPath []string `json:"fieldPath"` // resource path // Required: true ResourcePath *string `json:"resourcePath"` }
QuoteEventPlus quote event plus
swagger:model QuoteEventPlus
func (*QuoteEventPlus) ContextValidate ¶
ContextValidate validate this quote event plus based on the context it is used
func (*QuoteEventPlus) MarshalBinary ¶
func (m *QuoteEventPlus) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (QuoteEventPlus) MarshalJSON ¶
func (m QuoteEventPlus) MarshalJSON() ([]byte, error)
MarshalJSON marshals this object to a JSON structure
func (*QuoteEventPlus) UnmarshalBinary ¶
func (m *QuoteEventPlus) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
func (*QuoteEventPlus) UnmarshalJSON ¶
func (m *QuoteEventPlus) UnmarshalJSON(raw []byte) error
UnmarshalJSON unmarshals this object from a JSON structure
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 NewQuoteEventType ¶
func NewQuoteEventType(value QuoteEventType) *QuoteEventType
func (QuoteEventType) ContextValidate ¶
ContextValidate validates this quote event type based on context it is used
type QuoteFind ¶
type QuoteFind struct { // Description of the quote Description string `json:"description,omitempty"` // Date when the quoted was Cancelled or Rejected or Accepted // Format: date-time EffectiveQuoteCompletionDate strfmt.DateTime `json:"effectiveQuoteCompletionDate,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"` // This value MAY be assigned by the Buyer/Seller to identify a project the quoting request is associated with. ProjectID string `json:"projectId,omitempty"` // Date when the quote was created // Format: date-time QuoteDate strfmt.DateTime `json:"quoteDate,omitempty"` // quote level QuoteLevel QuoteLevel `json:"quoteLevel,omitempty"` // 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 QuoteStateType `json:"state,omitempty"` }
QuoteFind Quote Summary view is provided in the response of the GET(LIST) quote. Only a subset of information are provided.
swagger:model Quote_Find
func (*QuoteFind) ContextValidate ¶
ContextValidate validate this quote find based on the context it is used
func (*QuoteFind) MarshalBinary ¶
MarshalBinary interface implementation
func (*QuoteFind) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 *ProductActionType `json:"action"` // Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...). // Required: true ID *string `json:"id"` // note Note []*Note `json:"note"` // product Product *Product `json:"product,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // qualification Qualification []*ProductOfferingQualificationRef `json:"qualification"` // quote item price QuoteItemPrice []*QuotePrice `json:"quoteItemPrice"` // quote item relationship QuoteItemRelationship []*QuoteItemRelationship `json:"quoteItemRelationship"` // quote item term QuoteItemTerm *ItemTerm `json:"quoteItemTerm,omitempty"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // requested quote item term RequestedQuoteItemTerm *ItemTerm `json:"requestedQuoteItemTerm,omitempty"` // state // Required: true State *QuoteItemStateType `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) ContextValidate ¶
ContextValidate validate this quote item based on the context it is used
func (*QuoteItem) MarshalBinary ¶
MarshalBinary interface implementation
func (*QuoteItem) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 NewQuoteItemAction ¶
func NewQuoteItemAction(value QuoteItemAction) *QuoteItemAction
func (QuoteItemAction) ContextValidate ¶
ContextValidate validates this quote item action based on context it is used
type QuoteItemCreate ¶
type QuoteItemCreate 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 *ProductActionType `json:"action"` // Identifier of the quote item (generally it is a sequence number 01, 02, 03, ...). // Required: true ID *string `json:"id"` // note Note []*Note `json:"note"` // product Product *Product `json:"product,omitempty"` // product offering ProductOffering *ProductOfferingRef `json:"productOffering,omitempty"` // qualification Qualification *ProductOfferingQualificationRef `json:"qualification,omitempty"` // quote item relationship QuoteItemRelationship []*QuoteItemRelationship `json:"quoteItemRelationship"` // related party RelatedParty []*RelatedParty `json:"relatedParty"` // requested quote item term RequestedQuoteItemTerm *ItemTerm `json:"requestedQuoteItemTerm,omitempty"` }
QuoteItemCreate This structure is used to describe Quote item only in the POST operation for the request.
swagger:model QuoteItem_Create
func (*QuoteItemCreate) ContextValidate ¶
ContextValidate validate this quote item create based on the context it is used
func (*QuoteItemCreate) MarshalBinary ¶
func (m *QuoteItemCreate) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*QuoteItemCreate) UnmarshalBinary ¶
func (m *QuoteItemCreate) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
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) ContextValidate ¶
ContextValidate validate this quote item relationship based on the context it is used
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
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 NewQuoteItemState ¶
func NewQuoteItemState(value QuoteItemState) *QuoteItemState
func (QuoteItemState) ContextValidate ¶
ContextValidate validates this quote item state based on context it is used
type QuoteItemStateType ¶
type QuoteItemStateType string
QuoteItemStateType Valid quote item state enumeration
swagger:model QuoteItemStateType
const ( // QuoteItemStateTypeINPROGRESS captures enum value "IN_PROGRESS" QuoteItemStateTypeINPROGRESS QuoteItemStateType = "IN_PROGRESS" // QuoteItemStateTypeUNABLETOPROVIDE captures enum value "UNABLE_TO_PROVIDE" QuoteItemStateTypeUNABLETOPROVIDE QuoteItemStateType = "UNABLE_TO_PROVIDE" // QuoteItemStateTypeREADY captures enum value "READY" QuoteItemStateTypeREADY QuoteItemStateType = "READY" // QuoteItemStateTypeABANDONED captures enum value "ABANDONED" QuoteItemStateTypeABANDONED QuoteItemStateType = "ABANDONED" // QuoteItemStateTypeINSUFICIENTINFORMATIONPROVIDED captures enum value "INSUFICIENT_INFORMATION_PROVIDED" QuoteItemStateTypeINSUFICIENTINFORMATIONPROVIDED QuoteItemStateType = "INSUFICIENT_INFORMATION_PROVIDED" )
func NewQuoteItemStateType ¶
func NewQuoteItemStateType(value QuoteItemStateType) *QuoteItemStateType
func (QuoteItemStateType) ContextValidate ¶
ContextValidate validates this quote item state type based on context it is used
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 NewQuoteLevel ¶
func NewQuoteLevel(value QuoteLevel) *QuoteLevel
func (QuoteLevel) ContextValidate ¶
ContextValidate validates this quote level based on context it is used
type QuotePrice ¶
type QuotePrice struct { // 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 // Required: true Name *string `json:"name"` // price // Required: true Price *Price `json:"price"` // price type // Required: true PriceType *PriceType `json:"priceType"` // recurring charge period RecurringChargePeriod ChargePeriod `json:"recurringChargePeriod,omitempty"` }
QuotePrice Description of price and discount awarded.
swagger:model QuotePrice
func (*QuotePrice) ContextValidate ¶
ContextValidate validate this quote price based on the context it is used
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
type QuoteRef ¶
type QuoteRef struct { // Technical attribute to extend the API AtReferredType string `json:"@referredType,omitempty"` // Hyperlink to access the quote (using MEF quote API) Href string `json:"href,omitempty"` // Unique identifier for the Quote that is generated by the Seller when the Quote is initially accepted via an API. // Required: true ID *string `json:"id"` // Identifier of the quote item QuoteItem string `json:"quoteItem,omitempty"` }
QuoteRef Quote used before this order to define pricing terms
swagger:model QuoteRef
func (*QuoteRef) ContextValidate ¶
ContextValidate validates this quote ref based on context it is used
func (*QuoteRef) MarshalBinary ¶
MarshalBinary interface implementation
func (*QuoteRef) UnmarshalBinary ¶
UnmarshalBinary interface implementation
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 NewQuoteState ¶
func NewQuoteState(value QuoteState) *QuoteState
func (QuoteState) ContextValidate ¶
ContextValidate validates this quote state based on context it is used
type QuoteStateType ¶
type QuoteStateType string
QuoteStateType Valid quote state enumeration
swagger:model QuoteStateType
const ( // QuoteStateTypeINPROGRESS captures enum value "IN_PROGRESS" QuoteStateTypeINPROGRESS QuoteStateType = "IN_PROGRESS" // QuoteStateTypeREADY captures enum value "READY" QuoteStateTypeREADY QuoteStateType = "READY" // QuoteStateTypeCANCELLED captures enum value "CANCELLED" QuoteStateTypeCANCELLED QuoteStateType = "CANCELLED" // QuoteStateTypeREJECTED captures enum value "REJECTED" QuoteStateTypeREJECTED QuoteStateType = "REJECTED" // QuoteStateTypeACCEPTED captures enum value "ACCEPTED" QuoteStateTypeACCEPTED QuoteStateType = "ACCEPTED" // QuoteStateTypeEXPIRED captures enum value "EXPIRED" QuoteStateTypeEXPIRED QuoteStateType = "EXPIRED" // QuoteStateTypeUNABLETOPROVIDE captures enum value "UNABLE_TO_PROVIDE" QuoteStateTypeUNABLETOPROVIDE QuoteStateType = "UNABLE_TO_PROVIDE" // QuoteStateTypeINSUFICIENTINFORMATIONPROVIDED captures enum value "INSUFICIENT_INFORMATION_PROVIDED" QuoteStateTypeINSUFICIENTINFORMATIONPROVIDED QuoteStateType = "INSUFICIENT_INFORMATION_PROVIDED" )
func NewQuoteStateType ¶
func NewQuoteStateType(value QuoteStateType) *QuoteStateType
func (QuoteStateType) ContextValidate ¶
ContextValidate validates this quote state type based on context it is used
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) ContextValidate ¶
ContextValidate validate this quote summary view based on the context it is used
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
type ReferencedAddress ¶
type ReferencedAddress struct { // Unique identifier of the address ID string `json:"id,omitempty"` // Id of a reference address // Required: true ReferenceID *string `json:"referenceId"` // Type of a reference address // Required: true ReferenceType *string `json:"referenceType"` }
ReferencedAddress A globally unique identifier controlled by a generally accepted independent administrative authority that specifies a fixed geographical location.
swagger:model ReferencedAddress
func (*ReferencedAddress) ContextValidate ¶
ContextValidate validates this referenced address based on context it is used
func (*ReferencedAddress) MarshalBinary ¶
func (m *ReferencedAddress) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReferencedAddress) UnmarshalBinary ¶
func (m *ReferencedAddress) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RelatedParty ¶
type RelatedParty struct { // Allow to specify the party type like Organization or Individual AtReferredType string `json:"@referredType,omitempty"` // The email address of the related party. EmailAddress string `json:"emailAddress,omitempty"` // An identifier of the related party. // 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. Number string `json:"number,omitempty"` // Phone number Extension. NumberExtension string `json:"numberExtension,omitempty"` // Role played by this party for this Site as UNISiteContact for example. // Required: true Role []string `json:"role"` }
RelatedParty An entity or organization that is involved to the geographical site, such as the Site Contact or Site Alternate Contact.
swagger:model RelatedParty
func (*RelatedParty) ContextValidate ¶
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
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) ContextValidate ¶
ContextValidate validate this related party role based on the context it is used
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
type RelatedPlaceRefOrValue ¶
type RelatedPlaceRefOrValue interface { runtime.Validatable runtime.ContextValidatable // at type AtType() string SetAtType(string) // Unique reference of the place Href() string SetHref(string) // Unique identifier of the place ID() string SetID(string) // The role that the place plays, e.g. "UNI Site", or "ENNI Site". // Required: true Role() *string SetRole(*string) }
RelatedPlaceRefOrValue Place defines the places where the quoted products are sold or delivered
swagger:discriminator RelatedPlaceRefOrValue @type
func UnmarshalRelatedPlaceRefOrValue ¶
func UnmarshalRelatedPlaceRefOrValue(reader io.Reader, consumer runtime.Consumer) (RelatedPlaceRefOrValue, error)
UnmarshalRelatedPlaceRefOrValue unmarshals polymorphic RelatedPlaceRefOrValue
func UnmarshalRelatedPlaceRefOrValueSlice ¶
func UnmarshalRelatedPlaceRefOrValueSlice(reader io.Reader, consumer runtime.Consumer) ([]RelatedPlaceRefOrValue, error)
UnmarshalRelatedPlaceRefOrValueSlice unmarshals polymorphic slices of RelatedPlaceRefOrValue
type RelatedPlaceReforValue ¶
type RelatedPlaceReforValue interface { runtime.Validatable runtime.ContextValidatable // The actual type of the target instance when needed for disambiguation. // Used when place is described by reference // @referredType could be valued to FormattedAddress, FieldedAddress, GeographicSite, GeographicLocation or ReferencedAddress AtReferredType() string SetAtReferredType(string) // When sub-classing, this defines the sub-class entity name. // Used when place is described by value (litterally) // Could be valued to FormattedAddress, FieldedAddress, GeographicLocation or ReferencedAddress AtType() string SetAtType(string) // href to this place resource Href() string SetHref(string) // id of this place // Max Length: 45 ID() string SetID(string) // Role of this place // Required: true Role() *string SetRole(*string) }
RelatedPlaceReforValue Place defines the places where the products qualification must be done.
swagger:discriminator RelatedPlaceReforValue @type
func UnmarshalRelatedPlaceReforValue ¶
func UnmarshalRelatedPlaceReforValue(reader io.Reader, consumer runtime.Consumer) (RelatedPlaceReforValue, error)
UnmarshalRelatedPlaceReforValue unmarshals polymorphic RelatedPlaceReforValue
func UnmarshalRelatedPlaceReforValueSlice ¶
func UnmarshalRelatedPlaceReforValueSlice(reader io.Reader, consumer runtime.Consumer) ([]RelatedPlaceReforValue, error)
UnmarshalRelatedPlaceReforValueSlice unmarshals polymorphic slices of RelatedPlaceReforValue
type RelationshipType ¶
type RelationshipType string
RelationshipType Relationship type to be used between POQ item or product
swagger:model RelationshipType
const ( // RelationshipTypeReliesOn captures enum value "reliesOn" RelationshipTypeReliesOn RelationshipType = "reliesOn" // RelationshipTypeBundled captures enum value "bundled" RelationshipTypeBundled RelationshipType = "bundled" // RelationshipTypeComesFrom captures enum value "comesFrom" RelationshipTypeComesFrom RelationshipType = "comesFrom" )
func NewRelationshipType ¶
func NewRelationshipType(value RelationshipType) *RelationshipType
func (RelationshipType) ContextValidate ¶
ContextValidate validates this relationship type based on context it is used
type ServiceabilityColor ¶
type ServiceabilityColor string
ServiceabilityColor A color that indicates confidence to service the request.
swagger:model ServiceabilityColor
const ( // ServiceabilityColorGreen captures enum value "green" ServiceabilityColorGreen ServiceabilityColor = "green" // ServiceabilityColorRed captures enum value "red" ServiceabilityColorRed ServiceabilityColor = "red" // ServiceabilityColorYellow captures enum value "yellow" ServiceabilityColorYellow ServiceabilityColor = "yellow" )
func NewServiceabilityColor ¶
func NewServiceabilityColor(value ServiceabilityColor) *ServiceabilityColor
func (ServiceabilityColor) ContextValidate ¶
ContextValidate validates this serviceability color based on context it is used
type Severity ¶
type Severity string
Severity Severity of the order message
swagger:model Severity
func NewSeverity ¶
func (Severity) ContextValidate ¶
ContextValidate validates this severity based on context it is used
type StateChange ¶
type StateChange struct { // change date // Format: date-time ChangeDate strfmt.DateTime `json:"changeDate,omitempty"` // change reason ChangeReason string `json:"changeReason,omitempty"` // state State ProductOfferingQualificationStateType `json:"state,omitempty"` }
StateChange Holds the state notification reasons and associated date the state changed, populated by the server
swagger:model StateChange
func (*StateChange) ContextValidate ¶
ContextValidate validate this state change based on the context it is used
func (*StateChange) MarshalBinary ¶
func (m *StateChange) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StateChange) UnmarshalBinary ¶
func (m *StateChange) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Status ¶
type Status string
Status Status of a geographical site
swagger:model Status
const ( // StatusPlanned captures enum value "planned" StatusPlanned Status = "planned" // StatusCancelled captures enum value "cancelled" StatusCancelled Status = "cancelled" // StatusUnderConstruction captures enum value "underConstruction" StatusUnderConstruction Status = "underConstruction" // StatusExisting captures enum value "existing" StatusExisting Status = "existing" // StatusFormer captures enum value "former" StatusFormer Status = "former" )
func (Status) ContextValidate ¶
ContextValidate validates this status based on context it is used
type StatusChange ¶
type StatusChange struct { // Date when the state changed // Format: date-time ChangeDate strfmt.DateTime `json:"changeDate,omitempty"` // Raison for which the state changed ChangeReason string `json:"changeReason,omitempty"` // status Status ProductStatus `json:"status,omitempty"` }
StatusChange Holds the status modification reasons and associated date the status changed, populated by the server
swagger:model StatusChange
func (*StatusChange) ContextValidate ¶
ContextValidate validate this status change based on the context it is used
func (*StatusChange) MarshalBinary ¶
func (m *StatusChange) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StatusChange) UnmarshalBinary ¶
func (m *StatusChange) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SubUnit ¶
type SubUnit struct { // The discriminator used for the subunit, often just a simple number but may also be a range. // Required: true SubUnitIdentifier *string `json:"subUnitIdentifier"` // The type of subunit e.g.BERTH, FLAT, PIER, SUITE, SHOP, TOWER, UNIT, WHARF. // Required: true SubUnitType *string `json:"subUnitType"` }
SubUnit Sub Unit structure is used to describe several subUnits with a geographical subAddress.
swagger:model SubUnit
func (*SubUnit) ContextValidate ¶
ContextValidate validates this sub unit based on context it is used
func (*SubUnit) MarshalBinary ¶
MarshalBinary interface implementation
func (*SubUnit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TaskStateType ¶
type TaskStateType string
TaskStateType task state type
swagger:model TaskStateType
const ( // TaskStateTypeAcknowledged captures enum value "acknowledged" TaskStateTypeAcknowledged TaskStateType = "acknowledged" // TaskStateTypeInProgress captures enum value "inProgress" TaskStateTypeInProgress TaskStateType = "inProgress" // TaskStateTypeDone captures enum value "done" TaskStateTypeDone TaskStateType = "done" // TaskStateTypeTerminatedWithError captures enum value "terminatedWithError" TaskStateTypeTerminatedWithError TaskStateType = "terminatedWithError" )
func NewTaskStateType ¶
func NewTaskStateType(value TaskStateType) *TaskStateType
func (TaskStateType) ContextValidate ¶
ContextValidate validates this task state type based on context it is used
type TerminationError ¶
type TerminationError struct { // Id of the termination error ID string `json:"id,omitempty"` // Value (text) for the termination error Value string `json:"value,omitempty"` }
TerminationError Termination error may be provided if seller is unable to perform qualification
swagger:model TerminationError
func (*TerminationError) ContextValidate ¶
ContextValidate validates this termination error based on context it is used
func (*TerminationError) MarshalBinary ¶
func (m *TerminationError) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TerminationError) UnmarshalBinary ¶
func (m *TerminationError) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TimeInterval ¶
type TimeInterval struct { // Amount // Required: true Amount *int32 `json:"amount"` // time unit // Required: true TimeUnit *TimeUnit `json:"timeUnit"` }
TimeInterval A time interval, e.g. 3 hours, or 5 days.
swagger:model TimeInterval
func (*TimeInterval) ContextValidate ¶
ContextValidate validate this time interval based on the context it is used
func (*TimeInterval) MarshalBinary ¶
func (m *TimeInterval) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TimeInterval) UnmarshalBinary ¶
func (m *TimeInterval) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TimePeriod ¶
type TimePeriod struct { // end date time // Format: date-time EndDateTime strfmt.DateTime `json:"endDateTime,omitempty"` // start date time // Format: date-time StartDateTime strfmt.DateTime `json:"startDateTime,omitempty"` }
TimePeriod Indicates a time period for validity.
swagger:model TimePeriod
func (*TimePeriod) ContextValidate ¶
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
type TimeUnit ¶
type TimeUnit string
TimeUnit Represents a unit of time.
swagger:model TimeUnit
const ( // TimeUnitCalendarDays captures enum value "calendarDays" TimeUnitCalendarDays TimeUnit = "calendarDays" // TimeUnitCalendarHours captures enum value "calendarHours" TimeUnitCalendarHours TimeUnit = "calendarHours" // TimeUnitCalendarMinutes captures enum value "calendarMinutes" TimeUnitCalendarMinutes TimeUnit = "calendarMinutes" // TimeUnitBusinessDays captures enum value "businessDays" TimeUnitBusinessDays TimeUnit = "businessDays" // TimeUnitBusinessHours captures enum value "businessHours" TimeUnitBusinessHours TimeUnit = "businessHours" // TimeUnitBusinessMinutes captures enum value "businessMinutes" TimeUnitBusinessMinutes TimeUnit = "businessMinutes" )
func NewTimeUnit ¶
func (TimeUnit) ContextValidate ¶
ContextValidate validates this time unit based on context it is used
type ValidationResult ¶
type ValidationResult string
ValidationResult Validation Result
swagger:model ValidationResult
const ( // ValidationResultSuccess captures enum value "success" ValidationResultSuccess ValidationResult = "success" // ValidationResultFails captures enum value "fails" ValidationResultFails ValidationResult = "fails" // ValidationResultPartial captures enum value "partial" ValidationResultPartial ValidationResult = "partial" )
func NewValidationResult ¶
func NewValidationResult(value ValidationResult) *ValidationResult
func (ValidationResult) ContextValidate ¶
ContextValidate validates this validation result based on context it is used
Source Files
¶
- agreement.go
- agreement_ref.go
- alternate_product_proposal.go
- billing_account_ref.go
- cancel_product_order.go
- cancel_product_order_create.go
- change_quote_state_response.go
- changel_quote_state_request.go
- charge_period.go
- contact.go
- describing.go
- desired_order_responses.go
- duration.go
- duration_unit.go
- error_representation.go
- fielded_address.go
- fielded_address_request.go
- formatted_address.go
- formatted_address_request.go
- geographic_address.go
- geographic_address_find_resp.go
- geographic_address_request_buyer_input.go
- geographic_address_seller_response.go
- geographic_address_validation.go
- geographic_address_validation_create.go
- geographic_location.go
- geographic_point.go
- geographic_site.go
- geographic_site_find_resp.go
- geographic_sub_address.go
- geographic_sub_address_request.go
- hub.go
- hub_input.go
- item_term.go
- money.go
- note.go
- notification.go
- order_activity.go
- order_item.go
- order_item_event.go
- order_item_price.go
- order_item_relation_ship.go
- order_message.go
- po_event.go
- po_event_plus.go
- po_q_event_container.go
- poq_event.go
- poq_event_type.go
- poq_item_event.go
- price.go
- price_alteration.go
- price_range.go
- price_type.go
- pricing_method.go
- principal.go
- product.go
- product_action_type.go
- product_event.go
- product_offering_qualification.go
- product_offering_qualification_create.go
- product_offering_qualification_find.go
- product_offering_qualification_item.go
- product_offering_qualification_item_create.go
- product_offering_qualification_item_relationship.go
- product_offering_qualification_item_state_type.go
- product_offering_qualification_ref.go
- product_offering_qualification_state_type.go
- product_offering_ref.go
- product_order.go
- product_order_create.go
- product_order_event.go
- product_order_event_type.go
- product_order_item_create.go
- product_order_item_state_type.go
- product_order_ref.go
- product_order_ref_cancel.go
- product_order_state_type.go
- product_order_summary.go
- product_price.go
- product_ref.go
- product_relationship.go
- product_specification.go
- product_specification_ref.go
- product_specification_summary.go
- product_status.go
- product_summary.go
- product_term.go
- qualification_ref.go
- qualification_state.go
- quantity.go
- quote.go
- quote_change_state.go
- quote_create.go
- quote_event.go
- quote_event_plus.go
- quote_event_type.go
- quote_find.go
- quote_item.go
- quote_item_action.go
- quote_item_create.go
- quote_item_relationship.go
- quote_item_state.go
- quote_item_state_type.go
- quote_level.go
- quote_price.go
- quote_ref.go
- quote_state.go
- quote_state_type.go
- quote_summary_view.go
- referenced_address.go
- related_party.go
- related_party_role.go
- related_place_ref_or_value.go
- related_place_refor_value.go
- relationship_type.go
- serviceability_color.go
- severity.go
- state_change.go
- status.go
- status_change.go
- sub_unit.go
- task_state_type.go
- termination_error.go
- time_interval.go
- time_period.go
- time_unit.go
- validation_result.go