# README

Go API client for openapi_Nudm_SDM

Nudm Subscriber Data Management Service.
© 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: 2.3.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_Nudm_SDM "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nudm_SDM"

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_Nudm_SDM.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_Nudm_SDM.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_Nudm_SDM.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi_Nudm_SDM.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://example.com/nudm-sdm/v2

Class	Method	HTTP request	Description
AccessAndMobilitySubscriptionDataRetrievalApi	GetAmData	Get /{supi}/am-data	retrieve a UE's Access and Mobility Subscription Data
Class5MBSSubscriptionDataRetrievalApi	GetMbsData	Get /{supi}/5mbs-data	retrieve a UE's 5MBS Subscription Data
EnhancedCoverageRestrictionDataRetrievalApi	GetEcrData	Get /{supi}/am-data/ecr-data	retrieve a UE's subscribed Enhanced Coverage Restriction Data
GPSIToSUPITranslationOrSUPIToGPSITranslationApi	GetSupiOrGpsi	Get /{ueId}/id-translation-result	retrieve a UE's SUPI or GPSI
GroupIdentifiersApi	GetGroupIdentifiers	Get /group-data/group-identifiers	Mapping of Group Identifiers
LCSBroadcastAssistanceDataTypesRetrievalApi	GetLcsBcaData	Get /{supi}/lcs-bca-data	retrieve a UE's LCS Broadcast Assistance Data Types Subscription Data
LCSMobileOriginatedDataRetrievalApi	GetLcsMoData	Get /{supi}/lcs-mo-data	retrieve a UE's LCS Mobile Originated Subscription Data
LCSPrivacyDataRetrievalApi	GetLcsPrivacyData	Get /{ueId}/lcs-privacy-data	retrieve a UE's LCS Privacy Subscription Data
MultipleIdentifiersApi	GetMultipleIdentifiers	Get /multiple-identifiers	Mapping of UE Identifiers
ProseSubscriptionDataRetrievalApi	GetProseData	Get /{supi}/prose-data	retrieve a UE's ProSe Subscription Data
ProvidingAcknowledgementOfCAGUpdateApi	CAGAck	Put /{supi}/am-data/cag-ack	Nudm_Sdm Info operation for CAG acknowledgement
ProvidingAcknowledgementOfSNSSAIsUpdateApi	SNSSAIsAck	Put /{supi}/am-data/subscribed-snssais-ack	Nudm_Sdm Info operation for S-NSSAIs acknowledgement
ProvidingAcknowledgementOfSteeringOfRoamingApi	SorAckInfo	Put /{supi}/am-data/sor-ack	Nudm_Sdm Info service operation
ProvidingAcknowledgementOfUEParametersUpdateApi	UpuAck	Put /{supi}/am-data/upu-ack	Nudm_Sdm Info for UPU service operation
RetrievalOfMultipleDataSetsApi	GetDataSets	Get /{supi}	retrieve multiple data sets
RetrievalOfSharedDataApi	GetSharedData	Get /shared-data	retrieve shared data
RetrievalOfTheIndividualSharedDataApi	GetIndividualSharedData	Get /shared-data/{sharedDataId}	retrieve the individual shared data
SMFSelectionSubscriptionDataRetrievalApi	GetSmfSelData	Get /{supi}/smf-select-data	retrieve a UE's SMF Selection Subscription Data
SMSManagementSubscriptionDataRetrievalApi	GetSmsMngtData	Get /{supi}/sms-mng-data	retrieve a UE's SMS Management Subscription Data
SMSSubscriptionDataRetrievalApi	GetSmsData	Get /{supi}/sms-data	retrieve a UE's SMS Subscription Data
SessionManagementSubscriptionDataRetrievalApi	GetSmData	Get /{supi}/sm-data	retrieve a UE's Session Management Subscription Data
SliceSelectionSubscriptionDataRetrievalApi	GetNSSAI	Get /{supi}/nssai	retrieve a UE's subscribed NSSAI
SubscriptionCreationApi	Subscribe	Post /{ueId}/sdm-subscriptions	subscribe to notifications
SubscriptionCreationForSharedDataApi	SubscribeToSharedData	Post /shared-data-subscriptions	subscribe to notifications for shared data
SubscriptionDeletionApi	Unsubscribe	Delete /{ueId}/sdm-subscriptions/{subscriptionId}	unsubscribe from notifications
SubscriptionDeletionForSharedDataApi	UnsubscribeForSharedData	Delete /shared-data-subscriptions/{subscriptionId}	unsubscribe from notifications for shared data
SubscriptionModificationApi	Modify	Patch /{ueId}/sdm-subscriptions/{subscriptionId}	modify the subscription
SubscriptionModificationApi	ModifySharedDataSubs	Patch /shared-data-subscriptions/{subscriptionId}	modify the subscription
TraceConfigurationDataRetrievalApi	GetTraceConfigData	Get /{supi}/trace-data	retrieve a UE's Trace Configuration Data
TriggerSORInfoUpdateApi	UpdateSORInfo	Post /{supi}/am-data/update-sor	Nudm_Sdm custom operation to trigger SOR info update
UEContextInAMFDataRetrievalApi	GetUeCtxInAmfData	Get /{supi}/ue-context-in-amf-data	retrieve a UE's UE Context In AMF Data
UEContextInSMFDataRetrievalApi	GetUeCtxInSmfData	Get /{supi}/ue-context-in-smf-data	retrieve a UE's UE Context In SMF Data
UEContextInSMSFDataRetrievalApi	GetUeCtxInSmsfData	Get /{supi}/ue-context-in-smsf-data	retrieve a UE's UE Context In SMSF Data
UserConsentSubscriptionDataRetrievalApi	GetUcData	Get /{supi}/uc-data	retrieve a UE's User Consent Subscription Data
V2XSubscriptionDataRetrievalApi	GetV2xData	Get /{supi}/v2x-data	retrieve a UE's V2X Subscription Data

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

Type: OAuth
Flow: application
Authorization URL:
Scopes:
nudm-sdm: Access to the nudm-sdm API

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