Module: Knockapi

Defined in:: lib/knockapi/client.rb,
lib/knockapi/errors.rb,
lib/knockapi/models.rb,
lib/knockapi/version.rb,
lib/knockapi/internal.rb,
lib/knockapi/file_part.rb,
lib/knockapi/models/user.rb,
lib/knockapi/internal/util.rb,
lib/knockapi/models/object.rb,
lib/knockapi/models/tenant.rb,
lib/knockapi/models/message.rb,
lib/knockapi/models/activity.rb,
lib/knockapi/models/schedule.rb,
lib/knockapi/request_options.rb,
lib/knockapi/resources/users.rb,
lib/knockapi/models/condition.rb,
lib/knockapi/models/page_info.rb,
lib/knockapi/models/recipient.rb,
lib/knockapi/resources/objects.rb,
lib/knockapi/resources/tenants.rb,
lib/knockapi/internal/type/enum.rb,
lib/knockapi/resources/channels.rb,
lib/knockapi/resources/messages.rb,
lib/knockapi/internal/type/union.rb,
lib/knockapi/resources/audiences.rb,
lib/knockapi/resources/providers.rb,
lib/knockapi/resources/schedules.rb,
lib/knockapi/resources/workflows.rb,
lib/knockapi/models/message_event.rb,
lib/knockapi/resources/recipients.rb,
lib/knockapi/resources/users/bulk.rb,
lib/knockapi/internal/items_cursor.rb,
lib/knockapi/internal/type/boolean.rb,
lib/knockapi/internal/type/hash_of.rb,
lib/knockapi/internal/type/unknown.rb,
lib/knockapi/models/bulk_operation.rb,
lib/knockapi/models/tenant_request.rb,
lib/knockapi/resources/users/feeds.rb,
lib/knockapi/internal/type/array_of.rb,
lib/knockapi/models/audience_member.rb,
lib/knockapi/models/user_get_params.rb,
lib/knockapi/resources/integrations.rb,
lib/knockapi/resources/objects/bulk.rb,
lib/knockapi/resources/tenants/bulk.rb,
lib/knockapi/resources/users/guides.rb,
lib/knockapi/internal/entries_cursor.rb,
lib/knockapi/internal/type/base_page.rb,
lib/knockapi/internal/type/converter.rb,
lib/knockapi/models/user_list_params.rb,
lib/knockapi/resources/channels/bulk.rb,
lib/knockapi/internal/type/base_model.rb,
lib/knockapi/internal/type/file_input.rb,
lib/knockapi/models/object_get_params.rb,
lib/knockapi/models/object_set_params.rb,
lib/knockapi/models/recipient_request.rb,
lib/knockapi/models/tenant_get_params.rb,
lib/knockapi/models/tenant_set_params.rb,
lib/knockapi/models/user_merge_params.rb,
lib/knockapi/resources/messages/batch.rb,
lib/knockapi/resources/schedules/bulk.rb,
lib/knockapi/models/message_get_params.rb,
lib/knockapi/models/object_list_params.rb,
lib/knockapi/models/tenant_list_params.rb,
lib/knockapi/models/user_delete_params.rb,
lib/knockapi/models/user_update_params.rb,
lib/knockapi/resources/bulk_operations.rb,
lib/knockapi/resources/providers/slack.rb,
lib/knockapi/models/message_list_params.rb,
lib/knockapi/models/recipient_reference.rb,
lib/knockapi/models/message_delivery_log.rb,
lib/knockapi/models/object_delete_params.rb,
lib/knockapi/models/schedule_list_params.rb,
lib/knockapi/models/schedule_repeat_rule.rb,
lib/knockapi/models/tenant_delete_params.rb,
lib/knockapi/internal/ms_teams_pagination.rb,
lib/knockapi/models/identify_user_request.rb,
lib/knockapi/models/inline_object_request.rb,
lib/knockapi/models/inline_tenant_request.rb,
lib/knockapi/resources/providers/ms_teams.rb,
lib/knockapi/models/message_archive_params.rb,
lib/knockapi/models/schedule_create_params.rb,
lib/knockapi/models/schedule_delete_params.rb,
lib/knockapi/models/schedule_update_params.rb,
lib/knockapi/models/workflow_cancel_params.rb,
lib/knockapi/resources/integrations/census.rb,
lib/knockapi/internal/slack_channels_cursor.rb,
lib/knockapi/internal/transport/base_client.rb,
lib/knockapi/models/objects/bulk_set_params.rb,
lib/knockapi/models/recipients/channel_data.rb,
lib/knockapi/models/recipients/subscription.rb,
lib/knockapi/models/tenants/bulk_set_params.rb,
lib/knockapi/models/workflow_trigger_params.rb,
lib/knockapi/models/message_unarchive_params.rb,
lib/knockapi/models/schedule_create_response.rb,
lib/knockapi/models/schedule_delete_response.rb,
lib/knockapi/models/schedule_update_response.rb,
lib/knockapi/models/users/bulk_delete_params.rb,
lib/knockapi/internal/type/request_parameters.rb,
lib/knockapi/models/bulk_operation_get_params.rb,
lib/knockapi/models/recipients/preference_set.rb,
lib/knockapi/models/user_list_messages_params.rb,
lib/knockapi/models/workflow_trigger_response.rb,
lib/knockapi/resources/integrations/hightouch.rb,
lib/knockapi/resources/recipients/preferences.rb,
lib/knockapi/models/message_get_content_params.rb,
lib/knockapi/models/message_list_events_params.rb,
lib/knockapi/models/objects/bulk_delete_params.rb,
lib/knockapi/models/tenants/bulk_delete_params.rb,
lib/knockapi/models/user_list_schedules_params.rb,
lib/knockapi/models/users/bulk_identify_params.rb,
lib/knockapi/resources/recipients/channel_data.rb,
lib/knockapi/models/audience_add_members_params.rb,
lib/knockapi/models/message_mark_as_read_params.rb,
lib/knockapi/models/message_mark_as_seen_params.rb,
lib/knockapi/models/object_list_messages_params.rb,
lib/knockapi/models/user_get_preferences_params.rb,
lib/knockapi/models/user_set_preferences_params.rb,
lib/knockapi/resources/recipients/subscriptions.rb,
lib/knockapi/models/audience_list_members_params.rb,
lib/knockapi/models/inline_identify_user_request.rb,
lib/knockapi/models/message_get_content_response.rb,
lib/knockapi/models/object_list_schedules_params.rb,
lib/knockapi/models/schedules/bulk_create_params.rb,
lib/knockapi/models/user_get_channel_data_params.rb,
lib/knockapi/models/user_list_preferences_params.rb,
lib/knockapi/models/user_set_channel_data_params.rb,
lib/knockapi/models/users/feed_list_items_params.rb,
lib/knockapi/models/message_mark_as_unread_params.rb,
lib/knockapi/models/message_mark_as_unseen_params.rb,
lib/knockapi/models/messages/batch_archive_params.rb,
lib/knockapi/models/object_get_preferences_params.rb,
lib/knockapi/models/object_set_preferences_params.rb,
lib/knockapi/models/recipients/slack_channel_data.rb,
lib/knockapi/models/audience_list_members_response.rb,
lib/knockapi/models/audience_remove_members_params.rb,
lib/knockapi/models/message_list_activities_params.rb,
lib/knockapi/models/object_get_channel_data_params.rb,
lib/knockapi/models/object_list_preferences_params.rb,
lib/knockapi/models/object_set_channel_data_params.rb,
lib/knockapi/models/user_list_preferences_response.rb,
lib/knockapi/models/user_list_subscriptions_params.rb,
lib/knockapi/models/user_unset_channel_data_params.rb,
lib/knockapi/models/users/feed_get_settings_params.rb,
lib/knockapi/models/users/feed_list_items_response.rb,
lib/knockapi/models/users/guide_get_channel_params.rb,
lib/knockapi/models/messages/batch_archive_response.rb,
lib/knockapi/models/messages/batch_unarchive_params.rb,
lib/knockapi/models/object_add_subscriptions_params.rb,
lib/knockapi/models/recipients/channel_data_request.rb,
lib/knockapi/models/recipients/discord_channel_data.rb,
lib/knockapi/internal/transport/pooled_net_requester.rb,
lib/knockapi/models/object_list_preferences_response.rb,
lib/knockapi/models/object_list_subscriptions_params.rb,
lib/knockapi/models/object_unset_channel_data_params.rb,
lib/knockapi/models/recipients/ms_teams_channel_data.rb,
lib/knockapi/models/users/feed_get_settings_response.rb,
lib/knockapi/models/users/guide_get_channel_response.rb,
lib/knockapi/models/message_list_delivery_logs_params.rb,
lib/knockapi/models/message_mark_as_interacted_params.rb,
lib/knockapi/models/messages/batch_get_content_params.rb,
lib/knockapi/models/messages/batch_unarchive_response.rb,
lib/knockapi/models/object_add_subscriptions_response.rb,
lib/knockapi/models/providers/slack_check_auth_params.rb,
lib/knockapi/models/recipients/preference_set_request.rb,
lib/knockapi/models/users/bulk_set_preferences_params.rb,
lib/knockapi/models/messages/batch_mark_as_read_params.rb,
lib/knockapi/models/messages/batch_mark_as_seen_params.rb,
lib/knockapi/models/object_delete_subscriptions_params.rb,
lib/knockapi/models/messages/batch_get_content_response.rb,
lib/knockapi/models/providers/ms_team_check_auth_params.rb,
lib/knockapi/models/providers/ms_team_list_teams_params.rb,
lib/knockapi/models/providers/slack_check_auth_response.rb,
lib/knockapi/models/messages/batch_mark_as_read_response.rb,
lib/knockapi/models/messages/batch_mark_as_seen_response.rb,
lib/knockapi/models/messages/batch_mark_as_unread_params.rb,
lib/knockapi/models/messages/batch_mark_as_unseen_params.rb,
lib/knockapi/models/object_delete_subscriptions_response.rb,
lib/knockapi/models/providers/slack_list_channels_params.rb,
lib/knockapi/models/providers/slack_revoke_access_params.rb,
lib/knockapi/models/objects/bulk_add_subscriptions_params.rb,
lib/knockapi/models/providers/ms_team_check_auth_response.rb,
lib/knockapi/models/providers/ms_team_list_teams_response.rb,
lib/knockapi/models/messages/batch_mark_as_unread_response.rb,
lib/knockapi/models/messages/batch_mark_as_unseen_response.rb,
lib/knockapi/models/providers/ms_team_list_channels_params.rb,
lib/knockapi/models/providers/ms_team_revoke_access_params.rb,
lib/knockapi/models/providers/slack_list_channels_response.rb,
lib/knockapi/models/providers/slack_revoke_access_response.rb,
lib/knockapi/models/recipients/inline_channel_data_request.rb,
lib/knockapi/models/recipients/preference_set_channel_types.rb,
lib/knockapi/models/users/guide_mark_message_as_seen_params.rb,
lib/knockapi/models/messages/batch_mark_as_interacted_params.rb,
lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb,
lib/knockapi/models/providers/ms_team_list_channels_response.rb,
lib/knockapi/models/providers/ms_team_revoke_access_response.rb,
lib/knockapi/models/recipients/inline_preference_set_request.rb,
lib/knockapi/models/recipients/push_channel_data_tokens_only.rb,
lib/knockapi/models/recipients/preference_set_channel_setting.rb,
lib/knockapi/models/recipients/push_channel_data_devices_only.rb,
lib/knockapi/models/users/guide_mark_message_as_seen_response.rb,
lib/knockapi/models/channels/bulk_update_message_status_params.rb,
lib/knockapi/models/messages/batch_mark_as_interacted_response.rb,
lib/knockapi/models/users/guide_mark_message_as_archived_params.rb,
lib/knockapi/models/integrations/census_custom_destination_params.rb,
lib/knockapi/models/users/guide_mark_message_as_archived_response.rb,
lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb,
lib/knockapi/models/recipients/preference_set_channel_type_setting.rb,
lib/knockapi/models/integrations/census_custom_destination_response.rb,
lib/knockapi/models/users/guide_mark_message_as_interacted_response.rb,
lib/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rb,
lib/knockapi/models/integrations/hightouch_embedded_destination_params.rb,
lib/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rb,
lib/knockapi/models/integrations/hightouch_embedded_destination_response.rb,
lib/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rb

