# README

Go API client for openapi_Policy_Data

The API version is defined in 3GPP TS 29.504
© 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: -
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/net/context

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

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

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AccessAndMobilityPolicyDataDocumentApi	ReadAccessAndMobilityPolicyData	Get /policy-data/ues/{ueId}/am-data	Retrieves the access and mobility policy data for a subscriber
BdtDataStoreApi	ReadBdtData	Get /policy-data/bdt-data	Retrieves the BDT data collection
IndividualBdtDataDocumentApi	CreateIndividualBdtData	Put /policy-data/bdt-data/{bdtReferenceId}	Creates an BDT data resource associated with an BDT reference Id
IndividualBdtDataDocumentApi	DeleteIndividualBdtData	Delete /policy-data/bdt-data/{bdtReferenceId}	Deletes an BDT data resource associated with an BDT reference Id
IndividualBdtDataDocumentApi	ReadIndividualBdtData	Get /policy-data/bdt-data/{bdtReferenceId}	Retrieves the BDT data information associated with a BDT reference Id
IndividualBdtDataDocumentApi	UpdateIndividualBdtData	Patch /policy-data/bdt-data/{bdtReferenceId}	Modifies an BDT data resource associated with an BDT reference Id
IndividualPolicyDataSubscriptionDocumentApi	DeleteIndividualPolicyDataSubscription	Delete /policy-data/subs-to-notify/{subsId}	Delete the individual Policy Data subscription
IndividualPolicyDataSubscriptionDocumentApi	ReplaceIndividualPolicyDataSubscription	Put /policy-data/subs-to-notify/{subsId}	Modify a subscription to receive notification of policy data changes
MBSSessionPolicyControlDataDocumentApi	GetMBSSessPolCtrlData	Get /policy-data/mbs-session-pol-data/{polSessionId}	Retrieve MBS Session Policy Control Data for an MBS Session.
OperatorSpecificDataDocumentApi	DeleteOperatorSpecificData	Delete /policy-data/ues/{ueId}/operator-specific-data	When the feature OSDResource_Create_Delete is supported, delete OperatorSpecificData resource
OperatorSpecificDataDocumentApi	ReadOperatorSpecificData	Get /policy-data/ues/{ueId}/operator-specific-data	Retrieve the operator specific policy data of an UE
OperatorSpecificDataDocumentApi	ReplaceOperatorSpecificData	Put /policy-data/ues/{ueId}/operator-specific-data	Create or modify the operator specific policy data of a UE
OperatorSpecificDataDocumentApi	UpdateOperatorSpecificData	Patch /policy-data/ues/{ueId}/operator-specific-data	Modify the operator specific policy data of a UE
PlmnUePolicySetDocumentApi	ReadPlmnUePolicySet	Get /policy-data/plmns/{plmnId}/ue-policy-set	Retrieve the UE policy set data for an H-PLMN
PolicyDataForIndividualUeDocumentApi	ReadPolicyData	Get /policy-data/ues/{ueId}	Retrieve the policy data for a subscriber
PolicyDataSubscriptionsCollectionApi	CreateIndividualPolicyDataSubscription	Post /policy-data/subs-to-notify	Create a subscription to receive notification of policy data changes
SessionManagementPolicyDataDocumentApi	ReadSessionManagementPolicyData	Get /policy-data/ues/{ueId}/sm-data	Retrieves the session management policy data for a subscriber
SessionManagementPolicyDataDocumentApi	UpdateSessionManagementPolicyData	Patch /policy-data/ues/{ueId}/sm-data	Modify the session management policy data for a subscriber
SlicePolicyControlDataDocumentApi	ReadSlicePolicyControlData	Get /policy-data/slice-control-data/{snssai}	Retrieves a network Slice specific policy control data resource
SlicePolicyControlDataDocumentApi	UpdateSlicePolicyControlData	Patch /policy-data/slice-control-data/{snssai}	Modify a network Slice specific policy control data resource
SponsorConnectivityDataDocumentApi	ReadSponsorConnectivityData	Get /policy-data/sponsor-connectivity-data/{sponsorId}	Retrieves the sponsored connectivity information for a given sponsorId
UEPolicySetDocumentApi	CreateOrReplaceUEPolicySet	Put /policy-data/ues/{ueId}/ue-policy-set	Create or modify the UE policy set data for a subscriber
UEPolicySetDocumentApi	ReadUEPolicySet	Get /policy-data/ues/{ueId}/ue-policy-set	Retrieves the UE policy set data for a subscriber
UEPolicySetDocumentApi	UpdateUEPolicySet	Patch /policy-data/ues/{ueId}/ue-policy-set	Modify the UE policy set data for a subscriber
UsageMonitoringInformationDocumentApi	CreateUsageMonitoringResource	Put /policy-data/ues/{ueId}/sm-data/{usageMonId}	Create a usage monitoring resource
UsageMonitoringInformationDocumentApi	DeleteUsageMonitoringInformation	Delete /policy-data/ues/{ueId}/sm-data/{usageMonId}	Delete a usage monitoring resource
UsageMonitoringInformationDocumentApi	ReadUsageMonitoringInformation	Get /policy-data/ues/{ueId}/sm-data/{usageMonId}	Retrieve a usage monitoring resource

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

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