Ruby SDK

Setup & Initialization

1. Install:

gem install pingram

Or add to your Gemfile:

gem 'pingram'

2. Require and initialize:

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

* required

Region specific example:

client = Pingram::Client.new(api_key: 'YOUR_API_KEY', base_url: 'https://api.eu.pingram.io')

Send

call_send()

Send a notification

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SenderPostBody.new # configure as needed

begin
  result = client.send(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling call_send: #{e}"
end

Parameters

Request Body Properties

Return Type

SenderPostResponse

Addresses

addresses_create_address()

Create a new email address for inbound/outbound purposes. Each account can have one builtin address and many custom addresses. Custom addresses must belong to configured domains.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::CreateAddressRequest.new # configure as needed

begin
  result = client.addresses.addresses_create_address(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_create_address: #{e}"
end

Parameters

Request Body Properties

Return Type

AddressResponse

addresses_list_addresses()

Lists all email addresses the account has configured to send and receive emails. Custom addresses must belong to configured domains.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.addresses.addresses_list_addresses
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_list_addresses: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

AccountAddressesResponse

addresses_update_address()

Update an existing address

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::UpdateAddressRequest.new # configure as needed

begin
  result = client.addresses.addresses_update_address(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling addresses_update_address: #{e}"
end

Parameters

Request Body Properties

Return Type

AddressResponse

Domains

domains_add_domain()

Request to verify a new sender domain

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::PostSendersRequestBody.new # configure as needed

begin
  result = client.domains.domains_add_domain(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_add_domain: #{e}"
end

Parameters

Request Body Properties

Return Type

Array<GetSendersResponseInner>

domains_delete_domain()

Delete a sender domain or email address

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.domains.domains_delete_domain
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_delete_domain: #{e}"
end

Parameters

Return Type

SuccessResponse

domains_list_domains()

Get all sender domains configured for the account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.domains.domains_list_domains
  p result
rescue Pingram::ApiError => e
  puts "Error when calling domains_list_domains: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

Array<GetSendersResponseInner>

Environments

environments_create_environment()

Create a new environment for the account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::EnvironmentCreateRequest.new # configure as needed

begin
  result = client.environments.environments_create_environment(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling environments_create_environment: #{e}"
end

Parameters

Request Body Properties

Return Type

Environment

environments_list_environments()

Get all environments for the authenticated account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.environments.environments_list_environments
  p result
rescue Pingram::ApiError => e
  puts "Error when calling environments_list_environments: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

Array<GetEnvironmentsResponseInner>

environments_update_environment()

Update environment settings (title, secret, disable sending, secure mode)

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::EnvironmentPatchRequest.new # configure as needed

begin
  result = client.environments.environments_update_environment(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling environments_update_environment: #{e}"
end

Parameters

Request Body Properties

Return Type

Environment

Logs

logs_get_log_retention()

Get log retention period in days for the account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_log_retention
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_log_retention: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

LogsRetentionResponse

logs_get_logs()

List logs for the authenticated account

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs: #{e}"
end

Parameters

Return Type

GetLogsResponse

logs_get_logs_by_tracking_ids()

Get logs by tracking IDs (comma-separated, max 25 IDs)

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs_by_tracking_ids
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs_by_tracking_ids: #{e}"
end

Parameters

Return Type

LogsGetResponse

logs_get_logs_query_result()

Get results from a query ID

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_get_logs_query_result
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_get_logs_query_result: #{e}"
end

Parameters

Return Type

LogsQueryResultResponse

logs_start_logs_query()

Start a log query and return query ID for asynchronous log searching

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::LogQueryPostBody.new # configure as needed

begin
  result = client.logs.logs_start_logs_query(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_start_logs_query: #{e}"
end

Parameters

Request Body Properties

Return Type

LogsQueryResponse

logs_tail_logs()

Get last 100 logs from the stream

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.logs.logs_tail_logs
  p result
rescue Pingram::ApiError => e
  puts "Error when calling logs_tail_logs: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

LogsTailResponse

Organization

organization_get_usage()

Get usage for the authenticated account’s organization (new billing model).

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.organization_get_usage
  p result
rescue Pingram::ApiError => e
  puts "Error when calling organization_get_usage: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

OrganizationUsage

organization_get_usage_history()

Get historical usage for the authenticated account’s organization over a date range.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.organization_get_usage_history
  p result
rescue Pingram::ApiError => e
  puts "Error when calling organization_get_usage_history: #{e}"
end

Parameters

Return Type

OrganizationUsageHistory

PushSettings

push_settings_delete_push_apn_settings()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.push_settings_delete_push_apn_settings
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_delete_push_apn_settings: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

nil (empty response body)

push_settings_delete_push_fcm_settings()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.push_settings_delete_push_fcm_settings
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_delete_push_fcm_settings: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

nil (empty response body)

push_settings_get_push_apn_settings()

Get Apple Push Notification (APN) configuration for the current account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.push_settings_get_push_apn_settings
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_get_push_apn_settings: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

APNConfig

push_settings_get_push_fcm_settings()

Get Firebase Cloud Messaging (FCM) configuration for the current account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.push_settings_get_push_fcm_settings
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_get_push_fcm_settings: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

PushSettingsFCMResponse

push_settings_upsert_push_apn_settings()

Create or update Apple Push Notification (APN) configuration for the current account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::APNConfig.new # configure as needed

begin
  result = client.undefined.push_settings_upsert_push_apn_settings(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_upsert_push_apn_settings: #{e}"
end

Parameters

Request Body Properties

Return Type

APNConfig

push_settings_upsert_push_fcm_settings()

Create or update Firebase Cloud Messaging (FCM) configuration for the current account.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::PushSettingsFCMPutRequest.new # configure as needed

begin
  result = client.undefined.push_settings_upsert_push_fcm_settings(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling push_settings_upsert_push_fcm_settings: #{e}"
end

Parameters

Request Body Properties

Return Type

PushSettingsFCMResponse

Sender

sender_delete_schedule()

Delete (unschedule) an already scheduled notification

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.sender.sender_delete_schedule
  p result
rescue Pingram::ApiError => e
  puts "Error when calling sender_delete_schedule: #{e}"
end

Parameters

Return Type

MessageResponse

sender_update_schedule()

Update the body or schedule of an already scheduled notification.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SenderPostBody.new # configure as needed

begin
  result = client.sender.sender_update_schedule(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling sender_update_schedule: #{e}"
end

Parameters

Request Body Properties

Return Type

MessageResponse

Templates

templates_create_template()

Create a new template for a notification

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::TemplatePostRequest.new # configure as needed

begin
  result = client.templates.templates_create_template(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_create_template: #{e}"
end

Parameters

Request Body Properties

Return Type

Template

templates_delete_template()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.templates.templates_delete_template
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_delete_template: #{e}"
end

Parameters

Return Type

nil (empty response body)

templates_get_template()

Get a single template by ID

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.templates.templates_get_template
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_get_template: #{e}"
end

Parameters

Return Type

GetTemplatesResponse

templates_list_templates()

List all templates for a notification and channel

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.templates.templates_list_templates
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_list_templates: #{e}"
end

Parameters

Return Type

Array<GetTemplatesListResponseInner>

templates_set_default_template()

Set a template as default for specific delivery modes

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::SetDefaultTemplateRequest.new # configure as needed

begin
  result = client.templates.templates_set_default_template(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_set_default_template: #{e}"
end

Parameters

Request Body Properties

Return Type

Template

templates_update_template()

Update a template’s properties

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::TemplatePatchRequest.new # configure as needed

begin
  result = client.templates.templates_update_template(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling templates_update_template: #{e}"
end

Parameters

Request Body Properties

Return Type

Template

Types

types_create_notification_type()

Create a new notification

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::NotificationCreateRequest.new # configure as needed

begin
  result = client.types.types_create_notification_type(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling types_create_notification_type: #{e}"
end

Parameters

Request Body Properties

Return Type

Notification

types_delete_notification_type()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.types.types_delete_notification_type
  p result
rescue Pingram::ApiError => e
  puts "Error when calling types_delete_notification_type: #{e}"
end

Parameters

Return Type

nil (empty response body)

types_get_notification_type()

Get a specific notification by ID

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.types.types_get_notification_type
  p result
rescue Pingram::ApiError => e
  puts "Error when calling types_get_notification_type: #{e}"
end

Parameters

Return Type

Array<GetNotificationsResponseInner>

types_list_notification_types()

Get all notifications for an account with their templates

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.types.types_list_notification_types
  p result
rescue Pingram::ApiError => e
  puts "Error when calling types_list_notification_types: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

Array<GetNotificationsResponseInner>

types_update_notification_type()

Update a notification’s settings

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::NotificationPatchRequest.new # configure as needed

begin
  result = client.types.types_update_notification_type(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling types_update_notification_type: #{e}"
end

Parameters

Request Body Properties

Return Type

Notification

User

user_get_account_metadata()

Get account-level metadata including logo, VAPID key, and web push status

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.user.user_get_account_metadata
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_get_account_metadata: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

GetAccountMetadataResponse

user_get_available_slack_channels()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.user.user_get_available_slack_channels
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_get_available_slack_channels: #{e}"
end

Parameters

Return Type

nil (empty response body)

user_get_in_app_notifications()

Get in-app notifications for a user

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.user.user_get_in_app_notifications
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_get_in_app_notifications: #{e}"
end

Parameters

Return Type

GetInappNotificationsResponse

user_get_in_app_unread_count()

Get the count of unread in-app notifications for a user

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.user.user_get_in_app_unread_count
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_get_in_app_unread_count: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

InappUnreadCountResponse

user_get_user()

Get a user by ID. All users exist implicitly, returns basic user object if not found in DB.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.user.user_get_user
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_get_user: #{e}"
end

Parameters

Return Type

User

user_identify()

Create or update a user with the given ID. Updates lastSeenTime automatically.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::PostUserRequest.new # configure as needed

begin
  result = client.user.user_identify(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_identify: #{e}"
end

Parameters

Request Body Properties

Return Type

User

user_mark_in_app_notifications_as_seen()

Mark in-app web notifications as seen/read for a user

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::InAppNotificationUnreadClearRequest.new # configure as needed

begin
  result = client.user.user_mark_in_app_notifications_as_seen(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_mark_in_app_notifications_as_seen: #{e}"
end

Parameters

Request Body Properties

Return Type

SuccessResponse

user_update_in_app_notification_status()

Update in-app web notification status (opened, archived, clicked, etc.)

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::InAppNotificationPatchRequest.new # configure as needed

begin
  result = client.user.user_update_in_app_notification_status(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling user_update_in_app_notification_status: #{e}"
end

Parameters

Request Body Properties

Return Type

SuccessResponse

Users

users_delete_user()

Delete a user and all associated data (in-app notifications, preferences, and user record)

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.users.users_delete_user
  p result
rescue Pingram::ApiError => e
  puts "Error when calling users_delete_user: #{e}"
end

Parameters

Return Type

DeleteUserResponse

users_list_users()

Get all users for an environment with pagination support

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.users.users_list_users
  p result
rescue Pingram::ApiError => e
  puts "Error when calling users_list_users: #{e}"
end

Parameters

Return Type

GetUsersResponse

users_remove_user_from_suppression()

Remove user suppression status for a specific channel

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.users.users_remove_user_from_suppression
  p result
rescue Pingram::ApiError => e
  puts "Error when calling users_remove_user_from_suppression: #{e}"
end

Parameters

Return Type

UserSuppressionDeleteResponse

Webhooks

webhooks_delete_events_webhook()

```ruby
require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.webhooks_delete_events_webhook
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_delete_events_webhook: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

nil (empty response body)

webhooks_get_events_webhook()

Get the events webhook configuration for the current account/environment.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')

begin
  result = client.undefined.webhooks_get_events_webhook
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_get_events_webhook: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return Type

EventsWebhookResponse

webhooks_upsert_events_webhook()

Create or update the events webhook configuration for the current account/environment.

require 'pingram'

client = Pingram::Client.new(api_key: 'YOUR_API_KEY')
body = Pingram::EventsWebhookUpsertRequest.new # configure as needed

begin
  result = client.undefined.webhooks_upsert_events_webhook(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_upsert_events_webhook: #{e}"
end

Parameters

Request Body Properties

Return Type

EventsWebhookResponse