Documentation for knockapi (1.25.0)

Alphabetic Index

File Listing

README

Namespace Listing A-Z

APIConnectionError (Knockapi::Errors)
APIError (Knockapi::Errors)
APIStatusError (Knockapi::Errors)
APITimeoutError (Knockapi::Errors)
Action (Knockapi::Models::Channels::BulkUpdateMessageStatusParams)
ActivationURLPattern (Knockapi::Models::Users::GuideGetChannelResponse::Entry)
ActivationURLRule (Knockapi::Models::Users::GuideGetChannelResponse::Entry)
Activity (Knockapi::Models)
Archived (Knockapi::Models::Users::FeedListItemsParams)
Archived (Knockapi::Models::Channels::BulkUpdateMessageStatusParams)
ArrayOf (Knockapi::Internal::Type)
AudienceAddMembersParams (Knockapi::Models)
AudienceListMembersParams (Knockapi::Models)
AudienceListMembersResponse (Knockapi::Models)
AudienceMember (Knockapi::Models)
AudienceRemoveMembersParams (Knockapi::Models)
Audiences (Knockapi::Resources)
AuthenticationError (Knockapi::Errors)
AwsSnsPushChannelDataDevicesOnly (Knockapi::Models::Recipients)
AwsSnsPushChannelDataTargetArnsOnly (Knockapi::Models::Recipients)
AwssnsPushChannelDataFull (Knockapi::Models::Recipients::RecipientsChannelData::Data)

BadRequestError (Knockapi::Errors)
BaseClient (Knockapi::Internal::Transport)
BaseModel (Knockapi::Internal::Type)
BasePage (Knockapi::Internal::Type)
Batch (Knockapi::Resources::Messages)
BatchArchiveParams (Knockapi::Models::Messages)
BatchGetContentParams (Knockapi::Models::Messages)
BatchGetContentResponseItem (Knockapi::Models::Messages)
BatchMarkAsInteractedParams (Knockapi::Models::Messages)
BatchMarkAsReadParams (Knockapi::Models::Messages)
BatchMarkAsSeenParams (Knockapi::Models::Messages)
BatchMarkAsUnreadParams (Knockapi::Models::Messages)
BatchMarkAsUnseenParams (Knockapi::Models::Messages)
BatchUnarchiveParams (Knockapi::Models::Messages)
Block (Knockapi::Models::Users::FeedListItemsResponse)
Block (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent)
Block (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent)
Block (Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template)
Block (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template)
Body (Knockapi::Models::MessageDeliveryLog::Request)
Body (Knockapi::Models::MessageDeliveryLog::Response)
Boolean (Knockapi::Internal::Type)
Branding (Knockapi::Models::TenantRequest::Settings)
Branding (Knockapi::Models::TenantSetParams::Settings)
Branding (Knockapi::Models::Tenant::Settings)
Bulk (Knockapi::Resources::Objects)
Bulk (Knockapi::Resources::Users)
Bulk (Knockapi::Resources::Tenants)
Bulk (Knockapi::Resources::Schedules)
Bulk (Knockapi::Resources::Channels)
BulkAddSubscriptionsParams (Knockapi::Models::Objects)
BulkCreateParams (Knockapi::Models::Schedules)
BulkDeleteParams (Knockapi::Models::Objects)
BulkDeleteParams (Knockapi::Models::Users)
BulkDeleteParams (Knockapi::Models::Tenants)
BulkDeleteSubscriptionsParams (Knockapi::Models::Objects)
BulkIdentifyParams (Knockapi::Models::Users)
BulkOperation (Knockapi::Models)
BulkOperationGetParams (Knockapi::Models)
BulkOperations (Knockapi::Resources)
BulkSetParams (Knockapi::Models::Tenants)
BulkSetParams (Knockapi::Models::Objects)
BulkSetPreferencesParams (Knockapi::Models::Users)
BulkUpdateMessageStatusParams (Knockapi::Models::Channels)
Button (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)
Button (Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)
Button (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)