Defined Under Namespace

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

Constant Summary collapse

Activity =

Knockapi::Models::Activity

AudienceAddMembersParams =

Knockapi::Models::AudienceAddMembersParams

AudienceListMembersParams =

Knockapi::Models::AudienceListMembersParams

AudienceMember =

Knockapi::Models::AudienceMember

AudienceRemoveMembersParams =

Knockapi::Models::AudienceRemoveMembersParams

BulkOperation =

Knockapi::Models::BulkOperation

BulkOperationGetParams =

Knockapi::Models::BulkOperationGetParams

Channels =

Knockapi::Models::Channels

Condition =

Knockapi::Models::Condition

IdentifyUserRequest =

Knockapi::Models::IdentifyUserRequest

InlineIdentifyUserRequest =

Knockapi::Models::InlineIdentifyUserRequest

InlineObjectRequest =

Knockapi::Models::InlineObjectRequest

InlineTenantRequest =

Knockapi::Models::InlineTenantRequest

Integrations =

Knockapi::Models::Integrations

Message =

Knockapi::Models::Message

MessageArchiveParams =

Knockapi::Models::MessageArchiveParams

MessageDeliveryLog =

Knockapi::Models::MessageDeliveryLog

MessageEvent =

Knockapi::Models::MessageEvent

