Module: Courier

Defined in:: lib/courier/client.rb,
lib/courier/errors.rb,
lib/courier/models.rb,
lib/courier/version.rb,
lib/courier/internal.rb,
lib/courier/file_part.rb,
lib/courier/models/utm.rb,
lib/courier/models/expo.rb,
lib/courier/models/logo.rb,
lib/courier/models/rule.rb,
lib/courier/models/brand.rb,
lib/courier/models/check.rb,
lib/courier/models/icons.rb,
lib/courier/models/slack.rb,
lib/courier/models/token.rb,
lib/courier/internal/util.rb,
lib/courier/models/paging.rb,
lib/courier/models/tenant.rb,
lib/courier/models/discord.rb,
lib/courier/resources/auth.rb,
lib/courier/resources/bulk.rb,
lib/courier/resources/send.rb,
lib/courier/models/audience.rb,
lib/courier/models/intercom.rb,
lib/courier/models/ms_teams.rb,
lib/courier/request_options.rb,
lib/courier/resources/lists.rb,
lib/courier/resources/users.rb,
lib/courier/models/alignment.rb,
lib/courier/models/pagerduty.rb,
lib/courier/resources/brands.rb,
lib/courier/models/base_check.rb,
lib/courier/models/email_head.rb,
lib/courier/models/preference.rb,
lib/courier/models/text_style.rb,
lib/courier/resources/inbound.rb,
lib/courier/resources/tenants.rb,
lib/courier/internal/type/enum.rb,
lib/courier/models/audit_event.rb,
lib/courier/models/device_type.rb,
lib/courier/models/list_filter.rb,
lib/courier/resources/messages.rb,
lib/courier/resources/profiles.rb,
lib/courier/resources/requests.rb,
lib/courier/internal/type/union.rb,
lib/courier/models/brand_colors.rb,
lib/courier/models/email_footer.rb,
lib/courier/models/email_header.rb,
lib/courier/models/user_profile.rb,
lib/courier/resources/audiences.rb,
lib/courier/models/brand_snippet.rb,
lib/courier/models/filter_config.rb,
lib/courier/internal/type/boolean.rb,
lib/courier/internal/type/hash_of.rb,
lib/courier/internal/type/unknown.rb,
lib/courier/models/brand_settings.rb,
lib/courier/models/brand_snippets.rb,
lib/courier/models/brand_template.rb,
lib/courier/models/elemental_node.rb,
lib/courier/models/list_recipient.rb,
lib/courier/models/user_recipient.rb,
lib/courier/models/webhook_method.rb,
lib/courier/resources/automations.rb,
lib/courier/internal/type/array_of.rb,
lib/courier/models/airship_profile.rb,
lib/courier/models/audience_filter.rb,
lib/courier/models/message_context.rb,
lib/courier/models/message_details.rb,
lib/courier/models/message_routing.rb,
lib/courier/models/multiple_tokens.rb,
lib/courier/models/send_to_channel.rb,
lib/courier/models/slack_recipient.rb,
lib/courier/models/webhook_profile.rb,
lib/courier/resources/audit_events.rb,
lib/courier/resources/translations.rb,
lib/courier/resources/users/tokens.rb,
lib/courier/internal/type/base_page.rb,
lib/courier/internal/type/converter.rb,
lib/courier/models/list_list_params.rb,
lib/courier/models/users/user_token.rb,
lib/courier/resources/notifications.rb,
lib/courier/resources/users/tenants.rb,
lib/courier/internal/type/base_model.rb,
lib/courier/internal/type/file_input.rb,
lib/courier/models/brand_list_params.rb,
lib/courier/models/elemental_content.rb,
lib/courier/models/preference_status.rb,
lib/courier/models/subscription_list.rb,
lib/courier/models/webhook_auth_mode.rb,
lib/courier/models/webhook_recipient.rb,
lib/courier/models/widget_background.rb,
lib/courier/resources/profiles/lists.rb,
lib/courier/models/audience_recipient.rb,
lib/courier/models/channel_preference.rb,
lib/courier/models/intercom_recipient.rb,
lib/courier/models/list_delete_params.rb,
lib/courier/models/list_list_response.rb,
lib/courier/models/list_update_params.rb,
lib/courier/models/ms_teams_recipient.rb,
lib/courier/models/tenant_association.rb,
lib/courier/models/tenant_list_params.rb,
lib/courier/models/automation_template.rb,
lib/courier/models/brand_create_params.rb,
lib/courier/models/brand_delete_params.rb,
lib/courier/models/brand_list_response.rb,
lib/courier/models/brand_update_params.rb,
lib/courier/models/bulk_run_job_params.rb,
lib/courier/models/default_preferences.rb,
lib/courier/models/elemental_base_node.rb,
lib/courier/models/list_restore_params.rb,
lib/courier/models/message_list_params.rb,
lib/courier/models/pagerduty_recipient.rb,
lib/courier/models/send_direct_message.rb,
lib/courier/models/send_message_params.rb,
lib/courier/models/send_to_slack_email.rb,
lib/courier/models/audience_list_params.rb,
lib/courier/models/brand_settings_email.rb,
lib/courier/models/inbound_bulk_message.rb,
lib/courier/models/list_retrieve_params.rb,
lib/courier/models/tenant_delete_params.rb,
lib/courier/models/tenant_list_response.rb,
lib/courier/models/tenant_update_params.rb,
lib/courier/models/webhook_profile_type.rb,
lib/courier/resources/tenants/templates.rb,
lib/courier/resources/users/preferences.rb,
lib/courier/models/brand_retrieve_params.rb,
lib/courier/models/brand_settings_in_app.rb,
lib/courier/models/bulk_add_users_params.rb,
lib/courier/models/message_cancel_params.rb,
lib/courier/models/message_list_response.rb,
lib/courier/models/profile_create_params.rb,
lib/courier/models/profile_delete_params.rb,
lib/courier/models/profile_update_params.rb,
lib/courier/models/recipient_preferences.rb,
lib/courier/models/send_message_response.rb,
lib/courier/models/send_to_slack_channel.rb,
lib/courier/models/send_to_slack_user_id.rb,
lib/courier/models/slack_base_properties.rb,
lib/courier/models/tenant_template_input.rb,
lib/courier/resources/automations/invoke.rb,
lib/courier/models/audience_delete_params.rb,
lib/courier/models/audience_filter_config.rb,
lib/courier/models/audience_list_response.rb,
lib/courier/models/audience_update_params.rb,
lib/courier/models/automation_list_params.rb,
lib/courier/models/bulk_create_job_params.rb,
lib/courier/models/bulk_list_users_params.rb,
lib/courier/models/channel_classification.rb,
lib/courier/models/elemental_channel_node.rb,
lib/courier/models/list_pattern_recipient.rb,
lib/courier/models/message_content_params.rb,
lib/courier/models/message_history_params.rb,
lib/courier/models/profile_replace_params.rb,
lib/courier/models/request_archive_params.rb,
lib/courier/models/send_to_ms_teams_email.rb,
lib/courier/models/subscription_topic_new.rb,
lib/courier/models/tenant_retrieve_params.rb,
lib/courier/models/users/topic_preference.rb,
lib/courier/models/webhook_authentication.rb,
lib/courier/resources/lists/subscriptions.rb,
lib/courier/resources/notifications/draft.rb,
lib/courier/resources/tenants/preferences.rb,
lib/courier/internal/transport/base_client.rb,
lib/courier/models/audit_event_list_params.rb,
lib/courier/models/auth_issue_token_params.rb,
lib/courier/models/elemental_content_sugar.rb,
lib/courier/models/message_retrieve_params.rb,
lib/courier/models/message_routing_channel.rb,
lib/courier/models/profile_create_response.rb,
lib/courier/models/profile_retrieve_params.rb,
lib/courier/models/users/token_list_params.rb,
lib/courier/resources/notifications/checks.rb,
lib/courier/models/airship_profile_audience.rb,
lib/courier/models/audience_retrieve_params.rb,
lib/courier/models/audience_update_response.rb,
lib/courier/models/bulk_create_job_response.rb,
lib/courier/models/bulk_list_users_response.rb,
lib/courier/models/bulk_retrieve_job_params.rb,
lib/courier/models/message_content_response.rb,
lib/courier/models/message_history_response.rb,
lib/courier/models/ms_teams_base_properties.rb,
lib/courier/models/notification_get_content.rb,
lib/courier/models/notification_list_params.rb,
lib/courier/models/profile_replace_response.rb,
lib/courier/models/send_to_ms_teams_user_id.rb,
lib/courier/models/tenant_list_users_params.rb,
lib/courier/models/users/tenant_list_params.rb,
lib/courier/internal/type/request_parameters.rb,
lib/courier/models/audit_event_list_response.rb,
lib/courier/models/auth_issue_token_response.rb,
lib/courier/models/inbound_bulk_message_user.rb,
lib/courier/models/message_retrieve_response.rb,
lib/courier/models/profile_retrieve_response.rb,
lib/courier/models/translation_update_params.rb,
lib/courier/models/users/token_delete_params.rb,
lib/courier/models/users/token_list_response.rb,
lib/courier/models/users/token_update_params.rb,
lib/courier/models/automation_invoke_response.rb,
lib/courier/models/bulk_retrieve_job_response.rb,
lib/courier/models/inbound_track_event_params.rb,
lib/courier/models/notification_list_response.rb,
lib/courier/models/tenant_list_users_response.rb,
lib/courier/models/users/tenant_list_response.rb,
lib/courier/models/audit_event_retrieve_params.rb,
lib/courier/models/profiles/list_delete_params.rb,
lib/courier/models/put_subscriptions_recipient.rb,
lib/courier/models/put_tenant_template_request.rb,
lib/courier/models/send_to_ms_teams_channel_id.rb,
lib/courier/models/translation_retrieve_params.rb,
lib/courier/models/user_profile_firebase_token.rb,
lib/courier/models/users/token_retrieve_params.rb,
lib/courier/models/audience_list_members_params.rb,
lib/courier/models/inbound_track_event_response.rb,
lib/courier/models/put_tenant_template_response.rb,
lib/courier/models/tenants/template_list_params.rb,
lib/courier/resources/tenants/preferences/items.rb,
lib/courier/models/elemental_meta_node_with_type.rb,
lib/courier/models/elemental_text_node_with_type.rb,
lib/courier/models/lists/subscription_add_params.rb,
lib/courier/models/profiles/list_delete_response.rb,
lib/courier/models/profiles/list_retrieve_params.rb,
lib/courier/models/send_to_ms_teams_channel_name.rb,
lib/courier/models/translation_retrieve_response.rb,
lib/courier/models/users/token_add_single_params.rb,
lib/courier/models/users/token_retrieve_response.rb,
lib/courier/resources/tenants/templates/versions.rb,
lib/courier/models/audience_list_members_response.rb,
lib/courier/models/elemental_image_node_with_type.rb,
lib/courier/models/elemental_quote_node_with_type.rb,
lib/courier/models/lists/subscription_list_params.rb,
lib/courier/models/profiles/list_subscribe_params.rb,
lib/courier/models/tenants/template_list_response.rb,
lib/courier/models/users/tenant_add_single_params.rb,
lib/courier/models/users/tenant_remove_all_params.rb,
lib/courier/models/elemental_action_node_with_type.rb,
lib/courier/models/notification_preference_details.rb,
lib/courier/models/notifications/check_list_params.rb,
lib/courier/models/profiles/list_retrieve_response.rb,
lib/courier/models/subscribe_to_lists_request_item.rb,
lib/courier/models/tenants/template_publish_params.rb,
lib/courier/models/tenants/template_replace_params.rb,
lib/courier/models/users/token_add_multiple_params.rb,
lib/courier/internal/transport/pooled_net_requester.rb,
lib/courier/models/base_template_tenant_association.rb,
lib/courier/models/elemental_channel_node_with_type.rb,
lib/courier/models/elemental_divider_node_with_type.rb,
lib/courier/models/lists/subscription_list_response.rb,
lib/courier/models/profiles/list_subscribe_response.rb,
lib/courier/models/send_to_ms_teams_conversation_id.rb,
lib/courier/models/tenants/template_retrieve_params.rb,
lib/courier/models/users/preference_retrieve_params.rb,
lib/courier/models/users/tenant_add_multiple_params.rb,
lib/courier/models/automation_template_list_response.rb,
lib/courier/models/notifications/check_delete_params.rb,
lib/courier/models/notifications/check_list_response.rb,
lib/courier/models/notifications/check_update_params.rb,
lib/courier/models/users/tenant_remove_single_params.rb,
lib/courier/models/users/preference_retrieve_response.rb,
lib/courier/models/lists/subscription_subscribe_params.rb,
lib/courier/models/notifications/check_update_response.rb,
lib/courier/models/notification_retrieve_content_params.rb,
lib/courier/models/post_tenant_template_publish_request.rb,
lib/courier/models/post_tenant_template_publish_response.rb,
lib/courier/models/tenants/preferences/item_delete_params.rb,
lib/courier/models/tenants/preferences/item_update_params.rb,
lib/courier/models/users/preference_retrieve_topic_params.rb,
lib/courier/models/automations/invoke_invoke_ad_hoc_params.rb,
lib/courier/models/lists/subscription_subscribe_user_params.rb,
lib/courier/models/users/preference_retrieve_topic_response.rb,
lib/courier/models/tenants/templates/version_retrieve_params.rb,
lib/courier/models/lists/subscription_unsubscribe_user_params.rb,
lib/courier/models/notifications/draft_retrieve_content_params.rb,
lib/courier/models/automations/invoke_invoke_by_template_params.rb,
lib/courier/models/users/preference_update_or_create_topic_params.rb,
lib/courier/models/users/preference_update_or_create_topic_response.rb