Category (Knockapi::Models::Recipients::PreferenceSet)
Category (Knockapi::Models::Recipients::PreferenceSetRequest)
Census (Knockapi::Resources::Integrations)
CensusCustomDestinationParams (Knockapi::Models::Integrations)
CensusCustomDestinationResponse (Knockapi::Models::Integrations)
Channel (Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)
Channel (Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)
Channel (Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)
Channel (Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)
Channel (Knockapi::Models::Message)
Channel (Knockapi::Models::Recipients::PreferenceSetRequest)
Channel (Knockapi::Models::Recipients::PreferenceSet)
ChannelData (Knockapi::Resources::Recipients)
ChannelDataRequest (Knockapi::Models::Recipients)
Channels (Knockapi::Resources)
Channels (Knockapi::Models)
Chat (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
Client (Knockapi)
Condition (Knockapi::Models)
ConflictError (Knockapi::Errors)
Connection (Knockapi::Models::Recipients::DiscordChannelData)
Connection (Knockapi::Models::Recipients::MsTeamsChannelData)
Connection (Knockapi::Models::Providers::MsTeamCheckAuthResponse)
Connection (Knockapi::Models::Providers::SlackCheckAuthResponse)
Connection (Knockapi::Models::Recipients::SlackChannelData)
ConversionError (Knockapi::Errors)
Converter (Knockapi::Internal::Type::RequestParameters)
Converter (Knockapi::Internal::Type)

Data (Knockapi::Models::Recipients::ChannelDataRequest)
Data (Knockapi::Models::Recipients::RecipientsChannelData)
Data (Knockapi::Models::Messages::BatchGetContentResponseItem)
Data (Knockapi::Models::MessageGetContentResponse)
Day (Knockapi::Models::ScheduleRepeatRule)
DeliveryStatus (Knockapi::Models::Channels::BulkUpdateMessageStatusParams)
Device (Knockapi::Models::Recipients::PushChannelDataDevicesOnly)
Device (Knockapi::Models::Recipients::AwsSnsPushChannelDataDevicesOnly)
Device (Knockapi::Models::Recipients::RecipientsChannelData::Data::AwssnsPushChannelDataFull)
Device (Knockapi::Models::Recipients::RecipientsChannelData::Data::PushChannelDataFull)
DiscordChannelConnection (Knockapi::Models::Recipients::DiscordChannelData::Connection)
DiscordChannelData (Knockapi::Models::Recipients)
DiscordIncomingWebhookConnection (Knockapi::Models::Recipients::DiscordChannelData::Connection)

Email (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
EngagementStatus (Knockapi::Models::UserListMessagesParams)
EngagementStatus (Knockapi::Models::Message)
EngagementStatus (Knockapi::Models::Channels::BulkUpdateMessageStatusParams)
EngagementStatus (Knockapi::Models::MessageListParams)
EngagementStatus (Knockapi::Models::ObjectListMessagesParams)
EntriesCursor (Knockapi::Internal)
Entry (Knockapi::Models::Users::GuideGetChannelResponse)
Enum (Knockapi::Internal::Type)
Error (Knockapi::Errors)
ErrorItem (Knockapi::Models::BulkOperation)
Errors (Knockapi)

Features (Knockapi::Models::Users::FeedGetSettingsResponse)
FeedGetSettingsParams (Knockapi::Models::Users)
FeedGetSettingsResponse (Knockapi::Models::Users)
FeedListItemsParams (Knockapi::Models::Users)
FeedListItemsResponse (Knockapi::Models::Users)
Feeds (Knockapi::Resources::Users)
FileInput (Knockapi::Internal::Type)
FilePart (Knockapi)
Frequency (Knockapi::Models::ScheduleRepeatRule)

GuideGetChannelParams (Knockapi::Models::Users)
GuideGetChannelResponse (Knockapi::Models::Users)
GuideGroup (Knockapi::Models::Users::GuideGetChannelResponse)
GuideMarkMessageAsArchivedParams (Knockapi::Models::Users)
GuideMarkMessageAsArchivedResponse (Knockapi::Models::Users)
GuideMarkMessageAsInteractedParams (Knockapi::Models::Users)
GuideMarkMessageAsInteractedResponse (Knockapi::Models::Users)
GuideMarkMessageAsSeenParams (Knockapi::Models::Users)
GuideMarkMessageAsSeenResponse (Knockapi::Models::Users)
Guides (Knockapi::Resources::Users)

HTTP (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
HashOf (Knockapi::Internal::Type)
Hightouch (Knockapi::Resources::Integrations)
HightouchEmbeddedDestinationParams (Knockapi::Models::Integrations)
HightouchEmbeddedDestinationResponse (Knockapi::Models::Integrations)

IdentifyUserRequest (Knockapi::Models)
InAppFeed (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
Include (Knockapi::Models::ObjectListSubscriptionsParams)
Include (Knockapi::Models::UserListSubscriptionsParams)
Include (Knockapi::Models::ObjectListParams)
Include (Knockapi::Models::UserListParams)
IncomingWebhook (Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection)
IncomingWebhook (Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)
InlineChannelDataRequestItem (Knockapi::Models::Recipients)
InlineIdentifyUserRequest (Knockapi::Models)
InlineObjectRequest (Knockapi::Models)
InlineTenantRequest (Knockapi::Models)
InsertedAt (Knockapi::Models::MessageListParams)
InsertedAt (Knockapi::Models::ObjectListMessagesParams)
InsertedAt (Knockapi::Models::UserListMessagesParams)
Integrations (Knockapi::Models)
Integrations (Knockapi::Resources)
Internal (Knockapi)
InternalServerError (Knockapi::Errors)
ItemsCursor (Knockapi::Internal)

Knockapi

Member (Knockapi::Models::AudienceRemoveMembersParams)
Member (Knockapi::Models::AudienceAddMembersParams)
Message (Knockapi::Models)
Message (Knockapi::Models::Users::GuideGetChannelResponse::Entry::Step)
MessageArchiveParams (Knockapi::Models)
MessageChatContent (Knockapi::Models::MessageGetContentResponse::Data)
MessageChatContent (Knockapi::Models::Messages::BatchGetContentResponseItem::Data)
MessageDeliveryLog (Knockapi::Models)
MessageEmailContent (Knockapi::Models::Messages::BatchGetContentResponseItem::Data)
MessageEmailContent (Knockapi::Models::MessageGetContentResponse::Data)
MessageEvent (Knockapi::Models)
MessageGetContentParams (Knockapi::Models)
MessageGetContentResponse (Knockapi::Models)
MessageGetParams (Knockapi::Models)
MessageInAppFeedButtonSetBlock (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block)
MessageInAppFeedButtonSetBlock (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block)
MessageInAppFeedButtonSetBlock (Knockapi::Models::Users::FeedListItemsResponse::Block)
MessageInAppFeedContent (Knockapi::Models::MessageGetContentResponse::Data)
MessageInAppFeedContent (Knockapi::Models::Messages::BatchGetContentResponseItem::Data)
MessageInAppFeedContentBlock (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block)
MessageInAppFeedContentBlock (Knockapi::Models::Users::FeedListItemsResponse::Block)
MessageInAppFeedContentBlock (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block)
MessageListActivitiesParams (Knockapi::Models)
MessageListDeliveryLogsParams (Knockapi::Models)
MessageListEventsParams (Knockapi::Models)
MessageListParams (Knockapi::Models)
MessageMarkAsInteractedParams (Knockapi::Models)
MessageMarkAsReadParams (Knockapi::Models)
MessageMarkAsSeenParams (Knockapi::Models)
MessageMarkAsUnreadParams (Knockapi::Models)
MessageMarkAsUnseenParams (Knockapi::Models)
MessagePushContent (Knockapi::Models::MessageGetContentResponse::Data)
MessagePushContent (Knockapi::Models::Messages::BatchGetContentResponseItem::Data)
MessageSMSContent (Knockapi::Models::MessageGetContentResponse::Data)
MessageSMSContent (Knockapi::Models::Messages::BatchGetContentResponseItem::Data)
MessageUnarchiveParams (Knockapi::Models)
Messages (Knockapi::Models)
Messages (Knockapi::Resources)
Method (Knockapi::Models::MessageDeliveryLog::Request)
MissingSorbetRuntimeError (Knockapi::Internal::Util::SorbetRuntimeSupport)
Mode (Knockapi::Models::ObjectListSubscriptionsParams)
Models (Knockapi)
MsTeamCheckAuthParams (Knockapi::Models::Providers)
MsTeamCheckAuthResponse (Knockapi::Models::Providers)
MsTeamListChannelsParams (Knockapi::Models::Providers)
MsTeamListChannelsResponse (Knockapi::Models::Providers)
MsTeamListTeamsParams (Knockapi::Models::Providers)
MsTeamListTeamsResponse (Knockapi::Models::Providers)
MsTeamRevokeAccessParams (Knockapi::Models::Providers)
MsTeamRevokeAccessResponse (Knockapi::Models::Providers)
MsTeams (Knockapi::Resources::Providers)
MsTeamsChannel (Knockapi::Models::Providers::MsTeamListChannelsResponse)
MsTeamsChannelData (Knockapi::Models::Recipients)
MsTeamsIncomingWebhookConnection (Knockapi::Models::Recipients::MsTeamsChannelData::Connection)
MsTeamsPagination (Knockapi::Internal)
MsTeamsTokenConnection (Knockapi::Models::Recipients::MsTeamsChannelData::Connection)

NotFoundError (Knockapi::Errors)

Object (Knockapi::Models::Objects::BulkSetParams)
Object (Knockapi::Models)
Object (Knockapi::Models::ObjectListSubscriptionsParams)
ObjectAddSubscriptionsParams (Knockapi::Models)
ObjectDeleteParams (Knockapi::Models)
ObjectDeleteSubscriptionsParams (Knockapi::Models)
ObjectGetChannelDataParams (Knockapi::Models)
ObjectGetParams (Knockapi::Models)
ObjectGetPreferencesParams (Knockapi::Models)
ObjectListMessagesParams (Knockapi::Models)
ObjectListParams (Knockapi::Models)
ObjectListPreferencesParams (Knockapi::Models)
ObjectListSchedulesParams (Knockapi::Models)
ObjectListSubscriptionsParams (Knockapi::Models)
ObjectReference (Knockapi::Models::RecipientReference)
ObjectSetChannelDataParams (Knockapi::Models)
ObjectSetParams (Knockapi::Models)
ObjectSetPreferencesParams (Knockapi::Models)
ObjectUnsetChannelDataParams (Knockapi::Models)
Objects (Knockapi::Models)
Objects (Knockapi::Resources)
OneSignalChannelDataPlayerIDsOnly (Knockapi::Models::Recipients)
Operator (Knockapi::Models::Condition)

PageInfo (Knockapi::Internal::EntriesCursor)
PageInfo (Knockapi::Internal::ItemsCursor)
PageInfo (Knockapi::Models)
PermissionDeniedError (Knockapi::Errors)
PersistenceStrategy (Knockapi::Models::Recipients::PreferenceSetRequest)
PooledNetRequester (Knockapi::Internal::Transport)
PreferenceSet (Knockapi::Models::Recipients)
PreferenceSetChannelSetting (Knockapi::Models::Recipients)
PreferenceSetChannelTypeSetting (Knockapi::Models::Recipients)
PreferenceSetChannelTypes (Knockapi::Models::Recipients)
PreferenceSetRequest (Knockapi::Models::Recipients)
PreferenceSetWorkflowCategorySettingObject (Knockapi::Models::Recipients::PreferenceSet::Category)
PreferenceSetWorkflowCategorySettingObject (Knockapi::Models::Recipients::PreferenceSet::Workflow)
PreferenceSetWorkflowCategorySettingObject (Knockapi::Models::Recipients::PreferenceSetRequest::Workflow)
PreferenceSetWorkflowCategorySettingObject (Knockapi::Models::Recipients::PreferenceSetRequest::Category)
Preferences (Knockapi::Resources::Recipients)
Provider (Knockapi::Models::Recipients::RecipientsChannelData)
Providers (Knockapi::Resources)
Providers (Knockapi::Models)
Push (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
PushChannelDataDevicesOnly (Knockapi::Models::Recipients)
PushChannelDataFull (Knockapi::Models::Recipients::RecipientsChannelData::Data)
PushChannelDataTokensOnly (Knockapi::Models::Recipients)

QueryOptions (Knockapi::Models::Providers::MsTeamListChannelsParams)
QueryOptions (Knockapi::Models::Providers::SlackListChannelsParams)
QueryOptions (Knockapi::Models::Providers::MsTeamListTeamsParams)

RateLimitError (Knockapi::Errors)
ReadIOAdapter (Knockapi::Internal::Util)
Recipient (Knockapi::Models)
RecipientReference (Knockapi::Models)
RecipientRequest (Knockapi::Models)
Recipients (Knockapi::Resources)
Recipients (Knockapi::Models)
RecipientsChannelData (Knockapi::Models::Recipients)
Request (Knockapi::Models::MessageDeliveryLog)
RequestOptions (Knockapi)
RequestParameters (Knockapi::Internal::Type)
Resources (Knockapi)
Response (Knockapi::Models::MessageDeliveryLog)

SMS (Knockapi::Models::Recipients::PreferenceSetChannelTypes)
Schedule (Knockapi::Models::Schedules::BulkCreateParams)
Schedule (Knockapi::Models)
ScheduleCreateParams (Knockapi::Models)
ScheduleDeleteParams (Knockapi::Models)
ScheduleListParams (Knockapi::Models)
ScheduleRepeatRule (Knockapi::Models)
ScheduleUpdateParams (Knockapi::Models)
Schedules (Knockapi::Models)
Schedules (Knockapi::Resources)
Settings (Knockapi::Models::TenantSetParams)
Settings (Knockapi::Models::TenantRequest)
Settings (Knockapi::Models::Tenant)
Slack (Knockapi::Resources::Providers)
SlackChannelData (Knockapi::Models::Recipients)
SlackChannelsCursor (Knockapi::Internal)
SlackCheckAuthParams (Knockapi::Models::Providers)
SlackCheckAuthResponse (Knockapi::Models::Providers)
SlackIncomingWebhookConnection (Knockapi::Models::Recipients::SlackChannelData::Connection)
SlackListChannelsParams (Knockapi::Models::Providers)
SlackListChannelsResponse (Knockapi::Models::Providers)
SlackRevokeAccessParams (Knockapi::Models::Providers)
SlackRevokeAccessResponse (Knockapi::Models::Providers)
SlackTokenConnection (Knockapi::Models::Recipients::SlackChannelData::Connection)
SorbetRuntimeSupport (Knockapi::Internal::Util)
Source (Knockapi::Models::Users::FeedListItemsResponse)
Source (Knockapi::Models::Message)
Status (Knockapi::Models::Users::FeedListItemsParams)
Status (Knockapi::Models::UserListMessagesParams)
Status (Knockapi::Models::Message)
Status (Knockapi::Models::ObjectListMessagesParams)
Status (Knockapi::Models::MessageListParams)
Status (Knockapi::Models::BulkOperation)
Step (Knockapi::Models::Users::GuideGetChannelResponse::Entry)
Subscription (Knockapi::Models::Objects::BulkDeleteSubscriptionsParams)
Subscription (Knockapi::Models::Objects::BulkAddSubscriptionsParams)
Subscription (Knockapi::Models::Recipients)
Subscriptions (Knockapi::Resources::Recipients)

Template (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent)
Template (Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent)
Tenant (Knockapi::Models)
TenantDeleteParams (Knockapi::Models)
TenantGetParams (Knockapi::Models)
TenantListParams (Knockapi::Models)
TenantRequest (Knockapi::Models)
TenantSetParams (Knockapi::Models)
Tenants (Knockapi::Resources)
Tenants (Knockapi::Models)
Token (Knockapi::Models::Recipients::SlackChannelData)
Transport (Knockapi::Internal)
Type (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)
Type (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent::Template::Block)
Type (Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock)
Type (Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)
Type (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)
Type (Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock)
Type (Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock)
Type (Knockapi::Models::MessageEvent)
Type (Knockapi::Models::Message::Source)
Type (Knockapi::Models::Message::Channel)
Type (Knockapi::Internal)
Type (Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block)

Union (Knockapi::Internal::Type)
Unknown (Knockapi::Internal::Type)
UnprocessableEntityError (Knockapi::Errors)
User (Knockapi::Models::AudienceAddMembersParams::Member)
User (Knockapi::Models::AudienceRemoveMembersParams::Member)
User (Knockapi::Models)
UserDeleteParams (Knockapi::Models)
UserGetChannelDataParams (Knockapi::Models)
UserGetParams (Knockapi::Models)
UserGetPreferencesParams (Knockapi::Models)
UserListMessagesParams (Knockapi::Models)
UserListParams (Knockapi::Models)
UserListPreferencesParams (Knockapi::Models)
UserListSchedulesParams (Knockapi::Models)
UserListSubscriptionsParams (Knockapi::Models)
UserMergeParams (Knockapi::Models)
UserSetChannelDataParams (Knockapi::Models)
UserSetPreferencesParams (Knockapi::Models)
UserUnsetChannelDataParams (Knockapi::Models)
UserUpdateParams (Knockapi::Models)
Users (Knockapi::Resources)
Users (Knockapi::Models)
Util (Knockapi::Internal)

Workflow (Knockapi::Models::Recipients::PreferenceSet)
Workflow (Knockapi::Models::Recipients::PreferenceSetRequest)
WorkflowCancelParams (Knockapi::Models)
WorkflowTriggerParams (Knockapi::Models)
WorkflowTriggerResponse (Knockapi::Models)
Workflows (Knockapi::Resources)