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

# README

Go API client for openapi_ChargeableParty

API for Chargeable Party management.
© 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.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_ChargeableParty "github.com/GIT_USER_ID/GIT_REPO_ID/openapi_ChargeableParty"

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

Documentation for API Endpoints

All URIs are relative to https://example.com/3gpp-chargeable-party/v1

ClassMethodHTTP requestDescription
ChargeablePartyTransactionOperationApiCreateChargeablePartyTransactionPost /{scsAsId}/transactionsCreate a new chargeable party transaction resource.
ChargeablePartyTransactionOperationApiFetchAllChargeablePartyTransactionsGet /{scsAsId}/transactionsRead all or queried chargeable party transaction resources for a given SCS/AS.
IndividualChargeablePartyResourceOperationApiDeleteChargeablePartyTransactionDelete /{scsAsId}/transactions/{transactionId}Deletes a chargeable party resource for a given SCS/AS and a transcation Id.
IndividualChargeablePartyResourceOperationApiFetchIndChargeablePartyTransactionGet /{scsAsId}/transactions/{transactionId}Read a chargeable party resource for a given SCS/AS and a transaction Id.
IndividualChargeablePartyResourceOperationApiUpdateChargeablePartyTransactionPatch /{scsAsId}/transactions/{transactionId}Updates a existing chargeable party resource for a given SCS/AS and transaction Id.

Documentation For Models

Documentation For Authorization

oAuth2ClientCredentials

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes: N/A

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.
interface{}AsIpAddr is a convenience function that returns interface{} wrapped in IpAddr.
IsNil checks if an input is nil.
NewAccumulatedUsage instantiates a new AccumulatedUsage 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.
NewAccumulatedUsageWithDefaults instantiates a new AccumulatedUsage 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.
NewChargeableParty instantiates a new ChargeableParty 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.
NewChargeablePartyPatch instantiates a new ChargeablePartyPatch 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.
NewChargeablePartyPatchWithDefaults instantiates a new ChargeablePartyPatch 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.
NewChargeablePartyWithDefaults instantiates a new ChargeableParty 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.
NewEthFlowDescription instantiates a new EthFlowDescription 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.
NewEthFlowDescriptionWithDefaults instantiates a new EthFlowDescription 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.
NewEventReport instantiates a new EventReport 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.
NewEventReportWithDefaults instantiates a new EventReport 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.
NewFlowInfo instantiates a new FlowInfo 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.
NewFlowInfoWithDefaults instantiates a new FlowInfo 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.
NewIpv6Addr instantiates a new Ipv6Addr 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.
NewIpv6AddrWithDefaults instantiates a new Ipv6Addr 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.
NewIpv6Prefix instantiates a new Ipv6Prefix 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.
NewIpv6PrefixWithDefaults instantiates a new Ipv6Prefix 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.
NewNotificationData instantiates a new NotificationData 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.
NewNotificationDataWithDefaults instantiates a new NotificationData 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
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.
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.
NewSponsorInformation instantiates a new SponsorInformation 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.
NewSponsorInformationWithDefaults instantiates a new SponsorInformation 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.
NewUsageThreshold instantiates a new UsageThreshold 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.
NewUsageThresholdRm instantiates a new UsageThresholdRm 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.
NewUsageThresholdRmWithDefaults instantiates a new UsageThresholdRm 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.
NewUsageThresholdWithDefaults instantiates a new UsageThreshold 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.
NewWebsockNotifConfig instantiates a new WebsockNotifConfig 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.
NewWebsockNotifConfigWithDefaults instantiates a new WebsockNotifConfig 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

AccumulatedUsage Represents an accumulated usage.
APIClient manages communication with the 3gpp-chargeable-party API v1.2.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
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
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
ChargeableParty Represents the configuration of a chargeable party.
ChargeablePartyPatch Represents a modification request of a chargeable party resource.
Configuration stores the configuration of the API client.
EthFlowDescription Identifies an Ethernet flow.
Event Possible values are: - SESSION_TERMINATION: Indicates that Rx session is terminated.
EventReport Represents an event report.
FlowDirection Possible values are: - DOWNLINK: The corresponding filter applies for traffic to the UE.
FlowInfo Represents IP flow information.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
InvalidParam Represents the description of invalid parameters, for a request rejected due to invalid parameters.
IpAddr - Contains an IP adresse.
Ipv6Addr String identifying an IPv6 address formatted according to clause 4 of RFC5952.
Ipv6Prefix String identifying an IPv6 address prefix formatted according to clause 4 of RFC 5952.
NotificationData Represents the information to be conveyed in a bearer level event(s) notification.
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
ProblemDetails Represents additional information and details on an error response.
ServAuthInfo Indicates the result of the Policy Authorization service request from the AF.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Snssai When Snssai needs to be converted to string (e.g.
SponsorInformation Represents a sponsor information.
UsageThreshold Represents a usage threshold.
UsageThresholdRm Represents the same as the UsageThreshold data type but with the nullable:true property.
WebsockNotifConfig Represents the configuration information for the delivery of notifications over Websockets.

# Interfaces

No description provided by the author

# Type aliases

ChargeablePartyTransactionOperationApiService ChargeablePartyTransactionOperationApi service.
IndividualChargeablePartyResourceOperationApiService IndividualChargeablePartyResourceOperationApi service.
ServerConfigurations stores multiple ServerConfiguration items.