Go API client for openapi_Nhss_imsSDM

Nhss Subscriber Data Management Service for IMS.
© 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
All rights reserved.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.2.0-alpha.1
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi_Nhss_imsSDM "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nhss_imsSDM"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi_Nhss_imsSDM.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi_Nhss_imsSDM.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi_Nhss_imsSDM.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi_Nhss_imsSDM.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://example.com/nhss-ims-sdm/v1

Class	Method	HTTP request	Description
CSLocationRetrievalApi	GetLocCsDomain	Get /{imsUeId}/access-data/cs-domain/location-data	Retrieve the location data in CS domain
CSRNRetrievalApi	GetCsrn	Get /{imsUeId}/access-data/cs-domain/csrn	Retrieve the routeing number in CS domain
CSUserStateInfoRetrievalApi	GetCsUserStateInfo	Get /{imsUeId}/access-data/cs-domain/user-state	Retrieve the user state information in CS domain
ChargingInfoRetrievalApi	GetChargingInfo	Get /{imsUeId}/ims-data/profile-data/charging-info	Retrieve the charging information for to the user
DSAIRegistrationInformationApi	GetDsaiInfo	Get /{imsUeId}/service-data/dsai	Retrieve the DSAI information associated to an Application Server
DeleteRepositoryDataApi	DeleteRepositoryDataServInd	Delete /{imsUeId}/repository-data/{serviceIndication}	delete the Repository Data for a Service Indication
DeleteSMSRegistrationInformationApi	DeleteSmsRegistrationInfo	Delete /{imsUeId}/service-data/sms-registration-info	delete the SMS registration information
IFCsRetrievalApi	GetIfcs	Get /{imsUeId}/ims-data/profile-data/ifcs	Retrieve the Initial Filter Criteria for the associated IMS subscription
IMEISVRetrievalApi	GetIMEISVInfo	Get /{imsUeId}/identities/imeisv	Retrieve the IMEISV information
IMSProfileDataRetrievalApi	GetProfileData	Get /{imsUeId}/ims-data/profile-data	Retrieve the complete IMS profile for a given IMS public identity (and public identities in the same IRS)
IPAddressInfoRetrievalApi	GetIpAddressInfo	Get /{imsUeId}/access-data/ps-domain/ip-address	Retrieve the IP address information
PSLocationRetrievalApi	GetLocPsDomain	Get /{imsUeId}/access-data/ps-domain/location-data	Retrieve the location data in PS domain
PSUserStateInfoRetrievalApi	GetPsUserStateInfo	Get /{imsUeId}/access-data/ps-domain/user-state	Retrieve the user state information in PS domain
PriorityInfoRetrievalApi	GetPriorityInfo	Get /{imsUeId}/ims-data/profile-data/priority-levels	Retrieve the service priority levels associated to the user
ReachabilitySubscriptionDeletionApi	UeReachUnsubscribe	Delete /{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}	unsubscribe from notifications to UE reachability
ReachabilitySubscriptionModificationApi	UeReachSubsModify	Patch /{imsUeId}/access-data/ps-domain/ue-reach-subscriptions/{subscriptionId}	modify the subscription
ReferenceLocationInfoRetrievalApi	GetReferenceLocationInfo	Get /{imsUeId}/access-data/wireline-domain/reference-location	Retrieve the reference location information
RegistrationStatusRetrievalApi	GetRegistrationStatus	Get /{imsUeId}/ims-data/registration-status	Retrieve the registration status of a user
RepositoryDataApi	GetRepositoryDataServInd	Get /{imsUeId}/repository-data/{serviceIndication}	Retrieve the repository data associated to an IMPU and service indication
RepositoryDataListApi	GetRepositoryDataServIndList	Get /{imsUeId}/repository-data	Retrieve the repository data associated to an IMPU and service indication list
RetrievalOfAssociatedIMSPrivateIdentitiesApi	GetImsPrivateIds	Get /{imsUeId}/identities/private-identities	Retrieve the associated private identities to the IMS public identity included in the service request
RetrievalOfAssociatedIMSPublicIdentitiesApi	GetImsAssocIds	Get /{imsUeId}/identities/ims-associated-identities	Retrieve the associated identities to the IMS public identity included in the service request
RetrievalOfPSIActivationStateApi	GetPsiState	Get /{imsUeId}/service-data/psi-status	Retrieve the PSI activation state data
RetrievalOfSharedDataApi	GetSharedData	Get /shared-data	retrieve shared data
RetrievalOfTheAssociatedMsisdnsApi	GetMsisdns	Get /{imsUeId}/identities/msisdns	retrieve the Msisdns associated to requested identity
RetrievalOfTheSCSCFCapabilitiesForTheIMSSubscriptionApi	GetScscfCapabilities	Get /{imsUeId}/ims-data/location-data/scscf-capabilities	Retrieve the S-CSCF capabilities for the associated IMS subscription
RetrievalOfTheSCSCFSelectionAssistanceInformationForTheIMSSubscriptionApi	GetScscfSelectionAssistanceInfo	Get /{imsUeId}/ims-data/location-data/scscf-selection-assistance-info	Retrieve the S-CSCF selection assistance info
RetrievalOfUESRVCCCapabilityAndSTNSRApi	GetSrvccData	Get /{imsUeId}/srvcc-data	Retrieve the srvcc data
SDMSubscriptionCreationApi	ImsSdmSubscribe	Post /{imsUeId}/subscriptions	subscribe to notifications
SDMSubscriptionDeletionApi	ImsSdmUnsubscribe	Delete /{imsUeId}/subscriptions/{subscriptionId}	unsubscribe from notifications
SDMSubscriptionModificationApi	ImsSdmSubsModify	Patch /{imsUeId}/subscriptions/{subscriptionId}	modify the subscription
SMSRegistrationInformationApi	GetSmsRegistrationInfo	Get /{imsUeId}/service-data/sms-registration-info	Retrieve the SMS registration information associated to a user
ServerNameRetrievalApi	GetServerName	Get /{imsUeId}/ims-data/location-data/server-name	Retrieve the server name for the associated user
ServiceTraceInfoRetrievalApi	GetServiceTraceInfo	Get /{imsUeId}/ims-data/profile-data/service-level-trace-information	Retrieve the IMS service level trace information for the associated user
SubscriptionCreationForSharedDataApi	SubscribeToSharedData	Post /shared-data-subscriptions	subscribe to notifications for shared data
SubscriptionDeletionForSharedDataApi	UnsubscribeForSharedData	Delete /shared-data-subscriptions/{subscriptionId}	unsubscribe from notifications for shared data
SubscriptionModificationApi	ModifySharedDataSubs	Patch /shared-data-subscriptions/{subscriptionId}	modify the subscription
TADSInfoRetrievalApi	GetTadsInfo	Get /{imsUeId}/access-data/ps-domain/tads-info	Retrieve the T-ADS information
UEIPReachabilitySubscriptionCreationApi	UeReachIpSubscribe	Post /{imsUeId}/access-data/ps-domain/ue-reach-subscriptions	subscribe to notifications of UE reachability
UpdateDsaiStateApi	UpdateDsaiState	Patch /{imsUeId}/service-data/dsai	Patch
UpdatePSIStateDataApi	UpdatePsiState	Patch /{imsUeId}/service-data/psi-status	Patch
UpdateRepositoryDataApi	UpdateRepositoryDataServInd	Put /{imsUeId}/repository-data/{serviceIndication}	Update the repository data associated to an IMPU and service indication
UpdateSMSRegistrationInfoApi	UpdateSmsRegistrationInfo	Put /{imsUeId}/service-data/sms-registration-info	Update the SMS registration information associated to a user
UpdateSRVCCDataApi	UpdateSrvccData	Patch /{imsUeId}/srvcc-data	Patch

