knockapi 1.0.0 → 1.2.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 +61 -0
- data/README.md +101 -49
- data/lib/knockapi/client.rb +4 -4
- data/lib/knockapi/errors.rb +1 -1
- data/lib/knockapi/file_part.rb +2 -2
- data/lib/knockapi/internal/entries_cursor.rb +3 -3
- data/lib/knockapi/internal/items_cursor.rb +3 -3
- data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
- data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
- data/lib/knockapi/internal/transport/base_client.rb +79 -7
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/knockapi/internal/type/array_of.rb +9 -1
- data/lib/knockapi/internal/type/base_model.rb +78 -39
- data/lib/knockapi/internal/type/boolean.rb +8 -0
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +13 -0
- data/lib/knockapi/internal/type/file_input.rb +7 -0
- data/lib/knockapi/internal/type/hash_of.rb +9 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +16 -3
- data/lib/knockapi/internal/type/unknown.rb +8 -0
- data/lib/knockapi/internal/util.rb +119 -2
- data/lib/knockapi/internal.rb +9 -0
- data/lib/knockapi/models/activity.rb +6 -6
- data/lib/knockapi/models/audience_add_members_params.rb +10 -8
- data/lib/knockapi/models/audience_add_members_response.rb +7 -0
- data/lib/knockapi/models/audience_list_members_response.rb +6 -6
- data/lib/knockapi/models/audience_member.rb +5 -6
- data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +7 -8
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
- data/lib/knockapi/models/condition.rb +4 -4
- data/lib/knockapi/models/identify_user_request.rb +16 -17
- data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
- data/lib/knockapi/models/inline_object_request.rb +8 -6
- data/lib/knockapi/models/inline_tenant_request.rb +2 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +18 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_list_params.rb +14 -15
- 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.rb +9 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
- data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_delete_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_list_messages_params.rb +16 -14
- data/lib/knockapi/models/object_list_params.rb +3 -4
- data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
- data/lib/knockapi/models/object_set_params.rb +15 -13
- data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
- data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
- data/lib/knockapi/models/recipient.rb +3 -3
- data/lib/knockapi/models/recipient_reference.rb +2 -2
- data/lib/knockapi/models/recipient_request.rb +3 -3
- data/lib/knockapi/models/recipients/channel_data.rb +14 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +10 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +24 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/preference_set.rb +34 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +36 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +34 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +12 -10
- data/lib/knockapi/models/recipients/subscription.rb +6 -6
- data/lib/knockapi/models/schedule.rb +11 -12
- data/lib/knockapi/models/schedule_create_params.rb +10 -15
- data/lib/knockapi/models/schedule_create_response.rb +1 -1
- data/lib/knockapi/models/schedule_delete_response.rb +1 -1
- data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
- data/lib/knockapi/models/schedule_update_params.rb +9 -10
- data/lib/knockapi/models/schedule_update_response.rb +1 -1
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
- data/lib/knockapi/models/tenant.rb +13 -16
- data/lib/knockapi/models/tenant_delete_response.rb +7 -0
- data/lib/knockapi/models/tenant_request.rb +20 -20
- data/lib/knockapi/models/tenant_set_params.rb +19 -19
- data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/user.rb +9 -11
- data/lib/knockapi/models/user_delete_response.rb +7 -0
- data/lib/knockapi/models/user_list_messages_params.rb +18 -14
- data/lib/knockapi/models/user_list_params.rb +3 -4
- data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
- data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
- data/lib/knockapi/models/users/feed_list_items_response.rb +6 -6
- data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
- data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
- data/lib/knockapi/models.rb +213 -0
- data/lib/knockapi/request_options.rb +4 -0
- data/lib/knockapi/resources/audiences.rb +4 -4
- data/lib/knockapi/resources/bulk_operations.rb +2 -2
- data/lib/knockapi/resources/channels/bulk.rb +7 -8
- data/lib/knockapi/resources/integrations/census.rb +1 -1
- data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
- data/lib/knockapi/resources/messages/batch.rb +22 -22
- data/lib/knockapi/resources/messages.rb +32 -39
- data/lib/knockapi/resources/objects/bulk.rb +11 -11
- data/lib/knockapi/resources/objects.rb +52 -62
- data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
- data/lib/knockapi/resources/providers/slack.rb +4 -4
- data/lib/knockapi/resources/schedules/bulk.rb +4 -4
- data/lib/knockapi/resources/schedules.rb +18 -23
- data/lib/knockapi/resources/tenants/bulk.rb +7 -7
- data/lib/knockapi/resources/tenants.rb +11 -11
- data/lib/knockapi/resources/users/bulk.rb +11 -11
- data/lib/knockapi/resources/users/feeds.rb +3 -3
- data/lib/knockapi/resources/users/guides.rb +4 -4
- data/lib/knockapi/resources/users.rb +46 -54
- data/lib/knockapi/resources/workflows.rb +6 -11
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +11 -2
- data/rbi/knockapi/client.rbi +5 -4
- data/rbi/knockapi/errors.rbi +35 -16
- data/rbi/knockapi/file_part.rbi +9 -6
- data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
- data/rbi/knockapi/internal/items_cursor.rbi +9 -4
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
- data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
- data/rbi/knockapi/internal/type/array_of.rbi +40 -24
- data/rbi/knockapi/internal/type/base_model.rbi +156 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +22 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +33 -15
- data/rbi/knockapi/internal/type/file_input.rbi +13 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +40 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +60 -19
- data/rbi/knockapi/internal/type/unknown.rbi +22 -6
- data/rbi/knockapi/internal/util.rbi +273 -87
- data/rbi/knockapi/internal.rbi +5 -0
- data/rbi/knockapi/models/activity.rbi +28 -22
- data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
- data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
- data/rbi/knockapi/models/audience_member.rbi +23 -11
- data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +70 -42
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
- data/rbi/knockapi/models/condition.rbi +78 -31
- data/rbi/knockapi/models/identify_user_request.rbi +90 -36
- data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
- data/rbi/knockapi/models/inline_object_request.rbi +76 -22
- data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
- data/rbi/knockapi/models/message.rbi +140 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +175 -72
- data/rbi/knockapi/models/message_event.rbi +83 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +366 -226
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
- data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
- data/rbi/knockapi/models/message_list_params.rbi +162 -58
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +370 -227
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
- data/rbi/knockapi/models/object.rbi +31 -10
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_delete_params.rbi +13 -5
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_get_params.rbi +13 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +185 -61
- data/rbi/knockapi/models/object_list_params.rbi +43 -22
- data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_set_params.rbi +89 -33
- data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/page_info.rbi +22 -11
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/recipient.rbi +5 -2
- data/rbi/knockapi/models/recipient_reference.rbi +22 -5
- data/rbi/knockapi/models/recipient_request.rbi +11 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +113 -55
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/preference_set.rbi +159 -100
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
- data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
- data/rbi/knockapi/models/schedule.rbi +32 -27
- data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
- data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
- data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
- data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
- data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
- data/rbi/knockapi/models/tenant.rbi +71 -45
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
- data/rbi/knockapi/models/tenant_request.rbi +132 -57
- data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/user.rbi +32 -28
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
- data/rbi/knockapi/models/user_list_messages_params.rbi +183 -59
- data/rbi/knockapi/models/user_list_params.rbi +43 -22
- data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
- data/rbi/knockapi/models/user_merge_params.rbi +17 -6
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +199 -108
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
- data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
- data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +18 -7
- data/rbi/knockapi/resources/audiences.rbi +22 -14
- data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
- data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
- data/rbi/knockapi/resources/channels.rbi +2 -1
- data/rbi/knockapi/resources/integrations/census.rbi +8 -4
- data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
- data/rbi/knockapi/resources/integrations.rbi +2 -1
- data/rbi/knockapi/resources/messages/batch.rbi +58 -26
- data/rbi/knockapi/resources/messages.rbi +102 -43
- data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
- data/rbi/knockapi/resources/objects.rbi +177 -107
- data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
- data/rbi/knockapi/resources/providers/slack.rbi +28 -11
- data/rbi/knockapi/resources/providers.rbi +2 -1
- data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
- data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
- data/rbi/knockapi/resources/recipients.rbi +2 -1
- data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
- data/rbi/knockapi/resources/schedules.rbi +44 -33
- data/rbi/knockapi/resources/shared.rbi +2 -1
- data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
- data/rbi/knockapi/resources/tenants.rbi +51 -20
- data/rbi/knockapi/resources/users/bulk.rbi +21 -14
- data/rbi/knockapi/resources/users/feeds.rbi +20 -9
- data/rbi/knockapi/resources/users/guides.rbi +23 -16
- data/rbi/knockapi/resources/users.rbi +160 -91
- data/rbi/knockapi/resources/workflows.rbi +38 -29
- data/sig/knockapi/internal/entries_cursor.rbs +0 -2
- data/sig/knockapi/internal/items_cursor.rbs +0 -2
- data/sig/knockapi/internal/transport/base_client.rbs +16 -1
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/knockapi/internal/type/array_of.rbs +3 -0
- data/sig/knockapi/internal/type/base_model.rbs +13 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/boolean.rbs +3 -0
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +3 -0
- data/sig/knockapi/internal/type/file_input.rbs +2 -0
- data/sig/knockapi/internal/type/hash_of.rbs +3 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +3 -0
- data/sig/knockapi/internal/type/unknown.rbs +3 -0
- data/sig/knockapi/internal/util.rbs +27 -0
- data/sig/knockapi/internal.rbs +4 -0
- data/sig/knockapi/models/activity.rbs +0 -2
- data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
- data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
- data/sig/knockapi/models/audience_member.rbs +3 -5
- data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +9 -13
- data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
- data/sig/knockapi/models/condition.rbs +4 -6
- data/sig/knockapi/models/identify_user_request.rbs +0 -2
- data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
- data/sig/knockapi/models/inline_object_request.rbs +0 -2
- data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
- data/sig/knockapi/models/message.rbs +15 -23
- data/sig/knockapi/models/message_archive_params.rbs +0 -2
- data/sig/knockapi/models/message_delivery_log.rbs +24 -30
- data/sig/knockapi/models/message_event.rbs +4 -6
- data/sig/knockapi/models/message_get_content_params.rbs +0 -2
- data/sig/knockapi/models/message_get_content_response.rbs +2 -24
- data/sig/knockapi/models/message_get_params.rbs +0 -2
- data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
- data/sig/knockapi/models/message_list_events_params.rbs +0 -2
- data/sig/knockapi/models/message_list_params.rbs +30 -24
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +8 -4
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_delete_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_get_params.rbs +0 -2
- data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/object_list_params.rbs +6 -8
- data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
- data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_set_params.rbs +0 -2
- data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
- data/sig/knockapi/models/page_info.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/recipient.rbs +2 -2
- data/sig/knockapi/models/recipient_reference.rbs +2 -4
- data/sig/knockapi/models/recipient_request.rbs +3 -3
- data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
- data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
- data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
- data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/subscription.rbs +3 -5
- data/sig/knockapi/models/schedule.rbs +3 -5
- data/sig/knockapi/models/schedule_create_params.rbs +3 -5
- data/sig/knockapi/models/schedule_create_response.rbs +1 -1
- data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
- data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
- data/sig/knockapi/models/schedule_list_params.rbs +0 -2
- data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
- data/sig/knockapi/models/schedule_update_params.rbs +5 -7
- data/sig/knockapi/models/schedule_update_response.rbs +1 -1
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
- data/sig/knockapi/models/tenant.rbs +9 -15
- data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +0 -2
- data/sig/knockapi/models/tenant_list_params.rbs +0 -2
- data/sig/knockapi/models/tenant_request.rbs +13 -19
- data/sig/knockapi/models/tenant_set_params.rbs +13 -19
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
- data/sig/knockapi/models/user.rbs +0 -2
- data/sig/knockapi/models/user_delete_params.rbs +0 -2
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_get_params.rbs +0 -2
- data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/user_list_params.rbs +6 -8
- data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
- data/sig/knockapi/models/user_merge_params.rbs +0 -2
- data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
- data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
- data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
- data/sig/knockapi/models.rbs +173 -0
- data/sig/knockapi/request_options.rbs +1 -1
- data/sig/knockapi/resources/audiences.rbs +2 -2
- data/sig/knockapi/resources/bulk_operations.rbs +1 -1
- data/sig/knockapi/resources/channels/bulk.rbs +1 -1
- data/sig/knockapi/resources/messages.rbs +15 -17
- data/sig/knockapi/resources/objects/bulk.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +19 -19
- data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
- data/sig/knockapi/resources/providers/slack.rbs +1 -1
- data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
- data/sig/knockapi/resources/schedules.rbs +3 -3
- data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
- data/sig/knockapi/resources/tenants.rbs +4 -4
- data/sig/knockapi/resources/users/bulk.rbs +5 -5
- data/sig/knockapi/resources/users.rbs +19 -19
- metadata +29 -8
- data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
- data/lib/knockapi/resources/messages/activities.rb +0 -47
- data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
- data/rbi/knockapi/resources/messages/activities.rbi +0 -38
- data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
- data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -7,21 +7,21 @@ module Knockapi
|
|
7
7
|
# @!attribute entries
|
8
8
|
# A list of audience members.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::
|
11
|
-
required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
10
|
+
# @return [Array<Knockapi::AudienceMember>]
|
11
|
+
required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMember] }
|
12
12
|
|
13
13
|
# @!attribute page_info
|
14
14
|
# Pagination information for a list of resources.
|
15
15
|
#
|
16
|
-
# @return [Knockapi::
|
17
|
-
required :page_info, -> { Knockapi::
|
16
|
+
# @return [Knockapi::PageInfo]
|
17
|
+
required :page_info, -> { Knockapi::PageInfo }
|
18
18
|
|
19
19
|
# @!method initialize(entries:, page_info:)
|
20
20
|
# A paginated list of audience members.
|
21
21
|
#
|
22
|
-
# @param entries [Array<Knockapi::
|
22
|
+
# @param entries [Array<Knockapi::AudienceMember>] A list of audience members.
|
23
23
|
#
|
24
|
-
# @param page_info [Knockapi::
|
24
|
+
# @param page_info [Knockapi::PageInfo] Pagination information for a list of resources.
|
25
25
|
end
|
26
26
|
end
|
27
27
|
end
|
@@ -20,8 +20,8 @@ module Knockapi
|
|
20
20
|
# receive notifications through Knock. Users are the most common recipients of
|
21
21
|
# notifications and are always referenced by your internal identifier.
|
22
22
|
#
|
23
|
-
# @return [Knockapi::
|
24
|
-
required :user, -> { Knockapi::
|
23
|
+
# @return [Knockapi::User]
|
24
|
+
required :user, -> { Knockapi::User }
|
25
25
|
|
26
26
|
# @!attribute user_id
|
27
27
|
# The ID for the user that you set when identifying them in Knock.
|
@@ -36,8 +36,8 @@ module Knockapi
|
|
36
36
|
optional :tenant, String, nil?: true
|
37
37
|
|
38
38
|
# @!method initialize(_typename:, added_at:, user:, user_id:, tenant: nil)
|
39
|
-
# Some parameter documentations has been truncated, see
|
40
|
-
#
|
39
|
+
# Some parameter documentations has been truncated, see {Knockapi::AudienceMember}
|
40
|
+
# for more details.
|
41
41
|
#
|
42
42
|
# An audience member.
|
43
43
|
#
|
@@ -45,8 +45,7 @@ module Knockapi
|
|
45
45
|
#
|
46
46
|
# @param added_at [Time] Timestamp when the resource was created.
|
47
47
|
#
|
48
|
-
# @param user [Knockapi::
|
49
|
-
# ...
|
48
|
+
# @param user [Knockapi::User] A [User](/concepts/users) represents an individual in your system who can receiv
|
50
49
|
#
|
51
50
|
# @param user_id [String] The ID for the user that you set when identifying them in Knock.
|
52
51
|
#
|
@@ -10,20 +10,23 @@ module Knockapi
|
|
10
10
|
# @!attribute members
|
11
11
|
# A list of audience members to remove.
|
12
12
|
#
|
13
|
-
# @return [Array<Knockapi::
|
13
|
+
# @return [Array<Knockapi::AudienceRemoveMembersParams::Member>]
|
14
14
|
required :members,
|
15
|
-
-> {
|
15
|
+
-> {
|
16
|
+
Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member]
|
17
|
+
}
|
16
18
|
|
17
19
|
# @!method initialize(members:, request_options: {})
|
18
|
-
# @param members [Array<Knockapi::
|
20
|
+
# @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
19
21
|
#
|
20
22
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
23
|
|
22
24
|
class Member < Knockapi::Internal::Type::BaseModel
|
23
25
|
# @!attribute user
|
26
|
+
# An object containing the user's ID.
|
24
27
|
#
|
25
|
-
# @return [Knockapi::
|
26
|
-
required :user, -> { Knockapi::
|
28
|
+
# @return [Knockapi::AudienceRemoveMembersParams::Member::User]
|
29
|
+
required :user, -> { Knockapi::AudienceRemoveMembersParams::Member::User }
|
27
30
|
|
28
31
|
# @!attribute tenant
|
29
32
|
# The unique identifier for the tenant.
|
@@ -34,11 +37,11 @@ module Knockapi
|
|
34
37
|
# @!method initialize(user:, tenant: nil)
|
35
38
|
# An audience member.
|
36
39
|
#
|
37
|
-
# @param user [Knockapi::
|
40
|
+
# @param user [Knockapi::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
|
38
41
|
#
|
39
42
|
# @param tenant [String, nil] The unique identifier for the tenant.
|
40
43
|
|
41
|
-
# @see Knockapi::
|
44
|
+
# @see Knockapi::AudienceRemoveMembersParams::Member#user
|
42
45
|
class User < Knockapi::Internal::Type::BaseModel
|
43
46
|
# @!attribute id
|
44
47
|
# The ID for the user that you set when identifying them in Knock.
|
@@ -47,6 +50,8 @@ module Knockapi
|
|
47
50
|
optional :id, String
|
48
51
|
|
49
52
|
# @!method initialize(id: nil)
|
53
|
+
# An object containing the user's ID.
|
54
|
+
#
|
50
55
|
# @param id [String] The ID for the user that you set when identifying them in Knock.
|
51
56
|
end
|
52
57
|
end
|
@@ -43,8 +43,8 @@ module Knockapi
|
|
43
43
|
# @!attribute status
|
44
44
|
# The status of the bulk operation.
|
45
45
|
#
|
46
|
-
# @return [Symbol, Knockapi::
|
47
|
-
required :status, enum: -> { Knockapi::
|
46
|
+
# @return [Symbol, Knockapi::BulkOperation::Status]
|
47
|
+
required :status, enum: -> { Knockapi::BulkOperation::Status }
|
48
48
|
|
49
49
|
# @!attribute success_count
|
50
50
|
# The number of successful operations.
|
@@ -73,9 +73,8 @@ module Knockapi
|
|
73
73
|
# @!attribute error_items
|
74
74
|
# A list of items that failed to be processed.
|
75
75
|
#
|
76
|
-
# @return [Array<Knockapi::
|
77
|
-
optional :error_items,
|
78
|
-
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::Models::BulkOperation::ErrorItem] }
|
76
|
+
# @return [Array<Knockapi::BulkOperation::ErrorItem>, nil]
|
77
|
+
optional :error_items, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::BulkOperation::ErrorItem] }
|
79
78
|
|
80
79
|
# @!attribute failed_at
|
81
80
|
# Timestamp when the bulk operation failed.
|
@@ -110,7 +109,7 @@ module Knockapi
|
|
110
109
|
#
|
111
110
|
# @param processed_rows [Integer] The number of rows processed so far.
|
112
111
|
#
|
113
|
-
# @param status [Symbol, Knockapi::
|
112
|
+
# @param status [Symbol, Knockapi::BulkOperation::Status] The status of the bulk operation.
|
114
113
|
#
|
115
114
|
# @param success_count [Integer] The number of successful operations.
|
116
115
|
#
|
@@ -120,7 +119,7 @@ module Knockapi
|
|
120
119
|
#
|
121
120
|
# @param error_count [Integer] The number of failed operations.
|
122
121
|
#
|
123
|
-
# @param error_items [Array<Knockapi::
|
122
|
+
# @param error_items [Array<Knockapi::BulkOperation::ErrorItem>] A list of items that failed to be processed.
|
124
123
|
#
|
125
124
|
# @param failed_at [Time, nil] Timestamp when the bulk operation failed.
|
126
125
|
#
|
@@ -130,7 +129,7 @@ module Knockapi
|
|
130
129
|
|
131
130
|
# The status of the bulk operation.
|
132
131
|
#
|
133
|
-
# @see Knockapi::
|
132
|
+
# @see Knockapi::BulkOperation#status
|
134
133
|
module Status
|
135
134
|
extend Knockapi::Internal::Type::Enum
|
136
135
|
|
@@ -11,22 +11,24 @@ module Knockapi
|
|
11
11
|
# @!attribute archived
|
12
12
|
# Limits the results to messages with the given archived status.
|
13
13
|
#
|
14
|
-
# @return [Symbol, Knockapi::
|
15
|
-
optional :archived, enum: -> { Knockapi::
|
14
|
+
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived, nil]
|
15
|
+
optional :archived, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Archived }
|
16
16
|
|
17
17
|
# @!attribute delivery_status
|
18
18
|
# Limits the results to messages with the given delivery status.
|
19
19
|
#
|
20
|
-
# @return [Symbol, Knockapi::
|
20
|
+
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
|
21
21
|
optional :delivery_status,
|
22
|
-
enum: -> {
|
22
|
+
enum: -> {
|
23
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus
|
24
|
+
}
|
23
25
|
|
24
26
|
# @!attribute engagement_status
|
25
27
|
# Limits the results to messages with the given engagement status.
|
26
28
|
#
|
27
|
-
# @return [Symbol, Knockapi::
|
29
|
+
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
|
28
30
|
optional :engagement_status,
|
29
|
-
enum: -> { Knockapi::
|
31
|
+
enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
|
30
32
|
|
31
33
|
# @!attribute has_tenant
|
32
34
|
# Limits the results to messages that have a tenant or not.
|
@@ -76,11 +78,11 @@ module Knockapi
|
|
76
78
|
# Some parameter documentations has been truncated, see
|
77
79
|
# {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
|
78
80
|
#
|
79
|
-
# @param archived [Symbol, Knockapi::
|
81
|
+
# @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
|
80
82
|
#
|
81
|
-
# @param delivery_status [Symbol, Knockapi::
|
83
|
+
# @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
|
82
84
|
#
|
83
|
-
# @param engagement_status [Symbol, Knockapi::
|
85
|
+
# @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
|
84
86
|
#
|
85
87
|
# @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
|
86
88
|
#
|
@@ -93,7 +95,6 @@ module Knockapi
|
|
93
95
|
# @param tenants [Array<String>] Limits the results to messages with the given tenant IDs.
|
94
96
|
#
|
95
97
|
# @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
|
96
|
-
# ...
|
97
98
|
#
|
98
99
|
# @param workflows [Array<String>] Limits the results to messages with the given workflow keys.
|
99
100
|
#
|
@@ -12,8 +12,8 @@ module Knockapi
|
|
12
12
|
# @!attribute operator
|
13
13
|
# The operator to use in the condition evaluation.
|
14
14
|
#
|
15
|
-
# @return [Symbol, Knockapi::
|
16
|
-
required :operator, enum: -> { Knockapi::
|
15
|
+
# @return [Symbol, Knockapi::Condition::Operator]
|
16
|
+
required :operator, enum: -> { Knockapi::Condition::Operator }
|
17
17
|
|
18
18
|
# @!attribute variable
|
19
19
|
# The variable to be evaluated in the condition.
|
@@ -26,13 +26,13 @@ module Knockapi
|
|
26
26
|
#
|
27
27
|
# @param argument [String, nil] The argument value to compare against in the condition.
|
28
28
|
#
|
29
|
-
# @param operator [Symbol, Knockapi::
|
29
|
+
# @param operator [Symbol, Knockapi::Condition::Operator] The operator to use in the condition evaluation.
|
30
30
|
#
|
31
31
|
# @param variable [String] The variable to be evaluated in the condition.
|
32
32
|
|
33
33
|
# The operator to use in the condition evaluation.
|
34
34
|
#
|
35
|
-
# @see Knockapi::
|
35
|
+
# @see Knockapi::Condition#operator
|
36
36
|
module Operator
|
37
37
|
extend Knockapi::Internal::Type::Enum
|
38
38
|
|
@@ -12,9 +12,11 @@ module Knockapi
|
|
12
12
|
# @!attribute channel_data
|
13
13
|
# A request to set channel data for a type of channel inline.
|
14
14
|
#
|
15
|
-
# @return [Hash{Symbol=>Knockapi::
|
15
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
16
16
|
optional :channel_data,
|
17
|
-
-> {
|
17
|
+
-> {
|
18
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
19
|
+
},
|
18
20
|
nil?: true
|
19
21
|
|
20
22
|
# @!attribute created_at
|
@@ -42,7 +44,7 @@ module Knockapi
|
|
42
44
|
optional :name, String, nil?: true
|
43
45
|
|
44
46
|
# @!attribute phone_number
|
45
|
-
# The
|
47
|
+
# The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
46
48
|
# user (required for SMS channels).
|
47
49
|
#
|
48
50
|
# @return [String, nil]
|
@@ -51,23 +53,23 @@ module Knockapi
|
|
51
53
|
# @!attribute preferences
|
52
54
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
53
55
|
#
|
54
|
-
# @return [Hash{Symbol=>Knockapi::
|
56
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
55
57
|
optional :preferences,
|
56
|
-
-> { Knockapi::Internal::Type::HashOf[Knockapi::
|
58
|
+
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
57
59
|
nil?: true
|
58
60
|
|
59
61
|
# @!attribute timezone
|
60
|
-
# The timezone of the user. Must be a
|
61
|
-
# [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
62
|
-
# Used
|
63
|
-
# [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
62
|
+
# The timezone of the user. Must be a
|
63
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
64
|
+
# Used
|
65
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
64
66
|
#
|
65
67
|
# @return [String, nil]
|
66
68
|
optional :timezone, String, nil?: true
|
67
69
|
|
68
70
|
# @!method initialize(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
|
69
71
|
# Some parameter documentations has been truncated, see
|
70
|
-
# {Knockapi::
|
72
|
+
# {Knockapi::IdentifyUserRequest} for more details.
|
71
73
|
#
|
72
74
|
# A set of parameters to identify a user with. Does not include the user ID, as
|
73
75
|
# that's specified elsewhere in the request. You can supply any additional
|
@@ -75,24 +77,21 @@ module Knockapi
|
|
75
77
|
#
|
76
78
|
# @param avatar [String, nil] URL to the user's avatar image.
|
77
79
|
#
|
78
|
-
# @param channel_data [Hash{Symbol=>Knockapi::
|
80
|
+
# @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.
|
79
81
|
#
|
80
82
|
# @param created_at [Time, nil] The creation date of the user from your system.
|
81
83
|
#
|
82
84
|
# @param email [String, nil] The primary email address for the user.
|
83
85
|
#
|
84
86
|
# @param locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
|
85
|
-
# ...
|
86
87
|
#
|
87
88
|
# @param name [String, nil] Display name of the user.
|
88
89
|
#
|
89
|
-
# @param phone_number [String, nil] The
|
90
|
-
# ...
|
90
|
+
# @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
91
91
|
#
|
92
|
-
# @param preferences [Hash{Symbol=>Knockapi::
|
92
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
93
93
|
#
|
94
|
-
# @param timezone [String, nil] The timezone of the user. Must be a valid
|
95
|
-
# ...
|
94
|
+
# @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
|
96
95
|
end
|
97
96
|
end
|
98
97
|
end
|
@@ -9,12 +9,20 @@ module Knockapi
|
|
9
9
|
# @return [String]
|
10
10
|
required :id, String
|
11
11
|
|
12
|
+
# @!attribute avatar
|
13
|
+
# URL to the user's avatar image.
|
14
|
+
#
|
15
|
+
# @return [String, nil]
|
16
|
+
optional :avatar, String, nil?: true
|
17
|
+
|
12
18
|
# @!attribute channel_data
|
13
19
|
# A request to set channel data for a type of channel inline.
|
14
20
|
#
|
15
|
-
# @return [Hash{Symbol=>Knockapi::
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
16
22
|
optional :channel_data,
|
17
|
-
-> {
|
23
|
+
-> {
|
24
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
25
|
+
},
|
18
26
|
nil?: true
|
19
27
|
|
20
28
|
# @!attribute created_at
|
@@ -23,15 +31,52 @@ module Knockapi
|
|
23
31
|
# @return [Time, nil]
|
24
32
|
optional :created_at, Time, nil?: true
|
25
33
|
|
34
|
+
# @!attribute email
|
35
|
+
# The primary email address for the user.
|
36
|
+
#
|
37
|
+
# @return [String, nil]
|
38
|
+
optional :email, String, nil?: true
|
39
|
+
|
40
|
+
# @!attribute locale
|
41
|
+
# The locale of the user. Used for [message localization](/concepts/translations).
|
42
|
+
#
|
43
|
+
# @return [String, nil]
|
44
|
+
optional :locale, String, nil?: true
|
45
|
+
|
46
|
+
# @!attribute name
|
47
|
+
# Display name of the user.
|
48
|
+
#
|
49
|
+
# @return [String, nil]
|
50
|
+
optional :name, String, nil?: true
|
51
|
+
|
52
|
+
# @!attribute phone_number
|
53
|
+
# The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
54
|
+
# user (required for SMS channels).
|
55
|
+
#
|
56
|
+
# @return [String, nil]
|
57
|
+
optional :phone_number, String, nil?: true
|
58
|
+
|
26
59
|
# @!attribute preferences
|
27
60
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
28
61
|
#
|
29
|
-
# @return [Hash{Symbol=>Knockapi::
|
62
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
30
63
|
optional :preferences,
|
31
|
-
-> { Knockapi::Internal::Type::HashOf[Knockapi::
|
64
|
+
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
32
65
|
nil?: true
|
33
66
|
|
34
|
-
# @!
|
67
|
+
# @!attribute timezone
|
68
|
+
# The timezone of the user. Must be a
|
69
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
70
|
+
# Used
|
71
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
72
|
+
#
|
73
|
+
# @return [String, nil]
|
74
|
+
optional :timezone, String, nil?: true
|
75
|
+
|
76
|
+
# @!method initialize(id:, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
|
77
|
+
# Some parameter documentations has been truncated, see
|
78
|
+
# {Knockapi::InlineIdentifyUserRequest} for more details.
|
79
|
+
#
|
35
80
|
# A set of parameters to inline-identify a user with. Inline identifying the user
|
36
81
|
# will ensure that the user is available before the request is executed in Knock.
|
37
82
|
# It will perform an upsert for the user you're supplying, replacing any
|
@@ -39,11 +84,23 @@ module Knockapi
|
|
39
84
|
#
|
40
85
|
# @param id [String] The ID for the user that you set when identifying them in Knock.
|
41
86
|
#
|
42
|
-
# @param
|
87
|
+
# @param avatar [String, nil] URL to the user's avatar image.
|
88
|
+
#
|
89
|
+
# @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.
|
43
90
|
#
|
44
91
|
# @param created_at [Time, nil] The creation date of the user from your system.
|
45
92
|
#
|
46
|
-
# @param
|
93
|
+
# @param email [String, nil] The primary email address for the user.
|
94
|
+
#
|
95
|
+
# @param locale [String, nil] The locale of the user. Used for [message localization](/concepts/translations).
|
96
|
+
#
|
97
|
+
# @param name [String, nil] Display name of the user.
|
98
|
+
#
|
99
|
+
# @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
100
|
+
#
|
101
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
102
|
+
#
|
103
|
+
# @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
|
47
104
|
end
|
48
105
|
end
|
49
106
|
end
|
@@ -18,9 +18,11 @@ module Knockapi
|
|
18
18
|
# @!attribute channel_data
|
19
19
|
# A request to set channel data for a type of channel inline.
|
20
20
|
#
|
21
|
-
# @return [Hash{Symbol=>Knockapi::
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
22
22
|
optional :channel_data,
|
23
|
-
-> {
|
23
|
+
-> {
|
24
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
25
|
+
},
|
24
26
|
nil?: true
|
25
27
|
|
26
28
|
# @!attribute created_at
|
@@ -32,9 +34,9 @@ module Knockapi
|
|
32
34
|
# @!attribute preferences
|
33
35
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
34
36
|
#
|
35
|
-
# @return [Hash{Symbol=>Knockapi::
|
37
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
36
38
|
optional :preferences,
|
37
|
-
-> { Knockapi::Internal::Type::HashOf[Knockapi::
|
39
|
+
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
38
40
|
nil?: true
|
39
41
|
|
40
42
|
# @!method initialize(id:, collection:, channel_data: nil, created_at: nil, preferences: nil)
|
@@ -44,11 +46,11 @@ module Knockapi
|
|
44
46
|
#
|
45
47
|
# @param collection [String] The collection this object belongs to.
|
46
48
|
#
|
47
|
-
# @param channel_data [Hash{Symbol=>Knockapi::
|
49
|
+
# @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.
|
48
50
|
#
|
49
51
|
# @param created_at [Time, nil] Timestamp when the resource was created.
|
50
52
|
#
|
51
|
-
# @param preferences [Hash{Symbol=>Knockapi::
|
53
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
52
54
|
end
|
53
55
|
end
|
54
56
|
end
|
@@ -10,10 +10,10 @@ module Knockapi
|
|
10
10
|
variant String
|
11
11
|
|
12
12
|
# A tenant to be set in the system. You can supply any additional properties on the tenant object.
|
13
|
-
variant -> { Knockapi::
|
13
|
+
variant -> { Knockapi::TenantRequest }
|
14
14
|
|
15
15
|
# @!method self.variants
|
16
|
-
# @return [Array(String, Knockapi::
|
16
|
+
# @return [Array(String, Knockapi::TenantRequest)]
|
17
17
|
end
|
18
18
|
end
|
19
19
|
end
|
@@ -21,8 +21,8 @@ module Knockapi
|
|
21
21
|
# that can contain up to 10 actors if the message is produced from a
|
22
22
|
# [batch](/designing-workflows/batch-function).
|
23
23
|
#
|
24
|
-
# @return [Array<String, Knockapi::
|
25
|
-
optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
24
|
+
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
25
|
+
optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
26
26
|
|
27
27
|
# @!attribute archived_at
|
28
28
|
# Timestamp when the message was archived.
|
@@ -55,9 +55,9 @@ module Knockapi
|
|
55
55
|
# @!attribute engagement_statuses
|
56
56
|
# A list of engagement statuses.
|
57
57
|
#
|
58
|
-
# @return [Array<Symbol, Knockapi::
|
58
|
+
# @return [Array<Symbol, Knockapi::Message::EngagementStatus>, nil]
|
59
59
|
optional :engagement_statuses,
|
60
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::
|
60
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
|
61
61
|
|
62
62
|
# @!attribute inserted_at
|
63
63
|
# Timestamp when the resource was created.
|
@@ -93,8 +93,8 @@ module Knockapi
|
|
93
93
|
# A reference to a recipient, either a user identifier (string) or an object
|
94
94
|
# reference (ID, collection).
|
95
95
|
#
|
96
|
-
# @return [String, Knockapi::
|
97
|
-
optional :recipient, union: -> { Knockapi::
|
96
|
+
# @return [String, Knockapi::RecipientReference::ObjectReference, nil]
|
97
|
+
optional :recipient, union: -> { Knockapi::RecipientReference }
|
98
98
|
|
99
99
|
# @!attribute scheduled_at
|
100
100
|
# Timestamp when the message was scheduled to be sent.
|
@@ -111,14 +111,14 @@ module Knockapi
|
|
111
111
|
# @!attribute source
|
112
112
|
# The workflow that triggered the message.
|
113
113
|
#
|
114
|
-
# @return [Knockapi::
|
115
|
-
optional :source, -> { Knockapi::
|
114
|
+
# @return [Knockapi::Message::Source, nil]
|
115
|
+
optional :source, -> { Knockapi::Message::Source }
|
116
116
|
|
117
117
|
# @!attribute status
|
118
118
|
# The message delivery status.
|
119
119
|
#
|
120
|
-
# @return [Symbol, Knockapi::
|
121
|
-
optional :status, enum: -> { Knockapi::
|
120
|
+
# @return [Symbol, Knockapi::Message::Status, nil]
|
121
|
+
optional :status, enum: -> { Knockapi::Message::Status }
|
122
122
|
|
123
123
|
# @!attribute tenant
|
124
124
|
# The ID of the `tenant` associated with the message. Only present when a `tenant`
|
@@ -142,8 +142,8 @@ module Knockapi
|
|
142
142
|
optional :workflow, String, nil?: true
|
143
143
|
|
144
144
|
# @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil)
|
145
|
-
# Some parameter documentations has been truncated, see
|
146
|
-
#
|
145
|
+
# Some parameter documentations has been truncated, see {Knockapi::Message} for
|
146
|
+
# more details.
|
147
147
|
#
|
148
148
|
# Represents a single message that was generated by a workflow for a given
|
149
149
|
# channel.
|
@@ -152,8 +152,7 @@ module Knockapi
|
|
152
152
|
#
|
153
153
|
# @param _typename [String] The typename of the schema.
|
154
154
|
#
|
155
|
-
# @param actors [Array<String, Knockapi::
|
156
|
-
# ...
|
155
|
+
# @param actors [Array<String, Knockapi::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
|
157
156
|
#
|
158
157
|
# @param archived_at [Time, nil] Timestamp when the message was archived.
|
159
158
|
#
|
@@ -162,9 +161,8 @@ module Knockapi
|
|
162
161
|
# @param clicked_at [Time, nil] Timestamp when the message was clicked.
|
163
162
|
#
|
164
163
|
# @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
|
165
|
-
# ...
|
166
164
|
#
|
167
|
-
# @param engagement_statuses [Array<Symbol, Knockapi::
|
165
|
+
# @param engagement_statuses [Array<Symbol, Knockapi::Message::EngagementStatus>] A list of engagement statuses.
|
168
166
|
#
|
169
167
|
# @param inserted_at [Time] Timestamp when the resource was created.
|
170
168
|
#
|
@@ -176,19 +174,17 @@ module Knockapi
|
|
176
174
|
#
|
177
175
|
# @param read_at [Time, nil] Timestamp when the message was read.
|
178
176
|
#
|
179
|
-
# @param recipient [String, Knockapi::
|
180
|
-
# ...
|
177
|
+
# @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
181
178
|
#
|
182
179
|
# @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
|
183
180
|
#
|
184
181
|
# @param seen_at [Time, nil] Timestamp when the message was seen.
|
185
182
|
#
|
186
|
-
# @param source [Knockapi::
|
183
|
+
# @param source [Knockapi::Message::Source] The workflow that triggered the message.
|
187
184
|
#
|
188
|
-
# @param status [Symbol, Knockapi::
|
185
|
+
# @param status [Symbol, Knockapi::Message::Status] The message delivery status.
|
189
186
|
#
|
190
187
|
# @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
|
191
|
-
# ...
|
192
188
|
#
|
193
189
|
# @param updated_at [Time] The timestamp when the resource was last updated.
|
194
190
|
#
|
@@ -209,7 +205,7 @@ module Knockapi
|
|
209
205
|
# @return [Array<Symbol>]
|
210
206
|
end
|
211
207
|
|
212
|
-
# @see Knockapi::
|
208
|
+
# @see Knockapi::Message#source
|
213
209
|
class Source < Knockapi::Internal::Type::BaseModel
|
214
210
|
# @!attribute _typename
|
215
211
|
#
|
@@ -248,7 +244,7 @@ module Knockapi
|
|
248
244
|
|
249
245
|
# The message delivery status.
|
250
246
|
#
|
251
|
-
# @see Knockapi::
|
247
|
+
# @see Knockapi::Message#status
|
252
248
|
module Status
|
253
249
|
extend Knockapi::Internal::Type::Enum
|
254
250
|
|