sbim

package
v0.0.0-...-36a2cef Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2022 License: BSD-2-Clause, MIT Imports: 10 Imported by: 0

Documentation

Overview

Package sbim provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.

Package sbim provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen version (devel) DO NOT EDIT.

Index

Constants

View Source
const (
	OAuth2ClientCredentialsScopes = "oAuth2ClientCredentials.Scopes"
)

Variables

This section is empty.

Functions

func NewPostSmContextsRequest

func NewPostSmContextsRequest(server string, body PostSmContextsJSONRequestBody) (*http.Request, error)

NewPostSmContextsRequest calls the generic PostSmContexts builder with application/json body

func NewPostSmContextsRequestWithBody

func NewPostSmContextsRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error)

NewPostSmContextsRequestWithBody generates requests for PostSmContexts with any type of body

func NewReleaseSmContextRequest

func NewReleaseSmContextRequest(server string, smContextRef string, body ReleaseSmContextJSONRequestBody) (*http.Request, error)

NewReleaseSmContextRequest calls the generic ReleaseSmContext builder with application/json body

func NewReleaseSmContextRequestWithBody

func NewReleaseSmContextRequestWithBody(server string, smContextRef string, contentType string, body io.Reader) (*http.Request, error)

NewReleaseSmContextRequestWithBody generates requests for ReleaseSmContext with any type of body

func NewRetrieveSmContextRequest

func NewRetrieveSmContextRequest(server string, smContextRef string, body RetrieveSmContextJSONRequestBody) (*http.Request, error)

NewRetrieveSmContextRequest calls the generic RetrieveSmContext builder with application/json body

func NewRetrieveSmContextRequestWithBody

func NewRetrieveSmContextRequestWithBody(server string, smContextRef string, contentType string, body io.Reader) (*http.Request, error)

NewRetrieveSmContextRequestWithBody generates requests for RetrieveSmContext with any type of body

func NewUpdateSmContextRequest

func NewUpdateSmContextRequest(server string, smContextRef string, body UpdateSmContextJSONRequestBody) (*http.Request, error)

NewUpdateSmContextRequest calls the generic UpdateSmContext builder with application/json body

func NewUpdateSmContextRequestWithBody

func NewUpdateSmContextRequestWithBody(server string, smContextRef string, contentType string, body io.Reader) (*http.Request, error)

NewUpdateSmContextRequestWithBody generates requests for UpdateSmContext with any type of body

Types

type ChargingInformation

type ChargingInformation struct {
	DownlinkVolume int    `json:"downlinkVolume"`
	EndTimestamp   string `json:"endTimestamp"`
	StartTimestamp string `json:"startTimestamp"`
	UplinkVolume   int    `json:"uplinkVolume"`
}

Charging Information

type Client

type Client struct {
	// The endpoint of the server conforming to this interface, with scheme,
	// https://api.deepmap.com for example. This can contain a path relative
	// to the server, such as https://api.deepmap.com/dev-test, and all the
	// paths in the swagger spec will be appended to the server.
	Server string

	// Doer for performing requests, typically a *http.Client with any
	// customized settings, such as certificate chains.
	Client HttpRequestDoer

	// A list of callbacks for modifying requests which are generated before sending over
	// the network.
	RequestEditors []RequestEditorFn
}

Client which conforms to the OpenAPI3 specification for this service.

func NewClient

func NewClient(server string, opts ...ClientOption) (*Client, error)

Creates a new Client, with reasonable defaults

func (*Client) PostSmContexts

func (c *Client) PostSmContexts(ctx context.Context, body PostSmContextsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) PostSmContextsWithBody

func (c *Client) PostSmContextsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReleaseSmContext

func (c *Client) ReleaseSmContext(ctx context.Context, smContextRef string, body ReleaseSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) ReleaseSmContextWithBody

func (c *Client) ReleaseSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveSmContext

func (c *Client) RetrieveSmContext(ctx context.Context, smContextRef string, body RetrieveSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) RetrieveSmContextWithBody

func (c *Client) RetrieveSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSmContext

