package
1.18.2
Repository: https://github.com/5gcorenet/openapi.git
Documentation: pkg.go.dev

# README

Go API client for openapi_Nnef_SMContext

Nnef SMContext 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: 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_Nnef_SMContext "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_Nnef_SMContext"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/nnef-smcontext/v1

ClassMethodHTTP requestDescription
IndividualSMContextDocumentApiDeletePost /sm-contexts/{smContextId}/releaseDelete SM Context
IndividualSMContextDocumentApiDeliverPost /sm-contexts/{smContextId}/deliverDeliver Uplink MO Data
IndividualSMContextDocumentApiUpdatePost /sm-contexts/{smContextId}/updateUpdate SM Context
SMContextsCollectionCollectionApiCreatePost /sm-contextsCreate SM Context

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
  • nnef-smcontext: Access to the Nnef_SMContext 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

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAccessTokenErr instantiates a new AccessTokenErr object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccessTokenErrWithDefaults instantiates a new AccessTokenErr object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAccessTokenReq instantiates a new AccessTokenReq object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAccessTokenReqWithDefaults instantiates a new AccessTokenReq object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewApnRateStatus instantiates a new ApnRateStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewApnRateStatusWithDefaults instantiates a new ApnRateStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewDeliverReqData instantiates a new DeliverReqData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeliverReqDataWithDefaults instantiates a new DeliverReqData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeliverRequest instantiates a new DeliverRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeliverRequestWithDefaults instantiates a new DeliverRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewInvalidParam instantiates a new InvalidParam object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewInvalidParamWithDefaults instantiates a new InvalidParam object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewNiddInformation instantiates a new NiddInformation object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewNiddInformationWithDefaults instantiates a new NiddInformation object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPlmnId instantiates a new PlmnId object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPlmnIdNid instantiates a new PlmnIdNid object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPlmnIdNidWithDefaults instantiates a new PlmnIdNid object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewPlmnIdWithDefaults instantiates a new PlmnId object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProblemDetails instantiates a new ProblemDetails object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProblemDetailsWithDefaults instantiates a new ProblemDetails object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRedirectResponse instantiates a new RedirectResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRedirectResponseWithDefaults instantiates a new RedirectResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefToBinaryData instantiates a new RefToBinaryData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefToBinaryDataWithDefaults instantiates a new RefToBinaryData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmallDataRateControl instantiates a new SmallDataRateControl object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmallDataRateControlWithDefaults instantiates a new SmallDataRateControl object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmallDataRateStatus instantiates a new SmallDataRateStatus object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmallDataRateStatusWithDefaults instantiates a new SmallDataRateStatus object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextConfiguration instantiates a new SmContextConfiguration object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextConfigurationWithDefaults instantiates a new SmContextConfiguration object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextCreateData instantiates a new SmContextCreateData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextCreateDataWithDefaults instantiates a new SmContextCreateData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextCreatedData instantiates a new SmContextCreatedData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextCreatedDataWithDefaults instantiates a new SmContextCreatedData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextReleaseData instantiates a new SmContextReleaseData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextReleaseDataWithDefaults instantiates a new SmContextReleaseData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextReleasedData instantiates a new SmContextReleasedData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextReleasedDataWithDefaults instantiates a new SmContextReleasedData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextStatusNotification instantiates a new SmContextStatusNotification object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextStatusNotificationWithDefaults instantiates a new SmContextStatusNotification object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSmContextUpdateData instantiates a new SmContextUpdateData object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSmContextUpdateDataWithDefaults instantiates a new SmContextUpdateData object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnssai instantiates a new Snssai object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnssaiWithDefaults instantiates a new Snssai object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.

# Variables

ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.

# Structs

AccessTokenErr Error returned in the access token response message.
AccessTokenReq Contains information related to the access token request.
APIClient manages communication with the Nnef_SMContext API v1.2.0-alpha.1 In most cases there should be only one, shared, APIClient.
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
No description provided by the author
ApnRateStatus Contains the APN rate control status e.g.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
DeliverReqData The data for Deliver service request, including the Mobile Originated data to be delivered via NEF.
DeliverRequest struct for DeliverRequest.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InvalidParam It contains an invalid parameter and a related description.
NFType NF types known to NRF.
NiddInformation Informaiton related to NIDD used for the SM Context.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PlmnId When PlmnId needs to be converted to string (e.g.
PlmnIdNid Contains the serving core network operator PLMN ID and, for an SNPN, the NID that together with the PLMN ID identifies the SNPN.
ProblemDetails Provides additional information in an error response.
RedirectResponse The response shall include a Location header field containing a different URI (pointing to a different URI of an other service instance), or the same URI if a request is redirected to the same target resource via a different SCP.
RefToBinaryData This parameter provides information about the referenced binary body data.
ReleaseCause The cause to release the SM Context.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
SmallDataRateControl Configuration of Small Data Rate Control for the SM Context.
SmallDataRateControlTimeUnit Possible values are - MINUTE: Indicates the rate control is applied per minute.
SmallDataRateStatus It indicates theSmall Data Rate Control Status.
SmContextConfiguration NIDD Configuration for the SM context.
SmContextCreateData Representation of the Individual SM context to be created.
SmContextCreatedData Representation of an Individual SM context successfully created.
SmContextReleaseData Representation of the information to release the Individual SM context.
SmContextReleasedData Successful release of an Individual SM context with information sent to the NF service consumer.
SmContextStatus Possible values are - RELEASED: Indicates that the Individual SM Context for NIDD is released.
SmContextStatusNotification Representation of the SM Context status notification.
SmContextUpdateData Representation of the updates to apply to the Individual SM context.
Snssai When Snssai needs to be converted to string (e.g.

# Interfaces

No description provided by the author

# Type aliases

IndividualSMContextDocumentApiService IndividualSMContextDocumentApi service.
ServerConfigurations stores multiple ServerConfiguration items.
SMContextsCollectionCollectionApiService SMContextsCollectionCollectionApi service.