Documentation For Models

• AccessTokenErr
• AccessTokenReq
• AccessType
• AccessType1
• ActivationState
• AmfLocationData
• ApplicationServer
• CallReferenceInfo
• CellGlobalId
• ChangeItem
• ChangeType
• ChargingInfo
• CoreNetworkServiceAuthorization
• CreatedUeReachabilitySubscription
• CsLocation
• CsUserState
• CsgInformation
• Csrn
• DataSetName
• DetectingNode
• DsaiTagInformation
• DsaiTagStatus
• Ecgi
• EutraLocation
• GNbId
• GeraLocation
• GlobalRanNodeId
• HeaderSipRequest
• IdentityType
• Ifc
• Ifcs
• ImeiSvInformation
• ImsAssociatedIdentities
• ImsLocationData
• ImsProfileData
• ImsRegistrationState
• ImsRegistrationStatus
• ImsSdmSubscription
• ImsServiceProfile
• ImsVoiceOverPsSessionSupport
• InvalidParam
• IpAddr
• IpSmGwAddress
• Ipv6Addr
• Ipv6Prefix
• LocationAreaId
• MmeLocationData
• ModificationNotification
• MsisdnList
• NFType
• Ncgi
• NotifyItem
• NrLocation
• PatchItem
• PatchOperation
• PatchResult
• PlmnId
• PlmnIdNid
• PriorityLevels
• PrivateIdentities
• PrivateIdentity
• PrivateIdentityType
• ProblemDetails
• PsLocation
• PsUserState
• PsiActivationState
• PublicIdentifier
• PublicIdentities
• PublicIdentity
• RatType
• RedirectResponse
• ReferenceLocationInformation
• RegistrationType
• ReportItem
• RepositoryData
• RepositoryDataList
• RequestDirection
• RequestedNode
• RoutingAreaId
• ScscfCapabilityList
• ScscfSelectionAssistanceInformation
• SdpDescription
• ServiceAreaId
• ServiceInformation
• ServiceLevelTraceInformation
• SgsnLocationData
• SharedData
• SmsRegistrationInfo
• Snssai
• Spt
• SrvccCapability
• SrvccData
• TadsInformation
• Tai
• TriggerPoint
• TwanLocationData
• TypeOfCondition
• UeReachabilityNotification
• UeReachabilitySubscription
• UserStateCs
• UserStatePs
• UtraLocation

