# Functions
AsErrAPIFault tries to convert an error into an APIError, a generic API error.
AsErrAuthenticationFailed tries to convert the error into a AuthenticationError.
AsErrNotFound tries to convert an error into a not found error and will return nil if not successful.
AsErrPermissionDenied tries to convert the error into a PermissionError.
AsErrValidationFailed tries to convert an error into a ValidationError.
AssertBodyContains is a test helper for checking if a byte subslice exists.
IsErrAPIFault checks if the error is an APIError.
IsErrAuthenticationFailed checks if the error is an authentication error.
IsErrNotFound checks if the error is a not found error.
IsErrPermissionDenied checks if the error is a PermissionError.
IsErrValidationFailed checks if this is an validation error.
MustParseDate decodes a Date using ParseDate, but will panic in case of an error.
NewClient creates a new client instance.
NewMockResponseTransport creates a transport which will return mocked response data.
NewNotFoundResponse creates a new 404 not found response with body.
NewTestClient creates an IX-API client with a custom response for a request endpoint.
ParseDate decodes a date from a string.
# Constants
AllowMemberJoiningRulePatchType is a polymorphic type value for AllowMemberJoiningRulePatch.
AllowMemberJoiningRuleRequestType is a polymorphic type value for AllowMemberJoiningRuleRequest.
AllowMemberJoiningRuleType is a polymorphic type value for AllowMemberJoiningRule.
AllowMemberJoiningRuleUpdateType is a polymorphic type value for AllowMemberJoiningRuleUpdate.
CloudNetworkProductOfferingPatchType is a polymorphic type value for CloudNetworkProductOfferingPatch.
CloudNetworkProductOfferingType is a polymorphic type value for CloudNetworkProductOffering.
CloudNetworkServiceConfigPatchType is a polymorphic type value for CloudNetworkServiceConfigPatch.
CloudNetworkServiceConfigRequestType is a polymorphic type value for CloudNetworkServiceConfigRequest.
CloudNetworkServiceConfigType is a polymorphic type value for CloudNetworkServiceConfig.
CloudNetworkServiceConfigUpdateType is a polymorphic type value for CloudNetworkServiceConfigUpdate.
CloudNetworkServicePatchType is a polymorphic type value for CloudNetworkServicePatch.
CloudNetworkServiceRequestType is a polymorphic type value for CloudNetworkServiceRequest.
CloudNetworkServiceType is a polymorphic type value for CloudNetworkService.
CloudNetworkServiceUpdateType is a polymorphic type value for CloudNetworkServiceUpdate.
ConnectionProductOfferingPatchType is a polymorphic type value for ConnectionProductOfferingPatch.
ConnectionProductOfferingType is a polymorphic type value for ConnectionProductOffering.
DenyMemberJoiningRulePatchType is a polymorphic type value for DenyMemberJoiningRulePatch.
DenyMemberJoiningRuleRequestType is a polymorphic type value for DenyMemberJoiningRuleRequest.
DenyMemberJoiningRuleType is a polymorphic type value for DenyMemberJoiningRule.
DenyMemberJoiningRuleUpdateType is a polymorphic type value for DenyMemberJoiningRuleUpdate.
ExchangeLanNetworkProductOfferingPatchType is a polymorphic type value for ExchangeLanNetworkProductOfferingPatch.
ExchangeLanNetworkProductOfferingType is a polymorphic type value for ExchangeLanNetworkProductOffering.
ExchangeLanNetworkServiceConfigPatchType is a polymorphic type value for ExchangeLanNetworkServiceConfigPatch.
ExchangeLanNetworkServiceConfigRequestType is a polymorphic type value for ExchangeLanNetworkServiceConfigRequest.
ExchangeLanNetworkServiceConfigType is a polymorphic type value for ExchangeLanNetworkServiceConfig.
ExchangeLanNetworkServiceConfigUpdateType is a polymorphic type value for ExchangeLanNetworkServiceConfigUpdate.
ExchangeLanNetworkServiceType is a polymorphic type value for ExchangeLanNetworkService.
MP2MPNetworkProductOfferingPatchType is a polymorphic type value for MP2MPNetworkProductOfferingPatch.
MP2MPNetworkProductOfferingType is a polymorphic type value for MP2MPNetworkProductOffering.
MP2MPNetworkServiceConfigPatchType is a polymorphic type value for MP2MPNetworkServiceConfigPatch.
MP2MPNetworkServiceConfigRequestType is a polymorphic type value for MP2MPNetworkServiceConfigRequest.
MP2MPNetworkServiceConfigType is a polymorphic type value for MP2MPNetworkServiceConfig.
MP2MPNetworkServiceConfigUpdateType is a polymorphic type value for MP2MPNetworkServiceConfigUpdate.
MP2MPNetworkServicePatchType is a polymorphic type value for MP2MPNetworkServicePatch.
MP2MPNetworkServiceRequestType is a polymorphic type value for MP2MPNetworkServiceRequest.
MP2MPNetworkServiceType is a polymorphic type value for MP2MPNetworkService.
MP2MPNetworkServiceUpdateType is a polymorphic type value for MP2MPNetworkServiceUpdate.
P2MPNetworkProductOfferingPatchType is a polymorphic type value for P2MPNetworkProductOfferingPatch.
P2MPNetworkProductOfferingType is a polymorphic type value for P2MPNetworkProductOffering.
P2MPNetworkServiceConfigPatchType is a polymorphic type value for P2MPNetworkServiceConfigPatch.
P2MPNetworkServiceConfigRequestType is a polymorphic type value for P2MPNetworkServiceConfigRequest.
P2MPNetworkServiceConfigType is a polymorphic type value for P2MPNetworkServiceConfig.
P2MPNetworkServiceConfigUpdateType is a polymorphic type value for P2MPNetworkServiceConfigUpdate.
P2MPNetworkServicePatchType is a polymorphic type value for P2MPNetworkServicePatch.
P2MPNetworkServiceRequestType is a polymorphic type value for P2MPNetworkServiceRequest.
P2MPNetworkServiceType is a polymorphic type value for P2MPNetworkService.
P2MPNetworkServiceUpdateType is a polymorphic type value for P2MPNetworkServiceUpdate.
P2PNetworkProductOfferingPatchType is a polymorphic type value for P2PNetworkProductOfferingPatch.
P2PNetworkProductOfferingType is a polymorphic type value for P2PNetworkProductOffering.
P2PNetworkServiceConfigPatchType is a polymorphic type value for P2PNetworkServiceConfigPatch.
P2PNetworkServiceConfigRequestType is a polymorphic type value for P2PNetworkServiceConfigRequest.
P2PNetworkServiceConfigType is a polymorphic type value for P2PNetworkServiceConfig.
P2PNetworkServiceConfigUpdateType is a polymorphic type value for P2PNetworkServiceConfigUpdate.
P2PNetworkServicePatchType is a polymorphic type value for P2PNetworkServicePatch.
P2PNetworkServiceRequestType is a polymorphic type value for P2PNetworkServiceRequest.
P2PNetworkServiceType is a polymorphic type value for P2PNetworkService.
P2PNetworkServiceUpdateType is a polymorphic type value for P2PNetworkServiceUpdate.
RouteServerNetworkFeatureConfigPatchType is a polymorphic type value for RouteServerNetworkFeatureConfigPatch.
RouteServerNetworkFeatureConfigRequestType is a polymorphic type value for RouteServerNetworkFeatureConfigRequest.
RouteServerNetworkFeatureConfigType is a polymorphic type value for RouteServerNetworkFeatureConfig.
RouteServerNetworkFeatureConfigUpdateType is a polymorphic type value for RouteServerNetworkFeatureConfigUpdate.
RouteServerNetworkFeatureType is a polymorphic type value for RouteServerNetworkFeature.
SchemaVersion is the version of the ix-api schema.
VLANConfigDot1QType is a polymorphic type value for VLANConfigDot1Q.
VLANConfigPortType is a polymorphic type value for VLANConfigPort.
VLANConfigQinQType is a polymorphic type value for VLANConfigQinQ.
# Variables
ErrInvalidPolymorphicType is raised when a polymorphic type could not be resolved.
# Structs
Account Account.
AccountPatch Account Update.
AccountRequest Account Request.
AccountsListQuery has all query parameters for AccountsList.
AccountUpdate Account Update.
Address A postal address.
AllowMemberJoiningRule A rule for members joining a private vlan.
AllowMemberJoiningRulePatch A vlan member joining rule update.
AllowMemberJoiningRuleRequest A new vlan member joining rule.
AllowMemberJoiningRuleUpdate A vlan member joining rule update.
APIError is a generic api error.
APIExtensions Implementation specific API extensions.
APIHealth Health Status Response.
APIImplementation API Implementation.
AuthAPIKeySecret will use the legacy authentication endpoint.
AuthenticationError indicates that the authentication was not successful.
AuthToken AuthToken.
AuthTokenRequest AuthTokenRequest.
BillingInformation Optional information required for issuing invoices.
CancellationPolicy Cancellation Policy.
CancellationRequest Service Cancellation Request.
Client is an IX-API http client.
CloudNetworkProductOffering Cloud Network Product Offering.
CloudNetworkProductOfferingPatch Cloud Network Product Offering.
CloudNetworkService Cloud Network Service.
CloudNetworkServiceConfig Cloud Network Service Config.
CloudNetworkServiceConfigPatch Cloud Network Service Config Update.
CloudNetworkServiceConfigRequest Cloud Network Service Config Request.
CloudNetworkServiceConfigUpdate Cloud Network Service Config Update.
CloudNetworkServicePatch Cloud Network Service Update.
CloudNetworkServiceRequest Cloud Network Service Request.
CloudNetworkServiceUpdate Cloud Network Service Update.
Conflict A conflict is preventing success.
Connection Connection.
ConnectionPatch Connection Update.
ConnectionProductOffering Connection Product Offering.
ConnectionProductOfferingPatch Conncetion Product Offering.
ConnectionRequest Request a new connection.
ConnectionsCancellationPolicyQuery has all query parameters for ConnectionsCancellationPolicy.
ConnectionsListQuery has all query parameters for ConnectionsList.
ConnectionUpdate Connection Update.
Contact Contact.
ContactPatch Contact Update.
ContactRequest Contact Create Request.
ContactsListQuery has all query parameters for ContactsList.
ContactUpdate Contact Update.
DenyMemberJoiningRule A rule for members joining a private vlan.
DenyMemberJoiningRulePatch A vlan member joining rule update.
DenyMemberJoiningRuleRequest A new vlan member joining rule.
DenyMemberJoiningRuleUpdate A vlan member joining rule update.
Device Device.
DeviceCapability Device Capability.
DeviceConnection Device Connection.
DevicesListQuery has all query parameters for DevicesList.
Event Event.
ExchangeLanNetworkProductOffering Exchange Lan Network Product Offering.
ExchangeLanNetworkProductOfferingPatch Exchange Lan Network Product Offering.
ExchangeLanNetworkService Exchange Lan Network Service.
ExchangeLanNetworkServiceConfig Exchange Lan Network Service Config.
ExchangeLanNetworkServiceConfigPatch Exchange Lan Network Service Config Update.
ExchangeLanNetworkServiceConfigRequest Exchange Lan Network Service Config Request.
ExchangeLanNetworkServiceConfigUpdate Exchange Lan Network Service Config Update.
FacilitiesListQuery has all query parameters for FacilitiesList.
Facility Facility.
IPAddress IP-Address.
IPAddressPatch IP-Address Update.
IPAddressRequest IP-Address / Prefix allocation Request.
IPAddressUpdate IP-Address Update.
IPsListQuery has all query parameters for IPsList.
IXPSpecificFeatureFlag IXP-Specific Feature Flag.
IXPSpecificFeatureFlagConfig IXP-Specific Feature Flag Configuration.
MacAddress MAC-Address.
MacAddressRequest MAC-Address Request.
MacsListQuery has all query parameters for MacsList.
MemberJoiningRulesListQuery has all query parameters for MemberJoiningRulesList.
MetroArea MetroArea.
MetroAreaNetwork MetroAreaNetwork.
MetroAreaNetworksListQuery has all query parameters for MetroAreaNetworksList.
MetroAreasListQuery has all query parameters for MetroAreasList.
MockResponseTransport implements the RoundTripper interface and will create a response for a request to a specific endpoint.
MP2MPNetworkProductOffering MP2MP Network Product Offering.
MP2MPNetworkProductOfferingPatch MP2MP Network Product Offering.
MP2MPNetworkService MP2MP Network Service.
MP2MPNetworkServiceConfig MP2MP Network Service Config.
MP2MPNetworkServiceConfigPatch MP2MP Network Service Config Update.
MP2MPNetworkServiceConfigRequest MP2MP Network Service Config Request.
MP2MPNetworkServiceConfigUpdate MP2MP Network Service Config Update.
MP2MPNetworkServicePatch MP2MP Network Service Update.
MP2MPNetworkServiceRequest MP2MP Network Service Request.
MP2MPNetworkServiceUpdate MP2MP Network Service Update.
NetworkFeatureConfigsListQuery has all query parameters for NetworkFeatureConfigsList.
NetworkFeaturesListQuery has all query parameters for NetworkFeaturesList.
NetworkServiceCancellationPolicyReadQuery has all query parameters for NetworkServiceCancellationPolicyRead.
NetworkServiceChangeRequest NetworkServiceChangeRequest.
NetworkServiceConfigCancellationPolicyReadQuery has all query parameters for NetworkServiceConfigCancellationPolicyRead.
NetworkServiceConfigsListQuery has all query parameters for NetworkServiceConfigsList.
NetworkServicesListQuery has all query parameters for NetworkServicesList.
NotFoundError indicates that a resource was not found.
OAuth2ClientCredentials will use OAuth2 for authentication.
P2MPNetworkProductOffering P2MP Network Product Offering.
P2MPNetworkProductOfferingPatch P2MP Network Product Offering.
P2MPNetworkService P2MP Network Service.
P2MPNetworkServiceConfig P2MP Network Service Config.
P2MPNetworkServiceConfigPatch P2MP Network Service Config Update.
P2MPNetworkServiceConfigRequest P2MP Network Service Config Request.
P2MPNetworkServiceConfigUpdate P2MP Network Service Config Update.
P2MPNetworkServicePatch P2MP Network Service Update.
P2MPNetworkServiceRequest P2MP Network Service Request.
P2MPNetworkServiceUpdate P2MP Network Service Update.
P2PNetworkProductOffering P2P Network Product Offering.
P2PNetworkProductOfferingPatch P2P Network Product Offering.
P2PNetworkService P2P Network Service.
P2PNetworkServiceConfig P2P Network Service Config.
P2PNetworkServiceConfigPatch P2P Network Service Config Update.
P2PNetworkServiceConfigRequest P2P Network Service Config Request.
P2PNetworkServiceConfigUpdate P2P Network Service Config Update.
P2PNetworkServicePatch P2P Network Service Update.
P2PNetworkServiceRequest P2P Network Service Request.
P2PNetworkServiceUpdate P2P Network Service Update.
PermissionError indicates that insufficient rights were given, when trying to access a resource.
PointOfPresence Point Of Presence.
PolymorphicMemberJoiningRule is a polymorphic base.
PolymorphicMemberJoiningRulePatch is a polymorphic base.
PolymorphicMemberJoiningRuleRequest is a polymorphic base.
PolymorphicMemberJoiningRuleUpdate is a polymorphic base.
PolymorphicNetworkFeature is a polymorphic base.
PolymorphicNetworkFeatureConfig is a polymorphic base.
PolymorphicNetworkFeatureConfigPatch is a polymorphic base.
PolymorphicNetworkFeatureConfigRequest is a polymorphic base.
PolymorphicNetworkFeatureConfigUpdate is a polymorphic base.
PolymorphicNetworkService is a polymorphic base.
PolymorphicNetworkServiceConfig is a polymorphic base.
PolymorphicNetworkServiceConfigPatch is a polymorphic base.
PolymorphicNetworkServiceConfigRequest is a polymorphic base.
PolymorphicNetworkServiceConfigUpdate is a polymorphic base.
PolymorphicNetworkServiceDeleteResponse is a polymorphic base.
PolymorphicNetworkServicePatch is a polymorphic base.
PolymorphicNetworkServiceRequest is a polymorphic base.
PolymorphicNetworkServiceUpdate is a polymorphic base.
PolymorphicProductOffering is a polymorphic base.
PolymorphicProductOfferingPatch is a polymorphic base.
PolymorphicVLANConfig is a polymorphic base.
PopsListQuery has all query parameters for PopsList.
Port Port.
PortReservation A PortReservation.
PortReservationCancellationPolicyQuery has all query parameters for PortReservationCancellationPolicy.
PortReservationPatch PortReservation Update.
PortReservationRequest A PortReservation.
PortReservationsListQuery has all query parameters for PortReservationsList.
PortReservationUpdate PortReservation Update.
PortsListQuery has all query parameters for PortsList.
PortStatistics Port Statistics.
ProblemResponse Encodes a problem into an appropriate response body.
ProductOfferingsListQuery has all query parameters for ProductOfferingsList.
RefreshTokenRequest RefreshTokenRequest.
Role Role for a Contact.
RoleAssignment A role assignment for a contact.
RoleAssignmentPatch A role assignment update.
RoleAssignmentRequest A role assignment request.
RoleAssignmentsListQuery has all query parameters for RoleAssignmentsList.
RoleAssignmentUpdate A role assignemnt update.
RolePatch Role Update.
RoleRequest Create Role.
RolesListQuery has all query parameters for RolesList.
RoleUpdate Role Update.
RouteServerNetworkFeature Route Server Network Feature.
RouteServerNetworkFeatureConfig Route Server Network Feature Config.
RouteServerNetworkFeatureConfigPatch Route Server Network Feature Config Update.
RouteServerNetworkFeatureConfigRequest Route Server Network Feature Config Request.
RouteServerNetworkFeatureConfigUpdate Route Server Network Feature Config Update.
Status Status Message.
ValidationError indicates that the validation of user data failed.
ValidationErrorProp A failed validation.
ValidationErrorProperty A failed validation.
VLANConfigDot1Q A Dot1Q vlan configuration.
VLANConfigPort A Port vlan configuration.
VLANConfigQinQ A QinQ vlan configuration.
# Interfaces
AuthenticationProvider is an interface for authentication.
MemberJoiningRule Polymorphic Member Joining Rule.
MemberJoiningRulePatch Polymorphic Member Joining Rule Update.
MemberJoiningRuleRequest Polymorphic Member Joining Rule Request.
MemberJoiningRuleUpdate Polymorphic Member Joining Rule Update.
NetworkFeature Polymorphic Network Feature.
NetworkFeatureConfig Polymorphic Network Feature Config.
NetworkFeatureConfigPatch Polymorphic Network Feauture Config Patch.
NetworkFeatureConfigRequest Polymorphic Network Feature Config Request.
NetworkFeatureConfigUpdate Polymorphic Network Feauture Config Update.
NetworkService Polymorphic Network Services.
NetworkServiceConfig Polymorphic Network Service Config.
NetworkServiceConfigPatch Polymorphic Network Service Config.
NetworkServiceConfigRequest Polymorhic Network Service Config Request.
NetworkServiceConfigUpdate Polymorphic Network Service Config.
NetworkServiceDeleteResponse Polymorphic Network Service Request.
NetworkServicePatch Polymorphic Network Service Patch.
NetworkServiceRequest Polymorphic Network Service Request.
NetworkServiceUpdate Polymorphic Network Service Update.
Polymorphic indicates that the type is polymorphic.
ProductOffering Polymorphic Product Offering.
ProductOfferingPatch Polymorphic Product Offering.
Response is an IX-API general response.
VLANConfig The vlan configuration defines how the service is made available on the connection.
# Type aliases
Date is a date only time type representing a date without time.
TestResponseFunc is a test response generator.