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
@@ -28,7 +28,7 @@ module Knockapi
|
|
28
28
|
# @!attribute engagement_status
|
29
29
|
# Limits the results to messages with the given engagement status.
|
30
30
|
#
|
31
|
-
# @return [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>, nil]
|
31
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
33
|
-> {
|
34
34
|
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::EngagementStatus]
|
@@ -36,7 +36,7 @@ module Knockapi
|
|
36
36
|
|
37
37
|
# @!attribute inserted_at
|
38
38
|
#
|
39
|
-
# @return [Knockapi::ObjectListMessagesParams::InsertedAt, nil]
|
39
|
+
# @return [Knockapi::Models::ObjectListMessagesParams::InsertedAt, nil]
|
40
40
|
optional :inserted_at, -> { Knockapi::ObjectListMessagesParams::InsertedAt }
|
41
41
|
|
42
42
|
# @!attribute message_ids
|
@@ -61,7 +61,7 @@ module Knockapi
|
|
61
61
|
# @!attribute status
|
62
62
|
# Limits the results to messages with the given delivery status.
|
63
63
|
#
|
64
|
-
# @return [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>, nil]
|
64
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>, nil]
|
65
65
|
optional :status,
|
66
66
|
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::Status] }
|
67
67
|
|
@@ -108,9 +108,9 @@ module Knockapi
|
|
108
108
|
#
|
109
109
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
110
110
|
#
|
111
|
-
# @param engagement_status [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
111
|
+
# @param engagement_status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
112
112
|
#
|
113
|
-
# @param inserted_at [Knockapi::ObjectListMessagesParams::InsertedAt]
|
113
|
+
# @param inserted_at [Knockapi::Models::ObjectListMessagesParams::InsertedAt]
|
114
114
|
#
|
115
115
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
116
116
|
#
|
@@ -118,7 +118,7 @@ module Knockapi
|
|
118
118
|
#
|
119
119
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
120
120
|
#
|
121
|
-
# @param status [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
121
|
+
# @param status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
122
122
|
#
|
123
123
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
124
124
|
#
|
@@ -136,10 +136,13 @@ module Knockapi
|
|
136
136
|
extend Knockapi::Internal::Type::Enum
|
137
137
|
|
138
138
|
SEEN = :seen
|
139
|
+
UNSEEN = :unseen
|
139
140
|
READ = :read
|
140
|
-
|
141
|
-
LINK_CLICKED = :link_clicked
|
141
|
+
UNREAD = :unread
|
142
142
|
ARCHIVED = :archived
|
143
|
+
UNARCHIVED = :unarchived
|
144
|
+
LINK_CLICKED = :link_clicked
|
145
|
+
INTERACTED = :interacted
|
143
146
|
|
144
147
|
# @!method self.values
|
145
148
|
# @return [Array<Symbol>]
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Includes preferences of the objects in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::ObjectListParams::Include>, nil]
|
25
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListParams::Include>, nil]
|
26
26
|
optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }
|
27
27
|
|
28
28
|
# @!attribute page_size
|
@@ -36,7 +36,7 @@ module Knockapi
|
|
36
36
|
#
|
37
37
|
# @param before [String] The cursor to fetch entries before.
|
38
38
|
#
|
39
|
-
# @param include [Array<Symbol, Knockapi::ObjectListParams::Include>] Includes preferences of the objects in the response.
|
39
|
+
# @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
|
40
40
|
#
|
41
41
|
# @param page_size [Integer] The number of items per page.
|
42
42
|
#
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Additional fields to include in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>, nil]
|
25
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>, nil]
|
26
26
|
optional :include,
|
27
27
|
-> {
|
28
28
|
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListSubscriptionsParams::Include]
|
@@ -33,13 +33,13 @@ module Knockapi
|
|
33
33
|
# subscribed to, `object` to list the recipients that subscribe to the provided
|
34
34
|
# object.
|
35
35
|
#
|
36
|
-
# @return [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode, nil]
|
36
|
+
# @return [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode, nil]
|
37
37
|
optional :mode, enum: -> { Knockapi::ObjectListSubscriptionsParams::Mode }
|
38
38
|
|
39
39
|
# @!attribute objects
|
40
40
|
# Objects to filter by (only used if mode is `recipient`).
|
41
41
|
#
|
42
|
-
# @return [Array<Knockapi::ObjectListSubscriptionsParams::Object>, nil]
|
42
|
+
# @return [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>, nil]
|
43
43
|
optional :objects,
|
44
44
|
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
|
45
45
|
|
@@ -52,7 +52,7 @@ module Knockapi
|
|
52
52
|
# @!attribute recipients
|
53
53
|
# Recipients to filter by (only used if mode is `object`).
|
54
54
|
#
|
55
|
-
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
55
|
+
# @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
|
56
56
|
optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
57
57
|
|
58
58
|
# @!method initialize(after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
|
@@ -63,15 +63,15 @@ module Knockapi
|
|
63
63
|
#
|
64
64
|
# @param before [String] The cursor to fetch entries before.
|
65
65
|
#
|
66
|
-
# @param include [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
|
66
|
+
# @param include [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
|
67
67
|
#
|
68
|
-
# @param mode [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
|
68
|
+
# @param mode [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
|
69
69
|
#
|
70
|
-
# @param objects [Array<Knockapi::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
|
70
|
+
# @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
|
71
71
|
#
|
72
72
|
# @param page_size [Integer] The number of items per page.
|
73
73
|
#
|
74
|
-
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
|
74
|
+
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
|
75
75
|
#
|
76
76
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
77
77
|
|
@@ -10,7 +10,7 @@ module Knockapi
|
|
10
10
|
# @!attribute channel_data
|
11
11
|
# A request to set channel data for a type of channel inline.
|
12
12
|
#
|
13
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
14
14
|
optional :channel_data,
|
15
15
|
-> {
|
16
16
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
@@ -26,7 +26,7 @@ module Knockapi
|
|
26
26
|
# @!attribute preferences
|
27
27
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
28
28
|
#
|
29
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
29
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
|
30
30
|
optional :preferences,
|
31
31
|
-> {
|
32
32
|
Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest]
|
@@ -45,11 +45,11 @@ module Knockapi
|
|
45
45
|
# Some parameter documentations has been truncated, see
|
46
46
|
# {Knockapi::Models::ObjectSetParams} for more details.
|
47
47
|
#
|
48
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
|
48
|
+
# @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
|
49
49
|
#
|
50
50
|
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
51
51
|
#
|
52
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
|
52
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
|
53
53
|
#
|
54
54
|
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
55
55
|
#
|
@@ -11,14 +11,14 @@ module Knockapi
|
|
11
11
|
# @!attribute subscriptions
|
12
12
|
# A list of subscriptions.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>]
|
14
|
+
# @return [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>]
|
15
15
|
required :subscriptions,
|
16
16
|
-> {
|
17
17
|
Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription]
|
18
18
|
}
|
19
19
|
|
20
20
|
# @!method initialize(subscriptions:, request_options: {})
|
21
|
-
# @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
21
|
+
# @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
22
22
|
#
|
23
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
24
24
|
|
@@ -27,7 +27,7 @@ module Knockapi
|
|
27
27
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
28
28
|
# object at a time.
|
29
29
|
#
|
30
|
-
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
30
|
+
# @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
|
31
31
|
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
32
32
|
|
33
33
|
# @!attribute properties
|
@@ -40,9 +40,10 @@ module Knockapi
|
|
40
40
|
|
41
41
|
# @!method initialize(recipients:, properties: nil)
|
42
42
|
# Some parameter documentations has been truncated, see
|
43
|
-
# {Knockapi::Objects::BulkAddSubscriptionsParams::Subscription} for more
|
43
|
+
# {Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription} for more
|
44
|
+
# details.
|
44
45
|
#
|
45
|
-
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
46
|
+
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
46
47
|
#
|
47
48
|
# @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
|
48
49
|
end
|
@@ -11,11 +11,11 @@ module Knockapi
|
|
11
11
|
# @!attribute objects
|
12
12
|
# A list of objects.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::InlineObjectRequest>]
|
14
|
+
# @return [Array<Knockapi::Models::InlineObjectRequest>]
|
15
15
|
required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineObjectRequest] }
|
16
16
|
|
17
17
|
# @!method initialize(objects:, request_options: {})
|
18
|
-
# @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
|
18
|
+
# @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
|
19
19
|
#
|
20
20
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
end
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
|
23
23
|
# @!attribute query_options
|
24
24
|
#
|
25
|
-
# @return [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions, nil]
|
25
|
+
# @return [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, nil]
|
26
26
|
optional :query_options, -> { Knockapi::Providers::MsTeamListChannelsParams::QueryOptions }
|
27
27
|
|
28
28
|
# @!method initialize(ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
|
@@ -30,7 +30,7 @@ module Knockapi
|
|
30
30
|
#
|
31
31
|
# @param team_id [String] Microsoft Teams team ID.
|
32
32
|
#
|
33
|
-
# @param query_options [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions]
|
33
|
+
# @param query_options [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions]
|
34
34
|
#
|
35
35
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
36
36
|
|
@@ -51,7 +51,8 @@ module Knockapi
|
|
51
51
|
|
52
52
|
# @!method initialize(filter: nil, select_: nil)
|
53
53
|
# Some parameter documentations has been truncated, see
|
54
|
-
# {Knockapi::Providers::MsTeamListChannelsParams::QueryOptions} for more
|
54
|
+
# {Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions} for more
|
55
|
+
# details.
|
55
56
|
#
|
56
57
|
# @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
57
58
|
#
|
@@ -16,13 +16,13 @@ module Knockapi
|
|
16
16
|
|
17
17
|
# @!attribute query_options
|
18
18
|
#
|
19
|
-
# @return [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions, nil]
|
19
|
+
# @return [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions, nil]
|
20
20
|
optional :query_options, -> { Knockapi::Providers::MsTeamListTeamsParams::QueryOptions }
|
21
21
|
|
22
22
|
# @!method initialize(ms_teams_tenant_object:, query_options: nil, request_options: {})
|
23
23
|
# @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
|
24
24
|
#
|
25
|
-
# @param query_options [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions]
|
25
|
+
# @param query_options [Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions]
|
26
26
|
#
|
27
27
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
28
28
|
|
@@ -57,7 +57,8 @@ module Knockapi
|
|
57
57
|
|
58
58
|
# @!method initialize(filter: nil, select_: nil, skiptoken: nil, top: nil)
|
59
59
|
# Some parameter documentations has been truncated, see
|
60
|
-
# {Knockapi::Providers::MsTeamListTeamsParams::QueryOptions} for more
|
60
|
+
# {Knockapi::Models::Providers::MsTeamListTeamsParams::QueryOptions} for more
|
61
|
+
# details.
|
61
62
|
#
|
62
63
|
# @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
63
64
|
#
|
@@ -16,13 +16,13 @@ module Knockapi
|
|
16
16
|
|
17
17
|
# @!attribute query_options
|
18
18
|
#
|
19
|
-
# @return [Knockapi::Providers::SlackListChannelsParams::QueryOptions, nil]
|
19
|
+
# @return [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions, nil]
|
20
20
|
optional :query_options, -> { Knockapi::Providers::SlackListChannelsParams::QueryOptions }
|
21
21
|
|
22
22
|
# @!method initialize(access_token_object:, query_options: nil, request_options: {})
|
23
23
|
# @param access_token_object [String] A JSON encoded string containing the access token object reference.
|
24
24
|
#
|
25
|
-
# @param query_options [Knockapi::Providers::SlackListChannelsParams::QueryOptions]
|
25
|
+
# @param query_options [Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions]
|
26
26
|
#
|
27
27
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
28
28
|
|
@@ -62,7 +62,8 @@ module Knockapi
|
|
62
62
|
|
63
63
|
# @!method initialize(cursor: nil, exclude_archived: nil, limit: nil, team_id: nil, types: nil)
|
64
64
|
# Some parameter documentations has been truncated, see
|
65
|
-
# {Knockapi::Providers::SlackListChannelsParams::QueryOptions} for more
|
65
|
+
# {Knockapi::Models::Providers::SlackListChannelsParams::QueryOptions} for more
|
66
|
+
# details.
|
66
67
|
#
|
67
68
|
# @param cursor [String] Paginate through collections of data by setting the cursor parameter to a next_c
|
68
69
|
#
|
@@ -13,11 +13,7 @@ module Knockapi
|
|
13
13
|
variant -> { Knockapi::Object }
|
14
14
|
|
15
15
|
# @!method self.variants
|
16
|
-
# @return [Array(Knockapi::User, Knockapi::Object)]
|
17
|
-
|
18
|
-
define_sorbet_constant!(:Variants) do
|
19
|
-
T.type_alias { T.any(Knockapi::User, Knockapi::Object) }
|
20
|
-
end
|
16
|
+
# @return [Array(Knockapi::Models::User, Knockapi::Models::Object)]
|
21
17
|
end
|
22
18
|
end
|
23
19
|
end
|
@@ -35,11 +35,7 @@ module Knockapi
|
|
35
35
|
end
|
36
36
|
|
37
37
|
# @!method self.variants
|
38
|
-
# @return [Array(String, Knockapi::RecipientReference::ObjectReference)]
|
39
|
-
|
40
|
-
define_sorbet_constant!(:Variants) do
|
41
|
-
T.type_alias { T.any(String, Knockapi::RecipientReference::ObjectReference) }
|
42
|
-
end
|
38
|
+
# @return [Array(String, Knockapi::Models::RecipientReference::ObjectReference)]
|
43
39
|
end
|
44
40
|
end
|
45
41
|
end
|
@@ -18,11 +18,7 @@ module Knockapi
|
|
18
18
|
variant -> { Knockapi::InlineObjectRequest }
|
19
19
|
|
20
20
|
# @!method self.variants
|
21
|
-
# @return [Array(String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest)]
|
22
|
-
|
23
|
-
define_sorbet_constant!(:Variants) do
|
24
|
-
T.type_alias { T.any(String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest) }
|
25
|
-
end
|
21
|
+
# @return [Array(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)]
|
26
22
|
end
|
27
23
|
end
|
28
24
|
end
|
@@ -19,13 +19,13 @@ module Knockapi
|
|
19
19
|
# @!attribute data
|
20
20
|
# Channel data for a given channel type.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData]
|
22
|
+
# @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData]
|
23
23
|
required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data }
|
24
24
|
|
25
25
|
# @!attribute provider
|
26
26
|
# The type of provider.
|
27
27
|
#
|
28
|
-
# @return [Symbol, Knockapi::Recipients::RecipientsChannelData::Provider, nil]
|
28
|
+
# @return [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider, nil]
|
29
29
|
optional :provider, enum: -> { Knockapi::Recipients::RecipientsChannelData::Provider }
|
30
30
|
|
31
31
|
# @!method initialize(_typename:, channel_id:, data:, provider: nil)
|
@@ -35,13 +35,13 @@ module Knockapi
|
|
35
35
|
#
|
36
36
|
# @param channel_id [String] The unique identifier for the channel.
|
37
37
|
#
|
38
|
-
# @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData] Channel data for a given channel type.
|
38
|
+
# @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData] Channel data for a given channel type.
|
39
39
|
#
|
40
|
-
# @param provider [Symbol, Knockapi::Recipients::RecipientsChannelData::Provider] The type of provider.
|
40
|
+
# @param provider [Symbol, Knockapi::Models::Recipients::RecipientsChannelData::Provider] The type of provider.
|
41
41
|
|
42
42
|
# Channel data for a given channel type.
|
43
43
|
#
|
44
|
-
# @see Knockapi::Recipients::RecipientsChannelData#data
|
44
|
+
# @see Knockapi::Models::Recipients::RecipientsChannelData#data
|
45
45
|
module Data
|
46
46
|
extend Knockapi::Internal::Type::Union
|
47
47
|
|
@@ -61,24 +61,12 @@ module Knockapi
|
|
61
61
|
variant -> { Knockapi::Recipients::OneSignalChannelData }
|
62
62
|
|
63
63
|
# @!method self.variants
|
64
|
-
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData)]
|
65
|
-
|
66
|
-
define_sorbet_constant!(:Variants) do
|
67
|
-
T.type_alias do
|
68
|
-
T.any(
|
69
|
-
Knockapi::Recipients::PushChannelData,
|
70
|
-
Knockapi::Recipients::SlackChannelData,
|
71
|
-
Knockapi::Recipients::MsTeamsChannelData,
|
72
|
-
Knockapi::Recipients::DiscordChannelData,
|
73
|
-
Knockapi::Recipients::OneSignalChannelData
|
74
|
-
)
|
75
|
-
end
|
76
|
-
end
|
64
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)]
|
77
65
|
end
|
78
66
|
|
79
67
|
# The type of provider.
|
80
68
|
#
|
81
|
-
# @see Knockapi::Recipients::RecipientsChannelData#provider
|
69
|
+
# @see Knockapi::Models::Recipients::RecipientsChannelData#provider
|
82
70
|
module Provider
|
83
71
|
extend Knockapi::Internal::Type::Enum
|
84
72
|
|
@@ -7,17 +7,17 @@ module Knockapi
|
|
7
7
|
# @!attribute data
|
8
8
|
# Channel data for a given channel type.
|
9
9
|
#
|
10
|
-
# @return [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData]
|
10
|
+
# @return [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData]
|
11
11
|
required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
14
|
# A request to set channel data for a type of channel.
|
15
15
|
#
|
16
|
-
# @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
|
16
|
+
# @param data [Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData] Channel data for a given channel type.
|
17
17
|
|
18
18
|
# Channel data for a given channel type.
|
19
19
|
#
|
20
|
-
# @see Knockapi::Recipients::ChannelDataRequest#data
|
20
|
+
# @see Knockapi::Models::Recipients::ChannelDataRequest#data
|
21
21
|
module Data
|
22
22
|
extend Knockapi::Internal::Type::Union
|
23
23
|
|
@@ -37,19 +37,7 @@ module Knockapi
|
|
37
37
|
variant -> { Knockapi::Recipients::DiscordChannelData }
|
38
38
|
|
39
39
|
# @!method self.variants
|
40
|
-
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData)]
|
41
|
-
|
42
|
-
define_sorbet_constant!(:Variants) do
|
43
|
-
T.type_alias do
|
44
|
-
T.any(
|
45
|
-
Knockapi::Recipients::PushChannelData,
|
46
|
-
Knockapi::Recipients::OneSignalChannelData,
|
47
|
-
Knockapi::Recipients::SlackChannelData,
|
48
|
-
Knockapi::Recipients::MsTeamsChannelData,
|
49
|
-
Knockapi::Recipients::DiscordChannelData
|
50
|
-
)
|
51
|
-
end
|
52
|
-
end
|
40
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
53
41
|
end
|
54
42
|
end
|
55
43
|
end
|
@@ -7,7 +7,7 @@ module Knockapi
|
|
7
7
|
# @!attribute connections
|
8
8
|
# List of Discord channel connections.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>]
|
10
|
+
# @return [Array<Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>]
|
11
11
|
required :connections,
|
12
12
|
-> {
|
13
13
|
Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::DiscordChannelData::Connection]
|
@@ -16,7 +16,7 @@ module Knockapi
|
|
16
16
|
# @!method initialize(connections:)
|
17
17
|
# Discord channel data.
|
18
18
|
#
|
19
|
-
# @param connections [Array<Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>] List of Discord channel connections.
|
19
|
+
# @param connections [Array<Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>] List of Discord channel connections.
|
20
20
|
|
21
21
|
# Discord channel connection, either a channel connection or an incoming webhook
|
22
22
|
# connection.
|
@@ -48,7 +48,7 @@ module Knockapi
|
|
48
48
|
# @!attribute incoming_webhook
|
49
49
|
# Discord incoming webhook object.
|
50
50
|
#
|
51
|
-
# @return [Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook]
|
51
|
+
# @return [Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook]
|
52
52
|
required :incoming_webhook,
|
53
53
|
-> {
|
54
54
|
Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
|
@@ -57,9 +57,9 @@ module Knockapi
|
|
57
57
|
# @!method initialize(incoming_webhook:)
|
58
58
|
# Discord incoming webhook connection.
|
59
59
|
#
|
60
|
-
# @param incoming_webhook [Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook] Discord incoming webhook object.
|
60
|
+
# @param incoming_webhook [Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook] Discord incoming webhook object.
|
61
61
|
|
62
|
-
# @see Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection#incoming_webhook
|
62
|
+
# @see Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection#incoming_webhook
|
63
63
|
class IncomingWebhook < Knockapi::Internal::Type::BaseModel
|
64
64
|
# @!attribute url
|
65
65
|
# Incoming webhook URL.
|
@@ -75,16 +75,7 @@ module Knockapi
|
|
75
75
|
end
|
76
76
|
|
77
77
|
# @!method self.variants
|
78
|
-
# @return [Array(Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection)]
|
79
|
-
|
80
|
-
define_sorbet_constant!(:Variants) do
|
81
|
-
T.type_alias do
|
82
|
-
T.any(
|
83
|
-
Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
|
84
|
-
Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
|
85
|
-
)
|
86
|
-
end
|
87
|
-
end
|
78
|
+
# @return [Array(Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection)]
|
88
79
|
end
|
89
80
|
end
|
90
81
|
end
|
@@ -23,19 +23,7 @@ module Knockapi
|
|
23
23
|
variant -> { Knockapi::Recipients::DiscordChannelData }
|
24
24
|
|
25
25
|
# @!method self.variants
|
26
|
-
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData)]
|
27
|
-
|
28
|
-
define_sorbet_constant!(:Variants) do
|
29
|
-
T.type_alias do
|
30
|
-
T.any(
|
31
|
-
Knockapi::Recipients::PushChannelData,
|
32
|
-
Knockapi::Recipients::OneSignalChannelData,
|
33
|
-
Knockapi::Recipients::SlackChannelData,
|
34
|
-
Knockapi::Recipients::MsTeamsChannelData,
|
35
|
-
Knockapi::Recipients::DiscordChannelData
|
36
|
-
)
|
37
|
-
end
|
38
|
-
end
|
26
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
39
27
|
end
|
40
28
|
|
41
29
|
# @type [Knockapi::Internal::Type::Converter]
|
@@ -7,7 +7,7 @@ module Knockapi
|
|
7
7
|
# @!attribute connections
|
8
8
|
# List of Microsoft Teams connections.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>]
|
10
|
+
# @return [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>]
|
11
11
|
required :connections,
|
12
12
|
-> {
|
13
13
|
Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::MsTeamsChannelData::Connection]
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!method initialize(connections:, ms_teams_tenant_id: nil)
|
23
23
|
# Microsoft Teams channel connection.
|
24
24
|
#
|
25
|
-
# @param connections [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
|
25
|
+
# @param connections [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
|
26
26
|
#
|
27
27
|
# @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
|
28
28
|
|
@@ -79,7 +79,7 @@ module Knockapi
|
|
79
79
|
# @!attribute incoming_webhook
|
80
80
|
# Microsoft Teams incoming webhook.
|
81
81
|
#
|
82
|
-
# @return [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook]
|
82
|
+
# @return [Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook]
|
83
83
|
required :incoming_webhook,
|
84
84
|
-> {
|
85
85
|
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
|
@@ -88,9 +88,9 @@ module Knockapi
|
|
88
88
|
# @!method initialize(incoming_webhook:)
|
89
89
|
# Microsoft Teams incoming webhook connection.
|
90
90
|
#
|
91
|
-
# @param incoming_webhook [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook] Microsoft Teams incoming webhook.
|
91
|
+
# @param incoming_webhook [Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook] Microsoft Teams incoming webhook.
|
92
92
|
|
93
|
-
# @see Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection#incoming_webhook
|
93
|
+
# @see Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection#incoming_webhook
|
94
94
|
class IncomingWebhook < Knockapi::Internal::Type::BaseModel
|
95
95
|
# @!attribute url
|
96
96
|
# Microsoft Teams incoming webhook URL.
|
@@ -106,16 +106,7 @@ module Knockapi
|
|
106
106
|
end
|
107
107
|
|
108
108
|
# @!method self.variants
|
109
|
-
# @return [Array(Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
|
110
|
-
|
111
|
-
define_sorbet_constant!(:Variants) do
|
112
|
-
T.type_alias do
|
113
|
-
T.any(
|
114
|
-
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
|
115
|
-
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
|
116
|
-
)
|
117
|
-
end
|
118
|
-
end
|
109
|
+
# @return [Array(Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
|
119
110
|
end
|
120
111
|
end
|
121
112
|
end
|