Defined Under Namespace

Modules: Errors, Internal, Models, Resources Classes: Client, FilePart, RequestOptions

Constant Summary collapse

AirshipProfile =

Courier::Models::AirshipProfile

AirshipProfileAudience =

Courier::Models::AirshipProfileAudience

Alignment =

Courier::Models::Alignment

Audience =

Courier::Models::Audience

AudienceDeleteParams =

Courier::Models::AudienceDeleteParams

AudienceFilter =

Courier::Models::AudienceFilter

AudienceFilterConfig =

Courier::Models::AudienceFilterConfig

AudienceListMembersParams =

Courier::Models::AudienceListMembersParams

AudienceListParams =

Courier::Models::AudienceListParams

AudienceRecipient =

Courier::Models::AudienceRecipient

AudienceRetrieveParams =

Courier::Models::AudienceRetrieveParams

AudienceUpdateParams =

Courier::Models::AudienceUpdateParams

AuditEvent =

Courier::Models::AuditEvent

AuditEventListParams =

Courier::Models::AuditEventListParams

AuditEventRetrieveParams =

Courier::Models::AuditEventRetrieveParams

AuthIssueTokenParams =

Courier::Models::AuthIssueTokenParams

AutomationInvokeResponse =

Courier::Models::AutomationInvokeResponse

