package
0.0.1
Repository: https://github.com/gctziavas/tmf638.git
Documentation: pkg.go.dev

# Functions

AssertAddressableRequired checks if the required fields are not zero-ed.
AssertCharacteristicRelationshipRequired checks if the required fields are not zero-ed.
AssertCharacteristicRequired checks if the required fields are not zero-ed.
AssertConstraintRefRequired checks if the required fields are not zero-ed.
AssertEntityRefRequired checks if the required fields are not zero-ed.
AssertEntityValueRequired checks if the required fields are not zero-ed.
AssertErrorRequired checks if the required fields are not zero-ed.
AssertEventSubscriptionInputRequired checks if the required fields are not zero-ed.
AssertEventSubscriptionRequired checks if the required fields are not zero-ed.
AssertExtensibleRequired checks if the required fields are not zero-ed.
AssertFeatureRelationshipRequired checks if the required fields are not zero-ed.
AssertFeatureRequired checks if the required fields are not zero-ed.
AssertNoteRequired checks if the required fields are not zero-ed.
AssertOrderItemActionTypeRequired checks if the required fields are not zero-ed.
AssertPlaceRefRequired checks if the required fields are not zero-ed.
AssertPlaceRequired checks if the required fields are not zero-ed.
AssertRecurseAddressableRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseCharacteristicRelationshipRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseCharacteristicRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseConstraintRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseEntityRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseEntityValueRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseErrorRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseEventSubscriptionInputRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseEventSubscriptionRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseExtensibleRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseFeatureRelationshipRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseFeatureRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseInterfaceRequired recursively checks each struct in a slice against the callback.
AssertRecurseNoteRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseOrderItemActionTypeRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecursePlaceRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecursePlaceRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRelatedEntityRefOrValueRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRelatedPartyRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRelatedPlaceRefOrValueRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseRelatedServiceOrderItemRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseResourceRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceAttributeValueChangeEventPayloadRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceAttributeValueChangeEventRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceCreateEventPayloadRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceCreateEventRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceCreateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceDeleteEventPayloadRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceDeleteEventRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceRefOrValueRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceRelationshipRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceSpecificationRefRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceStateChangeEventPayloadRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceStateChangeEventRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceStateTypeRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseServiceUpdateRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseTimePeriodRequired recursively checks if required fields are not zero-ed in a nested slice.
AssertRecurseValueRequired checks each struct in the nested slice against the callback.
AssertRelatedEntityRefOrValueRequired checks if the required fields are not zero-ed.
AssertRelatedPartyRequired checks if the required fields are not zero-ed.
AssertRelatedPlaceRefOrValueRequired checks if the required fields are not zero-ed.
AssertRelatedServiceOrderItemRequired checks if the required fields are not zero-ed.
AssertResourceRefRequired checks if the required fields are not zero-ed.
AssertServiceAttributeValueChangeEventPayloadRequired checks if the required fields are not zero-ed.
AssertServiceAttributeValueChangeEventRequired checks if the required fields are not zero-ed.
AssertServiceCreateEventPayloadRequired checks if the required fields are not zero-ed.
AssertServiceCreateEventRequired checks if the required fields are not zero-ed.
AssertServiceCreateRequired checks if the required fields are not zero-ed.
AssertServiceDeleteEventPayloadRequired checks if the required fields are not zero-ed.
AssertServiceDeleteEventRequired checks if the required fields are not zero-ed.
AssertServiceRefOrValueRequired checks if the required fields are not zero-ed.
AssertServiceRefRequired checks if the required fields are not zero-ed.
AssertServiceRelationshipRequired checks if the required fields are not zero-ed.
AssertServiceRequired checks if the required fields are not zero-ed.
AssertServiceSpecificationRefRequired checks if the required fields are not zero-ed.
AssertServiceStateChangeEventPayloadRequired checks if the required fields are not zero-ed.
AssertServiceStateChangeEventRequired checks if the required fields are not zero-ed.
AssertServiceStateTypeRequired checks if the required fields are not zero-ed.
AssertServiceUpdateRequired checks if the required fields are not zero-ed.
AssertTimePeriodRequired checks if the required fields are not zero-ed.
DefaultErrorHandler defines the default logic on how to handle errors from the controller.
EncodeJSONResponse uses the json encoder to write an interface to the http response with an optional status code.
IsZeroValue checks if the val is the zero-ed value.
No description provided by the author
NewEventsSubscriptionApiController creates a default api controller.
NewEventsSubscriptionApiService creates a default api service.
NewNotificationListenersClientSideApiController creates a default api controller.
NewNotificationListenersClientSideApiService creates a default api service.
NewRouter creates a new router for any number of api routers.
NewServiceApiController creates a default api controller.
NewServiceApiService creates a default api service.
ReadFormFilesToTempFiles reads files array data from a request form and writes it to a temporary files.
ReadFormFileToTempFile reads file data from a request form and writes it to a temporary file.
Response return a ImplResponse struct filled.
No description provided by the author
WithEventsSubscriptionApiErrorHandler inject ErrorHandler into controller.
WithNotificationListenersClientSideApiErrorHandler inject ErrorHandler into controller.
WithServiceApiErrorHandler inject ErrorHandler into controller.

