knockapi 1.2.0 → 1.4.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 +30 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/knockapi/internal/items_cursor.rb +2 -2
- data/lib/knockapi/internal/util.rb +10 -2
- 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 -1
- data/lib/knockapi/models/message.rb +14 -14
- data/lib/knockapi/models/message_delivery_log.rb +13 -13
- data/lib/knockapi/models/message_event.rb +7 -7
- data/lib/knockapi/models/message_list_params.rb +6 -6
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- 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 +6 -6
- 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 -1
- data/lib/knockapi/models/recipient_reference.rb +1 -1
- data/lib/knockapi/models/recipient_request.rb +1 -1
- data/lib/knockapi/models/recipients/channel_data.rb +7 -7
- data/lib/knockapi/models/recipients/channel_data_request.rb +4 -4
- data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -6
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -6
- data/lib/knockapi/models/recipients/preference_set.rb +17 -17
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -24
- data/lib/knockapi/models/recipients/preference_set_request.rb +17 -17
- data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -6
- 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 +6 -6
- 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 -4
- data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
- data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
- 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 +27 -25
- data/lib/knockapi/resources/workflows.rb +5 -5
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +3 -1
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
- 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/schedule.rbi +8 -2
- 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/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 +4 -2
- 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/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 +32 -12
- 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 +32 -12
- 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 +32 -12
- 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
@@ -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
|
#
|
@@ -18,7 +18,7 @@ module Knockapi
|
|
18
18
|
variant -> { Knockapi::InlineObjectRequest }
|
19
19
|
|
20
20
|
# @!method self.variants
|
21
|
-
# @return [Array(String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest)]
|
21
|
+
# @return [Array(String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest)]
|
22
22
|
end
|
23
23
|
end
|
24
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,12 +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)]
|
64
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData, Knockapi::Models::Recipients::OneSignalChannelData)]
|
65
65
|
end
|
66
66
|
|
67
67
|
# The type of provider.
|
68
68
|
#
|
69
|
-
# @see Knockapi::Recipients::RecipientsChannelData#provider
|
69
|
+
# @see Knockapi::Models::Recipients::RecipientsChannelData#provider
|
70
70
|
module Provider
|
71
71
|
extend Knockapi::Internal::Type::Enum
|
72
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,7 +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)]
|
40
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
41
41
|
end
|
42
42
|
end
|
43
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,7 +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)]
|
78
|
+
# @return [Array(Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Models::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection)]
|
79
79
|
end
|
80
80
|
end
|
81
81
|
end
|
@@ -23,7 +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)]
|
26
|
+
# @return [Array(Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData)]
|
27
27
|
end
|
28
28
|
|
29
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,7 +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)]
|
109
|
+
# @return [Array(Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
|
110
110
|
end
|
111
111
|
end
|
112
112
|
end
|
@@ -14,7 +14,7 @@ module Knockapi
|
|
14
14
|
# An object where the key is the category and the values are the preference
|
15
15
|
# settings for that category.
|
16
16
|
#
|
17
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
17
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
18
18
|
optional :categories,
|
19
19
|
-> {
|
20
20
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Category]
|
@@ -24,14 +24,14 @@ module Knockapi
|
|
24
24
|
# @!attribute channel_types
|
25
25
|
# Channel type preferences.
|
26
26
|
#
|
27
|
-
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
27
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
28
28
|
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
29
29
|
|
30
30
|
# @!attribute workflows
|
31
31
|
# An object where the key is the workflow key and the values are the preference
|
32
32
|
# settings for that workflow.
|
33
33
|
#
|
34
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
34
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
35
35
|
optional :workflows,
|
36
36
|
-> {
|
37
37
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Workflow]
|
@@ -40,18 +40,18 @@ module Knockapi
|
|
40
40
|
|
41
41
|
# @!method initialize(id:, categories: nil, channel_types: nil, workflows: nil)
|
42
42
|
# Some parameter documentations has been truncated, see
|
43
|
-
# {Knockapi::Recipients::PreferenceSet} for more details.
|
43
|
+
# {Knockapi::Models::Recipients::PreferenceSet} for more details.
|
44
44
|
#
|
45
45
|
# A preference set represents a specific set of notification preferences for a
|
46
46
|
# recipient. A recipient can have multiple preference sets.
|
47
47
|
#
|
48
48
|
# @param id [String] Unique identifier for the preference set.
|
49
49
|
#
|
50
|
-
# @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
50
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
51
51
|
#
|
52
|
-
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
52
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
53
53
|
#
|
54
|
-
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
54
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
55
55
|
|
56
56
|
# Workflow or category preferences within a preference set
|
57
57
|
module Category
|
@@ -68,26 +68,26 @@ module Knockapi
|
|
68
68
|
# @!attribute channel_types
|
69
69
|
# Channel type preferences.
|
70
70
|
#
|
71
|
-
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
71
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
72
72
|
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
73
73
|
|
74
74
|
# @!attribute conditions
|
75
75
|
# A list of conditions to apply to a channel type.
|
76
76
|
#
|
77
|
-
# @return [Array<Knockapi::Condition>, nil]
|
77
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
78
78
|
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
79
79
|
|
80
80
|
# @!method initialize(channel_types: nil, conditions: nil)
|
81
81
|
# The settings object for a workflow or category, where you can specify channel
|
82
82
|
# types or conditions.
|
83
83
|
#
|
84
|
-
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
84
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
85
85
|
#
|
86
|
-
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
86
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
87
87
|
end
|
88
88
|
|
89
89
|
# @!method self.variants
|
90
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
|
90
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
|
91
91
|
end
|
92
92
|
|
93
93
|
# Workflow or category preferences within a preference set
|
@@ -105,26 +105,26 @@ module Knockapi
|
|
105
105
|
# @!attribute channel_types
|
106
106
|
# Channel type preferences.
|
107
107
|
#
|
108
|
-
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
108
|
+
# @return [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil]
|
109
109
|
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
110
110
|
|
111
111
|
# @!attribute conditions
|
112
112
|
# A list of conditions to apply to a channel type.
|
113
113
|
#
|
114
|
-
# @return [Array<Knockapi::Condition>, nil]
|
114
|
+
# @return [Array<Knockapi::Models::Condition>, nil]
|
115
115
|
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
116
116
|
|
117
117
|
# @!method initialize(channel_types: nil, conditions: nil)
|
118
118
|
# The settings object for a workflow or category, where you can specify channel
|
119
119
|
# types or conditions.
|
120
120
|
#
|
121
|
-
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
121
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
122
122
|
#
|
123
|
-
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
123
|
+
# @param conditions [Array<Knockapi::Models::Condition>, nil] A list of conditions to apply to a channel type.
|
124
124
|
end
|
125
125
|
|
126
126
|
# @!method self.variants
|
127
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
127
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
128
128
|
end
|
129
129
|
end
|
130
130
|
end
|
@@ -7,14 +7,14 @@ module Knockapi
|
|
7
7
|
# @!attribute conditions
|
8
8
|
# A list of conditions to apply to a channel type.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::Condition>]
|
10
|
+
# @return [Array<Knockapi::Models::Condition>]
|
11
11
|
required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
|
12
12
|
|
13
13
|
# @!method initialize(conditions:)
|
14
14
|
# A set of settings for a channel type. Currently, this can only be a list of
|
15
15
|
# conditions to apply.
|
16
16
|
#
|
17
|
-
# @param conditions [Array<Knockapi::Condition>] A list of conditions to apply to a channel type.
|
17
|
+
# @param conditions [Array<Knockapi::Models::Condition>] A list of conditions to apply to a channel type.
|
18
18
|
end
|
19
19
|
end
|
20
20
|
end
|
@@ -7,57 +7,57 @@ module Knockapi
|
|
7
7
|
# @!attribute chat
|
8
8
|
# Whether the channel type is enabled for the preference set.
|
9
9
|
#
|
10
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
10
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
11
11
|
optional :chat, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Chat }
|
12
12
|
|
13
13
|
# @!attribute email
|
14
14
|
# Whether the channel type is enabled for the preference set.
|
15
15
|
#
|
16
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
16
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
17
17
|
optional :email, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Email }
|
18
18
|
|
19
19
|
# @!attribute http
|
20
20
|
# Whether the channel type is enabled for the preference set.
|
21
21
|
#
|
22
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
22
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
23
23
|
optional :http, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::HTTP }
|
24
24
|
|
25
25
|
# @!attribute in_app_feed
|
26
26
|
# Whether the channel type is enabled for the preference set.
|
27
27
|
#
|
28
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
28
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
29
29
|
optional :in_app_feed, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::InAppFeed }
|
30
30
|
|
31
31
|
# @!attribute push
|
32
32
|
# Whether the channel type is enabled for the preference set.
|
33
33
|
#
|
34
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
34
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
35
35
|
optional :push, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Push }
|
36
36
|
|
37
37
|
# @!attribute sms
|
38
38
|
# Whether the channel type is enabled for the preference set.
|
39
39
|
#
|
40
|
-
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
40
|
+
# @return [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting, nil]
|
41
41
|
optional :sms, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::SMS }
|
42
42
|
|
43
43
|
# @!method initialize(chat: nil, email: nil, http: nil, in_app_feed: nil, push: nil, sms: nil)
|
44
44
|
# Channel type preferences.
|
45
45
|
#
|
46
|
-
# @param chat [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
46
|
+
# @param chat [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
47
47
|
#
|
48
|
-
# @param email [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
48
|
+
# @param email [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
49
49
|
#
|
50
|
-
# @param http [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
50
|
+
# @param http [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
51
51
|
#
|
52
|
-
# @param in_app_feed [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
52
|
+
# @param in_app_feed [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
53
53
|
#
|
54
|
-
# @param push [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
54
|
+
# @param push [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
55
55
|
#
|
56
|
-
# @param sms [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
56
|
+
# @param sms [Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
57
57
|
|
58
58
|
# Whether the channel type is enabled for the preference set.
|
59
59
|
#
|
60
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#chat
|
60
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#chat
|
61
61
|
module Chat
|
62
62
|
extend Knockapi::Internal::Type::Union
|
63
63
|
|
@@ -67,12 +67,12 @@ module Knockapi
|
|
67
67
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
68
68
|
|
69
69
|
# @!method self.variants
|
70
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
70
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
71
71
|
end
|
72
72
|
|
73
73
|
# Whether the channel type is enabled for the preference set.
|
74
74
|
#
|
75
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#email
|
75
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#email
|
76
76
|
module Email
|
77
77
|
extend Knockapi::Internal::Type::Union
|
78
78
|
|
@@ -82,12 +82,12 @@ module Knockapi
|
|
82
82
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
83
83
|
|
84
84
|
# @!method self.variants
|
85
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
85
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
86
86
|
end
|
87
87
|
|
88
88
|
# Whether the channel type is enabled for the preference set.
|
89
89
|
#
|
90
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#http
|
90
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#http
|
91
91
|
module HTTP
|
92
92
|
extend Knockapi::Internal::Type::Union
|
93
93
|
|
@@ -97,12 +97,12 @@ module Knockapi
|
|
97
97
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
98
98
|
|
99
99
|
# @!method self.variants
|
100
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
100
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
101
101
|
end
|
102
102
|
|
103
103
|
# Whether the channel type is enabled for the preference set.
|
104
104
|
#
|
105
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#in_app_feed
|
105
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#in_app_feed
|
106
106
|
module InAppFeed
|
107
107
|
extend Knockapi::Internal::Type::Union
|
108
108
|
|
@@ -112,12 +112,12 @@ module Knockapi
|
|
112
112
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
113
113
|
|
114
114
|
# @!method self.variants
|
115
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
115
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
116
116
|
end
|
117
117
|
|
118
118
|
# Whether the channel type is enabled for the preference set.
|
119
119
|
#
|
120
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#push
|
120
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#push
|
121
121
|
module Push
|
122
122
|
extend Knockapi::Internal::Type::Union
|
123
123
|
|
@@ -127,12 +127,12 @@ module Knockapi
|
|
127
127
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
128
128
|
|
129
129
|
# @!method self.variants
|
130
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
130
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
131
131
|
end
|
132
132
|
|
133
133
|
# Whether the channel type is enabled for the preference set.
|
134
134
|
#
|
135
|
-
# @see Knockapi::Recipients::PreferenceSetChannelTypes#sms
|
135
|
+
# @see Knockapi::Models::Recipients::PreferenceSetChannelTypes#sms
|
136
136
|
module SMS
|
137
137
|
extend Knockapi::Internal::Type::Union
|
138
138
|
|
@@ -142,7 +142,7 @@ module Knockapi
|
|
142
142
|
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
143
143
|
|
144
144
|
# @!method self.variants
|
145
|
-
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
145
|
+
# @return [Array(Boolean, Knockapi::Models::Recipients::PreferenceSetChannelTypeSetting)]
|
146
146
|
end
|
147
147
|
end
|
148
148
|
end
|