MessageGetContentParams =

Knockapi::Models::MessageGetContentParams

MessageGetParams =

Knockapi::Models::MessageGetParams

MessageListActivitiesParams =

Knockapi::Models::MessageListActivitiesParams

MessageListDeliveryLogsParams =

Knockapi::Models::MessageListDeliveryLogsParams

MessageListEventsParams =

Knockapi::Models::MessageListEventsParams

MessageListParams =

Knockapi::Models::MessageListParams

MessageMarkAsInteractedParams =

Knockapi::Models::MessageMarkAsInteractedParams

MessageMarkAsReadParams =

Knockapi::Models::MessageMarkAsReadParams

MessageMarkAsSeenParams =

Knockapi::Models::MessageMarkAsSeenParams

MessageMarkAsUnreadParams =

Knockapi::Models::MessageMarkAsUnreadParams

MessageMarkAsUnseenParams =

Knockapi::Models::MessageMarkAsUnseenParams

Messages =

Knockapi::Models::Messages

MessageUnarchiveParams =

Knockapi::Models::MessageUnarchiveParams

Object =

Knockapi::Models::Object

ObjectAddSubscriptionsParams =

Knockapi::Models::ObjectAddSubscriptionsParams

ObjectDeleteParams =

Knockapi::Models::ObjectDeleteParams