# Constants

List of ServiceStateType.
List of OrderItemActionType.
List of OrderItemActionType.
List of ServiceStateType.
List of ServiceStateType.
List of ServiceStateType.
List of OrderItemActionType.
List of OrderItemActionType.
List of ServiceStateType.
List of ServiceStateType.

# Variables

ErrTypeAssertionError is thrown when type an interface does not match the asserted type.
No description provided by the author

# Structs

Addressable - Base schema for adressable entities.
Characteristic - Describes a given characteristic of an object or entity through a name/value pair.
CharacteristicRelationship - Another Characteristic that is related to the current Characteristic;.
ConstraintRef - Constraint reference.
EntityRef - Entity reference schema to be use for all entityRef class.
EntityValue - Base entity value schema for use in TMForum Open-APIs.
Error - Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx).
EventsSubscriptionApiController binds http requests to an api service and writes the service results to the http response.
EventsSubscriptionApiService is a service that implements the logic for the EventsSubscriptionApiServicer This service should implement the business logic for every endpoint for the EventsSubscriptionApi API.
EventSubscription - Sets the communication endpoint address the service instance must use to deliver notification information.
EventSubscriptionInput - Sets the communication endpoint address the service instance must use to deliver notification information.
Extensible - Base Extensible schema for use in TMForum Open-APIs.
Feature - Configuration feature.
FeatureRelationship - Configuration feature.
ImplResponse response defines an error code with the associated body.
Note - Extra information about a given entity.
NotificationListenersClientSideApiController binds http requests to an api service and writes the service results to the http response.
NotificationListenersClientSideApiService is a service that implements the logic for the NotificationListenersClientSideApiServicer This service should implement the business logic for every endpoint for the NotificationListenersClientSideApi API.
ParsingError indicates that an error has occurred when parsing request parameters.
Place - Place reference.
PlaceRef - Place reference.
RelatedEntityRefOrValue - A reference to an entity, where the type of the entity is not known in advance.
RelatedParty - Related Entity reference.
RelatedPlaceRefOrValue - Related Entity reference.
RelatedServiceOrderItem - RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
RequiredError indicates that an error has occurred when parsing request parameters.
No description provided by the author
A Route defines the parameters for an api endpoint.
Service - Service is a base class for defining the Service hierarchy.
ServiceApiController binds http requests to an api service and writes the service results to the http response.
ServiceApiService is a service that implements the logic for the ServiceApiServicer This service should implement the business logic for every endpoint for the ServiceApi API.
ServiceAttributeValueChangeEvent - The notification data structure.
ServiceAttributeValueChangeEventPayload - The event data structure.
ServiceCreate - Service is a base class for defining the Service hierarchy.
ServiceCreateEvent - The notification data structure.
ServiceCreateEventPayload - The event data structure.
ServiceDeleteEvent - The notification data structure.
ServiceDeleteEventPayload - The event data structure.
ServiceRef - Service reference, for when Service is used by other entities.
ServiceRefOrValue - A Service to be created defined by value or existing defined by reference.
No description provided by the author
ServiceSpecificationRef - Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.
ServiceStateChangeEvent - The notification data structure.
ServiceStateChangeEventPayload - The event data structure.
ServiceUpdate - Service is a base class for defining the Service hierarchy.
TimePeriod - A period of time, either as a deadline (endDateTime only) a startDateTime only, or both.

# Interfaces

EventsSubscriptionApiRouter defines the required methods for binding the api requests to a responses for the EventsSubscriptionApi The EventsSubscriptionApiRouter implementation should parse necessary information from the http request, pass the data to a EventsSubscriptionApiServicer to perform the required actions, then write the service results to the http response.
EventsSubscriptionApiServicer defines the api actions for the EventsSubscriptionApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
NotificationListenersClientSideApiRouter defines the required methods for binding the api requests to a responses for the NotificationListenersClientSideApi The NotificationListenersClientSideApiRouter implementation should parse necessary information from the http request, pass the data to a NotificationListenersClientSideApiServicer to perform the required actions, then write the service results to the http response.
NotificationListenersClientSideApiServicer defines the api actions for the NotificationListenersClientSideApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.
Router defines the required methods for retrieving api routes.
ServiceApiRouter defines the required methods for binding the api requests to a responses for the ServiceApi The ServiceApiRouter implementation should parse necessary information from the http request, pass the data to a ServiceApiServicer to perform the required actions, then write the service results to the http response.
ServiceApiServicer defines the api actions for the ServiceApi service This interface intended to stay up to date with the openapi yaml used to generate it, while the service implementation can be ignored with the .openapi-generator-ignore file and updated with the logic required for the API.

# Type aliases

ErrorHandler defines the required method for handling error.
EventsSubscriptionApiOption for how the controller is set up.
NotificationListenersClientSideApiOption for how the controller is set up.
OrderItemActionType : action to be performed on the product.
Routes are a collection of defined api endpoints.
ServiceApiOption for how the controller is set up.
ServiceStateType : Valid values for the lifecycle state of the service.