Module: Pingram

Defined in:
lib/pingram/version.rb,
lib/pingram.rb,
lib/pingram/api_error.rb,
lib/pingram/api_client.rb,
lib/pingram/models/user.rb,
lib/pingram/api/keys_api.rb,
lib/pingram/api/logs_api.rb,
lib/pingram/api/user_api.rb,
lib/pingram/api/types_api.rb,
lib/pingram/api/users_api.rb,
lib/pingram/configuration.rb,
lib/pingram/api/editor_api.rb,
lib/pingram/api/health_api.rb,
lib/pingram/api/sender_api.rb,
lib/pingram/api_model_base.rb,
lib/pingram/client_wrapper.rb,
lib/pingram/api/account_api.rb,
lib/pingram/api/default_api.rb,
lib/pingram/api/domains_api.rb,
lib/pingram/api/members_api.rb,
lib/pingram/models/template.rb,
lib/pingram/api/insights_api.rb,
lib/pingram/api/addresses_api.rb,
lib/pingram/api/templates_api.rb,
lib/pingram/api/components_api.rb,
lib/pingram/models/environment.rb,
lib/pingram/models/bee_token_v2.rb,
lib/pingram/models/notification.rb,
lib/pingram/api/environments_api.rb,
lib/pingram/models/channels_enum.rb,
lib/pingram/models/address_response.rb,
lib/pingram/models/intercom_webhook.rb,
lib/pingram/models/message_response.rb,
lib/pingram/models/sender_post_body.rb,
lib/pingram/models/success_response.rb,
lib/pingram/models/webhook_response.rb,
lib/pingram/models/get_keys_response.rb,
lib/pingram/models/get_logs_response.rb,
lib/pingram/models/logs_bulk_request.rb,
lib/pingram/models/logs_get_response.rb,
lib/pingram/models/post_user_request.rb,
lib/pingram/models/create_key_request.rb,
lib/pingram/models/get_users_response.rb,
lib/pingram/models/logs_tail_response.rb,
lib/pingram/models/create_key_response.rb,
lib/pingram/models/delete_key_response.rb,
lib/pingram/models/log_query_post_body.rb,
lib/pingram/models/logs_query_response.rb,
lib/pingram/models/sender_post_body_to.rb,
lib/pingram/models/slack_oauth_request.rb,
lib/pingram/models/account_get_response.rb,
lib/pingram/models/delete_user_response.rb,
lib/pingram/models/inbound_request_body.rb,
lib/pingram/models/invite_post_response.rb,
lib/pingram/models/sender_post_body_sms.rb,
lib/pingram/models/sender_post_response.rb,
lib/pingram/models/inbound_response_body.rb,
lib/pingram/models/ingishts_post_request.rb,
lib/pingram/models/intercom_webhook_data.rb,
lib/pingram/models/member_invite_request.rb,
lib/pingram/models/member_update_request.rb,
lib/pingram/models/sender_post_body_user.rb,
lib/pingram/models/template_post_request.rb,
lib/pingram/models/auto_join_get_response.rb,
lib/pingram/models/auto_join_request_body.rb,
lib/pingram/models/create_address_request.rb,
lib/pingram/models/get_templates_response.rb,
lib/pingram/models/sender_post_body_email.rb,
lib/pingram/models/sender_post_body_inapp.rb,
lib/pingram/models/sender_post_body_slack.rb,
lib/pingram/models/template_patch_request.rb,
lib/pingram/models/update_address_request.rb,
lib/pingram/models/auto_join_post_response.rb,
lib/pingram/models/create_account_response.rb,
lib/pingram/models/logs_retention_response.rb,
lib/pingram/models/post_email_test_request.rb,
lib/pingram/models/supabase_o_auth_request.rb,
lib/pingram/models/email_component_response.rb,
lib/pingram/models/post_email_test_response.rb,
lib/pingram/models/sender_post_body_options.rb,
lib/pingram/models/supabase_o_auth_response.rb,
lib/pingram/models/supabase_status_response.rb,
lib/pingram/models/billing_post_request_body.rb,
lib/pingram/models/environment_patch_request.rb,
lib/pingram/models/post_senders_request_body.rb,
lib/pingram/models/sender_post_body_web_push.rb,
lib/pingram/models/account_addresses_response.rb,
lib/pingram/models/billing_post_response_body.rb,
lib/pingram/models/environment_create_request.rb,
lib/pingram/models/get_members_response_inner.rb,
lib/pingram/models/get_metrics_response_inner.rb,
lib/pingram/models/get_senders_response_inner.rb,
lib/pingram/models/intercom_webhook_data_item.rb,
lib/pingram/models/logs_query_result_response.rb,
lib/pingram/models/notification_patch_request.rb,
lib/pingram/models/supabase_configure_request.rb,
lib/pingram/models/supabase_projects_response.rb,
lib/pingram/models/create_account_request_body.rb,
lib/pingram/models/inapp_unread_count_response.rb,
lib/pingram/models/notification_create_request.rb,
lib/pingram/models/supabase_configure_response.rb,
lib/pingram/models/template_post_request_batch.rb,
lib/pingram/models/email_component_post_request.rb,
lib/pingram/models/get_keys_response_keys_inner.rb,
lib/pingram/models/logs_get_response_logs_inner.rb,
lib/pingram/models/sender_post_body_mobile_push.rb,
lib/pingram/models/sender_post_body_options_apn.rb,
lib/pingram/models/sender_post_body_options_fcm.rb,
lib/pingram/models/set_default_template_request.rb,
lib/pingram/models/slack_interactivity_response.rb,
lib/pingram/models/email_auth_token_post_request.rb,
lib/pingram/models/email_component_patch_request.rb,
lib/pingram/models/get_account_metadata_response.rb,
lib/pingram/models/template_patch_request_any_of.rb,
lib/pingram/models/template_post_request_instant.rb,
lib/pingram/models/get_users_response_users_inner.rb,
lib/pingram/models/sender_post_body_options_email.rb,
lib/pingram/models/template_patch_request_any_of1.rb,
lib/pingram/models/get_environments_response_inner.rb,
lib/pingram/models/sender_post_body_sms_auto_reply.rb,
lib/pingram/models/get_inapp_notifications_response.rb,
lib/pingram/models/get_logs_response_messages_inner.rb,
lib/pingram/models/get_notifications_response_inner.rb,
lib/pingram/models/user_suppression_delete_response.rb,
lib/pingram/models/get_templates_list_response_inner.rb,
lib/pingram/models/in_app_notification_patch_request.rb,
lib/pingram/models/intercom_webhook_data_item_any_of.rb,
lib/pingram/models/get_email_components_response_inner.rb,
lib/pingram/models/inbound_response_body_results_inner.rb,
lib/pingram/models/ingishts_post_request_label_options.rb,
lib/pingram/models/sender_post_body_options_fcm_android.rb,
lib/pingram/models/template_patch_request_any_of1_batch.rb,
lib/pingram/models/template_patch_request_any_of1_instant.rb,
lib/pingram/models/get_notifications_response_inner_options.rb,
lib/pingram/models/get_templates_list_response_inner_any_of.rb,
lib/pingram/models/in_app_notification_unread_clear_request.rb,
lib/pingram/models/intercom_webhook_data_item_any_of_source.rb,
lib/pingram/models/get_metrics_response_inner_messages_inner.rb,
lib/pingram/models/get_templates_list_response_inner_any_of1.rb,
lib/pingram/models/get_templates_list_response_inner_any_of2.rb,
lib/pingram/models/get_templates_list_response_inner_any_of3.rb,
lib/pingram/models/get_templates_list_response_inner_any_of4.rb,
lib/pingram/models/get_templates_list_response_inner_any_of5.rb,
lib/pingram/models/supabase_projects_response_projects_inner.rb,
lib/pingram/models/account_addresses_response_addresses_inner.rb,
lib/pingram/models/get_users_response_users_inner_slack_token.rb,
lib/pingram/models/intercom_webhook_data_item_any_of_contacts.rb,
lib/pingram/models/get_notifications_response_inner_throttling.rb,
lib/pingram/models/email_component_response_referenced_by_inner.rb,
lib/pingram/models/get_notifications_response_inner_deduplication.rb,
lib/pingram/models/get_notifications_response_inner_options_email.rb,
lib/pingram/models/ingishts_post_request_metric_data_queries_inner.rb,
lib/pingram/models/intercom_webhook_data_item_any_of_source_author.rb,
lib/pingram/models/get_notifications_response_inner_templates_inner.rb,
lib/pingram/models/get_users_response_users_inner_push_tokens_inner.rb,
lib/pingram/models/sender_post_body_options_email_attachments_inner.rb,
lib/pingram/models/get_templates_list_response_inner_any_of1_instant.rb,
lib/pingram/models/account_get_response_pending_downgrade_usage_limit.rb,
lib/pingram/models/get_logs_response_messages_inner_attachments_inner.rb,
lib/pingram/models/get_templates_list_response_inner_any_of5_metadata.rb,
lib/pingram/models/get_account_metadata_response_user_account_metadata.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner.rb,
lib/pingram/models/get_notifications_response_inner_options_email_daily.rb,
lib/pingram/models/get_users_response_users_inner_web_push_tokens_inner.rb,
lib/pingram/models/get_notifications_response_inner_options_email_weekly.rb,
lib/pingram/models/get_users_response_users_inner_slack_token_enterprise.rb,
lib/pingram/models/get_notifications_response_inner_options_email_monthly.rb,
lib/pingram/models/get_users_response_users_inner_slack_token_authed_user.rb,
lib/pingram/models/get_users_response_users_inner_email_suppression_status.rb,
lib/pingram/models/get_users_response_users_inner_push_tokens_inner_device.rb,
lib/pingram/models/sender_post_body_options_email_attachments_inner_any_of.rb,
lib/pingram/models/billing_post_response_body_pending_downgrade_usage_limit.rb,
lib/pingram/models/get_users_response_users_inner_web_push_tokens_inner_sub.rb,
lib/pingram/models/sender_post_body_options_email_attachments_inner_any_of1.rb,
lib/pingram/models/intercom_webhook_data_item_any_of_contacts_contacts_inner.rb,
lib/pingram/models/get_users_response_users_inner_slack_token_incoming_webhook.rb,
lib/pingram/models/ingishts_post_request_metric_data_queries_inner_metric_stat.rb,
lib/pingram/models/get_users_response_users_inner_slack_token_response_metadata.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_template.rb,
lib/pingram/models/get_users_response_users_inner_web_push_tokens_inner_sub_keys.rb,
lib/pingram/models/get_templates_list_response_inner_any_of5_metadata_entities_inner.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_replies_inner.rb,
lib/pingram/models/ingishts_post_request_metric_data_queries_inner_metric_stat_metric.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_template_any_of.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_delivery_options.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_delivery_options_off.rb,
lib/pingram/models/get_inapp_notifications_response_notifications_inner_delivery_options_instant.rb,
lib/pingram/models/get_templates_list_response_inner_any_of5_metadata_entities_inner_external_ref.rb,
lib/pingram/models/ingishts_post_request_metric_data_queries_inner_metric_stat_metric_dimensions_inner.rb