func (c *Client) UpdateSmContext(ctx context.Context, smContextRef string, body UpdateSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

func (*Client) UpdateSmContextWithBody

func (c *Client) UpdateSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

type ClientInterface

type ClientInterface interface {
	// PostSmContexts request  with any body
	PostSmContextsWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	PostSmContexts(ctx context.Context, body PostSmContextsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// UpdateSmContext request  with any body
	UpdateSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	UpdateSmContext(ctx context.Context, smContextRef string, body UpdateSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// ReleaseSmContext request  with any body
	ReleaseSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	ReleaseSmContext(ctx context.Context, smContextRef string, body ReleaseSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RetrieveSmContext request  with any body
	RetrieveSmContextWithBody(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RetrieveSmContext(ctx context.Context, smContextRef string, body RetrieveSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}

The interface specification for the client above.

type ClientOption

type ClientOption func(*Client) error

ClientOption allows setting custom parameters during construction

func WithBaseURL

func WithBaseURL(baseURL string) ClientOption

WithBaseURL overrides the baseURL.

func WithHTTPClient

func WithHTTPClient(doer HttpRequestDoer) ClientOption

WithHTTPClient allows overriding the default Doer, which is automatically created using http.Client. This is useful for tests.

func WithRequestEditorFn

func WithRequestEditorFn(fn RequestEditorFn) ClientOption

WithRequestEditorFn allows setting up a callback function, which will be called right before sending the request. This can be used to mutate the request.

type ClientWithResponses

type ClientWithResponses struct {
	ClientInterface
}

ClientWithResponses builds on ClientInterface to offer response payloads

func NewClientWithResponses

func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error)

NewClientWithResponses creates a new ClientWithResponses, which wraps Client with return type handling

func (*ClientWithResponses) PostSmContextsWithBodyWithResponse

func (c *ClientWithResponses) PostSmContextsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSmContextsResponse, error)

PostSmContextsWithBodyWithResponse request with arbitrary body returning *PostSmContextsResponse

func (*ClientWithResponses) PostSmContextsWithResponse

func (c *ClientWithResponses) PostSmContextsWithResponse(ctx context.Context, body PostSmContextsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSmContextsResponse, error)

func (*ClientWithResponses) ReleaseSmContextWithBodyWithResponse

func (c *ClientWithResponses) ReleaseSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReleaseSmContextResponse, error)

ReleaseSmContextWithBodyWithResponse request with arbitrary body returning *ReleaseSmContextResponse

func (*ClientWithResponses) ReleaseSmContextWithResponse

func (c *ClientWithResponses) ReleaseSmContextWithResponse(ctx context.Context, smContextRef string, body ReleaseSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*ReleaseSmContextResponse, error)

func (*ClientWithResponses) RetrieveSmContextWithBodyWithResponse

func (c *ClientWithResponses) RetrieveSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetrieveSmContextResponse, error)

RetrieveSmContextWithBodyWithResponse request with arbitrary body returning *RetrieveSmContextResponse

func (*ClientWithResponses) RetrieveSmContextWithResponse

func (c *ClientWithResponses) RetrieveSmContextWithResponse(ctx context.Context, smContextRef string, body RetrieveSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*RetrieveSmContextResponse, error)

func (*ClientWithResponses) UpdateSmContextWithBodyWithResponse

func (c *ClientWithResponses) UpdateSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSmContextResponse, error)

UpdateSmContextWithBodyWithResponse request with arbitrary body returning *UpdateSmContextResponse

func (*ClientWithResponses) UpdateSmContextWithResponse

func (c *ClientWithResponses) UpdateSmContextWithResponse(ctx context.Context, smContextRef string, body UpdateSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSmContextResponse, error)

type ClientWithResponsesInterface

type ClientWithResponsesInterface interface {
	// PostSmContexts request  with any body
	PostSmContextsWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostSmContextsResponse, error)

	PostSmContextsWithResponse(ctx context.Context, body PostSmContextsJSONRequestBody, reqEditors ...RequestEditorFn) (*PostSmContextsResponse, error)

	// UpdateSmContext request  with any body
	UpdateSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*UpdateSmContextResponse, error)

	UpdateSmContextWithResponse(ctx context.Context, smContextRef string, body UpdateSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*UpdateSmContextResponse, error)

	// ReleaseSmContext request  with any body
	ReleaseSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*ReleaseSmContextResponse, error)

	ReleaseSmContextWithResponse(ctx context.Context, smContextRef string, body ReleaseSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*ReleaseSmContextResponse, error)

	// RetrieveSmContext request  with any body
	RetrieveSmContextWithBodyWithResponse(ctx context.Context, smContextRef string, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*RetrieveSmContextResponse, error)

	RetrieveSmContextWithResponse(ctx context.Context, smContextRef string, body RetrieveSmContextJSONRequestBody, reqEditors ...RequestEditorFn) (*RetrieveSmContextResponse, error)
}