ObjectDeleteSubscriptionsParams =

Knockapi::Models::ObjectDeleteSubscriptionsParams

ObjectGetChannelDataParams =

Knockapi::Models::ObjectGetChannelDataParams

ObjectGetParams =

Knockapi::Models::ObjectGetParams

ObjectGetPreferencesParams =

Knockapi::Models::ObjectGetPreferencesParams

ObjectListMessagesParams =

Knockapi::Models::ObjectListMessagesParams

ObjectListParams =

Knockapi::Models::ObjectListParams

ObjectListPreferencesParams =

Knockapi::Models::ObjectListPreferencesParams

ObjectListSchedulesParams =

Knockapi::Models::ObjectListSchedulesParams

ObjectListSubscriptionsParams =

Knockapi::Models::ObjectListSubscriptionsParams

Objects =

Knockapi::Models::Objects

ObjectSetChannelDataParams =

Knockapi::Models::ObjectSetChannelDataParams

ObjectSetParams =

Knockapi::Models::ObjectSetParams

ObjectSetPreferencesParams =

Knockapi::Models::ObjectSetPreferencesParams

ObjectUnsetChannelDataParams =

Knockapi::Models::ObjectUnsetChannelDataParams

PageInfo =

Knockapi::Models::PageInfo

Providers =

Knockapi::Models::Providers

Recipient =

Knockapi::Models::Recipient

RecipientReference =

Knockapi::Models::RecipientReference

RecipientRequest =

Knockapi::Models::RecipientRequest

Recipients =

Knockapi::Models::Recipients

Schedule =

Knockapi::Models::Schedule

ScheduleCreateParams =

Knockapi::Models::ScheduleCreateParams

ScheduleDeleteParams =

Knockapi::Models::ScheduleDeleteParams

ScheduleListParams =

Knockapi::Models::ScheduleListParams

ScheduleRepeatRule =

Knockapi::Models::ScheduleRepeatRule

Schedules =

Knockapi::Models::Schedules

ScheduleUpdateParams =

Knockapi::Models::ScheduleUpdateParams

Tenant =

Knockapi::Models::Tenant

TenantDeleteParams =

Knockapi::Models::TenantDeleteParams

TenantGetParams =

Knockapi::Models::TenantGetParams

TenantListParams =

Knockapi::Models::TenantListParams

TenantRequest =

Knockapi::Models::TenantRequest

Tenants =

Knockapi::Models::Tenants

TenantSetParams =

Knockapi::Models::TenantSetParams

User =

Knockapi::Models::User

UserDeleteParams =

Knockapi::Models::UserDeleteParams

UserGetChannelDataParams =

Knockapi::Models::UserGetChannelDataParams

UserGetParams =

Knockapi::Models::UserGetParams

UserGetPreferencesParams =

Knockapi::Models::UserGetPreferencesParams

UserListMessagesParams =

Knockapi::Models::UserListMessagesParams

UserListParams =

Knockapi::Models::UserListParams

UserListPreferencesParams =

Knockapi::Models::UserListPreferencesParams

UserListSchedulesParams =

Knockapi::Models::UserListSchedulesParams

UserListSubscriptionsParams =

Knockapi::Models::UserListSubscriptionsParams

UserMergeParams =

Knockapi::Models::UserMergeParams

Users =

Knockapi::Models::Users

UserSetChannelDataParams =

Knockapi::Models::UserSetChannelDataParams

UserSetPreferencesParams =

Knockapi::Models::UserSetPreferencesParams

UserUnsetChannelDataParams =

Knockapi::Models::UserUnsetChannelDataParams

UserUpdateParams =

Knockapi::Models::UserUpdateParams

WorkflowCancelParams =

Knockapi::Models::WorkflowCancelParams

WorkflowTriggerParams =

Knockapi::Models::WorkflowTriggerParams

VERSION =

"1.25.0"