Documentation For Authorization

oAuth2ClientCredentials

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• nhss-ims-sdm: Access to the Nhss IMS Subscription Data Management API
• nhss-ims-sdm:registration-status:read: Access to read the Registration Status resource
• nhss-ims-sdm:profile-data:read: Access to read the Profile Data resource
• nhss-ims-sdm:priority-levels:read: Access to read the Priority Levels resource
• nhss-ims-sdm:ifcs:read: Access to read the Initial Filter Criteria resource
• nhss-ims-sdm:service-level-trace-information:read: Access to read the Service Level Trace Information resource
• nhss-ims-sdm:server-name:read: Access to read the Server Name resource
• nhss-ims-sdm:scscf-capabilities:read: Access to read the S-CSCF Capabilities resource
• nhss-ims-sdm:ps-domain:location-data:read: Access to read the PS-Domain Location Data resource
• nhss-ims-sdm:ps-domain:ip-address:read: Access to read the PS-Domain IP Address resource
• nhss-ims-sdm:ps-domain:tads-info:read: Access to read the PS-Domain TADS Info resource
• nhss-ims-sdm:ps-domain:ue-reach-subscriptions:create: Access to create PS-Domain UE Reachability Subscriptions resources
• nhss-ims-sdm:ps-domain:ue-reach-subscriptions:modify: Access to update/delete a PS-Domain UE Reachability Subscription resource
• nhss-ims-sdm:ps-domain:user-state:read: Access to read the PS-Domain User State resource
• nhss-ims-sdm:cs-domain:location-data:read: Access to read the CS-Domain Location Data resource
• nhss-ims-sdm:cs-domain:user-state:read: Access to read the CS-Domain User State resource
• nhss-ims-sdm:cs-domain:csrn:read: Access to read the CS-Domain CSRN resource
• nhss-ims-sdm:wireline-domain:reference-location:read: Access to read the Wireline-Domain Reference Location resource
• nhss-ims-sdm:repository-data:modify: Access to create/update/delete the Repository Data resource
• nhss-ims-sdm:repository-data:read: Access to read the Repository Data resource
• nhss-ims-sdm:identities:read: Access to read the Identities resource
• nhss-ims-sdm:srvcc:read: Access to read the SRVCC resource
• nhss-ims-sdm:srvcc:modify: Acess to update the SRVCC resource
• nhss-ims-sdm:psi-status:read: Access to read the PSI Status resource
• nhss-ims-sdm:psi-status:modify: Acess to update the PSI Status resource
• nhss-ims-sdm:dsai:read: Acess to read the DSAI resource
• nhss-ims-sdm:dsai:modify: Acess to update the DSAI resource
• nhss-ims-sdm:sms-registration-info:read: Acess to read the SMS Registration Info resource
• nhss-ims-sdm:sms-registration-info:modify: Acess to create/update/delete the SMS Registration Info resource
• nhss-ims-sdm:subscriptions:create: Access to create Subscriptions resources
• nhss-ims-sdm:subscription:modify: Access to update/delete a Subscription resource
• nhss-ims-sdm:shared-subscriptions:create: Access to create a Shared-Data Subscriptions resource
• nhss-ims-sdm:shared-subscription:modify: Access to update/delete a Shared-Data Subscription resource
• nhss-ims-sdm:shared-data:read: Access to read the Shared-Data resource
• nhss-ims-sdm:charging-info:read: Access to read the ChargingInfo resource

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author