AutomationListParams =

Courier::Models::AutomationListParams

Automations =

Courier::Models::Automations

AutomationTemplate =

Courier::Models::AutomationTemplate

AutomationTemplateListResponse =

Courier::Models::AutomationTemplateListResponse

BaseCheck =

Courier::Models::BaseCheck

BaseTemplateTenantAssociation =

Courier::Models::BaseTemplateTenantAssociation

Brand =

Courier::Models::Brand

BrandColors =

Courier::Models::BrandColors

BrandCreateParams =

Courier::Models::BrandCreateParams

BrandDeleteParams =

Courier::Models::BrandDeleteParams

BrandListParams =

Courier::Models::BrandListParams

BrandRetrieveParams =

Courier::Models::BrandRetrieveParams

BrandSettings =

Courier::Models::BrandSettings

BrandSettingsEmail =

Courier::Models::BrandSettingsEmail

BrandSettingsInApp =

Courier::Models::BrandSettingsInApp

BrandSnippet =

Courier::Models::BrandSnippet

BrandSnippets =

Courier::Models::BrandSnippets

BrandTemplate =

Courier::Models::BrandTemplate

BrandUpdateParams =

Courier::Models::BrandUpdateParams

BulkAddUsersParams =

Courier::Models::BulkAddUsersParams

