TypeScript SDK

IntroCopy Anchor Link

The Verizon SDK provides access to the Verizon REST APIs.

"The Connection Planner is a service that provides devices windows to connect to their backend APIs. The service validates device access permissions and processes valid devices asynchronously. For each batch, it retrieves device connectivity windows from the RAN KPI Data Application, and sends callbacks back to customers via UWS-Callback for both successful and failed device requests."

InstallationCopy Anchor Link

To add the SDK to your project from npm:

npm install vz-apimatic-v-4-sdk

To install from the SDK source instead, compile it to dist/ — run its build script once in the SDK folder — then add it to your project by path:

npm install <path-to-sdk>

Quick StartCopy Anchor Link

Create one client and reuse it. Configure its behaviour through ClientOptions.

import { ServerEnvironment, VerizonClient } from "vz-apimatic-v-4-sdk";

const client = new VerizonClient({
  serverEnvironment: ServerEnvironment.Production,
  thingspaceOauth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" },
  vzM2MToken: "YOUR_API_KEY",
  sessionToken: "YOUR_API_KEY",
});

Nothing in ClientOptions is required — new VerizonClient() compiles — and each option left out falls back to its default. serverEnvironment is spelled out above so the environment a call reaches is visible where the client is built rather than inherited silently.

From CommonJSCopy Anchor Link

The package ships both dialects from a single entry, so require works with full types. In a TypeScript CommonJS file use the import ... = require(...) form — a plain destructuring require runs fine but gives you any.

import sdk = require("vz-apimatic-v-4-sdk");

const client = new sdk.VerizonClient({
  serverEnvironment: sdk.ServerEnvironment.Production,
  thingspaceOauth: { clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" },
  vzM2MToken: "YOUR_API_KEY",
  sessionToken: "YOUR_API_KEY",
});