sdksio-verizon-apis-sdk 1.5.1

Use the Verizon API for connectivity management, device diagnostics, device location, edge discovery service, edge performance, software management and much more.

Getting Started with Verizon

Introduction

The Verizon Edge Discovery Service API can direct your application clients to connect to the optimal service endpoints for your Multi-access Edge Computing (MEC) applications for every session. The Edge Discovery Service takes into account the current location of a device, its IP anchor location, current network traffic and other factors to determine which 5G Edge platform a device should connect to.

Verizon Terms of Service: https://www.verizon.com/business/5g-edge-portal/legal.html

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install sdksio-verizon-apis-sdk==1.5.1

You can also view the package at: https://pypi.python.org/pypi/sdksio-verizon-apis-sdk/1.5.1

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. Default: Environment.PRODUCTION
http_client_instance	HttpClient	The Http Client passed from the sdk user for making requests
override_http_client_configuration	bool	The value which determines to override properties of the passed Http Client from the sdk user
http_call_back	HttpCallBack	The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout	float	The value to use for connection timeout. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods	Array of string	The http methods on which retry is to be done. Default: ['GET', 'PUT']
thingspace_oauth_credentials	ThingspaceOauthCredentials	The credential object for OAuth 2 Client Credentials Grant
vz_m2m_token_credentials	VZM2mTokenCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

client = VerizonClient(
    thingspace_oauth_credentials=ThingspaceOauthCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeThingspaceOauthEnum.DISCOVERYREAD,
            OauthScopeThingspaceOauthEnum.SERVICEPROFILEREAD
        ]
    ),
    vz_m2m_token_credentials=VZM2mTokenCredentials(
        vz_m2m_token='VZ-M2M-Token'
    ),
    environment=Environment.PRODUCTION
)

API calls return an ApiResponse object that includes the following fields:

Field	Description
status_code	Status code of the HTTP response
reason_phrase	Reason phrase of the HTTP response
headers	Headers of the HTTP response as a dictionary
text	The body of the HTTP response as a string
request	HTTP request info
errors	Errors, if they exist
body	The deserialized body of the HTTP response

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name	Description
Production	Default
Mock server for limited availability, see quick start	-

Authorization

This API uses the following authentication schemes.

• thingspace_oauth (OAuth 2 Client Credentials Grant)
• VZ-M2M-Token (Custom Header Signature)

List of APIs

• 5G Edge Platforms
• Service Endpoints
• Service Profiles
• Device Management
• Device Groups
• Session Management
• Connectivity Callbacks
• Account Requests
• Service Plans
• Device Diagnostics
• Device Profile Management
• Device Monitoring
• E UICC Device Profile Management
• Devices Locations
• Devices Location Subscriptions
• Device Location Callbacks
• Usage Trigger Management
• Software Management Subscriptions V1
• Software Management Licenses V1
• Firmware V1
• Software Management Callbacks V1
• Software Management Reports V1
• Software Management Subscriptions V2
• Software Management Licenses V2
• Campaigns V2
• Software Management Callbacks V2
• Software Management Reports V2
• Client Logging
• Server Logging
• Configuration Files
• Software Management Subscriptions V3
• Software Management Licenses V3
• Campaigns V3
• Software Management Reports V3
• Firmware V3
• Account Devices
• Software Management Callbacks V3
• SIM Securefor Io T Licenses
• Account Subscriptions
• Performance Metrics
• Diagnostics Subscriptions
• Diagnostics Observations
• Diagnostics History
• Diagnostics Settings
• Diagnostics Callbacks
• Diagnostics Factory Reset
• Cloud Connector Subscriptions
• Cloud Connector Devices
• Device Service Management
• Device Reports
• Hyper Precise Location Callbacks
• Anomaly Settings
• Anomaly Triggers
• Anomaly Triggers V2
• Wireless Network Performance
• Fixed Wireless Qualification
• Managinge SIM Profiles
• Device SMS Messaging
• Device Actions
• Thing Space Qualityof Service API Actions
• Promotion Period Information
• Retrievethe Triggers
• Update Triggers
• SIM Actions
• Global Reporting
• 5G BI Device Actions
• Accounts
• SMS
• Exclusions
• Billing
• Targets
• PWN
• V2 Triggers

Classes Documentation

• Utility Classes
• HttpResponse
• HttpRequest