Documentation
¶
Index ¶
- type APIToken
- type AuditLog
- type Client
- func (c *Client) ClearRadioEvents(ctx context.Context) error
- func (c *Client) CreateDataNetwork(ctx context.Context, opts *CreateDataNetworkOptions) error
- func (c *Client) CreateMyAPIToken(ctx context.Context, opts *CreateAPITokenOptions) (*CreateAPITokenResponse, error)
- func (c *Client) CreatePolicy(ctx context.Context, opts *CreatePolicyOptions) error
- func (c *Client) CreateRoute(ctx context.Context, opts *CreateRouteOptions) error
- func (c *Client) CreateSubscriber(ctx context.Context, opts *CreateSubscriberOptions) error
- func (c *Client) CreateUser(ctx context.Context, opts *CreateUserOptions) error
- func (c *Client) DeleteDataNetwork(ctx context.Context, opts *DeleteDataNetworkOptions) error
- func (c *Client) DeleteMyAPIToken(ctx context.Context, tokenID string) error
- func (c *Client) DeletePolicy(ctx context.Context, opts *DeletePolicyOptions) error
- func (c *Client) DeleteRoute(ctx context.Context, opts *DeleteRouteOptions) error
- func (c *Client) DeleteSubscriber(ctx context.Context, opts *DeleteSubscriberOptions) error
- func (c *Client) DeleteUser(ctx context.Context, opts *DeleteUserOptions) error
- func (c *Client) GetAuditLogRetentionPolicy(ctx context.Context) (*GetAuditLogsRetentionPolicy, error)
- func (c *Client) GetDataNetwork(ctx context.Context, opts *GetDataNetworkOptions) (*DataNetwork, error)
- func (c *Client) GetMetrics(ctx context.Context) (map[string]float64, error)
- func (c *Client) GetNATInfo(ctx context.Context) (*GetNATInfoResponse, error)
- func (c *Client) GetOperator(ctx context.Context) (*Operator, error)
- func (c *Client) GetPolicy(ctx context.Context, opts *GetPolicyOptions) (*Policy, error)
- func (c *Client) GetRadio(ctx context.Context, opts *GetRadioOptions) (*Radio, error)
- func (c *Client) GetRadioEvent(ctx context.Context, id int) (*RadioEventContent, error)
- func (c *Client) GetRadioEventRetentionPolicy(ctx context.Context) (*GetRadioEventsRetentionPolicy, error)
- func (c *Client) GetRoute(ctx context.Context, opts *GetRouteOptions) (*Route, error)
- func (c *Client) GetStatus(ctx context.Context) (*Status, error)
- func (c *Client) GetSubscriber(ctx context.Context, opts *GetSubscriberOptions) (*Subscriber, error)
- func (c *Client) GetToken() string
- func (c *Client) GetUsageRetentionPolicy(ctx context.Context) (*GetUsageRetentionPolicy, error)
- func (c *Client) Initialize(ctx context.Context, opts *InitializeOptions) error
- func (c *Client) ListAuditLogs(ctx context.Context, p *ListParams) (*ListAuditLogsResponse, error)
- func (c *Client) ListDataNetworks(ctx context.Context, p *ListParams) (*ListDataNetworksResponse, error)
- func (c *Client) ListMyAPITokens(ctx context.Context, p *ListParams) (*ListAPITokensResponse, error)
- func (c *Client) ListPolicies(ctx context.Context, p *ListParams) (*ListPoliciesResponse, error)
- func (c *Client) ListRadioEvents(ctx context.Context, p *ListRadioEventsParams) (*ListRadioEventsResponse, error)
- func (c *Client) ListRadios(ctx context.Context, p *ListParams) (*ListRadiosResponse, error)
- func (c *Client) ListRoutes(ctx context.Context, p *ListParams) (*ListRoutesResponse, error)
- func (c *Client) ListSubscribers(ctx context.Context, p *ListParams) (*ListSubscribersResponse, error)
- func (c *Client) ListUsage(ctx context.Context, p *ListUsageParams) (*ListUsageResponse, error)
- func (c *Client) ListUsers(ctx context.Context, p *ListParams) (*ListUsersResponse, error)
- func (c *Client) Login(ctx context.Context, opts *LoginOptions) error
- func (c *Client) Refresh(ctx context.Context) error
- func (c *Client) SetToken(token string)
- func (c *Client) UpdateAuditLogRetentionPolicy(ctx context.Context, opts *UpdateAuditLogsRetentionPolicyOptions) error
- func (c *Client) UpdateNATInfo(ctx context.Context, opts *UpdateNATInfoOptions) error
- func (c *Client) UpdateOperatorHomeNetwork(ctx context.Context, opts *UpdateOperatorHomeNetworkOptions) error
- func (c *Client) UpdateOperatorID(ctx context.Context, opts *UpdateOperatorIDOptions) error
- func (c *Client) UpdateOperatorSlice(ctx context.Context, opts *UpdateOperatorSliceOptions) error
- func (c *Client) UpdateOperatorTracking(ctx context.Context, opts *UpdateOperatorTrackingOptions) error
- func (c *Client) UpdateRadioEventRetentionPolicy(ctx context.Context, opts *UpdateRadioEventsRetentionPolicyOptions) error
- func (c *Client) UpdateUsageRetentionPolicy(ctx context.Context, opts *UpdateUsageRetentionPolicyOptions) error
- type Config
- type ConnectionError
- type CreateAPITokenOptions
- type CreateAPITokenResponse
- type CreateDataNetworkOptions
- type CreatePolicyOptions
- type CreateRouteOptions
- type CreateSubscriberOptions
- type CreateUserOptions
- type DataNetwork
- type DeleteDataNetworkOptions
- type DeletePolicyOptions
- type DeleteRouteOptions
- type DeleteSubscriberOptions
- type DeleteUserOptions
- type GetAuditLogsRetentionPolicy
- type GetDataNetworkOptions
- type GetNATInfoResponse
- type GetOperatorHomeNetworkResponse
- type GetOperatorIDResponse
- type GetOperatorSliceResponse
- type GetOperatorTrackingResponse
- type GetPolicyOptions
- type GetRadioEventsRetentionPolicy
- type GetRadioOptions
- type GetRouteOptions
- type GetSubscriberOptions
- type GetUsageRetentionPolicy
- type InitializeOptions
- type ListAPITokensResponse
- type ListAuditLogsResponse
- type ListDataNetworksResponse
- type ListParams
- type ListPoliciesResponse
- type ListRadioEventsParams
- type ListRadioEventsResponse
- type ListRadiosResponse
- type ListRoutesResponse
- type ListSubscribersResponse
- type ListUsageParams
- type ListUsageResponse
- type ListUsersResponse
- type LoginOptions
- type Operator
- type PlmnID
- type Policy
- type Radio
- type RadioEvent
- type RadioEventContent
- type RefreshResponseResult
- type RequestError
- type RequestOptions
- type RequestResponse
- type RequestType
- type Requester
- type RoleID
- type Route
- type Snssai
- type Status
- type Subscriber
- type SubscriberSession
- type SubscriberStatus
- type SubscriberUsage
- type SupportedTAI
- type Tai
- type UpdateAuditLogsRetentionPolicyOptions
- type UpdateNATInfoOptions
- type UpdateOperatorHomeNetworkOptions
- type UpdateOperatorIDOptions
- type UpdateOperatorSliceOptions
- type UpdateOperatorTrackingOptions
- type UpdateRadioEventsRetentionPolicyOptions
- type UpdateUsageRetentionPolicyOptions
- type User
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
Requester Requester
// contains filtered or unexported fields
}
A Client knows how to talk to the the Ella Core API.
func (*Client) ClearRadioEvents ¶ added in v0.6.0
func (*Client) CreateDataNetwork ¶ added in v0.1.0
func (c *Client) CreateDataNetwork(ctx context.Context, opts *CreateDataNetworkOptions) error
func (*Client) CreateMyAPIToken ¶ added in v0.2.0
func (c *Client) CreateMyAPIToken(ctx context.Context, opts *CreateAPITokenOptions) (*CreateAPITokenResponse, error)
func (*Client) CreatePolicy ¶ added in v0.1.0
func (c *Client) CreatePolicy(ctx context.Context, opts *CreatePolicyOptions) error
func (*Client) CreateRoute ¶
func (c *Client) CreateRoute(ctx context.Context, opts *CreateRouteOptions) error
func (*Client) CreateSubscriber ¶
func (c *Client) CreateSubscriber(ctx context.Context, opts *CreateSubscriberOptions) error
func (*Client) CreateUser ¶
func (c *Client) CreateUser(ctx context.Context, opts *CreateUserOptions) error
func (*Client) DeleteDataNetwork ¶ added in v0.1.0
func (c *Client) DeleteDataNetwork(ctx context.Context, opts *DeleteDataNetworkOptions) error
func (*Client) DeleteMyAPIToken ¶ added in v0.2.0
func (*Client) DeletePolicy ¶ added in v0.1.0
func (c *Client) DeletePolicy(ctx context.Context, opts *DeletePolicyOptions) error
func (*Client) DeleteRoute ¶
func (c *Client) DeleteRoute(ctx context.Context, opts *DeleteRouteOptions) error
func (*Client) DeleteSubscriber ¶
func (c *Client) DeleteSubscriber(ctx context.Context, opts *DeleteSubscriberOptions) error
func (*Client) DeleteUser ¶
func (c *Client) DeleteUser(ctx context.Context, opts *DeleteUserOptions) error
func (*Client) GetAuditLogRetentionPolicy ¶ added in v0.2.0
func (c *Client) GetAuditLogRetentionPolicy(ctx context.Context) (*GetAuditLogsRetentionPolicy, error)
func (*Client) GetDataNetwork ¶ added in v0.1.0
func (c *Client) GetDataNetwork(ctx context.Context, opts *GetDataNetworkOptions) (*DataNetwork, error)
func (*Client) GetMetrics ¶
GetMetrics retrieves the metrics from the server and returns a map where keys are metric names and values are their corresponding float values.
func (*Client) GetNATInfo ¶ added in v0.3.0
func (c *Client) GetNATInfo(ctx context.Context) (*GetNATInfoResponse, error)
func (*Client) GetRadioEvent ¶ added in v0.6.0
func (*Client) GetRadioEventRetentionPolicy ¶ added in v0.6.0
func (c *Client) GetRadioEventRetentionPolicy(ctx context.Context) (*GetRadioEventsRetentionPolicy, error)
func (*Client) GetSubscriber ¶
func (c *Client) GetSubscriber(ctx context.Context, opts *GetSubscriberOptions) (*Subscriber, error)
func (*Client) GetUsageRetentionPolicy ¶ added in v0.6.0
func (c *Client) GetUsageRetentionPolicy(ctx context.Context) (*GetUsageRetentionPolicy, error)
func (*Client) Initialize ¶ added in v0.4.0
func (c *Client) Initialize(ctx context.Context, opts *InitializeOptions) error
func (*Client) ListAuditLogs ¶ added in v0.2.0
func (c *Client) ListAuditLogs(ctx context.Context, p *ListParams) (*ListAuditLogsResponse, error)
func (*Client) ListDataNetworks ¶ added in v0.1.0
func (c *Client) ListDataNetworks(ctx context.Context, p *ListParams) (*ListDataNetworksResponse, error)
func (*Client) ListMyAPITokens ¶ added in v0.2.0
func (c *Client) ListMyAPITokens(ctx context.Context, p *ListParams) (*ListAPITokensResponse, error)
func (*Client) ListPolicies ¶ added in v0.1.0
func (c *Client) ListPolicies(ctx context.Context, p *ListParams) (*ListPoliciesResponse, error)
func (*Client) ListRadioEvents ¶ added in v0.6.0
func (c *Client) ListRadioEvents(ctx context.Context, p *ListRadioEventsParams) (*ListRadioEventsResponse, error)
func (*Client) ListRadios ¶
func (c *Client) ListRadios(ctx context.Context, p *ListParams) (*ListRadiosResponse, error)
func (*Client) ListRoutes ¶
func (c *Client) ListRoutes(ctx context.Context, p *ListParams) (*ListRoutesResponse, error)
func (*Client) ListSubscribers ¶
func (c *Client) ListSubscribers(ctx context.Context, p *ListParams) (*ListSubscribersResponse, error)
func (*Client) ListUsage ¶ added in v0.6.0
func (c *Client) ListUsage(ctx context.Context, p *ListUsageParams) (*ListUsageResponse, error)
func (*Client) ListUsers ¶
func (c *Client) ListUsers(ctx context.Context, p *ListParams) (*ListUsersResponse, error)
func (*Client) Login ¶
func (c *Client) Login(ctx context.Context, opts *LoginOptions) error
Login authenticates the user with the provided email and password. It stores the token in the client for future requests.
func (*Client) UpdateAuditLogRetentionPolicy ¶ added in v0.2.0
func (c *Client) UpdateAuditLogRetentionPolicy(ctx context.Context, opts *UpdateAuditLogsRetentionPolicyOptions) error
func (*Client) UpdateNATInfo ¶ added in v0.3.0
func (c *Client) UpdateNATInfo(ctx context.Context, opts *UpdateNATInfoOptions) error
func (*Client) UpdateOperatorHomeNetwork ¶ added in v0.5.0
func (c *Client) UpdateOperatorHomeNetwork(ctx context.Context, opts *UpdateOperatorHomeNetworkOptions) error
func (*Client) UpdateOperatorID ¶
func (c *Client) UpdateOperatorID(ctx context.Context, opts *UpdateOperatorIDOptions) error
func (*Client) UpdateOperatorSlice ¶
func (c *Client) UpdateOperatorSlice(ctx context.Context, opts *UpdateOperatorSliceOptions) error
func (*Client) UpdateOperatorTracking ¶
func (c *Client) UpdateOperatorTracking(ctx context.Context, opts *UpdateOperatorTrackingOptions) error
func (*Client) UpdateRadioEventRetentionPolicy ¶ added in v0.6.0
func (c *Client) UpdateRadioEventRetentionPolicy(ctx context.Context, opts *UpdateRadioEventsRetentionPolicyOptions) error
func (*Client) UpdateUsageRetentionPolicy ¶ added in v0.6.0
func (c *Client) UpdateUsageRetentionPolicy(ctx context.Context, opts *UpdateUsageRetentionPolicyOptions) error
type Config ¶
type Config struct {
// BaseURL contains the base URL where Ella Core is expected to be.
BaseURL string
// APIToken is the API token used for authentication.
APIToken string
// TLSConfig is an optional TLS configuration.
TLSConfig *tls.Config
}
Config allows the user to customize client behavior.
type ConnectionError ¶
type ConnectionError struct {
// contains filtered or unexported fields
}
ConnectionError represents a connection or communication error.
func (ConnectionError) Error ¶
func (e ConnectionError) Error() string
func (ConnectionError) Unwrap ¶
func (e ConnectionError) Unwrap() error
type CreateAPITokenOptions ¶ added in v0.2.0
type CreateAPITokenResponse ¶ added in v0.2.0
type CreateAPITokenResponse struct {
Token string `json:"token"`
}
type CreateDataNetworkOptions ¶ added in v0.1.0
type CreatePolicyOptions ¶ added in v0.1.0
type CreateRouteOptions ¶
type CreateSubscriberOptions ¶
type CreateUserOptions ¶
type DataNetwork ¶ added in v0.1.0
type DeleteDataNetworkOptions ¶ added in v0.1.0
type DeleteDataNetworkOptions struct {
Name string `json:"name"`
}
type DeletePolicyOptions ¶ added in v0.1.0
type DeletePolicyOptions struct {
Name string `json:"name"`
}
type DeleteRouteOptions ¶
type DeleteRouteOptions struct {
ID int64 `json:"id"`
}
type DeleteSubscriberOptions ¶
type DeleteSubscriberOptions struct {
ID string `json:"id"`
}
type DeleteUserOptions ¶
type DeleteUserOptions struct {
Email string `json:"email"`
}
type GetAuditLogsRetentionPolicy ¶ added in v0.2.0
type GetAuditLogsRetentionPolicy struct {
Days int `json:"days"`
}
type GetDataNetworkOptions ¶ added in v0.1.0
type GetDataNetworkOptions struct {
Name string `json:"name"`
}
type GetNATInfoResponse ¶ added in v0.3.0
type GetNATInfoResponse struct {
Enabled bool `json:"enabled,omitempty"`
}
type GetOperatorHomeNetworkResponse ¶
type GetOperatorHomeNetworkResponse struct {
PublicKey string `json:"publicKey,omitempty"`
}
type GetOperatorIDResponse ¶
type GetOperatorTrackingResponse ¶
type GetOperatorTrackingResponse struct {
SupportedTacs []string `json:"supportedTacs,omitempty"`
}
type GetPolicyOptions ¶ added in v0.1.0
type GetPolicyOptions struct {
Name string `json:"name"`
}
type GetRadioEventsRetentionPolicy ¶ added in v0.6.0
type GetRadioEventsRetentionPolicy struct {
Days int `json:"days"`
}
type GetRadioOptions ¶
type GetRadioOptions struct {
Name string `json:"name"`
}
type GetRouteOptions ¶
type GetRouteOptions struct {
ID int64 `json:"id"`
}
type GetSubscriberOptions ¶
type GetSubscriberOptions struct {
ID string `json:"id"`
}
type GetUsageRetentionPolicy ¶ added in v0.6.0
type GetUsageRetentionPolicy struct {
Days int `json:"days"`
}
type InitializeOptions ¶ added in v0.4.0
type ListAPITokensResponse ¶ added in v0.3.0
type ListAuditLogsResponse ¶ added in v0.3.0
type ListDataNetworksResponse ¶ added in v0.3.0
type ListDataNetworksResponse struct {
Items []DataNetwork `json:"items"`
Page int `json:"page"`
PerPage int `json:"per_page"`
TotalCount int `json:"total_count"`
}
type ListParams ¶ added in v0.3.0
type ListPoliciesResponse ¶ added in v0.3.0
type ListRadioEventsParams ¶ added in v0.6.0
type ListRadioEventsResponse ¶ added in v0.6.0
type ListRadioEventsResponse struct {
Items []RadioEvent `json:"items"`
Page int `json:"page"`
PerPage int `json:"per_page"`
TotalCount int `json:"total_count"`
}
type ListRadiosResponse ¶ added in v0.3.0
type ListRoutesResponse ¶ added in v0.3.0
type ListSubscribersResponse ¶ added in v0.3.0
type ListSubscribersResponse struct {
Items []Subscriber `json:"items"`
Page int `json:"page"`
PerPage int `json:"per_page"`
TotalCount int `json:"total_count"`
}
type ListUsageParams ¶ added in v0.6.0
type ListUsageResponse ¶ added in v0.6.0
type ListUsageResponse []map[string]SubscriberUsage
type ListUsersResponse ¶ added in v0.3.0
type LoginOptions ¶
type Operator ¶
type Operator struct {
ID GetOperatorIDResponse `json:"id,omitempty"`
Slice GetOperatorSliceResponse `json:"slice,omitempty"`
Tracking GetOperatorTrackingResponse `json:"tracking,omitempty"`
HomeNetwork GetOperatorHomeNetworkResponse `json:"homeNetwork,omitempty"`
}
type Radio ¶
type Radio struct {
Name string `json:"name"`
ID string `json:"id"`
Address string `json:"address"`
SupportedTAIs []SupportedTAI `json:"supported_tais"`
}
type RadioEvent ¶ added in v0.6.0
type RadioEventContent ¶ added in v0.6.0
type RefreshResponseResult ¶ added in v0.3.0
type RefreshResponseResult struct {
Token string `json:"token"`
}
type RequestError ¶
type RequestError struct {
// contains filtered or unexported fields
}
RequestError is returned when there's an error processing the request.
func (RequestError) Error ¶
func (e RequestError) Error() string
type RequestOptions ¶
type RequestResponse ¶
type RequestResponse struct {
StatusCode int
Headers http.Header
// Result can contain request specific JSON data. The result can be
// unmarshalled into the expected type using the DecodeResult method.
Result []byte
// Body is only set for request type RawRequest.
Body io.ReadCloser
}
func (*RequestResponse) DecodeResult ¶
func (resp *RequestResponse) DecodeResult(result any) error
DecodeResult decodes the endpoint-specific result payload that is included as part of sync and async request responses.
type Requester ¶
type Requester interface {
// Do performs the HTTP transaction using the provided options.
Do(ctx context.Context, opts *RequestOptions) (*RequestResponse, error)
}
type Subscriber ¶
type SubscriberSession ¶ added in v0.1.0
type SubscriberSession struct {
IPAddress string `json:"ipAddress"`
}
type SubscriberStatus ¶ added in v0.1.0
type SubscriberStatus struct {
Registered bool `json:"registered"`
Sessions []SubscriberSession `json:"sessions"`
}
type SubscriberUsage ¶ added in v0.6.0
type SupportedTAI ¶
type UpdateAuditLogsRetentionPolicyOptions ¶ added in v0.2.0
type UpdateAuditLogsRetentionPolicyOptions struct {
Days int `json:"days"`
}
type UpdateNATInfoOptions ¶ added in v0.3.0
type UpdateNATInfoOptions struct {
Enabled bool `json:"enabled"`
}
type UpdateOperatorHomeNetworkOptions ¶ added in v0.5.0
type UpdateOperatorHomeNetworkOptions struct {
PrivateKey string
}
type UpdateOperatorIDOptions ¶
type UpdateOperatorTrackingOptions ¶
type UpdateOperatorTrackingOptions struct {
SupportedTacs []string
}
type UpdateRadioEventsRetentionPolicyOptions ¶ added in v0.6.0
type UpdateRadioEventsRetentionPolicyOptions struct {
Days int `json:"days"`
}
type UpdateUsageRetentionPolicyOptions ¶ added in v0.6.0
type UpdateUsageRetentionPolicyOptions struct {
Days int `json:"days"`
}
Click to show internal directories.
Click to hide internal directories.