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 (email, SMS, etc.) to one user. Requires a notification type which categorizes this messages for future reporting, and channel-specific payloads such as email or sms. Recipient is specified with the to parameter. Returns a trackingId for error or delivery lookup through our Logs.

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

| Name | Type | Description | Notes | | –––––––––– | —————— | ——————————— | —– | — | | sender_post_body | SenderPostBody | See Request Body Properties below | | |

Request Body Properties

Return Type

SenderPostResponse

Webhooks

webhooks_delete_events_webhook()

```ruby
require 'pingram'

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

begin
  result = client.webhooks.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.webhooks.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.webhooks.webhooks_upsert_events_webhook(body)
  p result
rescue Pingram::ApiError => e
  puts "Error when calling webhooks_upsert_events_webhook: #{e}"
end

Parameters

| Name | Type | Description | Notes | | ——————————— | —————————— | ——————————— | —– | — | | events_webhook_upsert_request | EventsWebhookUpsertRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

EventsWebhookResponse

Addresses

addresses_create_address()

Create a new email inbox. Omit domain for a built-in @mail.pingram.io address; set domain and displayName for a custom address on a verified domain.

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

| Name | Type | Description | Notes | | ––––––––––––– | ———————— | ——————————— | —– | — | | create_address_request | CreateAddressRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

AddressResponse

addresses_delete_address()

Delete a custom inbound address. Builtin addresses cannot be deleted.

require 'pingram'

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

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

Parameters

Return Type

SuccessResponse

addresses_list_addresses()

List email inboxes (addresses) configured for receiving. Custom addresses must use a verified domain.

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 inbox prefix or display name.

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

| Name | Type | Description | Notes | | ––––––––––––– | ———————— | ——————————— | —– | — | | update_address_request | UpdateAddressRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

AddressResponse

Domains

domains_add_domain()

Add and start verification for a new sender domain. Pass the domain only (not a full email address).

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

| Name | Type | Description | Notes | | —————————– | ––––––––––––– | ——————————— | —– | — | | post_senders_request_body | PostSendersRequestBody | See Request Body Properties below | | |

Request Body Properties

Return Type

Array<GetSendersResponseInner>

domains_delete_domain()

Remove a sender domain from the account.

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()

List sender domains configured for the account (for outbound email).

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>

domains_start_domain_verification()

Start SES domain verification (DNS readiness is checked client-side via checkDomainDns)

require 'pingram'

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

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

Parameters

Return Type

Array<GetSendersResponseInner>

Email

email_send()

Send an email. Requires type, to, subject, and html. Optional: fromAddress, fromName, schedule, attachments. The fromAddress must be a verified domain; otherwise our built-in address will be used which is fine for testing purposes.

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ––––––––––– | –––––––––– | ——————————— | —– | — | | send_email_request | SendEmailRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

SendEmailApiResponse

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

| Name | Type | Description | Notes | | —————————— | –––––––––––––– | ——————————— | —– | — | | environment_create_request | EnvironmentCreateRequest | See Request Body Properties below | | |

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

| Name | Type | Description | Notes | | —————————– | ————————— | ——————————— | —– | — | | client_id | String | Environment client ID | | | environment_patch_request | EnvironmentPatchRequest | See Request Body Properties below | | |

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 recent notification logs for the authenticated account, newest first.

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). Use after sending email or SMS to look up delivery status.

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 log query started with Start Log Query. Poll until status is Complete.

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 an asynchronous log search over a date range. Returns a queryId; poll with Get Log Query Results until status is Complete.

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

| Name | Type | Description | Notes | | ———————– | –––––––––– | ——————————— | —– | — | | log_query_post_body | LogQueryPostBody | See Request Body Properties below | | |

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

Numbers

numbers_list()

List active phone numbers registered for the account.

require 'pingram'

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

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

Parameters

This endpoint does not need any parameter.

Return Type

ListPhoneNumbersResponse

numbers_list_released()

List released phone numbers. Released numbers may be purchased again with 2 weeks of being released. Released numbers may be removed from released list after 2 weeks.

require 'pingram'

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

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

Parameters

This endpoint does not need any parameter.

Return Type

ListReleasedPhoneNumbersResponse

numbers_order_number()

Purchase a phone number for the authenticated account, or reactivate a released number owned by the account (preserves original createdAt). Pass phoneNumber in E.164 format (e.g. +15551234567).

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | —————————— | ————————— | ——————————— | —– | — | | order_phone_number_request | OrderPhoneNumberRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

OrderPhoneNumberResponse

numbers_release_number()

Release a phone number from the account. No refund for the current billing month.

require 'pingram'

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

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

Parameters

Return Type

ReleasePhoneNumberResponse

numbers_search_available()

Search for available phone numbers to purchase. Requires countryCode (e.g. US, CA). Use before ordering a number.

require 'pingram'

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

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

Parameters

Return Type

SearchAvailablePhoneNumbersResponse

Organization

organization_create()

Create organization after SMS verification bypass

require 'pingram'

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

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

Parameters

This endpoint does not need any parameter.

Return Type

CreateOrganizationResponse

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.organization.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.organization.organization_get_usage_history
  p result
rescue Pingram::ApiError => e
  puts "Error when calling organization_get_usage_history: #{e}"
end

Parameters

Return Type

OrganizationUsageHistory

Profile

profile_accept_invite()

Accept a team invitation using a token

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ———————–– | ———————– | ——————————— | —– | — | | accept_invite_request | AcceptInviteRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

AcceptInviteResponse

profile_change_email()

Change the email address of the authenticated user

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ———————— | ––––––––––– | ——————————— | —– | — | | change_email_request | ChangeEmailRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

SuccessResponse

profile_delete_account()

Permanently delete the authenticated user’s account

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ––––––––––––– | ———————— | ——————————— | —– | — | | delete_account_request | DeleteAccountRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

SuccessResponse

profile_disable_mfa()

Disable MFA for the authenticated user

require 'pingram'

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

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

Parameters

Return Type

SuccessResponse

profile_get_mfa_status()

Get MFA status for the authenticated user

require 'pingram'

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

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

Parameters

This endpoint does not need any parameter.

Return Type

MFAStatusResponse

profile_setup_mfa()

Start TOTP MFA setup and return QR code data

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ——————— | —————–– | ——————————— | —– | — | | mfa_setup_request | MFASetupRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

MFASetupResponse

profile_verify_mfa()

Verify TOTP code and enable MFA

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | ––––––––––– | –––––––––– | ——————————— | —– | — | | mfa_verify_request | MFAVerifyRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

SuccessResponse

PushSettings

push_settings_delete_push_apn_settings()

```ruby
require 'pingram'

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