Overview

#NotificationAPI

#Internal API for notification delivery and management

The version of the OpenAPI document: 1.0.0

Generated by: openapi-generator.tech Generator version: 7.19.0

Defined Under Namespace

Modules: GetInappNotificationsResponseNotificationsInnerTemplate, GetTemplatesListResponseInner, GetTemplatesResponse, InboundRequestBody, IntercomWebhookDataItem, SenderPostBodyOptionsEmailAttachmentsInner, TemplatePatchRequest Classes: AccountAddressesResponse, AccountAddressesResponseAddressesInner, AccountApi, AccountGetResponse, AccountGetResponsePendingDowngradeUsageLimit, AddressResponse, AddressesApi, ApiClient, ApiError, ApiModelBase, AutoJoinGetResponse, AutoJoinPostResponse, AutoJoinRequestBody, BeeTokenV2, BillingPostRequestBody, BillingPostResponseBody, BillingPostResponseBodyPendingDowngradeUsageLimit, ChannelsEnum, Client, ComponentsApi, Configuration, CreateAccountRequestBody, CreateAccountResponse, CreateAddressRequest, CreateKeyRequest, CreateKeyResponse, DefaultApi, DeleteKeyResponse, DeleteUserResponse, DomainsApi, EditorApi, EmailAuthTokenPostRequest, EmailComponentPatchRequest, EmailComponentPostRequest, EmailComponentResponse, EmailComponentResponseReferencedByInner, Environment, EnvironmentCreateRequest, EnvironmentPatchRequest, EnvironmentsApi, GetAccountMetadataResponse, GetAccountMetadataResponseUserAccountMetadata, GetEmailComponentsResponseInner, GetEnvironmentsResponseInner, GetInappNotificationsResponse, GetInappNotificationsResponseNotificationsInner, GetInappNotificationsResponseNotificationsInnerDeliveryOptions, GetInappNotificationsResponseNotificationsInnerDeliveryOptionsInstant, GetInappNotificationsResponseNotificationsInnerDeliveryOptionsOff, GetInappNotificationsResponseNotificationsInnerRepliesInner, GetInappNotificationsResponseNotificationsInnerTemplateAnyOf, GetKeysResponse, GetKeysResponseKeysInner, GetLogsResponse, GetLogsResponseMessagesInner, GetLogsResponseMessagesInnerAttachmentsInner, GetMembersResponseInner, GetMetricsResponseInner, GetMetricsResponseInnerMessagesInner, GetNotificationsResponseInner, GetNotificationsResponseInnerDeduplication, GetNotificationsResponseInnerOptions, GetNotificationsResponseInnerOptionsEMAIL, GetNotificationsResponseInnerOptionsEMAILDaily, GetNotificationsResponseInnerOptionsEMAILMonthly, GetNotificationsResponseInnerOptionsEMAILWeekly, GetNotificationsResponseInnerTemplatesInner, GetNotificationsResponseInnerThrottling, GetSendersResponseInner, GetTemplatesListResponseInnerAnyOf, GetTemplatesListResponseInnerAnyOf1, GetTemplatesListResponseInnerAnyOf1Instant, GetTemplatesListResponseInnerAnyOf2, GetTemplatesListResponseInnerAnyOf3, GetTemplatesListResponseInnerAnyOf4, GetTemplatesListResponseInnerAnyOf5, GetTemplatesListResponseInnerAnyOf5Metadata, GetTemplatesListResponseInnerAnyOf5MetadataEntitiesInner, GetTemplatesListResponseInnerAnyOf5MetadataEntitiesInnerExternalRef, GetUsersResponse, GetUsersResponseUsersInner, GetUsersResponseUsersInnerEmailSuppressionStatus, GetUsersResponseUsersInnerPushTokensInner, GetUsersResponseUsersInnerPushTokensInnerDevice, GetUsersResponseUsersInnerSlackToken, GetUsersResponseUsersInnerSlackTokenAuthedUser, GetUsersResponseUsersInnerSlackTokenEnterprise, GetUsersResponseUsersInnerSlackTokenIncomingWebhook, GetUsersResponseUsersInnerSlackTokenResponseMetadata, GetUsersResponseUsersInnerWebPushTokensInner, GetUsersResponseUsersInnerWebPushTokensInnerSub, GetUsersResponseUsersInnerWebPushTokensInnerSubKeys, HealthApi, InAppNotificationPatchRequest, InAppNotificationUnreadClearRequest, InappUnreadCountResponse, InboundResponseBody, InboundResponseBodyResultsInner, IngishtsPostRequest, IngishtsPostRequestLabelOptions, IngishtsPostRequestMetricDataQueriesInner, IngishtsPostRequestMetricDataQueriesInnerMetricStat, IngishtsPostRequestMetricDataQueriesInnerMetricStatMetric, IngishtsPostRequestMetricDataQueriesInnerMetricStatMetricDimensionsInner, InsightsApi, IntercomWebhook, IntercomWebhookData, IntercomWebhookDataItemAnyOf, IntercomWebhookDataItemAnyOfContacts, IntercomWebhookDataItemAnyOfContactsContactsInner, IntercomWebhookDataItemAnyOfSource, IntercomWebhookDataItemAnyOfSourceAuthor, InvitePostResponse, KeysApi, LogQueryPostBody, LogsApi, LogsBulkRequest, LogsGetResponse, LogsGetResponseLogsInner, LogsQueryResponse, LogsQueryResultResponse, LogsRetentionResponse, LogsTailResponse, MemberInviteRequest, MemberUpdateRequest, MembersApi, MessageResponse, Notification, NotificationCreateRequest, NotificationPatchRequest, PostEmailTestRequest, PostEmailTestResponse, PostSendersRequestBody, PostUserRequest, SenderApi, SenderPostBody, SenderPostBodyEmail, SenderPostBodyInapp, SenderPostBodyMobilePush, SenderPostBodyOptions, SenderPostBodyOptionsApn, SenderPostBodyOptionsEmail, SenderPostBodyOptionsEmailAttachmentsInnerAnyOf, SenderPostBodyOptionsEmailAttachmentsInnerAnyOf1, SenderPostBodyOptionsFcm, SenderPostBodyOptionsFcmAndroid, SenderPostBodySlack, SenderPostBodySms, SenderPostBodySmsAutoReply, SenderPostBodyTo, SenderPostBodyUser, SenderPostBodyWebPush, SenderPostResponse, SetDefaultTemplateRequest, SlackInteractivityResponse, SlackOauthRequest, SuccessResponse, SupabaseConfigureRequest, SupabaseConfigureResponse, SupabaseOAuthRequest, SupabaseOAuthResponse, SupabaseProjectsResponse, SupabaseProjectsResponseProjectsInner, SupabaseStatusResponse, Template, TemplatePatchRequestAnyOf, TemplatePatchRequestAnyOf1, TemplatePatchRequestAnyOf1Batch, TemplatePatchRequestAnyOf1Instant, TemplatePostRequest, TemplatePostRequestBatch, TemplatePostRequestInstant, TemplatesApi, TypesApi, UpdateAddressRequest, User, UserApi, UserSuppressionDeleteResponse, UsersApi, WebhookResponse

Constant Summary collapse

VERSION = 
'0.1.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

Pingram.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



215
216
217
218
219
220
221
 
# File 'lib/pingram.rb', line 215

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end