ClientWithResponsesInterface is the interface specification for the client with responses above.

type Error

type Error struct {
	Message string `json:"message"`
	Slug    string `json:"slug"`
}

Error defines model for Error.

type HttpRequestDoer

type HttpRequestDoer interface {
	Do(req *http.Request) (*http.Response, error)
}

Doer performs HTTP requests.

The standard http.Client implements this interface.

type N3TunnelInfo

type N3TunnelInfo struct {
	NgRanIp   string `json:"ngRanIp"`
	NgRanTeid int    `json:"ngRanTeid"`
	UpfIp     string `json:"upfIp"`
	UpfTeid   int    `json:"upfTeid"`
}

N3 Tunnel Information

type N4TunnelInfo

type N4TunnelInfo struct {
	SmfIp   string `json:"smfIp"`
	SmfPort int    `json:"smfPort"`
	SmfTeid int    `json:"smfTeid"`
	UpfIp   string `json:"upfIp"`
	UpfPort int    `json:"upfPort"`
	UpfTeid int    `json:"upfTeid"`
}

N4 Tunnel Information

type PostSmContextsJSONBody

type PostSmContextsJSONBody SmContextCreateData

PostSmContextsJSONBody defines parameters for PostSmContexts.

type PostSmContextsJSONRequestBody

type PostSmContextsJSONRequestBody PostSmContextsJSONBody

PostSmContextsJSONRequestBody defines body for PostSmContexts for application/json ContentType.

type PostSmContextsResponse

type PostSmContextsResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON201      *SmContextCreatedData
	JSONDefault  *Error
}

func ParsePostSmContextsResponse

func ParsePostSmContextsResponse(rsp *http.Response) (*PostSmContextsResponse, error)

ParsePostSmContextsResponse parses an HTTP response from a PostSmContextsWithResponse call

func (PostSmContextsResponse) Status

func (r PostSmContextsResponse) Status() string

Status returns HTTPResponse.Status

func (PostSmContextsResponse) StatusCode

func (r PostSmContextsResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type ReleaseSmContextJSONBody

type ReleaseSmContextJSONBody SmContextReleaseData

ReleaseSmContextJSONBody defines parameters for ReleaseSmContext.

type ReleaseSmContextJSONRequestBody

type ReleaseSmContextJSONRequestBody ReleaseSmContextJSONBody

ReleaseSmContextJSONRequestBody defines body for ReleaseSmContext for application/json ContentType.

type ReleaseSmContextResponse

type ReleaseSmContextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SmContextReleasedData
	JSONDefault  *Error
}

func ParseReleaseSmContextResponse

func ParseReleaseSmContextResponse(rsp *http.Response) (*ReleaseSmContextResponse, error)

ParseReleaseSmContextResponse parses an HTTP response from a ReleaseSmContextWithResponse call

func (ReleaseSmContextResponse) Status

func (r ReleaseSmContextResponse) Status() string

Status returns HTTPResponse.Status

func (ReleaseSmContextResponse) StatusCode

func (r ReleaseSmContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type RequestEditorFn

type RequestEditorFn func(ctx context.Context, req *http.Request) error

RequestEditorFn is the function signature for the RequestEditor callback function

type RetrieveSmContextJSONBody

type RetrieveSmContextJSONBody SmContextRetrieveData

RetrieveSmContextJSONBody defines parameters for RetrieveSmContext.

type RetrieveSmContextJSONRequestBody

type RetrieveSmContextJSONRequestBody RetrieveSmContextJSONBody

RetrieveSmContextJSONRequestBody defines body for RetrieveSmContext for application/json ContentType.

type RetrieveSmContextResponse

type RetrieveSmContextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SmContextRetrievedData
	JSONDefault  *Error
}

func ParseRetrieveSmContextResponse

func ParseRetrieveSmContextResponse(rsp *http.Response) (*RetrieveSmContextResponse, error)

ParseRetrieveSmContextResponse parses an HTTP response from a RetrieveSmContextWithResponse call

func (RetrieveSmContextResponse) Status

func (r RetrieveSmContextResponse) Status() string

Status returns HTTPResponse.Status

func (RetrieveSmContextResponse) StatusCode