BulkCreateJobParams =

Courier::Models::BulkCreateJobParams

BulkListUsersParams =

Courier::Models::BulkListUsersParams

BulkRetrieveJobParams =

Courier::Models::BulkRetrieveJobParams

BulkRunJobParams =

Courier::Models::BulkRunJobParams

ChannelClassification =

Courier::Models::ChannelClassification

ChannelPreference =

Courier::Models::ChannelPreference

Check =

Courier::Models::Check

DefaultPreferences =

Courier::Models::DefaultPreferences

DeviceType =

Courier::Models::DeviceType

Discord =

Courier::Models::Discord

ElementalActionNodeWithType =

Courier::Models::ElementalActionNodeWithType

ElementalBaseNode =

Courier::Models::ElementalBaseNode

ElementalChannelNode =

Courier::Models::ElementalChannelNode

ElementalChannelNodeWithType =

Courier::Models::ElementalChannelNodeWithType

ElementalContent =

Courier::Models::ElementalContent

ElementalContentSugar =

Courier::Models::ElementalContentSugar

ElementalDividerNodeWithType =

Courier::Models::ElementalDividerNodeWithType

ElementalImageNodeWithType =

Courier::Models::ElementalImageNodeWithType

ElementalMetaNodeWithType =

Courier::Models::ElementalMetaNodeWithType

