knockapi 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +42 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/knockapi/internal/items_cursor.rb +2 -2
- data/lib/knockapi/internal/type/array_of.rb +8 -0
- data/lib/knockapi/internal/type/base_model.rb +7 -0
- data/lib/knockapi/internal/type/boolean.rb +8 -0
- data/lib/knockapi/internal/type/enum.rb +12 -0
- data/lib/knockapi/internal/type/file_input.rb +7 -0
- data/lib/knockapi/internal/type/hash_of.rb +8 -0
- data/lib/knockapi/internal/type/union.rb +12 -0
- data/lib/knockapi/internal/type/unknown.rb +8 -0
- data/lib/knockapi/internal/util.rb +54 -1
- data/lib/knockapi/internal.rb +3 -0
- data/lib/knockapi/models/activity.rb +4 -4
- data/lib/knockapi/models/audience_add_members_params.rb +5 -5
- data/lib/knockapi/models/audience_list_members_response.rb +4 -4
- data/lib/knockapi/models/audience_member.rb +4 -4
- data/lib/knockapi/models/audience_remove_members_params.rb +5 -5
- data/lib/knockapi/models/bulk_operation.rb +5 -5
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +6 -6
- data/lib/knockapi/models/condition.rb +3 -3
- data/lib/knockapi/models/identify_user_request.rb +5 -5
- data/lib/knockapi/models/inline_identify_user_request.rb +5 -5
- data/lib/knockapi/models/inline_object_request.rb +4 -4
- data/lib/knockapi/models/inline_tenant_request.rb +1 -5
- data/lib/knockapi/models/message.rb +14 -14
- data/lib/knockapi/models/message_delivery_log.rb +13 -21
- data/lib/knockapi/models/message_event.rb +7 -7
- data/lib/knockapi/models/message_get_content_response.rb +0 -21
- data/lib/knockapi/models/message_list_params.rb +11 -8
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_get_content_response.rb +0 -21
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/object_list_messages_params.rb +11 -8
- data/lib/knockapi/models/object_list_params.rb +2 -2
- data/lib/knockapi/models/object_list_subscriptions_params.rb +8 -8
- data/lib/knockapi/models/object_set_params.rb +4 -4
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +6 -5
- data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -3
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -3
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -3
- data/lib/knockapi/models/recipient.rb +1 -5
- data/lib/knockapi/models/recipient_reference.rb +1 -5
- data/lib/knockapi/models/recipient_request.rb +1 -5
- data/lib/knockapi/models/recipients/channel_data.rb +7 -19
- data/lib/knockapi/models/recipients/channel_data_request.rb +4 -16
- data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -15
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -13
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -15
- data/lib/knockapi/models/recipients/preference_set.rb +17 -35
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -48
- data/lib/knockapi/models/recipients/preference_set_request.rb +17 -35
- data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -15
- data/lib/knockapi/models/recipients/subscription.rb +4 -4
- data/lib/knockapi/models/schedule.rb +13 -10
- data/lib/knockapi/models/schedule_create_params.rb +14 -8
- data/lib/knockapi/models/schedule_repeat_rule.rb +5 -5
- data/lib/knockapi/models/schedule_update_params.rb +11 -8
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -13
- data/lib/knockapi/models/tenant.rb +10 -10
- data/lib/knockapi/models/tenant_request.rb +13 -13
- data/lib/knockapi/models/tenant_set_params.rb +12 -12
- data/lib/knockapi/models/tenants/bulk_set_params.rb +2 -2
- data/lib/knockapi/models/user.rb +2 -2
- data/lib/knockapi/models/user_list_messages_params.rb +11 -8
- data/lib/knockapi/models/user_list_params.rb +2 -2
- data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/users/bulk_identify_params.rb +2 -2
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +2 -2
- data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
- data/lib/knockapi/models/users/feed_list_items_response.rb +4 -13
- data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
- data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
- data/lib/knockapi/models.rb +30 -19
- data/lib/knockapi/resources/audiences.rb +2 -2
- data/lib/knockapi/resources/bulk_operations.rb +1 -1
- data/lib/knockapi/resources/channels/bulk.rb +5 -5
- data/lib/knockapi/resources/messages/batch.rb +14 -14
- data/lib/knockapi/resources/messages.rb +18 -18
- data/lib/knockapi/resources/objects/bulk.rb +5 -5
- data/lib/knockapi/resources/objects.rb +30 -30
- data/lib/knockapi/resources/providers/ms_teams.rb +2 -2
- data/lib/knockapi/resources/providers/slack.rb +1 -1
- data/lib/knockapi/resources/schedules/bulk.rb +2 -2
- data/lib/knockapi/resources/schedules.rb +15 -12
- data/lib/knockapi/resources/tenants/bulk.rb +3 -3
- data/lib/knockapi/resources/tenants.rb +6 -6
- data/lib/knockapi/resources/users/bulk.rb +5 -5
- data/lib/knockapi/resources/users/feeds.rb +2 -2
- data/lib/knockapi/resources/users.rb +24 -24
- data/lib/knockapi/resources/workflows.rb +5 -5
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +3 -1
- data/rbi/knockapi/internal/type/array_of.rbi +6 -0
- data/rbi/knockapi/internal/type/base_model.rbi +5 -0
- data/rbi/knockapi/internal/type/boolean.rbi +6 -0
- data/rbi/knockapi/internal/type/enum.rbi +5 -0
- data/rbi/knockapi/internal/type/file_input.rbi +5 -0
- data/rbi/knockapi/internal/type/hash_of.rbi +6 -0
- data/rbi/knockapi/internal/type/union.rbi +5 -0
- data/rbi/knockapi/internal/type/unknown.rbi +6 -0
- data/rbi/knockapi/internal/util.rbi +34 -0
- data/rbi/knockapi/internal.rbi +3 -0
- data/rbi/knockapi/models/activity.rbi +4 -4
- data/rbi/knockapi/models/message.rbi +4 -20
- data/rbi/knockapi/models/message_delivery_log.rbi +24 -8
- data/rbi/knockapi/models/message_event.rbi +2 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +4 -25
- data/rbi/knockapi/models/message_list_params.rbi +19 -4
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +4 -22
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_messages_params.rbi +19 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +2 -17
- data/rbi/knockapi/models/recipients/preference_set.rbi +4 -16
- data/rbi/knockapi/models/recipients/subscription.rbi +2 -2
- data/rbi/knockapi/models/schedule.rbi +12 -6
- data/rbi/knockapi/models/schedule_create_params.rbi +8 -2
- data/rbi/knockapi/models/schedule_update_params.rbi +8 -2
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -2
- data/rbi/knockapi/models/user_list_messages_params.rbi +19 -4
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +4 -10
- data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -2
- data/rbi/knockapi/resources/messages/batch.rbi +7 -7
- data/rbi/knockapi/resources/messages.rbi +3 -5
- data/rbi/knockapi/resources/objects.rbi +1 -1
- data/rbi/knockapi/resources/schedules.rbi +8 -2
- data/rbi/knockapi/resources/users.rbi +1 -1
- data/rbi/knockapi/resources/workflows.rbi +4 -1
- data/sig/knockapi/internal/entries_cursor.rbs +2 -0
- data/sig/knockapi/internal/items_cursor.rbs +2 -0
- data/sig/knockapi/internal/type/array_of.rbs +3 -0
- data/sig/knockapi/internal/type/base_model.rbs +2 -0
- data/sig/knockapi/internal/type/boolean.rbs +3 -0
- data/sig/knockapi/internal/type/enum.rbs +2 -0
- data/sig/knockapi/internal/type/file_input.rbs +2 -0
- data/sig/knockapi/internal/type/hash_of.rbs +3 -0
- data/sig/knockapi/internal/type/union.rbs +2 -0
- data/sig/knockapi/internal/type/unknown.rbs +3 -0
- data/sig/knockapi/internal/util.rbs +12 -0
- data/sig/knockapi/internal.rbs +2 -0
- data/sig/knockapi/models/activity.rbs +10 -0
- data/sig/knockapi/models/audience_add_members_params.rbs +12 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +2 -0
- data/sig/knockapi/models/audience_list_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_member.rbs +8 -0
- data/sig/knockapi/models/audience_remove_members_params.rbs +12 -0
- data/sig/knockapi/models/bulk_operation.rbs +24 -4
- data/sig/knockapi/models/bulk_operation_get_params.rbs +2 -0
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +14 -0
- data/sig/knockapi/models/condition.rbs +10 -4
- data/sig/knockapi/models/identify_user_request.rbs +12 -0
- data/sig/knockapi/models/inline_identify_user_request.rbs +13 -0
- data/sig/knockapi/models/inline_object_request.rbs +8 -0
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +8 -0
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +2 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +8 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +2 -0
- data/sig/knockapi/models/message.rbs +44 -11
- data/sig/knockapi/models/message_archive_params.rbs +2 -0
- data/sig/knockapi/models/message_delivery_log.rbs +43 -18
- data/sig/knockapi/models/message_event.rbs +13 -4
- data/sig/knockapi/models/message_get_content_params.rbs +2 -0
- data/sig/knockapi/models/message_get_content_response.rbs +68 -0
- data/sig/knockapi/models/message_get_params.rbs +2 -0
- data/sig/knockapi/models/message_list_activities_params.rbs +8 -0
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +7 -0
- data/sig/knockapi/models/message_list_events_params.rbs +7 -0
- data/sig/knockapi/models/message_list_params.rbs +45 -15
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -0
- data/sig/knockapi/models/message_mark_as_read_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +2 -0
- data/sig/knockapi/models/message_unarchive_params.rbs +2 -0
- data/sig/knockapi/models/messages/batch_archive_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +72 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +6 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +2 -1
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +9 -0
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +6 -0
- data/sig/knockapi/models/object_delete_params.rbs +2 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +5 -0
- data/sig/knockapi/models/object_get_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/object_get_params.rbs +2 -0
- data/sig/knockapi/models/object_get_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_list_messages_params.rbs +45 -15
- data/sig/knockapi/models/object_list_params.rbs +14 -6
- data/sig/knockapi/models/object_list_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_list_schedules_params.rbs +9 -0
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +19 -6
- data/sig/knockapi/models/object_set_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/object_set_params.rbs +8 -0
- data/sig/knockapi/models/object_set_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +10 -0
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
- data/sig/knockapi/models/page_info.rbs +7 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +6 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +9 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +13 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +13 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +6 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +2 -0
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -0
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +6 -0
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +14 -0
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +8 -0
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -0
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +2 -0
- data/sig/knockapi/models/recipient_reference.rbs +2 -0
- data/sig/knockapi/models/recipients/channel_data.rbs +17 -10
- data/sig/knockapi/models/recipients/channel_data_request.rbs +8 -4
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +16 -4
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +2 -2
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +22 -4
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +2 -0
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -8
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +2 -0
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +45 -36
- data/sig/knockapi/models/recipients/preference_set_request.rbs +24 -8
- data/sig/knockapi/models/recipients/push_channel_data.rbs +2 -0
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +19 -4
- data/sig/knockapi/models/recipients/subscription.rbs +9 -0
- data/sig/knockapi/models/schedule.rbs +15 -0
- data/sig/knockapi/models/schedule_create_params.rbs +11 -0
- data/sig/knockapi/models/schedule_delete_params.rbs +5 -0
- data/sig/knockapi/models/schedule_list_params.rbs +10 -0
- data/sig/knockapi/models/schedule_repeat_rule.rbs +18 -8
- data/sig/knockapi/models/schedule_update_params.rbs +11 -0
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +16 -0
- data/sig/knockapi/models/tenant.rbs +19 -0
- data/sig/knockapi/models/tenant_delete_params.rbs +2 -0
- data/sig/knockapi/models/tenant_get_params.rbs +2 -0
- data/sig/knockapi/models/tenant_list_params.rbs +9 -0
- data/sig/knockapi/models/tenant_request.rbs +19 -0
- data/sig/knockapi/models/tenant_set_params.rbs +19 -0
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +5 -0
- data/sig/knockapi/models/user.rbs +12 -0
- data/sig/knockapi/models/user_delete_params.rbs +2 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_get_params.rbs +2 -0
- data/sig/knockapi/models/user_get_preferences_params.rbs +5 -0
- data/sig/knockapi/models/user_list_messages_params.rbs +45 -15
- data/sig/knockapi/models/user_list_params.rbs +14 -6
- data/sig/knockapi/models/user_list_preferences_params.rbs +2 -0
- data/sig/knockapi/models/user_list_schedules_params.rbs +9 -0
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +15 -6
- data/sig/knockapi/models/user_merge_params.rbs +5 -0
- data/sig/knockapi/models/user_set_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_set_preferences_params.rbs +2 -0
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_update_params.rbs +2 -0
- data/sig/knockapi/models/users/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/users/bulk_identify_params.rbs +5 -0
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +6 -0
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +2 -0
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +6 -0
- data/sig/knockapi/models/users/feed_list_items_params.rbs +14 -0
- data/sig/knockapi/models/users/feed_list_items_response.rbs +43 -0
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +7 -0
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +14 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +2 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +2 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +2 -0
- data/sig/knockapi/models/workflow_cancel_params.rbs +6 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +9 -0
- data/sig/knockapi/models/workflow_trigger_response.rbs +2 -0
- data/sig/knockapi/resources/messages.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +7 -7
- data/sig/knockapi/resources/users.rbs +7 -7
- metadata +2 -2
@@ -17,7 +17,7 @@ module Knockapi
|
|
17
17
|
# @!attribute archived
|
18
18
|
# The archived status of the feed items.
|
19
19
|
#
|
20
|
-
# @return [Symbol, Knockapi::Users::FeedListItemsParams::Archived, nil]
|
20
|
+
# @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived, nil]
|
21
21
|
optional :archived, enum: -> { Knockapi::Users::FeedListItemsParams::Archived }
|
22
22
|
|
23
23
|
# @!attribute before
|
@@ -47,7 +47,7 @@ module Knockapi
|
|
47
47
|
# @!attribute status
|
48
48
|
# The status of the feed items.
|
49
49
|
#
|
50
|
-
# @return [Symbol, Knockapi::Users::FeedListItemsParams::Status, nil]
|
50
|
+
# @return [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status, nil]
|
51
51
|
optional :status, enum: -> { Knockapi::Users::FeedListItemsParams::Status }
|
52
52
|
|
53
53
|
# @!attribute tenant
|
@@ -71,7 +71,7 @@ module Knockapi
|
|
71
71
|
# @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
|
72
72
|
# @param after [String] The cursor to fetch entries after.
|
73
73
|
#
|
74
|
-
# @param archived [Symbol, Knockapi::Users::FeedListItemsParams::Archived] The archived status of the feed items.
|
74
|
+
# @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
|
75
75
|
#
|
76
76
|
# @param before [String] The cursor to fetch entries before.
|
77
77
|
#
|
@@ -81,7 +81,7 @@ module Knockapi
|
|
81
81
|
#
|
82
82
|
# @param source [String] The source of the feed items.
|
83
83
|
#
|
84
|
-
# @param status [Symbol, Knockapi::Users::FeedListItemsParams::Status] The status of the feed items.
|
84
|
+
# @param status [Symbol, Knockapi::Models::Users::FeedListItemsParams::Status] The status of the feed items.
|
85
85
|
#
|
86
86
|
# @param tenant [String] The tenant associated with the feed items.
|
87
87
|
#
|
@@ -20,13 +20,13 @@ module Knockapi
|
|
20
20
|
# @!attribute activities
|
21
21
|
# List of activities associated with this feed item.
|
22
22
|
#
|
23
|
-
# @return [Array<Knockapi::Activity>]
|
23
|
+
# @return [Array<Knockapi::Models::Activity>]
|
24
24
|
required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Activity] }
|
25
25
|
|
26
26
|
# @!attribute actors
|
27
27
|
# List of actors associated with this feed item.
|
28
28
|
#
|
29
|
-
# @return [Array<Knockapi::User, Knockapi::Object>]
|
29
|
+
# @return [Array<Knockapi::Models::User, Knockapi::Models::Object>]
|
30
30
|
required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipient] }
|
31
31
|
|
32
32
|
# @!attribute blocks
|
@@ -121,9 +121,9 @@ module Knockapi
|
|
121
121
|
#
|
122
122
|
# @param _typename [String] The typename of the schema.
|
123
123
|
#
|
124
|
-
# @param activities [Array<Knockapi::Activity>] List of activities associated with this feed item.
|
124
|
+
# @param activities [Array<Knockapi::Models::Activity>] List of activities associated with this feed item.
|
125
125
|
#
|
126
|
-
# @param actors [Array<Knockapi::User, Knockapi::Object>] List of actors associated with this feed item.
|
126
|
+
# @param actors [Array<Knockapi::Models::User, Knockapi::Models::Object>] List of actors associated with this feed item.
|
127
127
|
#
|
128
128
|
# @param blocks [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>] Content blocks that make up the feed item.
|
129
129
|
#
|
@@ -288,15 +288,6 @@ module Knockapi
|
|
288
288
|
|
289
289
|
# @!method self.variants
|
290
290
|
# @return [Array(Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock)]
|
291
|
-
|
292
|
-
define_sorbet_constant!(:Variants) do
|
293
|
-
T.type_alias do
|
294
|
-
T.any(
|
295
|
-
Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock,
|
296
|
-
Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock
|
297
|
-
)
|
298
|
-
end
|
299
|
-
end
|
300
291
|
end
|
301
292
|
|
302
293
|
# @see Knockapi::Models::Users::FeedListItemsResponse#source
|
@@ -21,7 +21,7 @@ module Knockapi
|
|
21
21
|
# A list of recipients to cancel the notification for. If omitted, cancels for all
|
22
22
|
# recipients associated with the cancellation key.
|
23
23
|
#
|
24
|
-
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
24
|
+
# @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
|
25
25
|
optional :recipients,
|
26
26
|
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
|
27
27
|
nil?: true
|
@@ -32,7 +32,7 @@ module Knockapi
|
|
32
32
|
#
|
33
33
|
# @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
|
34
34
|
#
|
35
|
-
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
35
|
+
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
36
36
|
#
|
37
37
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
38
38
|
end
|
@@ -11,7 +11,7 @@ module Knockapi
|
|
11
11
|
# The recipients to trigger the workflow for. Can inline identify users, objects,
|
12
12
|
# or use a list of user IDs. Limited to 1,000 recipients.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
14
|
+
# @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
|
15
15
|
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
16
16
|
|
17
17
|
# @!attribute actor
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
# (string), an inline user request (object), or an inline object request, which is
|
20
20
|
# determined by the presence of a `collection` property.
|
21
21
|
#
|
22
|
-
# @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
|
22
|
+
# @return [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil]
|
23
23
|
optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
|
24
24
|
|
25
25
|
# @!attribute cancellation_key
|
@@ -33,7 +33,10 @@ module Knockapi
|
|
33
33
|
optional :cancellation_key, String, nil?: true
|
34
34
|
|
35
35
|
# @!attribute data
|
36
|
-
# An optional map of data to pass into the workflow execution.
|
36
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
37
|
+
# byte limit on the size of any single string value (with the exception of
|
38
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
39
|
+
# size of the full `data` payload.
|
37
40
|
#
|
38
41
|
# @return [Hash{Symbol=>Object}, nil]
|
39
42
|
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
|
@@ -41,22 +44,22 @@ module Knockapi
|
|
41
44
|
# @!attribute tenant
|
42
45
|
# An request to set a tenant inline.
|
43
46
|
#
|
44
|
-
# @return [String, Knockapi::TenantRequest, nil]
|
47
|
+
# @return [String, Knockapi::Models::TenantRequest, nil]
|
45
48
|
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
46
49
|
|
47
50
|
# @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
|
48
51
|
# Some parameter documentations has been truncated, see
|
49
52
|
# {Knockapi::Models::WorkflowTriggerParams} for more details.
|
50
53
|
#
|
51
|
-
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
54
|
+
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
52
55
|
#
|
53
|
-
# @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
56
|
+
# @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
54
57
|
#
|
55
58
|
# @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
|
56
59
|
#
|
57
|
-
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
60
|
+
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
|
58
61
|
#
|
59
|
-
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
62
|
+
# @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
|
60
63
|
#
|
61
64
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
62
65
|
end
|
data/lib/knockapi/models.rb
CHANGED
@@ -5,29 +5,40 @@ module Knockapi
|
|
5
5
|
cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Knockapi::Internal::AnyHash) } }
|
6
6
|
end
|
7
7
|
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
8
|
+
Knockapi::Internal::Util.walk_namespaces(Knockapi::Models).each do |mod|
|
9
|
+
case mod
|
10
|
+
in Knockapi::Internal::Type::Enum | Knockapi::Internal::Type::Union
|
11
|
+
mod.constants.each do |name|
|
12
|
+
case mod.const_get(name)
|
13
|
+
in true | false
|
14
|
+
mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
|
15
|
+
mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
|
16
|
+
in Integer
|
17
|
+
mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
|
18
|
+
mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
|
19
|
+
in Float
|
20
|
+
mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
|
21
|
+
mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
|
22
|
+
in Symbol
|
23
|
+
mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
|
24
|
+
mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
|
25
|
+
else
|
26
|
+
end
|
27
27
|
end
|
28
|
+
else
|
28
29
|
end
|
29
30
|
end
|
30
31
|
|
32
|
+
Knockapi::Internal::Util.walk_namespaces(Knockapi::Models)
|
33
|
+
.lazy
|
34
|
+
.grep(Knockapi::Internal::Type::Union)
|
35
|
+
.each do |mod|
|
36
|
+
const = :Variants
|
37
|
+
next if mod.sorbet_constant_defined?(const)
|
38
|
+
|
39
|
+
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
40
|
+
end
|
41
|
+
|
31
42
|
Activity = Knockapi::Models::Activity
|
32
43
|
|
33
44
|
AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
|
@@ -9,7 +9,7 @@ module Knockapi
|
|
9
9
|
#
|
10
10
|
# @param key [String] The key of the audience.
|
11
11
|
#
|
12
|
-
# @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
|
12
|
+
# @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
|
13
13
|
#
|
14
14
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
15
|
#
|
@@ -53,7 +53,7 @@ module Knockapi
|
|
53
53
|
#
|
54
54
|
# @param key [String] The key of the audience.
|
55
55
|
#
|
56
|
-
# @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
56
|
+
# @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
57
57
|
#
|
58
58
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
59
59
|
#
|
@@ -11,7 +11,7 @@ module Knockapi
|
|
11
11
|
#
|
12
12
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
13
13
|
#
|
14
|
-
# @return [Knockapi::BulkOperation]
|
14
|
+
# @return [Knockapi::Models::BulkOperation]
|
15
15
|
#
|
16
16
|
# @see Knockapi::Models::BulkOperationGetParams
|
17
17
|
def get(id, params = {})
|
@@ -16,13 +16,13 @@ module Knockapi
|
|
16
16
|
#
|
17
17
|
# @param channel_id [String] The ID of the channel to update messages for.
|
18
18
|
#
|
19
|
-
# @param action [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
|
19
|
+
# @param action [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Action] The target status to be applied to the messages.
|
20
20
|
#
|
21
|
-
# @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
|
21
|
+
# @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
|
22
22
|
#
|
23
|
-
# @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
|
23
|
+
# @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
|
24
24
|
#
|
25
|
-
# @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
|
25
|
+
# @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
|
26
26
|
#
|
27
27
|
# @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
|
28
28
|
#
|
@@ -40,7 +40,7 @@ module Knockapi
|
|
40
40
|
#
|
41
41
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
42
42
|
#
|
43
|
-
# @return [Knockapi::BulkOperation]
|
43
|
+
# @return [Knockapi::Models::BulkOperation]
|
44
44
|
#
|
45
45
|
# @see Knockapi::Models::Channels::BulkUpdateMessageStatusParams
|
46
46
|
def update_message_status(channel_id, action, params = {})
|
@@ -13,7 +13,7 @@ module Knockapi
|
|
13
13
|
#
|
14
14
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
15
|
#
|
16
|
-
# @return [Array<Knockapi::Message>]
|
16
|
+
# @return [Array<Knockapi::Models::Message>]
|
17
17
|
#
|
18
18
|
# @see Knockapi::Models::Messages::BatchArchiveParams
|
19
19
|
def archive(params)
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
method: :post,
|
23
23
|
path: "v1/messages/batch/archived",
|
24
24
|
body: parsed,
|
25
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
25
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
26
26
|
options: options
|
27
27
|
)
|
28
28
|
end
|
@@ -63,7 +63,7 @@ module Knockapi
|
|
63
63
|
#
|
64
64
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
65
65
|
#
|
66
|
-
# @return [Array<Knockapi::Message>]
|
66
|
+
# @return [Array<Knockapi::Models::Message>]
|
67
67
|
#
|
68
68
|
# @see Knockapi::Models::Messages::BatchMarkAsInteractedParams
|
69
69
|
def mark_as_interacted(params)
|
@@ -72,7 +72,7 @@ module Knockapi
|
|
72
72
|
method: :post,
|
73
73
|
path: "v1/messages/batch/interacted",
|
74
74
|
body: parsed,
|
75
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
75
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
76
76
|
options: options
|
77
77
|
)
|
78
78
|
end
|
@@ -86,7 +86,7 @@ module Knockapi
|
|
86
86
|
#
|
87
87
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
88
88
|
#
|
89
|
-
# @return [Array<Knockapi::Message>]
|
89
|
+
# @return [Array<Knockapi::Models::Message>]
|
90
90
|
#
|
91
91
|
# @see Knockapi::Models::Messages::BatchMarkAsReadParams
|
92
92
|
def mark_as_read(params)
|
@@ -95,7 +95,7 @@ module Knockapi
|
|
95
95
|
method: :post,
|
96
96
|
path: "v1/messages/batch/read",
|
97
97
|
body: parsed,
|
98
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
98
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
99
99
|
options: options
|
100
100
|
)
|
101
101
|
end
|
@@ -110,7 +110,7 @@ module Knockapi
|
|
110
110
|
#
|
111
111
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
112
112
|
#
|
113
|
-
# @return [Array<Knockapi::Message>]
|
113
|
+
# @return [Array<Knockapi::Models::Message>]
|
114
114
|
#
|
115
115
|
# @see Knockapi::Models::Messages::BatchMarkAsSeenParams
|
116
116
|
def mark_as_seen(params)
|
@@ -119,7 +119,7 @@ module Knockapi
|
|
119
119
|
method: :post,
|
120
120
|
path: "v1/messages/batch/seen",
|
121
121
|
body: parsed,
|
122
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
122
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
123
123
|
options: options
|
124
124
|
)
|
125
125
|
end
|
@@ -134,7 +134,7 @@ module Knockapi
|
|
134
134
|
#
|
135
135
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
136
136
|
#
|
137
|
-
# @return [Array<Knockapi::Message>]
|
137
|
+
# @return [Array<Knockapi::Models::Message>]
|
138
138
|
#
|
139
139
|
# @see Knockapi::Models::Messages::BatchMarkAsUnreadParams
|
140
140
|
def mark_as_unread(params)
|
@@ -143,7 +143,7 @@ module Knockapi
|
|
143
143
|
method: :post,
|
144
144
|
path: "v1/messages/batch/unread",
|
145
145
|
body: parsed,
|
146
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
146
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
147
147
|
options: options
|
148
148
|
)
|
149
149
|
end
|
@@ -158,7 +158,7 @@ module Knockapi
|
|
158
158
|
#
|
159
159
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
160
160
|
#
|
161
|
-
# @return [Array<Knockapi::Message>]
|
161
|
+
# @return [Array<Knockapi::Models::Message>]
|
162
162
|
#
|
163
163
|
# @see Knockapi::Models::Messages::BatchMarkAsUnseenParams
|
164
164
|
def mark_as_unseen(params)
|
@@ -167,7 +167,7 @@ module Knockapi
|
|
167
167
|
method: :post,
|
168
168
|
path: "v1/messages/batch/unseen",
|
169
169
|
body: parsed,
|
170
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
170
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
171
171
|
options: options
|
172
172
|
)
|
173
173
|
end
|
@@ -182,7 +182,7 @@ module Knockapi
|
|
182
182
|
#
|
183
183
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
184
184
|
#
|
185
|
-
# @return [Array<Knockapi::Message>]
|
185
|
+
# @return [Array<Knockapi::Models::Message>]
|
186
186
|
#
|
187
187
|
# @see Knockapi::Models::Messages::BatchUnarchiveParams
|
188
188
|
def unarchive(params)
|
@@ -191,7 +191,7 @@ module Knockapi
|
|
191
191
|
method: :post,
|
192
192
|
path: "v1/messages/batch/unarchived",
|
193
193
|
body: parsed,
|
194
|
-
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Message],
|
194
|
+
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Message],
|
195
195
|
options: options
|
196
196
|
)
|
197
197
|
end
|
@@ -19,9 +19,9 @@ module Knockapi
|
|
19
19
|
#
|
20
20
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
21
21
|
#
|
22
|
-
# @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
22
|
+
# @param engagement_status [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
23
23
|
#
|
24
|
-
# @param inserted_at [Knockapi::MessageListParams::InsertedAt]
|
24
|
+
# @param inserted_at [Knockapi::Models::MessageListParams::InsertedAt]
|
25
25
|
#
|
26
26
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
27
27
|
#
|
@@ -29,7 +29,7 @@ module Knockapi
|
|
29
29
|
#
|
30
30
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
31
31
|
#
|
32
|
-
# @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
|
32
|
+
# @param status [Array<Symbol, Knockapi::Models::MessageListParams::Status>] Limits the results to messages with the given delivery status.
|
33
33
|
#
|
34
34
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
35
35
|
#
|
@@ -43,7 +43,7 @@ module Knockapi
|
|
43
43
|
#
|
44
44
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
45
45
|
#
|
46
|
-
# @return [Knockapi::Internal::
|
46
|
+
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Message>]
|
47
47
|
#
|
48
48
|
# @see Knockapi::Models::MessageListParams
|
49
49
|
def list(params = {})
|
@@ -52,7 +52,7 @@ module Knockapi
|
|
52
52
|
method: :get,
|
53
53
|
path: "v1/messages",
|
54
54
|
query: parsed,
|
55
|
-
page: Knockapi::Internal::
|
55
|
+
page: Knockapi::Internal::ItemsCursor,
|
56
56
|
model: Knockapi::Message,
|
57
57
|
options: options
|
58
58
|
)
|
@@ -67,7 +67,7 @@ module Knockapi
|
|
67
67
|
#
|
68
68
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
69
69
|
#
|
70
|
-
# @return [Knockapi::Message]
|
70
|
+
# @return [Knockapi::Models::Message]
|
71
71
|
#
|
72
72
|
# @see Knockapi::Models::MessageArchiveParams
|
73
73
|
def archive(message_id, params = {})
|
@@ -87,7 +87,7 @@ module Knockapi
|
|
87
87
|
#
|
88
88
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
89
89
|
#
|
90
|
-
# @return [Knockapi::Message]
|
90
|
+
# @return [Knockapi::Models::Message]
|
91
91
|
#
|
92
92
|
# @see Knockapi::Models::MessageGetParams
|
93
93
|
def get(message_id, params = {})
|
@@ -136,7 +136,7 @@ module Knockapi
|
|
136
136
|
#
|
137
137
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
138
138
|
#
|
139
|
-
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Activity>]
|
139
|
+
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Activity>]
|
140
140
|
#
|
141
141
|
# @see Knockapi::Models::MessageListActivitiesParams
|
142
142
|
def list_activities(message_id, params = {})
|
@@ -165,7 +165,7 @@ module Knockapi
|
|
165
165
|
#
|
166
166
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
167
167
|
#
|
168
|
-
# @return [Knockapi::Internal::
|
168
|
+
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::MessageDeliveryLog>]
|
169
169
|
#
|
170
170
|
# @see Knockapi::Models::MessageListDeliveryLogsParams
|
171
171
|
def list_delivery_logs(message_id, params = {})
|
@@ -174,7 +174,7 @@ module Knockapi
|
|
174
174
|
method: :get,
|
175
175
|
path: ["v1/messages/%1$s/delivery_logs", message_id],
|
176
176
|
query: parsed,
|
177
|
-
page: Knockapi::Internal::
|
177
|
+
page: Knockapi::Internal::ItemsCursor,
|
178
178
|
model: Knockapi::MessageDeliveryLog,
|
179
179
|
options: options
|
180
180
|
)
|
@@ -194,7 +194,7 @@ module Knockapi
|
|
194
194
|
#
|
195
195
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
196
196
|
#
|
197
|
-
# @return [Knockapi::Internal::
|
197
|
+
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::MessageEvent>]
|
198
198
|
#
|
199
199
|
# @see Knockapi::Models::MessageListEventsParams
|
200
200
|
def list_events(message_id, params = {})
|
@@ -203,7 +203,7 @@ module Knockapi
|
|
203
203
|
method: :get,
|
204
204
|
path: ["v1/messages/%1$s/events", message_id],
|
205
205
|
query: parsed,
|
206
|
-
page: Knockapi::Internal::
|
206
|
+
page: Knockapi::Internal::ItemsCursor,
|
207
207
|
model: Knockapi::MessageEvent,
|
208
208
|
options: options
|
209
209
|
)
|
@@ -223,7 +223,7 @@ module Knockapi
|
|
223
223
|
#
|
224
224
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
225
225
|
#
|
226
|
-
# @return [Knockapi::Message]
|
226
|
+
# @return [Knockapi::Models::Message]
|
227
227
|
#
|
228
228
|
# @see Knockapi::Models::MessageMarkAsInteractedParams
|
229
229
|
def mark_as_interacted(message_id, params = {})
|
@@ -247,7 +247,7 @@ module Knockapi
|
|
247
247
|
#
|
248
248
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
249
249
|
#
|
250
|
-
# @return [Knockapi::Message]
|
250
|
+
# @return [Knockapi::Models::Message]
|
251
251
|
#
|
252
252
|
# @see Knockapi::Models::MessageMarkAsReadParams
|
253
253
|
def mark_as_read(message_id, params = {})
|
@@ -269,7 +269,7 @@ module Knockapi
|
|
269
269
|
#
|
270
270
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
271
271
|
#
|
272
|
-
# @return [Knockapi::Message]
|
272
|
+
# @return [Knockapi::Models::Message]
|
273
273
|
#
|
274
274
|
# @see Knockapi::Models::MessageMarkAsSeenParams
|
275
275
|
def mark_as_seen(message_id, params = {})
|
@@ -291,7 +291,7 @@ module Knockapi
|
|
291
291
|
#
|
292
292
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
293
293
|
#
|
294
|
-
# @return [Knockapi::Message]
|
294
|
+
# @return [Knockapi::Models::Message]
|
295
295
|
#
|
296
296
|
# @see Knockapi::Models::MessageMarkAsUnreadParams
|
297
297
|
def mark_as_unread(message_id, params = {})
|
@@ -313,7 +313,7 @@ module Knockapi
|
|
313
313
|
#
|
314
314
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
315
315
|
#
|
316
|
-
# @return [Knockapi::Message]
|
316
|
+
# @return [Knockapi::Models::Message]
|
317
317
|
#
|
318
318
|
# @see Knockapi::Models::MessageMarkAsUnseenParams
|
319
319
|
def mark_as_unseen(message_id, params = {})
|
@@ -334,7 +334,7 @@ module Knockapi
|
|
334
334
|
#
|
335
335
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
336
336
|
#
|
337
|
-
# @return [Knockapi::Message]
|
337
|
+
# @return [Knockapi::Models::Message]
|
338
338
|
#
|
339
339
|
# @see Knockapi::Models::MessageUnarchiveParams
|
340
340
|
def unarchive(message_id, params = {})
|
@@ -14,7 +14,7 @@ module Knockapi
|
|
14
14
|
#
|
15
15
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
16
16
|
#
|
17
|
-
# @return [Knockapi::BulkOperation]
|
17
|
+
# @return [Knockapi::Models::BulkOperation]
|
18
18
|
#
|
19
19
|
# @see Knockapi::Models::Objects::BulkDeleteParams
|
20
20
|
def delete(collection, params)
|
@@ -38,11 +38,11 @@ module Knockapi
|
|
38
38
|
#
|
39
39
|
# @param collection [String] The collection this object belongs to.
|
40
40
|
#
|
41
|
-
# @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
41
|
+
# @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
42
42
|
#
|
43
43
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
44
44
|
#
|
45
|
-
# @return [Knockapi::BulkOperation]
|
45
|
+
# @return [Knockapi::Models::BulkOperation]
|
46
46
|
#
|
47
47
|
# @see Knockapi::Models::Objects::BulkAddSubscriptionsParams
|
48
48
|
def add_subscriptions(collection, params)
|
@@ -62,11 +62,11 @@ module Knockapi
|
|
62
62
|
#
|
63
63
|
# @param collection [String] The collection this object belongs to.
|
64
64
|
#
|
65
|
-
# @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
|
65
|
+
# @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
|
66
66
|
#
|
67
67
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
68
68
|
#
|
69
|
-
# @return [Knockapi::BulkOperation]
|
69
|
+
# @return [Knockapi::Models::BulkOperation]
|
70
70
|
#
|
71
71
|
# @see Knockapi::Models::Objects::BulkSetParams
|
72
72
|
def set(collection, params)
|