datarepository

package
v0.0.0-...-444540b Latest Latest
Warning

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

 Go to latest Published: May 24, 2022 License: Apache-2.0 Imports: 23 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKeys takes a string apikey as authentication for the request
	ContextAPIKeys = contextKey("apiKeys")

	// ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
	ContextHttpSignatureAuth = contextKey("httpsignature")

	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {
	AdminApi *AdminApiService

	BandwidthApi *BandwidthApiService

	LocationApi *LocationApiService

	SubscriberApi *SubscriberApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Network as Code API v2 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig 

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type AdminApiService 

type AdminApiService service

AdminApiService AdminApi service

func (*AdminApiService) CreateTestUser 

func (a *AdminApiService) CreateTestUser(ctx _context.Context) ApiCreateTestUserRequest

CreateTestUser Create a new test user 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateTestUserRequest

func (*AdminApiService) CreateTestUserExecute 

func (a *AdminApiService) CreateTestUserExecute(r ApiCreateTestUserRequest) (clientmodel.SubscriberDetails, *_nethttp.Response, error)

Execute executes the request 

@return SubscriberDetails

func (*AdminApiService) DeleteTestuser 

func (a *AdminApiService) DeleteTestuser(ctx _context.Context) ApiDeleteTestuserRequest

DeleteTestuser Delete an existing test user 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDeleteTestuserRequest

func (*AdminApiService) DeleteTestuserExecute 

func (a *AdminApiService) DeleteTestuserExecute(r ApiDeleteTestuserRequest) (*_nethttp.Response, error)

Execute executes the request

func (*AdminApiService) GetApiStatus 

func (a *AdminApiService) GetApiStatus(ctx _context.Context) ApiGetApiStatusRequest

GetApiStatus Is API accessible

Used to determine if the API is currently accessible 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetApiStatusRequest

func (*AdminApiService) GetApiStatusExecute 

func (a *AdminApiService) GetApiStatusExecute(r ApiGetApiStatusRequest) (clientmodel.HelloResponses, *_nethttp.Response, error)

Execute executes the request 

@return HelloResponses

type ApiCreateTestUserRequest 

type ApiCreateTestUserRequest struct {
	ApiService *AdminApiService
	// contains filtered or unexported fields
}

func (ApiCreateTestUserRequest) Execute 

func (r ApiCreateTestUserRequest) Execute() (clientmodel.SubscriberDetails, *_nethttp.Response, error)

func (ApiCreateTestUserRequest) SubscriberDetails 

func (r ApiCreateTestUserRequest) SubscriberDetails(subscriberDetails clientmodel.SubscriberDetails) ApiCreateTestUserRequest

Add a new test user

func (ApiCreateTestUserRequest) XTestmode 

func (r ApiCreateTestUserRequest) XTestmode(xTestmode string) ApiCreateTestUserRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiDeleteTestuserRequest 

type ApiDeleteTestuserRequest struct {
	ApiService *AdminApiService
	// contains filtered or unexported fields
}

func (ApiDeleteTestuserRequest) Execute 

func (r ApiDeleteTestuserRequest) Execute() (*_nethttp.Response, error)

func (ApiDeleteTestuserRequest) SubscriberId 

func (r ApiDeleteTestuserRequest) SubscriberId(subscriberId clientmodel.SubscriberId) ApiDeleteTestuserRequest

External ID of the subscriber

func (ApiDeleteTestuserRequest) XTestmode 

func (r ApiDeleteTestuserRequest) XTestmode(xTestmode string) ApiDeleteTestuserRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiGetApiStatusRequest 

type ApiGetApiStatusRequest struct {
	ApiService *AdminApiService
	// contains filtered or unexported fields
}

func (ApiGetApiStatusRequest) Execute 

func (r ApiGetApiStatusRequest) Execute() (clientmodel.HelloResponses, *_nethttp.Response, error)

type ApiGetCustomBandwidthRequest 

type ApiGetCustomBandwidthRequest struct {
	ApiService *BandwidthApiService
	// contains filtered or unexported fields
}

func (ApiGetCustomBandwidthRequest) Execute 

func (r ApiGetCustomBandwidthRequest) Execute() (clientmodel.CustomLimits, *_nethttp.Response, error)

func (ApiGetCustomBandwidthRequest) SubscriberId 

func (r ApiGetCustomBandwidthRequest) SubscriberId(subscriberId clientmodel.SubscriberId) ApiGetCustomBandwidthRequest

External ID of the subscriber

func (ApiGetCustomBandwidthRequest) XTestmode 

func (r ApiGetCustomBandwidthRequest) XTestmode(xTestmode string) ApiGetCustomBandwidthRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiGetSubscriberBandwidthRequest 

type ApiGetSubscriberBandwidthRequest struct {
	ApiService *BandwidthApiService
	// contains filtered or unexported fields
}

func (ApiGetSubscriberBandwidthRequest) Execute 

func (r ApiGetSubscriberBandwidthRequest) Execute() (clientmodel.BandwidthResponse, *_nethttp.Response, error)

func (ApiGetSubscriberBandwidthRequest) SubscriberId 

func (r ApiGetSubscriberBandwidthRequest) SubscriberId(subscriberId clientmodel.SubscriberId) ApiGetSubscriberBandwidthRequest

External ID of the subscriber

func (ApiGetSubscriberBandwidthRequest) XTestmode 

func (r ApiGetSubscriberBandwidthRequest) XTestmode(xTestmode string) ApiGetSubscriberBandwidthRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiGetSubscriberLocationRequest 

type ApiGetSubscriberLocationRequest struct {
	ApiService *LocationApiService
	// contains filtered or unexported fields
}

func (ApiGetSubscriberLocationRequest) Execute 

func (r ApiGetSubscriberLocationRequest) Execute() (clientmodel.LocationResponse, *_nethttp.Response, error)

func (ApiGetSubscriberLocationRequest) SubscriberId 

func (r ApiGetSubscriberLocationRequest) SubscriberId(subscriberId clientmodel.SubscriberId) ApiGetSubscriberLocationRequest

External ID of the subscriber

func (ApiGetSubscriberLocationRequest) XTestmode 

func (r ApiGetSubscriberLocationRequest) XTestmode(xTestmode string) ApiGetSubscriberLocationRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiGetSubscriberRequest 

type ApiGetSubscriberRequest struct {
	ApiService *SubscriberApiService
	// contains filtered or unexported fields
}

func (ApiGetSubscriberRequest) Execute 

func (r ApiGetSubscriberRequest) Execute() (clientmodel.SubscriberDetails, *_nethttp.Response, error)

func (ApiGetSubscriberRequest) SubscriberId 

func (r ApiGetSubscriberRequest) SubscriberId(subscriberId clientmodel.SubscriberId) ApiGetSubscriberRequest

External ID of the subscriber

func (ApiGetSubscriberRequest) XTestmode 

func (r ApiGetSubscriberRequest) XTestmode(xTestmode string) ApiGetSubscriberRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiUpdateCustomBandwidthRequest 

type ApiUpdateCustomBandwidthRequest struct {
	ApiService *BandwidthApiService
	// contains filtered or unexported fields
}

func (ApiUpdateCustomBandwidthRequest) CustomLimits 

func (r ApiUpdateCustomBandwidthRequest) CustomLimits(customLimits clientmodel.CustomLimits) ApiUpdateCustomBandwidthRequest

New upload/download limits for the subscriber

func (ApiUpdateCustomBandwidthRequest) Execute 

func (r ApiUpdateCustomBandwidthRequest) Execute() (clientmodel.CustomLimits, *_nethttp.Response, error)

func (ApiUpdateCustomBandwidthRequest) XTestmode 

func (r ApiUpdateCustomBandwidthRequest) XTestmode(xTestmode string) ApiUpdateCustomBandwidthRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type ApiUpdateSubscriberBandwidthRequest 

type ApiUpdateSubscriberBandwidthRequest struct {
	ApiService *BandwidthApiService
	// contains filtered or unexported fields
}

func (ApiUpdateSubscriberBandwidthRequest) BandwidthUpdate 

func (r ApiUpdateSubscriberBandwidthRequest) BandwidthUpdate(bandwidthUpdate clientmodel.BandwidthUpdate) ApiUpdateSubscriberBandwidthRequest

New bandwidth for subscriber

func (ApiUpdateSubscriberBandwidthRequest) Execute 

func (r ApiUpdateSubscriberBandwidthRequest) Execute() (clientmodel.BandwidthResponse, *_nethttp.Response, error)

func (ApiUpdateSubscriberBandwidthRequest) XTestmode 

func (r ApiUpdateSubscriberBandwidthRequest) XTestmode(xTestmode string) ApiUpdateSubscriberBandwidthRequest

Enables test mode when set to \"true\". Assumes \"false\" if not present.

type BandwidthApiService 

type BandwidthApiService service

BandwidthApiService BandwidthApi service

func (*BandwidthApiService) GetCustomBandwidth 

func (a *BandwidthApiService) GetCustomBandwidth(ctx _context.Context) ApiGetCustomBandwidthRequest

GetCustomBandwidth Get upload/download limit

Get the current upload/download bandwidth limits for the subscriber identified by the given ID 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetCustomBandwidthRequest

func (*BandwidthApiService) GetCustomBandwidthExecute 

func (a *BandwidthApiService) GetCustomBandwidthExecute(r ApiGetCustomBandwidthRequest) (clientmodel.CustomLimits, *_nethttp.Response, error)

Execute executes the request 

@return CustomLimits

func (*BandwidthApiService) GetSubscriberBandwidth 

func (a *BandwidthApiService) GetSubscriberBandwidth(ctx _context.Context) ApiGetSubscriberBandwidthRequest

GetSubscriberBandwidth Get the current subscriber bandwidth

Get the bandwidth identifier for the subscriber identified by the given IMSI 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetSubscriberBandwidthRequest

func (*BandwidthApiService) GetSubscriberBandwidthExecute 

func (a *BandwidthApiService) GetSubscriberBandwidthExecute(r ApiGetSubscriberBandwidthRequest) (clientmodel.BandwidthResponse, *_nethttp.Response, error)

Execute executes the request 

@return BandwidthResponse

func (*BandwidthApiService) UpdateCustomBandwidth 

func (a *BandwidthApiService) UpdateCustomBandwidth(ctx _context.Context) ApiUpdateCustomBandwidthRequest

UpdateCustomBandwidth Set upload limit

Set the upload/download bandwidth limits for the subscriber identified by the given ID 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiUpdateCustomBandwidthRequest

func (*BandwidthApiService) UpdateCustomBandwidthExecute 

func (a *BandwidthApiService) UpdateCustomBandwidthExecute(r ApiUpdateCustomBandwidthRequest) (clientmodel.CustomLimits, *_nethttp.Response, error)

Execute executes the request 

@return CustomLimits

func (*BandwidthApiService) UpdateSubscriberBandwidth 

func (a *BandwidthApiService) UpdateSubscriberBandwidth(ctx _context.Context) ApiUpdateSubscriberBandwidthRequest

UpdateSubscriberBandwidth Update the bandwidth of the subscriber

Update the bandwidth identifier for the subscriber identified by the given IMSI 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiUpdateSubscriberBandwidthRequest

func (*BandwidthApiService) UpdateSubscriberBandwidthExecute 

func (a *BandwidthApiService) UpdateSubscriberBandwidthExecute(r ApiUpdateSubscriberBandwidthRequest) (clientmodel.BandwidthResponse, *_nethttp.Response, error)

Execute executes the request 

@return BandwidthResponse

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration 

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration 

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL 

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext 

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type GenericOpenAPIError 

type GenericOpenAPIError struct {
	// contains filtered or unexported fields
}

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body 

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error 

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model 

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type LocationApiService 

type LocationApiService service

LocationApiService LocationApi service

func (*LocationApiService) GetSubscriberLocation 

func (a *LocationApiService) GetSubscriberLocation(ctx _context.Context) ApiGetSubscriberLocationRequest

GetSubscriberLocation Get last reported location

Get the last reported location of the subscriber identified by the given ID 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetSubscriberLocationRequest

func (*LocationApiService) GetSubscriberLocationExecute 

func (a *LocationApiService) GetSubscriberLocationExecute(r ApiGetSubscriberLocationRequest) (clientmodel.LocationResponse, *_nethttp.Response, error)

Execute executes the request 

@return LocationResponse

type ServerConfiguration 

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations 

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL 

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable 

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

type SubscriberApiService 

type SubscriberApiService service

SubscriberApiService SubscriberApi service

func (*SubscriberApiService) CreateTestUserExecute 

func (a *SubscriberApiService) CreateTestUserExecute(r ApiCreateTestUserRequest) (clientmodel.SubscriberDetails, *_nethttp.Response, error)

Execute executes the request 

@return SubscriberDetails

func (*SubscriberApiService) DeleteTestuserExecute 

func (a *SubscriberApiService) DeleteTestuserExecute(r ApiDeleteTestuserRequest) (*_nethttp.Response, error)

Execute executes the request

func (*SubscriberApiService) GetCustomBandwidthExecute 

func (a *SubscriberApiService) GetCustomBandwidthExecute(r ApiGetCustomBandwidthRequest) (clientmodel.CustomLimits, *_nethttp.Response, error)

Execute executes the request 

@return CustomLimits

func (*SubscriberApiService) GetSubscriber 

func (a *SubscriberApiService) GetSubscriber(ctx _context.Context) ApiGetSubscriberRequest

GetSubscriber Get the subscriber SUPI/IMSI and MSISDN 

@param ctx _context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiGetSubscriberRequest

func (*SubscriberApiService) GetSubscriberBandwidthExecute 

func (a *SubscriberApiService) GetSubscriberBandwidthExecute(r ApiGetSubscriberBandwidthRequest) (clientmodel.BandwidthResponse, *_nethttp.Response, error)

Execute executes the request 

@return BandwidthResponse

func (*SubscriberApiService) GetSubscriberExecute 

func (a *SubscriberApiService) GetSubscriberExecute(r ApiGetSubscriberRequest) (clientmodel.SubscriberDetails, *_nethttp.Response, error)

Execute executes the request 

@return SubscriberDetails

func (*SubscriberApiService) GetSubscriberLocationExecute 

func (a *SubscriberApiService) GetSubscriberLocationExecute(r ApiGetSubscriberLocationRequest) (clientmodel.LocationResponse, *_nethttp.Response, error)

Execute executes the request 

@return LocationResponse

func (*SubscriberApiService) UpdateCustomBandwidthExecute 

func (a *SubscriberApiService) UpdateCustomBandwidthExecute(r ApiUpdateCustomBandwidthRequest) (clientmodel.CustomLimits, *_nethttp.Response, error)

Execute executes the request 

@return CustomLimits

func (*SubscriberApiService) UpdateSubscriberBandwidthExecute 

func (a *SubscriberApiService) UpdateSubscriberBandwidthExecute(r ApiUpdateSubscriberBandwidthRequest) (clientmodel.BandwidthResponse, *_nethttp.Response, error)

Execute executes the request 

@return BandwidthResponse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.