ElementalNode =

Courier::Models::ElementalNode

ElementalQuoteNodeWithType =

Courier::Models::ElementalQuoteNodeWithType

ElementalTextNodeWithType =

Courier::Models::ElementalTextNodeWithType

EmailFooter =

Courier::Models::EmailFooter

EmailHead =

Courier::Models::EmailHead

EmailHeader =

Courier::Models::EmailHeader

Expo =

Courier::Models::Expo

FilterConfig =

Courier::Models::FilterConfig

Icons =

Courier::Models::Icons

InboundBulkMessage =

Courier::Models::InboundBulkMessage

InboundBulkMessageUser =

Courier::Models::InboundBulkMessageUser

InboundTrackEventParams =

Courier::Models::InboundTrackEventParams

Intercom =

Courier::Models::Intercom

IntercomRecipient =

Courier::Models::IntercomRecipient

ListDeleteParams =

Courier::Models::ListDeleteParams

ListFilter =

Courier::Models::ListFilter

ListListParams =

Courier::Models::ListListParams

ListPatternRecipient =

Courier::Models::ListPatternRecipient

ListRecipient =

Courier::Models::ListRecipient

ListRestoreParams =

Courier::Models::ListRestoreParams

ListRetrieveParams =

Courier::Models::ListRetrieveParams

Lists =

Courier::Models::Lists

ListUpdateParams =

Courier::Models::ListUpdateParams

Logo =

Courier::Models::Logo

MessageCancelParams =

Courier::Models::MessageCancelParams

MessageContentParams =

Courier::Models::MessageContentParams

MessageContext =

Courier::Models::MessageContext

MessageDetails =

Courier::Models::MessageDetails

MessageHistoryParams =

Courier::Models::MessageHistoryParams

MessageListParams =

Courier::Models::MessageListParams

MessageRetrieveParams =

Courier::Models::MessageRetrieveParams

MessageRouting =

Courier::Models::MessageRouting

MessageRoutingChannel =

Courier::Models::MessageRoutingChannel

MsTeams =

Courier::Models::MsTeams

MsTeamsBaseProperties =

Courier::Models::MsTeamsBaseProperties

MsTeamsRecipient =

Courier::Models::MsTeamsRecipient

MultipleTokens =

Courier::Models::MultipleTokens

NotificationGetContent =

Courier::Models::NotificationGetContent

NotificationListParams =

Courier::Models::NotificationListParams

NotificationPreferenceDetails =

Courier::Models::NotificationPreferenceDetails

NotificationRetrieveContentParams =

Courier::Models::NotificationRetrieveContentParams

Notifications =

Courier::Models::Notifications

Pagerduty =