begin
  result = client.push_settings.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.push_settings.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.push_settings.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.push_settings.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.push_settings.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

| Name | Type | Description | Notes | | ––––––– | ———–– | ——————————— | —– | — | | apn_config | APNConfig | See Request Body Properties below | | |

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.push_settings.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

| Name | Type | Description | Notes | | ——————————— | —————————– | ——————————— | —– | — | | push_settings_fcm_put_request | PushSettingsFCMPutRequest | See Request Body Properties below | | |

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

| Name | Type | Description | Notes | | –––––––––– | —————— | ——————————————— | —– | — | | tracking_id | String | The tracking ID of the scheduled notification | | | sender_post_body | SenderPostBody | See Request Body Properties below | | |

Request Body Properties

Return Type

MessageResponse

Sms

sms_send()

Send an SMS or MMS directly without a template. Requires type and to. Pass message and/or mediaUrls. Optional: from, schedule.

require 'pingram'

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

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

Parameters

| Name | Type | Description | Notes | | –––––––––– | —————— | ——————————— | —– | — | | send_sms_request | SendSmsRequest | See Request Body Properties below | | |

Request Body Properties

Return Type

SendSmsResponse

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

| Name | Type | Description | Notes | | ———————–– | ———————– | ——————————— | —– | — | | notification_id | String | Notification ID | | | channel | String | Channel type | | | template_post_request | TemplatePostRequest | See Request Body Properties below | | |

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

| Name | Type | Description | Notes | | –––––––––––––––– | —————————– | ——————————— | —– | — | | notification_id | String | Notification ID | | | channel | String | Channel type | | | set_default_template_request | SetDefaultTemplateRequest | See Request Body Properties below | | |

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

| Name | Type | Description | Notes | | ––––––––––––– | ———————— | ——————————— | —– | — | | notification_id | String | Notification ID | | | channel | String | Channel type | | | template_id | String | Template ID | | | template_patch_request | TemplatePatchRequest | See Request Body Properties below | | |

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

| Name | Type | Description | Notes | | —————————–– | —————————– | ——————————— | —– | — | | notification_create_request | NotificationCreateRequest | See Request Body Properties below | | |

Request Body Properties