func (r RetrieveSmContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

type SmContext

type SmContext struct {
	ChargingId   string                `json:"chargingId"`
	ChargingInfo []ChargingInformation `json:"chargingInfo"`
	Dnn          string                `json:"dnn"`

	// N3 Tunnel Information
	N3TunnelInfo N3TunnelInfo `json:"n3TunnelInfo"`

	// N4 Tunnel Information
	N4TunnelInfo         N4TunnelInfo `json:"n4TunnelInfo"`
	PduSessionId         int          `json:"pduSessionId"`
	PduSessionRef        string       `json:"pduSessionRef"`
	PduSessionType       string       `json:"pduSessionType"`
	SNssai               string       `json:"sNssai"`
	SmfInstanceId        string       `json:"smfInstanceId"`
	SmfServiceInstanceId string       `json:"smfServiceInstanceId"`
	SmfUri               string       `json:"smfUri"`
	Supi                 string       `json:"supi"`
	UeIpv4Address        string       `json:"ueIpv4Address"`
}

Complete SM Context

type SmContextCreateData

type SmContextCreateData struct {
	AmfServiceInstanceId string `json:"amfServiceInstanceId"`
	AmfUri               string `json:"amfUri"`
	Dnn                  string `json:"dnn"`
	PduSessionId         int    `json:"pduSessionId"`
	SNssai               string `json:"sNssai"`
	ServingNetwork       string `json:"servingNetwork"`
	SmContextStatusUri   string `json:"smContextStatusUri"`
	Supi                 string `json:"supi"`
}

Data within Create SM Context Request

type SmContextCreatedData

type SmContextCreatedData struct {
	N3Ip                 string `json:"n3Ip"`
	N3Teid               int    `json:"n3Teid"`
	PduSessionId         int    `json:"pduSessionId"`
	SNssai               string `json:"sNssai"`
	SmfServiceInstanceId string `json:"smfServiceInstanceId"`
	SmfUri               string `json:"smfUri"`
	UeIp                 string `json:"ueIp"`
	UpCnxState           string `json:"upCnxState"`
}

Data within Create SM Context Response

type SmContextReleaseData

type SmContextReleaseData struct {
	Cause int `json:"cause"`
}

Data within Release SM Context Request

type SmContextReleasedData

type SmContextReleasedData struct {
	ApnRateStatus string `json:"apnRateStatus"`
}

Data within Release SM Context Response

type SmContextRetrieveData

type SmContextRetrieveData struct {
	ServingNetwork string `json:"servingNetwork"`
	SmContextType  string `json:"smContextType"`
}

Data within Retrieve SM Context Request

type SmContextRetrievedData

type SmContextRetrievedData struct {

	// Complete SM Context
	SmContext SmContext `json:"smContext"`
}

Data within Retrieve SM Context Response

type SmContextStatusNotification

type SmContextStatusNotification struct {
	ApnRateStatus string `json:"apnRateStatus"`
	Cause         int    `json:"cause"`
	ResouceStatus string `json:"resouceStatus"`
}

Data within Notify SM Context Status Request

type SmContextUpdateData

type SmContextUpdateData struct {
	Cause      int    `json:"cause"`
	N3Ip       string `json:"n3Ip"`
	N3Teid     int    `json:"n3Teid"`
	Release    bool   `json:"release"`
	UpCnxState string `json:"upCnxState"`
}

Data within Update SM Context Request

type SmContextUpdatedData

type SmContextUpdatedData struct {
	Cause      int    `json:"cause"`
	N3Ip       string `json:"n3Ip"`
	N3Teid     int    `json:"n3Teid"`
	UpCnxState string `json:"upCnxState"`
}

Data within Update SM Context Response

type UpdateSmContextJSONBody

type UpdateSmContextJSONBody SmContextUpdateData

UpdateSmContextJSONBody defines parameters for UpdateSmContext.

type UpdateSmContextJSONRequestBody

type UpdateSmContextJSONRequestBody UpdateSmContextJSONBody

UpdateSmContextJSONRequestBody defines body for UpdateSmContext for application/json ContentType.

type UpdateSmContextResponse

type UpdateSmContextResponse struct {
	Body         []byte
	HTTPResponse *http.Response
	JSON200      *SmContextUpdatedData
	JSONDefault  *Error
}

func ParseUpdateSmContextResponse

func ParseUpdateSmContextResponse(rsp *http.Response) (*UpdateSmContextResponse, error)

ParseUpdateSmContextResponse parses an HTTP response from a UpdateSmContextWithResponse call

func (UpdateSmContextResponse) Status

func (r UpdateSmContextResponse) Status() string

Status returns HTTPResponse.Status

func (UpdateSmContextResponse) StatusCode

func (r UpdateSmContextResponse) StatusCode() int

StatusCode returns HTTPResponse.StatusCode

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL