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
@@ -9,7 +9,7 @@ module Knockapi
|
|
9
9
|
channel_id: String,
|
10
10
|
clicked_at: Time?,
|
11
11
|
data: ::Hash[Symbol, top]?,
|
12
|
-
engagement_statuses: ::Array[Knockapi::
|
12
|
+
engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
13
13
|
inserted_at: Time,
|
14
14
|
interacted_at: Time?,
|
15
15
|
link_clicked_at: Time?,
|
@@ -18,8 +18,8 @@ module Knockapi
|
|
18
18
|
recipient: Knockapi::Models::recipient_reference,
|
19
19
|
scheduled_at: Time?,
|
20
20
|
seen_at: Time?,
|
21
|
-
source: Knockapi::
|
22
|
-
status: Knockapi::
|
21
|
+
source: Knockapi::Message::Source,
|
22
|
+
status: Knockapi::Message::status,
|
23
23
|
tenant: String?,
|
24
24
|
updated_at: Time,
|
25
25
|
workflow: String?
|
@@ -50,11 +50,11 @@ module Knockapi
|
|
50
50
|
|
51
51
|
attr_accessor data: ::Hash[Symbol, top]?
|
52
52
|
|
53
|
-
attr_reader engagement_statuses: ::Array[Knockapi::
|
53
|
+
attr_reader engagement_statuses: ::Array[Knockapi::Message::engagement_status]?
|
54
54
|
|
55
55
|
def engagement_statuses=: (
|
56
|
-
::Array[Knockapi::
|
57
|
-
) -> ::Array[Knockapi::
|
56
|
+
::Array[Knockapi::Message::engagement_status]
|
57
|
+
) -> ::Array[Knockapi::Message::engagement_status]
|
58
58
|
|
59
59
|
attr_reader inserted_at: Time?
|
60
60
|
|
@@ -78,17 +78,13 @@ module Knockapi
|
|
78
78
|
|
79
79
|
attr_accessor seen_at: Time?
|
80
80
|
|
81
|
-
attr_reader source: Knockapi::
|
81
|
+
attr_reader source: Knockapi::Message::Source?
|
82
82
|
|
83
|
-
def source=: (
|
84
|
-
Knockapi::Models::Message::Source
|
85
|
-
) -> Knockapi::Models::Message::Source
|
83
|
+
def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source
|
86
84
|
|
87
|
-
attr_reader status: Knockapi::
|
85
|
+
attr_reader status: Knockapi::Message::status?
|
88
86
|
|
89
|
-
def status=: (
|
90
|
-
Knockapi::Models::Message::status
|
91
|
-
) -> Knockapi::Models::Message::status
|
87
|
+
def status=: (Knockapi::Message::status) -> Knockapi::Message::status
|
92
88
|
|
93
89
|
attr_accessor tenant: String?
|
94
90
|
|
@@ -106,7 +102,7 @@ module Knockapi
|
|
106
102
|
?channel_id: String,
|
107
103
|
?clicked_at: Time?,
|
108
104
|
?data: ::Hash[Symbol, top]?,
|
109
|
-
?engagement_statuses: ::Array[Knockapi::
|
105
|
+
?engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
110
106
|
?inserted_at: Time,
|
111
107
|
?interacted_at: Time?,
|
112
108
|
?link_clicked_at: Time?,
|
@@ -115,15 +111,13 @@ module Knockapi
|
|
115
111
|
?recipient: Knockapi::Models::recipient_reference,
|
116
112
|
?scheduled_at: Time?,
|
117
113
|
?seen_at: Time?,
|
118
|
-
?source: Knockapi::
|
119
|
-
?status: Knockapi::
|
114
|
+
?source: Knockapi::Message::Source,
|
115
|
+
?status: Knockapi::Message::status,
|
120
116
|
?tenant: String?,
|
121
117
|
?updated_at: Time,
|
122
118
|
?workflow: String?
|
123
119
|
) -> void
|
124
120
|
|
125
|
-
def to_hash: -> Knockapi::Models::message
|
126
|
-
|
127
121
|
type engagement_status =
|
128
122
|
:seen | :read | :interacted | :link_clicked | :archived
|
129
123
|
|
@@ -136,7 +130,7 @@ module Knockapi
|
|
136
130
|
LINK_CLICKED: :link_clicked
|
137
131
|
ARCHIVED: :archived
|
138
132
|
|
139
|
-
def self?.values: -> ::Array[Knockapi::
|
133
|
+
def self?.values: -> ::Array[Knockapi::Message::engagement_status]
|
140
134
|
end
|
141
135
|
|
142
136
|
type source =
|
@@ -162,8 +156,6 @@ module Knockapi
|
|
162
156
|
key: String,
|
163
157
|
version_id: String
|
164
158
|
) -> void
|
165
|
-
|
166
|
-
def to_hash: -> Knockapi::Models::Message::source
|
167
159
|
end
|
168
160
|
|
169
161
|
type status =
|
@@ -186,7 +178,7 @@ module Knockapi
|
|
186
178
|
NOT_SENT: :not_sent
|
187
179
|
BOUNCED: :bounced
|
188
180
|
|
189
|
-
def self?.values: -> ::Array[Knockapi::
|
181
|
+
def self?.values: -> ::Array[Knockapi::Message::status]
|
190
182
|
end
|
191
183
|
end
|
192
184
|
end
|
@@ -6,8 +6,8 @@ module Knockapi
|
|
6
6
|
_typename: String,
|
7
7
|
environment_id: String,
|
8
8
|
inserted_at: String,
|
9
|
-
request: Knockapi::
|
10
|
-
response: Knockapi::
|
9
|
+
request: Knockapi::MessageDeliveryLog::Request,
|
10
|
+
response: Knockapi::MessageDeliveryLog::Response,
|
11
11
|
service_name: String
|
12
12
|
}
|
13
13
|
|
@@ -20,9 +20,9 @@ module Knockapi
|
|
20
20
|
|
21
21
|
attr_accessor inserted_at: String
|
22
22
|
|
23
|
-
attr_accessor request: Knockapi::
|
23
|
+
attr_accessor request: Knockapi::MessageDeliveryLog::Request
|
24
24
|
|
25
|
-
attr_accessor response: Knockapi::
|
25
|
+
attr_accessor response: Knockapi::MessageDeliveryLog::Response
|
26
26
|
|
27
27
|
attr_accessor service_name: String
|
28
28
|
|
@@ -31,29 +31,27 @@ module Knockapi
|
|
31
31
|
_typename: String,
|
32
32
|
environment_id: String,
|
33
33
|
inserted_at: String,
|
34
|
-
request: Knockapi::
|
35
|
-
response: Knockapi::
|
34
|
+
request: Knockapi::MessageDeliveryLog::Request,
|
35
|
+
response: Knockapi::MessageDeliveryLog::Response,
|
36
36
|
service_name: String
|
37
37
|
) -> void
|
38
38
|
|
39
|
-
def to_hash: -> Knockapi::Models::message_delivery_log
|
40
|
-
|
41
39
|
type request =
|
42
40
|
{
|
43
|
-
body: Knockapi::
|
41
|
+
body: Knockapi::MessageDeliveryLog::Request::body,
|
44
42
|
headers: ::Hash[Symbol, top]?,
|
45
43
|
host: String,
|
46
|
-
method_: Knockapi::
|
44
|
+
method_: Knockapi::MessageDeliveryLog::Request::method_,
|
47
45
|
path: String,
|
48
46
|
query: String?
|
49
47
|
}
|
50
48
|
|
51
49
|
class Request < Knockapi::Internal::Type::BaseModel
|
52
|
-
attr_reader body: Knockapi::
|
50
|
+
attr_reader body: Knockapi::MessageDeliveryLog::Request::body?
|
53
51
|
|
54
52
|
def body=: (
|
55
|
-
Knockapi::
|
56
|
-
) -> Knockapi::
|
53
|
+
Knockapi::MessageDeliveryLog::Request::body
|
54
|
+
) -> Knockapi::MessageDeliveryLog::Request::body
|
57
55
|
|
58
56
|
attr_accessor headers: ::Hash[Symbol, top]?
|
59
57
|
|
@@ -61,11 +59,11 @@ module Knockapi
|
|
61
59
|
|
62
60
|
def host=: (String) -> String
|
63
61
|
|
64
|
-
attr_reader method_: Knockapi::
|
62
|
+
attr_reader method_: Knockapi::MessageDeliveryLog::Request::method_?
|
65
63
|
|
66
64
|
def method_=: (
|
67
|
-
Knockapi::
|
68
|
-
) -> Knockapi::
|
65
|
+
Knockapi::MessageDeliveryLog::Request::method_
|
66
|
+
) -> Knockapi::MessageDeliveryLog::Request::method_
|
69
67
|
|
70
68
|
attr_reader path: String?
|
71
69
|
|
@@ -74,22 +72,20 @@ module Knockapi
|
|
74
72
|
attr_accessor query: String?
|
75
73
|
|
76
74
|
def initialize: (
|
77
|
-
?body: Knockapi::
|
75
|
+
?body: Knockapi::MessageDeliveryLog::Request::body,
|
78
76
|
?headers: ::Hash[Symbol, top]?,
|
79
77
|
?host: String,
|
80
|
-
?method_: Knockapi::
|
78
|
+
?method_: Knockapi::MessageDeliveryLog::Request::method_,
|
81
79
|
?path: String,
|
82
80
|
?query: String?
|
83
81
|
) -> void
|
84
82
|
|
85
|
-
def to_hash: -> Knockapi::Models::MessageDeliveryLog::request
|
86
|
-
|
87
83
|
type body = String | ::Hash[Symbol, top]
|
88
84
|
|
89
85
|
module Body
|
90
86
|
extend Knockapi::Internal::Type::Union
|
91
87
|
|
92
|
-
def self?.variants: -> [
|
88
|
+
def self?.variants: -> ::Array[Knockapi::MessageDeliveryLog::Request::body]
|
93
89
|
|
94
90
|
UnionMember1Map: Knockapi::Internal::Type::Converter
|
95
91
|
end
|
@@ -105,23 +101,23 @@ module Knockapi
|
|
105
101
|
DELETE: :DELETE
|
106
102
|
PATCH: :PATCH
|
107
103
|
|
108
|
-
def self?.values: -> ::Array[Knockapi::
|
104
|
+
def self?.values: -> ::Array[Knockapi::MessageDeliveryLog::Request::method_]
|
109
105
|
end
|
110
106
|
end
|
111
107
|
|
112
108
|
type response =
|
113
109
|
{
|
114
|
-
body: Knockapi::
|
110
|
+
body: Knockapi::MessageDeliveryLog::Response::body,
|
115
111
|
headers: ::Hash[Symbol, top]?,
|
116
112
|
status: Integer
|
117
113
|
}
|
118
114
|
|
119
115
|
class Response < Knockapi::Internal::Type::BaseModel
|
120
|
-
attr_reader body: Knockapi::
|
116
|
+
attr_reader body: Knockapi::MessageDeliveryLog::Response::body?
|
121
117
|
|
122
118
|
def body=: (
|
123
|
-
Knockapi::
|
124
|
-
) -> Knockapi::
|
119
|
+
Knockapi::MessageDeliveryLog::Response::body
|
120
|
+
) -> Knockapi::MessageDeliveryLog::Response::body
|
125
121
|
|
126
122
|
attr_accessor headers: ::Hash[Symbol, top]?
|
127
123
|
|
@@ -130,19 +126,17 @@ module Knockapi
|
|
130
126
|
def status=: (Integer) -> Integer
|
131
127
|
|
132
128
|
def initialize: (
|
133
|
-
?body: Knockapi::
|
129
|
+
?body: Knockapi::MessageDeliveryLog::Response::body,
|
134
130
|
?headers: ::Hash[Symbol, top]?,
|
135
131
|
?status: Integer
|
136
132
|
) -> void
|
137
133
|
|
138
|
-
def to_hash: -> Knockapi::Models::MessageDeliveryLog::response
|
139
|
-
|
140
134
|
type body = String | ::Hash[Symbol, top]
|
141
135
|
|
142
136
|
module Body
|
143
137
|
extend Knockapi::Internal::Type::Union
|
144
138
|
|
145
|
-
def self?.variants: -> [
|
139
|
+
def self?.variants: -> ::Array[Knockapi::MessageDeliveryLog::Response::body]
|
146
140
|
|
147
141
|
UnionMember1Map: Knockapi::Internal::Type::Converter
|
148
142
|
end
|
@@ -6,7 +6,7 @@ module Knockapi
|
|
6
6
|
_typename: String,
|
7
7
|
inserted_at: Time,
|
8
8
|
recipient: Knockapi::Models::recipient_reference,
|
9
|
-
type: Knockapi::
|
9
|
+
type: Knockapi::MessageEvent::type_,
|
10
10
|
data: ::Hash[Symbol, top]?
|
11
11
|
}
|
12
12
|
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
|
20
20
|
attr_accessor recipient: Knockapi::Models::recipient_reference
|
21
21
|
|
22
|
-
attr_accessor type: Knockapi::
|
22
|
+
attr_accessor type: Knockapi::MessageEvent::type_
|
23
23
|
|
24
24
|
attr_accessor data: ::Hash[Symbol, top]?
|
25
25
|
|
@@ -28,12 +28,10 @@ module Knockapi
|
|
28
28
|
_typename: String,
|
29
29
|
inserted_at: Time,
|
30
30
|
recipient: Knockapi::Models::recipient_reference,
|
31
|
-
type: Knockapi::
|
31
|
+
type: Knockapi::MessageEvent::type_,
|
32
32
|
?data: ::Hash[Symbol, top]?
|
33
33
|
) -> void
|
34
34
|
|
35
|
-
def to_hash: -> Knockapi::Models::message_event
|
36
|
-
|
37
35
|
type type_ =
|
38
36
|
:"message.archived"
|
39
37
|
| :"message.bounced"
|
@@ -70,7 +68,7 @@ module Knockapi
|
|
70
68
|
MESSAGE_UNREAD: :"message.unread"
|
71
69
|
MESSAGE_UNSEEN: :"message.unseen"
|
72
70
|
|
73
|
-
def self?.values: -> ::Array[Knockapi::
|
71
|
+
def self?.values: -> ::Array[Knockapi::MessageEvent::type_]
|
74
72
|
end
|
75
73
|
end
|
76
74
|
end
|
@@ -24,8 +24,6 @@ module Knockapi
|
|
24
24
|
message_id: String
|
25
25
|
) -> void
|
26
26
|
|
27
|
-
def to_hash: -> Knockapi::Models::message_get_content_response
|
28
|
-
|
29
27
|
type data =
|
30
28
|
Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent
|
31
29
|
| Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent
|
@@ -79,8 +77,6 @@ module Knockapi
|
|
79
77
|
?cc: String?,
|
80
78
|
?reply_to: String?
|
81
79
|
) -> void
|
82
|
-
|
83
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::message_email_content
|
84
80
|
end
|
85
81
|
|
86
82
|
type message_sms_content =
|
@@ -94,8 +90,6 @@ module Knockapi
|
|
94
90
|
attr_accessor to: String
|
95
91
|
|
96
92
|
def initialize: (_typename: String, body: String, to: String) -> void
|
97
|
-
|
98
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::message_sms_content
|
99
93
|
end
|
100
94
|
|
101
95
|
type message_push_content =
|
@@ -125,8 +119,6 @@ module Knockapi
|
|
125
119
|
title: String,
|
126
120
|
?data: ::Hash[Symbol, top]?
|
127
121
|
) -> void
|
128
|
-
|
129
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::message_push_content
|
130
122
|
end
|
131
123
|
|
132
124
|
type message_chat_content =
|
@@ -153,8 +145,6 @@ module Knockapi
|
|
153
145
|
?metadata: ::Hash[Symbol, top]?
|
154
146
|
) -> void
|
155
147
|
|
156
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::message_chat_content
|
157
|
-
|
158
148
|
type template =
|
159
149
|
{
|
160
150
|
blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block]?,
|
@@ -175,8 +165,6 @@ module Knockapi
|
|
175
165
|
?summary: String?
|
176
166
|
) -> void
|
177
167
|
|
178
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::template
|
179
|
-
|
180
168
|
type block =
|
181
169
|
{
|
182
170
|
content: String,
|
@@ -197,8 +185,6 @@ module Knockapi
|
|
197
185
|
type: Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::Block::type_
|
198
186
|
) -> void
|
199
187
|
|
200
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent::Template::block
|
201
|
-
|
202
188
|
type type_ = :text | :markdown
|
203
189
|
|
204
190
|
module Type
|
@@ -229,8 +215,6 @@ module Knockapi
|
|
229
215
|
blocks: ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
|
230
216
|
) -> void
|
231
217
|
|
232
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::message_in_app_feed_content
|
233
|
-
|
234
218
|
type block =
|
235
219
|
Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock
|
236
220
|
| Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
|
@@ -262,8 +246,6 @@ module Knockapi
|
|
262
246
|
type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock::type_
|
263
247
|
) -> void
|
264
248
|
|
265
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::message_in_app_feed_content_block
|
266
|
-
|
267
249
|
type type_ = :markdown | :text
|
268
250
|
|
269
251
|
module Type
|
@@ -296,8 +278,6 @@ module Knockapi
|
|
296
278
|
type: Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::type_
|
297
279
|
) -> void
|
298
280
|
|
299
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::message_in_app_feed_button_set_block
|
300
|
-
|
301
281
|
type button = { action: String, label: String, name: String }
|
302
282
|
|
303
283
|
class Button < Knockapi::Internal::Type::BaseModel
|
@@ -312,8 +292,6 @@ module Knockapi
|
|
312
292
|
label: String,
|
313
293
|
name: String
|
314
294
|
) -> void
|
315
|
-
|
316
|
-
def to_hash: -> Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock::button
|
317
295
|
end
|
318
296
|
|
319
297
|
type type_ = :button_set
|
@@ -327,11 +305,11 @@ module Knockapi
|
|
327
305
|
end
|
328
306
|
end
|
329
307
|
|
330
|
-
def self?.variants: -> [Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::
|
308
|
+
def self?.variants: -> ::Array[Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::block]
|
331
309
|
end
|
332
310
|
end
|
333
311
|
|
334
|
-
def self?.variants: -> [Knockapi::Models::MessageGetContentResponse::
|
312
|
+
def self?.variants: -> ::Array[Knockapi::Models::MessageGetContentResponse::data]
|
335
313
|
end
|
336
314
|
end
|
337
315
|
end
|
@@ -5,12 +5,12 @@ module Knockapi
|
|
5
5
|
after: String,
|
6
6
|
before: String,
|
7
7
|
channel_id: String,
|
8
|
-
engagement_status: ::Array[Knockapi::
|
9
|
-
inserted_at: Knockapi::
|
8
|
+
engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
|
9
|
+
inserted_at: Knockapi::MessageListParams::InsertedAt,
|
10
10
|
message_ids: ::Array[String],
|
11
11
|
page_size: Integer,
|
12
12
|
source: String,
|
13
|
-
status: ::Array[Knockapi::
|
13
|
+
status: ::Array[Knockapi::MessageListParams::status],
|
14
14
|
tenant: String,
|
15
15
|
trigger_data: String,
|
16
16
|
workflow_categories: ::Array[String],
|
@@ -35,17 +35,17 @@ module Knockapi
|
|
35
35
|
|
36
36
|
def channel_id=: (String) -> String
|
37
37
|
|
38
|
-
attr_reader engagement_status: ::Array[Knockapi::
|
38
|
+
attr_reader engagement_status: ::Array[Knockapi::MessageListParams::engagement_status]?
|
39
39
|
|
40
40
|
def engagement_status=: (
|
41
|
-
::Array[Knockapi::
|
42
|
-
) -> ::Array[Knockapi::
|
41
|
+
::Array[Knockapi::MessageListParams::engagement_status]
|
42
|
+
) -> ::Array[Knockapi::MessageListParams::engagement_status]
|
43
43
|
|
44
|
-
attr_reader inserted_at: Knockapi::
|
44
|
+
attr_reader inserted_at: Knockapi::MessageListParams::InsertedAt?
|
45
45
|
|
46
46
|
def inserted_at=: (
|
47
|
-
Knockapi::
|
48
|
-
) -> Knockapi::
|
47
|
+
Knockapi::MessageListParams::InsertedAt
|
48
|
+
) -> Knockapi::MessageListParams::InsertedAt
|
49
49
|
|
50
50
|
attr_reader message_ids: ::Array[String]?
|
51
51
|
|
@@ -59,11 +59,11 @@ module Knockapi
|
|
59
59
|
|
60
60
|
def source=: (String) -> String
|
61
61
|
|
62
|
-
attr_reader status: ::Array[Knockapi::
|
62
|
+
attr_reader status: ::Array[Knockapi::MessageListParams::status]?
|
63
63
|
|
64
64
|
def status=: (
|
65
|
-
::Array[Knockapi::
|
66
|
-
) -> ::Array[Knockapi::
|
65
|
+
::Array[Knockapi::MessageListParams::status]
|
66
|
+
) -> ::Array[Knockapi::MessageListParams::status]
|
67
67
|
|
68
68
|
attr_reader tenant: String?
|
69
69
|
|
@@ -89,12 +89,12 @@ module Knockapi
|
|
89
89
|
?after: String,
|
90
90
|
?before: String,
|
91
91
|
?channel_id: String,
|
92
|
-
?engagement_status: ::Array[Knockapi::
|
93
|
-
?inserted_at: Knockapi::
|
92
|
+
?engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
|
93
|
+
?inserted_at: Knockapi::MessageListParams::InsertedAt,
|
94
94
|
?message_ids: ::Array[String],
|
95
95
|
?page_size: Integer,
|
96
96
|
?source: String,
|
97
|
-
?status: ::Array[Knockapi::
|
97
|
+
?status: ::Array[Knockapi::MessageListParams::status],
|
98
98
|
?tenant: String,
|
99
99
|
?trigger_data: String,
|
100
100
|
?workflow_categories: ::Array[String],
|
@@ -103,21 +103,29 @@ module Knockapi
|
|
103
103
|
?request_options: Knockapi::request_opts
|
104
104
|
) -> void
|
105
105
|
|
106
|
-
def to_hash: -> Knockapi::Models::message_list_params
|
107
|
-
|
108
106
|
type engagement_status =
|
109
|
-
:seen
|
107
|
+
:seen
|
108
|
+
| :unseen
|
109
|
+
| :read
|
110
|
+
| :unread
|
111
|
+
| :archived
|
112
|
+
| :unarchived
|
113
|
+
| :link_clicked
|
114
|
+
| :interacted
|
110
115
|
|
111
116
|
module EngagementStatus
|
112
117
|
extend Knockapi::Internal::Type::Enum
|
113
118
|
|
114
119
|
SEEN: :seen
|
120
|
+
UNSEEN: :unseen
|
115
121
|
READ: :read
|
116
|
-
|
117
|
-
LINK_CLICKED: :link_clicked
|
122
|
+
UNREAD: :unread
|
118
123
|
ARCHIVED: :archived
|
124
|
+
UNARCHIVED: :unarchived
|
125
|
+
LINK_CLICKED: :link_clicked
|
126
|
+
INTERACTED: :interacted
|
119
127
|
|
120
|
-
def self?.values: -> ::Array[Knockapi::
|
128
|
+
def self?.values: -> ::Array[Knockapi::MessageListParams::engagement_status]
|
121
129
|
end
|
122
130
|
|
123
131
|
type inserted_at = { gt: String, gte: String, lt: String, lte: String }
|
@@ -145,8 +153,6 @@ module Knockapi
|
|
145
153
|
?lt: String,
|
146
154
|
?lte: String
|
147
155
|
) -> void
|
148
|
-
|
149
|
-
def to_hash: -> Knockapi::Models::MessageListParams::inserted_at
|
150
156
|
end
|
151
157
|
|
152
158
|
type status =
|
@@ -169,7 +175,7 @@ module Knockapi
|
|
169
175
|
NOT_SENT: :not_sent
|
170
176
|
BOUNCED: :bounced
|
171
177
|
|
172
|
-
def self?.values: -> ::Array[Knockapi::
|
178
|
+
def self?.values: -> ::Array[Knockapi::MessageListParams::status]
|
173
179
|
end
|
174
180
|
end
|
175
181
|
end
|