Node.js SDK

npm install pingram

yarn add pingram

pnpm add pingram

import { Pingram } from 'pingram';

const pingram = new Pingram({
  apiKey: 'pingram_sk_...' // Your API key from the dashboard
});

import { Pingram } from 'pingram';

const pingram = new Pingram({
  apiKey: 'pingram_sk_...',
  baseURL: 'https://api.eu.pingram.io'
});

// Request body only
await pingram.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.webhooks.deleteEventsWebhook();

// No parameters
await pingram.webhooks.getEventsWebhook();

// Request body only
await pingram.webhooks.upsertEventsWebhook({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.accounts.createAccount({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.accounts.listAccounts();

// Request body only
await pingram.addresses.createAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.addresses.deleteAddress('fullAddress_example');

// No parameters
await pingram.addresses.listAddresses();

// Request body only
await pingram.addresses.updateAddress({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.domains.addDomain({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.domains.deleteDomain('sender_example');

// No parameters
await pingram.domains.listDomains();

// Path parameter only
await pingram.domains.startDomainVerification('sender_example');

// Path parameter only
await pingram.email.deleteSuppressions('reason_example');

// Request body only
await pingram.email.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.environments.listEnvironments();

// Path parameter + request body
await pingram.environments.updateEnvironment('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.logs.getLogRetention();

// No parameters
await pingram.logs.getLogs();

// Path parameter only
await pingram.logs.getLogsByTrackingIds('trackingIds_example');

// Path parameter only
await pingram.logs.getLogsQueryResult('queryId_example');

// Request body only
await pingram.logs.startLogsQuery({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.logs.tailLogs();

// No parameters
await pingram.numbers.list();

// No parameters
await pingram.numbers.listReleased();

// Request body only
await pingram.numbers.orderNumber({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.numbers.releaseNumber('phoneNumber_example');

// No parameters
await pingram.numbers.searchAvailable();

// Request body only
await pingram.profile.acceptInvite({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.profile.changeEmail({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.profile.deleteAccount({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.profile.disableMfa('type_example');

// No parameters
await pingram.profile.getMfaStatus();

// Request body only
await pingram.profile.setupMfa({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.profile.verifyMfa({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.registrations.createUs10dlcBrand({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.registrations.getUs10dlcBrand();

// No parameters
await pingram.registrations.getUs10dlcCampaign();

// Request body only
await pingram.registrations.updateUs10dlcBrand({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.registrations.updateUs10dlcCampaign({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.sender.deleteSchedule('trackingId_example');

// Path parameter + request body
await pingram.sender.updateSchedule('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.sms.send({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter + request body
await pingram.templates.createTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.templates.deleteTemplate('notificationId_example');

// Path parameter only
await pingram.templates.getTemplate('notificationId_example');

// Path parameter only
await pingram.templates.listTemplates('notificationId_example');

// Path parameter + request body
await pingram.templates.setDefaultTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter + request body
await pingram.templates.updateTemplate('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.types.createNotificationType({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.types.deleteNotificationType('notificationId_example');

// Path parameter only
await pingram.types.getNotificationType('notificationId_example');

// No parameters
await pingram.types.listNotificationTypes();

// Path parameter + request body
await pingram.types.updateNotificationType('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// No parameters
await pingram.user.getAccountMetadata();

// No parameters
await pingram.user.getInAppNotifications();

// No parameters
await pingram.user.getInAppUnreadCount();

// Path parameter only
await pingram.user.getUser('userId_example');

// Path parameter + request body
await pingram.user.identify('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.user.markInAppNotificationsAsSeen({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.user.updateInAppNotificationStatus({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Path parameter only
await pingram.users.deleteUser('userId_example');

// No parameters
await pingram.users.listUsers();

// Path parameter only
await pingram.users.removeUserFromSuppression('userId_example');

// Path parameter + request body
await pingram.voice.bindNumber('', {
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.voice.call({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.voice.createAgent({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});

// Request body only
await pingram.voice.createBrowserCall({
  // See Request Body Properties table below for all available fields
  // Example structure (adjust based on your needs):
  // fieldName: 'value'
});