knockapi 1.2.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 +22 -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 +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/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 +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/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
@@ -25,7 +25,7 @@ module Knockapi
|
|
25
25
|
#
|
26
26
|
# @param avatar [String, nil] URL to the user's avatar image.
|
27
27
|
#
|
28
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
28
|
+
# @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}, nil] A request to set channel data for a type of channel inline.
|
29
29
|
#
|
30
30
|
# @param created_at [Time, nil] The creation date of the user from your system.
|
31
31
|
#
|
@@ -37,13 +37,13 @@ module Knockapi
|
|
37
37
|
#
|
38
38
|
# @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
39
39
|
#
|
40
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
40
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
41
41
|
#
|
42
42
|
# @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
|
43
43
|
#
|
44
44
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
45
45
|
#
|
46
|
-
# @return [Knockapi::User]
|
46
|
+
# @return [Knockapi::Models::User]
|
47
47
|
#
|
48
48
|
# @see Knockapi::Models::UserUpdateParams
|
49
49
|
def update(user_id, params = {})
|
@@ -66,13 +66,13 @@ module Knockapi
|
|
66
66
|
#
|
67
67
|
# @param before [String] The cursor to fetch entries before.
|
68
68
|
#
|
69
|
-
# @param include [Array<Symbol, Knockapi::UserListParams::Include>] Associated resources to include in the response.
|
69
|
+
# @param include [Array<Symbol, Knockapi::Models::UserListParams::Include>] Associated resources to include in the response.
|
70
70
|
#
|
71
71
|
# @param page_size [Integer] The number of items per page.
|
72
72
|
#
|
73
73
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
74
74
|
#
|
75
|
-
# @return [Knockapi::Internal::EntriesCursor<Knockapi::User>]
|
75
|
+
# @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::User>]
|
76
76
|
#
|
77
77
|
# @see Knockapi::Models::UserListParams
|
78
78
|
def list(params = {})
|
@@ -115,7 +115,7 @@ module Knockapi
|
|
115
115
|
#
|
116
116
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
117
117
|
#
|
118
|
-
# @return [Knockapi::User]
|
118
|
+
# @return [Knockapi::Models::User]
|
119
119
|
#
|
120
120
|
# @see Knockapi::Models::UserGetParams
|
121
121
|
def get(user_id, params = {})
|
@@ -137,7 +137,7 @@ module Knockapi
|
|
137
137
|
#
|
138
138
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
139
139
|
#
|
140
|
-
# @return [Knockapi::Recipients::RecipientsChannelData]
|
140
|
+
# @return [Knockapi::Models::Recipients::RecipientsChannelData]
|
141
141
|
#
|
142
142
|
# @see Knockapi::Models::UserGetChannelDataParams
|
143
143
|
def get_channel_data(user_id, channel_id, params = {})
|
@@ -162,7 +162,7 @@ module Knockapi
|
|
162
162
|
#
|
163
163
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
164
164
|
#
|
165
|
-
# @return [Knockapi::Recipients::PreferenceSet]
|
165
|
+
# @return [Knockapi::Models::Recipients::PreferenceSet]
|
166
166
|
#
|
167
167
|
# @see Knockapi::Models::UserGetPreferencesParams
|
168
168
|
def get_preferences(user_id, id, params = {})
|
@@ -193,9 +193,9 @@ module Knockapi
|
|
193
193
|
#
|
194
194
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
195
195
|
#
|
196
|
-
# @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
196
|
+
# @param engagement_status [Array<Symbol, Knockapi::Models::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
197
197
|
#
|
198
|
-
# @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
|
198
|
+
# @param inserted_at [Knockapi::Models::UserListMessagesParams::InsertedAt]
|
199
199
|
#
|
200
200
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
201
201
|
#
|
@@ -203,7 +203,7 @@ module Knockapi
|
|
203
203
|
#
|
204
204
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
205
205
|
#
|
206
|
-
# @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
206
|
+
# @param status [Array<Symbol, Knockapi::Models::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
207
207
|
#
|
208
208
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
209
209
|
#
|
@@ -217,7 +217,7 @@ module Knockapi
|
|
217
217
|
#
|
218
218
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
219
219
|
#
|
220
|
-
# @return [Knockapi::Internal::
|
220
|
+
# @return [Knockapi::Internal::ItemsCursor<Knockapi::Models::Message>]
|
221
221
|
#
|
222
222
|
# @see Knockapi::Models::UserListMessagesParams
|
223
223
|
def list_messages(user_id, params = {})
|
@@ -226,7 +226,7 @@ module Knockapi
|
|
226
226
|
method: :get,
|
227
227
|
path: ["v1/users/%1$s/messages", user_id],
|
228
228
|
query: parsed,
|
229
|
-
page: Knockapi::Internal::
|
229
|
+
page: Knockapi::Internal::ItemsCursor,
|
230
230
|
model: Knockapi::Message,
|
231
231
|
options: options
|
232
232
|
)
|
@@ -240,7 +240,7 @@ module Knockapi
|
|
240
240
|
#
|
241
241
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
242
242
|
#
|
243
|
-
# @return [Array<Knockapi::Recipients::PreferenceSet>]
|
243
|
+
# @return [Array<Knockapi::Models::Recipients::PreferenceSet>]
|
244
244
|
#
|
245
245
|
# @see Knockapi::Models::UserListPreferencesParams
|
246
246
|
def list_preferences(user_id, params = {})
|
@@ -270,7 +270,7 @@ module Knockapi
|
|
270
270
|
#
|
271
271
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
272
272
|
#
|
273
|
-
# @return [Knockapi::Internal::EntriesCursor<Knockapi::Schedule>]
|
273
|
+
# @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Schedule>]
|
274
274
|
#
|
275
275
|
# @see Knockapi::Models::UserListSchedulesParams
|
276
276
|
def list_schedules(user_id, params = {})
|
@@ -296,7 +296,7 @@ module Knockapi
|
|
296
296
|
#
|
297
297
|
# @param before [String] The cursor to fetch entries before.
|
298
298
|
#
|
299
|
-
# @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
|
299
|
+
# @param include [Array<Symbol, Knockapi::Models::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
|
300
300
|
#
|
301
301
|
# @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
|
302
302
|
#
|
@@ -304,7 +304,7 @@ module Knockapi
|
|
304
304
|
#
|
305
305
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
306
306
|
#
|
307
|
-
# @return [Knockapi::Internal::EntriesCursor<Knockapi::Recipients::Subscription>]
|
307
|
+
# @return [Knockapi::Internal::EntriesCursor<Knockapi::Models::Recipients::Subscription>]
|
308
308
|
#
|
309
309
|
# @see Knockapi::Models::UserListSubscriptionsParams
|
310
310
|
def list_subscriptions(user_id, params = {})
|
@@ -330,7 +330,7 @@ module Knockapi
|
|
330
330
|
#
|
331
331
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
332
332
|
#
|
333
|
-
# @return [Knockapi::User]
|
333
|
+
# @return [Knockapi::Models::User]
|
334
334
|
#
|
335
335
|
# @see Knockapi::Models::UserMergeParams
|
336
336
|
def merge(user_id, params)
|
@@ -352,11 +352,11 @@ module Knockapi
|
|
352
352
|
#
|
353
353
|
# @param channel_id [String] The unique identifier for the channel.
|
354
354
|
#
|
355
|
-
# @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
|
355
|
+
# @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.
|
356
356
|
#
|
357
357
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
358
358
|
#
|
359
|
-
# @return [Knockapi::Recipients::RecipientsChannelData]
|
359
|
+
# @return [Knockapi::Models::Recipients::RecipientsChannelData]
|
360
360
|
#
|
361
361
|
# @see Knockapi::Models::UserSetChannelDataParams
|
362
362
|
def set_channel_data(user_id, channel_id, params)
|
@@ -382,15 +382,15 @@ module Knockapi
|
|
382
382
|
#
|
383
383
|
# @param id [String] Unique identifier for the preference set.
|
384
384
|
#
|
385
|
-
# @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
385
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
386
386
|
#
|
387
|
-
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
387
|
+
# @param channel_types [Knockapi::Models::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
388
388
|
#
|
389
|
-
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
389
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Models::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
390
390
|
#
|
391
391
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
392
392
|
#
|
393
|
-
# @return [Knockapi::Recipients::PreferenceSet]
|
393
|
+
# @return [Knockapi::Models::Recipients::PreferenceSet]
|
394
394
|
#
|
395
395
|
# @see Knockapi::Models::UserSetPreferencesParams
|
396
396
|
def set_preferences(user_id, id, params = {})
|
@@ -16,7 +16,7 @@ module Knockapi
|
|
16
16
|
#
|
17
17
|
# @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
|
18
18
|
#
|
19
|
-
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
19
|
+
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
20
20
|
#
|
21
21
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
22
22
|
#
|
@@ -47,15 +47,15 @@ module Knockapi
|
|
47
47
|
#
|
48
48
|
# @param key [String] Key of the workflow to trigger.
|
49
49
|
#
|
50
|
-
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
50
|
+
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
51
51
|
#
|
52
|
-
# @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
52
|
+
# @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
53
53
|
#
|
54
54
|
# @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
|
55
55
|
#
|
56
|
-
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
56
|
+
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
|
57
57
|
#
|
58
|
-
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
58
|
+
# @param tenant [String, Knockapi::Models::TenantRequest, nil] An request to set a tenant inline.
|
59
59
|
#
|
60
60
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
61
61
|
#
|
data/lib/knockapi/version.rb
CHANGED
data/lib/knockapi.rb
CHANGED
@@ -20,7 +20,9 @@ require "uri"
|
|
20
20
|
|
21
21
|
# We already ship the preferred sorbet manifests in the package itself.
|
22
22
|
# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
|
23
|
-
if Object.const_defined?(:Tapioca) &&
|
23
|
+
if Object.const_defined?(:Tapioca) &&
|
24
|
+
caller.chain([$PROGRAM_NAME]).chain(ARGV).any?(/tapioca/) &&
|
25
|
+
ARGV.none?(/dsl/)
|
24
26
|
return
|
25
27
|
end
|
26
28
|
|
@@ -41,7 +41,10 @@ module Knockapi
|
|
41
41
|
sig { returns(T.nilable(Knockapi::Recipient::Variants)) }
|
42
42
|
attr_accessor :actor
|
43
43
|
|
44
|
-
# An optional map of data to pass into the workflow execution.
|
44
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
45
|
+
# byte limit on the size of any single string value (with the exception of
|
46
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
47
|
+
# size of the full `data` payload.
|
45
48
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
46
49
|
attr_accessor :data
|
47
50
|
|
@@ -94,7 +97,10 @@ module Knockapi
|
|
94
97
|
_typename: nil,
|
95
98
|
# A recipient of a notification, which is either a user or an object.
|
96
99
|
actor: nil,
|
97
|
-
# An optional map of data to pass into the workflow execution.
|
100
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
101
|
+
# byte limit on the size of any single string value (with the exception of
|
102
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
103
|
+
# size of the full `data` payload.
|
98
104
|
data: nil,
|
99
105
|
# The last occurrence of the schedule.
|
100
106
|
last_occurrence_at: nil,
|
@@ -33,7 +33,10 @@ module Knockapi
|
|
33
33
|
sig { returns(String) }
|
34
34
|
attr_accessor :workflow
|
35
35
|
|
36
|
-
# An optional map of data to pass into the workflow execution.
|
36
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
37
|
+
# byte limit on the size of any single string value (with the exception of
|
38
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
39
|
+
# size of the full `data` payload.
|
37
40
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
38
41
|
attr_accessor :data
|
39
42
|
|
@@ -75,7 +78,10 @@ module Knockapi
|
|
75
78
|
repeats:,
|
76
79
|
# The key of the workflow.
|
77
80
|
workflow:,
|
78
|
-
# An optional map of data to pass into the workflow execution.
|
81
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
82
|
+
# byte limit on the size of any single string value (with the exception of
|
83
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
84
|
+
# size of the full `data` payload.
|
79
85
|
data: nil,
|
80
86
|
# The ending date and time for the schedule.
|
81
87
|
ending_at: nil,
|
@@ -26,7 +26,10 @@ module Knockapi
|
|
26
26
|
end
|
27
27
|
attr_accessor :actor
|
28
28
|
|
29
|
-
# An optional map of data to pass into the workflow execution.
|
29
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
30
|
+
# byte limit on the size of any single string value (with the exception of
|
31
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
32
|
+
# size of the full `data` payload.
|
30
33
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
31
34
|
attr_accessor :data
|
32
35
|
|
@@ -75,7 +78,10 @@ module Knockapi
|
|
75
78
|
# A reference to a recipient, either a user identifier (string) or an object
|
76
79
|
# reference (ID, collection).
|
77
80
|
actor: nil,
|
78
|
-
# An optional map of data to pass into the workflow execution.
|
81
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
82
|
+
# byte limit on the size of any single string value (with the exception of
|
83
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
84
|
+
# size of the full `data` payload.
|
79
85
|
data: nil,
|
80
86
|
# The ending date and time for the schedule.
|
81
87
|
ending_at: nil,
|
@@ -76,7 +76,10 @@ module Knockapi
|
|
76
76
|
end
|
77
77
|
attr_accessor :actor
|
78
78
|
|
79
|
-
# An optional map of data to pass into the workflow execution.
|
79
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
80
|
+
# byte limit on the size of any single string value (with the exception of
|
81
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
82
|
+
# size of the full `data` payload.
|
80
83
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
81
84
|
attr_accessor :data
|
82
85
|
|
@@ -161,7 +164,10 @@ module Knockapi
|
|
161
164
|
# (string), an inline user request (object), or an inline object request, which is
|
162
165
|
# determined by the presence of a `collection` property.
|
163
166
|
actor: nil,
|
164
|
-
# An optional map of data to pass into the workflow execution.
|
167
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
168
|
+
# byte limit on the size of any single string value (with the exception of
|
169
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
170
|
+
# size of the full `data` payload.
|
165
171
|
data: nil,
|
166
172
|
# The ending date and time for the schedule.
|
167
173
|
ending_at: nil,
|
@@ -50,7 +50,10 @@ module Knockapi
|
|
50
50
|
sig { returns(T.nilable(String)) }
|
51
51
|
attr_accessor :cancellation_key
|
52
52
|
|
53
|
-
# An optional map of data to pass into the workflow execution.
|
53
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
54
|
+
# byte limit on the size of any single string value (with the exception of
|
55
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
56
|
+
# size of the full `data` payload.
|
54
57
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
55
58
|
attr_accessor :data
|
56
59
|
|
@@ -96,7 +99,10 @@ module Knockapi
|
|
96
99
|
# subsequent cancellation. Should be unique across trigger requests to avoid
|
97
100
|
# unintentional cancellations.
|
98
101
|
cancellation_key: nil,
|
99
|
-
# An optional map of data to pass into the workflow execution.
|
102
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
103
|
+
# byte limit on the size of any single string value (with the exception of
|
104
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
105
|
+
# size of the full `data` payload.
|
100
106
|
data: nil,
|
101
107
|
# An request to set a tenant inline.
|
102
108
|
tenant: nil,
|
@@ -10,7 +10,7 @@ module Knockapi
|
|
10
10
|
params(
|
11
11
|
message_ids: T::Array[String],
|
12
12
|
request_options: Knockapi::RequestOptions::OrHash
|
13
|
-
).returns(T::Array[Knockapi::Message])
|
13
|
+
).returns(T::Array[Knockapi::Models::Message])
|
14
14
|
end
|
15
15
|
def archive(
|
16
16
|
# The message IDs to update the status of.
|
@@ -45,7 +45,7 @@ module Knockapi
|
|
45
45
|
message_ids: T::Array[String],
|
46
46
|
metadata: T.nilable(T::Hash[Symbol, T.anything]),
|
47
47
|
request_options: Knockapi::RequestOptions::OrHash
|
48
|
-
).returns(T::Array[Knockapi::Message])
|
48
|
+
).returns(T::Array[Knockapi::Models::Message])
|
49
49
|
end
|
50
50
|
def mark_as_interacted(
|
51
51
|
# The message IDs to batch mark as interacted with.
|
@@ -62,7 +62,7 @@ module Knockapi
|
|
62
62
|
params(
|
63
63
|
message_ids: T::Array[String],
|
64
64
|
request_options: Knockapi::RequestOptions::OrHash
|
65
|
-
).returns(T::Array[Knockapi::Message])
|
65
|
+
).returns(T::Array[Knockapi::Models::Message])
|
66
66
|
end
|
67
67
|
def mark_as_read(
|
68
68
|
# The message IDs to update the status of.
|
@@ -78,7 +78,7 @@ module Knockapi
|
|
78
78
|
params(
|
79
79
|
message_ids: T::Array[String],
|
80
80
|
request_options: Knockapi::RequestOptions::OrHash
|
81
|
-
).returns(T::Array[Knockapi::Message])
|
81
|
+
).returns(T::Array[Knockapi::Models::Message])
|
82
82
|
end
|
83
83
|
def mark_as_seen(
|
84
84
|
# The message IDs to update the status of.
|
@@ -94,7 +94,7 @@ module Knockapi
|
|
94
94
|
params(
|
95
95
|
message_ids: T::Array[String],
|
96
96
|
request_options: Knockapi::RequestOptions::OrHash
|
97
|
-
).returns(T::Array[Knockapi::Message])
|
97
|
+
).returns(T::Array[Knockapi::Models::Message])
|
98
98
|
end
|
99
99
|
def mark_as_unread(
|
100
100
|
# The message IDs to update the status of.
|
@@ -110,7 +110,7 @@ module Knockapi
|
|
110
110
|
params(
|
111
111
|
message_ids: T::Array[String],
|
112
112
|
request_options: Knockapi::RequestOptions::OrHash
|
113
|
-
).returns(T::Array[Knockapi::Message])
|
113
|
+
).returns(T::Array[Knockapi::Models::Message])
|
114
114
|
end
|
115
115
|
def mark_as_unseen(
|
116
116
|
# The message IDs to update the status of.
|
@@ -126,7 +126,7 @@ module Knockapi
|
|
126
126
|
params(
|
127
127
|
message_ids: T::Array[String],
|
128
128
|
request_options: Knockapi::RequestOptions::OrHash
|
129
|
-
).returns(T::Array[Knockapi::Message])
|
129
|
+
).returns(T::Array[Knockapi::Models::Message])
|
130
130
|
end
|
131
131
|
def unarchive(
|
132
132
|
# The message IDs to update the status of.
|
@@ -25,7 +25,7 @@ module Knockapi
|
|
25
25
|
workflow_recipient_run_id: String,
|
26
26
|
workflow_run_id: String,
|
27
27
|
request_options: Knockapi::RequestOptions::OrHash
|
28
|
-
).returns(Knockapi::Internal::
|
28
|
+
).returns(Knockapi::Internal::ItemsCursor[Knockapi::Message])
|
29
29
|
end
|
30
30
|
def list(
|
31
31
|
# The cursor to fetch entries after.
|
@@ -141,9 +141,7 @@ module Knockapi
|
|
141
141
|
before: String,
|
142
142
|
page_size: Integer,
|
143
143
|
request_options: Knockapi::RequestOptions::OrHash
|
144
|
-
).returns(
|
145
|
-
Knockapi::Internal::EntriesCursor[Knockapi::MessageDeliveryLog]
|
146
|
-
)
|
144
|
+
).returns(Knockapi::Internal::ItemsCursor[Knockapi::MessageDeliveryLog])
|
147
145
|
end
|
148
146
|
def list_delivery_logs(
|
149
147
|
# The ID of the message to fetch delivery logs for.
|
@@ -166,7 +164,7 @@ module Knockapi
|
|
166
164
|
before: String,
|
167
165
|
page_size: Integer,
|
168
166
|
request_options: Knockapi::RequestOptions::OrHash
|
169
|
-
).returns(Knockapi::Internal::
|
167
|
+
).returns(Knockapi::Internal::ItemsCursor[Knockapi::MessageEvent])
|
170
168
|
end
|
171
169
|
def list_events(
|
172
170
|
# The ID of the message to fetch events for.
|
@@ -197,7 +197,7 @@ module Knockapi
|
|
197
197
|
workflow_recipient_run_id: String,
|
198
198
|
workflow_run_id: String,
|
199
199
|
request_options: Knockapi::RequestOptions::OrHash
|
200
|
-
).returns(Knockapi::Internal::
|
200
|
+
).returns(Knockapi::Internal::ItemsCursor[Knockapi::Message])
|
201
201
|
end
|
202
202
|
def list_messages(
|
203
203
|
# The collection this object belongs to.
|
@@ -37,7 +37,10 @@ module Knockapi
|
|
37
37
|
repeats:,
|
38
38
|
# The key of the workflow.
|
39
39
|
workflow:,
|
40
|
-
# An optional map of data to pass into the workflow execution.
|
40
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
41
|
+
# byte limit on the size of any single string value (with the exception of
|
42
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
43
|
+
# size of the full `data` payload.
|
41
44
|
data: nil,
|
42
45
|
# The ending date and time for the schedule.
|
43
46
|
ending_at: nil,
|
@@ -78,7 +81,10 @@ module Knockapi
|
|
78
81
|
# A reference to a recipient, either a user identifier (string) or an object
|
79
82
|
# reference (ID, collection).
|
80
83
|
actor: nil,
|
81
|
-
# An optional map of data to pass into the workflow execution.
|
84
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
85
|
+
# byte limit on the size of any single string value (with the exception of
|
86
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
87
|
+
# size of the full `data` payload.
|
82
88
|
data: nil,
|
83
89
|
# The ending date and time for the schedule.
|
84
90
|
ending_at: nil,
|
@@ -191,7 +191,7 @@ module Knockapi
|
|
191
191
|
workflow_recipient_run_id: String,
|
192
192
|
workflow_run_id: String,
|
193
193
|
request_options: Knockapi::RequestOptions::OrHash
|
194
|
-
).returns(Knockapi::Internal::
|
194
|
+
).returns(Knockapi::Internal::ItemsCursor[Knockapi::Message])
|
195
195
|
end
|
196
196
|
def list_messages(
|
197
197
|
# The user ID to list messages for.
|
@@ -84,7 +84,10 @@ module Knockapi
|
|
84
84
|
# subsequent cancellation. Should be unique across trigger requests to avoid
|
85
85
|
# unintentional cancellations.
|
86
86
|
cancellation_key: nil,
|
87
|
-
# An optional map of data to pass into the workflow execution.
|
87
|
+
# An optional map of data to pass into the workflow execution. There is a 1024
|
88
|
+
# byte limit on the size of any single string value (with the exception of
|
89
|
+
# [email attachments](/integrations/email/attachments)), and a 10MB limit on the
|
90
|
+
# size of the full `data` payload.
|
88
91
|
data: nil,
|
89
92
|
# An request to set a tenant inline.
|
90
93
|
tenant: nil,
|
@@ -47,6 +47,16 @@ module Knockapi
|
|
47
47
|
?recipient: Knockapi::Models::recipient,
|
48
48
|
?updated_at: Time
|
49
49
|
) -> void
|
50
|
+
|
51
|
+
def to_hash: -> {
|
52
|
+
id: String,
|
53
|
+
_typename: String,
|
54
|
+
actor: Knockapi::Models::recipient?,
|
55
|
+
data: ::Hash[Symbol, top]?,
|
56
|
+
inserted_at: Time,
|
57
|
+
recipient: Knockapi::Models::recipient,
|
58
|
+
updated_at: Time
|
59
|
+
}
|
50
60
|
end
|
51
61
|
end
|
52
62
|
end
|
@@ -15,6 +15,11 @@ module Knockapi
|
|
15
15
|
?request_options: Knockapi::request_opts
|
16
16
|
) -> void
|
17
17
|
|
18
|
+
def to_hash: -> {
|
19
|
+
members: ::Array[Knockapi::AudienceAddMembersParams::Member],
|
20
|
+
request_options: Knockapi::RequestOptions
|
21
|
+
}
|
22
|
+
|
18
23
|
type member =
|
19
24
|
{
|
20
25
|
user: Knockapi::AudienceAddMembersParams::Member::User,
|
@@ -31,6 +36,11 @@ module Knockapi
|
|
31
36
|
?tenant: String?
|
32
37
|
) -> void
|
33
38
|
|
39
|
+
def to_hash: -> {
|
40
|
+
user: Knockapi::AudienceAddMembersParams::Member::User,
|
41
|
+
tenant: String?
|
42
|
+
}
|
43
|
+
|
34
44
|
type user = { id: String }
|
35
45
|
|
36
46
|
class User < Knockapi::Internal::Type::BaseModel
|
@@ -39,6 +49,8 @@ module Knockapi
|
|
39
49
|
def id=: (String) -> String
|
40
50
|
|
41
51
|
def initialize: (?id: String) -> void
|
52
|
+
|
53
|
+
def to_hash: -> { id: String }
|
42
54
|
end
|
43
55
|
end
|
44
56
|
end
|