Courier::Models::Pagerduty

PagerdutyRecipient =

Courier::Models::PagerdutyRecipient

Paging =

Courier::Models::Paging

PostTenantTemplatePublishRequest =

Courier::Models::PostTenantTemplatePublishRequest

PostTenantTemplatePublishResponse =

Courier::Models::PostTenantTemplatePublishResponse

Preference =

Courier::Models::Preference

PreferenceStatus =

Courier::Models::PreferenceStatus

ProfileCreateParams =

Courier::Models::ProfileCreateParams

ProfileDeleteParams =

Courier::Models::ProfileDeleteParams

ProfileReplaceParams =

Courier::Models::ProfileReplaceParams

ProfileRetrieveParams =

Courier::Models::ProfileRetrieveParams

Profiles =

Courier::Models::Profiles

ProfileUpdateParams =

Courier::Models::ProfileUpdateParams

PutSubscriptionsRecipient =

Courier::Models::PutSubscriptionsRecipient

PutTenantTemplateRequest =

Courier::Models::PutTenantTemplateRequest

PutTenantTemplateResponse =

Courier::Models::PutTenantTemplateResponse

RecipientPreferences =

Courier::Models::RecipientPreferences

RequestArchiveParams =

Courier::Models::RequestArchiveParams

Rule =

Courier::Models::Rule

SendDirectMessage =

Courier::Models::SendDirectMessage

SendMessageParams =

Courier::Models::SendMessageParams

SendToChannel =

Courier::Models::SendToChannel

SendToMsTeamsChannelID =

Courier::Models::SendToMsTeamsChannelID

SendToMsTeamsChannelName =

Courier::Models::SendToMsTeamsChannelName

SendToMsTeamsConversationID =

Courier::Models::SendToMsTeamsConversationID

SendToMsTeamsEmail =

Courier::Models::SendToMsTeamsEmail

SendToMsTeamsUserID =

Courier::Models::SendToMsTeamsUserID

SendToSlackChannel =

Courier::Models::SendToSlackChannel

SendToSlackEmail =

Courier::Models::SendToSlackEmail

SendToSlackUserID =

Courier::Models::SendToSlackUserID

Slack =

Courier::Models::Slack

SlackBaseProperties =

Courier::Models::SlackBaseProperties

SlackRecipient =

Courier::Models::SlackRecipient

SubscribeToListsRequestItem =

Courier::Models::SubscribeToListsRequestItem

SubscriptionList =

Courier::Models::SubscriptionList

SubscriptionTopicNew =

Courier::Models::SubscriptionTopicNew

Tenant =

Courier::Models::Tenant

TenantAssociation =

Courier::Models::TenantAssociation

TenantDeleteParams =

Courier::Models::TenantDeleteParams

TenantListParams =

Courier::Models::TenantListParams

TenantListUsersParams =

Courier::Models::TenantListUsersParams

TenantRetrieveParams =

Courier::Models::TenantRetrieveParams

Tenants =

Courier::Models::Tenants

TenantTemplateInput =

Courier::Models::TenantTemplateInput

TenantUpdateParams =

Courier::Models::TenantUpdateParams

TextStyle =

Courier::Models::TextStyle

Token =

Courier::Models::Token

TranslationRetrieveParams =

Courier::Models::TranslationRetrieveParams

TranslationUpdateParams =

Courier::Models::TranslationUpdateParams

UserProfile =

Courier::Models::UserProfile

UserProfileFirebaseToken =

Courier::Models::UserProfileFirebaseToken

UserRecipient =

Courier::Models::UserRecipient

Users =

Courier::Models::Users

Utm =

Courier::Models::Utm

WebhookAuthentication =

Courier::Models::WebhookAuthentication

WebhookAuthMode =

Courier::Models::WebhookAuthMode

WebhookMethod =

Courier::Models::WebhookMethod

WebhookProfile =

Courier::Models::WebhookProfile

WebhookProfileType =

Courier::Models::WebhookProfileType

WebhookRecipient =

Courier::Models::WebhookRecipient

WidgetBackground =

Courier::Models::WidgetBackground

VERSION =

"4.7.1"