knockapi 1.0.0 → 1.1.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 +41 -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 +1 -1
- data/lib/knockapi/internal/type/base_model.rb +71 -39
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +1 -0
- data/lib/knockapi/internal/type/hash_of.rb +1 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +4 -3
- data/lib/knockapi/internal/util.rb +74 -2
- data/lib/knockapi/internal.rb +6 -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 +6 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +26 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_get_content_response.rb +21 -0
- data/lib/knockapi/models/message_list_params.rb +9 -13
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_get_content_response.rb +21 -0
- 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 +11 -12
- 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 +7 -3
- data/lib/knockapi/models/recipient_reference.rb +6 -2
- data/lib/knockapi/models/recipient_request.rb +7 -3
- data/lib/knockapi/models/recipients/channel_data.rb +26 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +22 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +36 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/preference_set.rb +52 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +60 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +52 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +21 -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 +13 -12
- 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 +15 -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 +202 -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 +34 -24
- data/rbi/knockapi/internal/type/base_model.rbi +151 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +16 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +28 -15
- data/rbi/knockapi/internal/type/file_input.rbi +8 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +34 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +55 -19
- data/rbi/knockapi/internal/type/unknown.rbi +16 -6
- data/rbi/knockapi/internal/util.rbi +239 -87
- data/rbi/knockapi/internal.rbi +2 -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 +156 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +153 -66
- data/rbi/knockapi/models/message_event.rbi +86 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +364 -203
- 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 +147 -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 +367 -206
- 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 +169 -60
- 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 +123 -50
- 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 -88
- 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 +168 -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 +197 -100
- 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/base_model.rbs +11 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +1 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +1 -0
- data/sig/knockapi/internal/util.rbs +15 -0
- data/sig/knockapi/internal.rbs +2 -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 +17 -21
- 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 +17 -21
- 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 +17 -21
- 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
@@ -3,6 +3,11 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
class MessageDeliveryLog < Knockapi::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(Knockapi::MessageDeliveryLog, Knockapi::Internal::AnyHash)
|
9
|
+
end
|
10
|
+
|
6
11
|
# The unique identifier for the message delivery log.
|
7
12
|
sig { returns(String) }
|
8
13
|
attr_accessor :id
|
@@ -20,17 +25,21 @@ module Knockapi
|
|
20
25
|
attr_accessor :inserted_at
|
21
26
|
|
22
27
|
# A message delivery log request.
|
23
|
-
sig { returns(Knockapi::
|
28
|
+
sig { returns(Knockapi::MessageDeliveryLog::Request) }
|
24
29
|
attr_reader :request
|
25
30
|
|
26
|
-
sig
|
31
|
+
sig do
|
32
|
+
params(request: Knockapi::MessageDeliveryLog::Request::OrHash).void
|
33
|
+
end
|
27
34
|
attr_writer :request
|
28
35
|
|
29
36
|
# A message delivery log response.
|
30
|
-
sig { returns(Knockapi::
|
37
|
+
sig { returns(Knockapi::MessageDeliveryLog::Response) }
|
31
38
|
attr_reader :response
|
32
39
|
|
33
|
-
sig
|
40
|
+
sig do
|
41
|
+
params(response: Knockapi::MessageDeliveryLog::Response::OrHash).void
|
42
|
+
end
|
34
43
|
attr_writer :response
|
35
44
|
|
36
45
|
# The name of the service that processed the delivery.
|
@@ -45,11 +54,10 @@ module Knockapi
|
|
45
54
|
_typename: String,
|
46
55
|
environment_id: String,
|
47
56
|
inserted_at: String,
|
48
|
-
request:
|
49
|
-
response:
|
57
|
+
request: Knockapi::MessageDeliveryLog::Request::OrHash,
|
58
|
+
response: Knockapi::MessageDeliveryLog::Response::OrHash,
|
50
59
|
service_name: String
|
51
|
-
)
|
52
|
-
.returns(T.attached_class)
|
60
|
+
).returns(T.attached_class)
|
53
61
|
end
|
54
62
|
def self.new(
|
55
63
|
# The unique identifier for the message delivery log.
|
@@ -66,24 +74,34 @@ module Knockapi
|
|
66
74
|
response:,
|
67
75
|
# The name of the service that processed the delivery.
|
68
76
|
service_name:
|
69
|
-
)
|
77
|
+
)
|
78
|
+
end
|
79
|
+
|
70
80
|
sig do
|
71
|
-
override
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
81
|
+
override.returns(
|
82
|
+
{
|
83
|
+
id: String,
|
84
|
+
_typename: String,
|
85
|
+
environment_id: String,
|
86
|
+
inserted_at: String,
|
87
|
+
request: Knockapi::MessageDeliveryLog::Request,
|
88
|
+
response: Knockapi::MessageDeliveryLog::Response,
|
89
|
+
service_name: String
|
90
|
+
}
|
91
|
+
)
|
92
|
+
end
|
93
|
+
def to_hash
|
83
94
|
end
|
84
|
-
def to_hash; end
|
85
95
|
|
86
96
|
class Request < Knockapi::Internal::Type::BaseModel
|
97
|
+
OrHash =
|
98
|
+
T.type_alias do
|
99
|
+
T.any(
|
100
|
+
Knockapi::MessageDeliveryLog::Request,
|
101
|
+
Knockapi::Internal::AnyHash
|
102
|
+
)
|
103
|
+
end
|
104
|
+
|
87
105
|
# The body content that was sent with the request.
|
88
106
|
sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
|
89
107
|
attr_reader :body
|
@@ -103,10 +121,20 @@ module Knockapi
|
|
103
121
|
attr_writer :host
|
104
122
|
|
105
123
|
# The HTTP method used for the request.
|
106
|
-
sig
|
124
|
+
sig do
|
125
|
+
returns(
|
126
|
+
T.nilable(
|
127
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
128
|
+
)
|
129
|
+
)
|
130
|
+
end
|
107
131
|
attr_reader :method_
|
108
132
|
|
109
|
-
sig
|
133
|
+
sig do
|
134
|
+
params(
|
135
|
+
method_: Knockapi::MessageDeliveryLog::Request::Method::OrSymbol
|
136
|
+
).void
|
137
|
+
end
|
110
138
|
attr_writer :method_
|
111
139
|
|
112
140
|
# The path of the URL that was requested.
|
@@ -126,11 +154,10 @@ module Knockapi
|
|
126
154
|
body: T.any(String, T::Hash[Symbol, T.anything]),
|
127
155
|
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
128
156
|
host: String,
|
129
|
-
method_: Knockapi::
|
157
|
+
method_: Knockapi::MessageDeliveryLog::Request::Method::OrSymbol,
|
130
158
|
path: String,
|
131
159
|
query: T.nilable(String)
|
132
|
-
)
|
133
|
-
.returns(T.attached_class)
|
160
|
+
).returns(T.attached_class)
|
134
161
|
end
|
135
162
|
def self.new(
|
136
163
|
# The body content that was sent with the request.
|
@@ -145,32 +172,44 @@ module Knockapi
|
|
145
172
|
path: nil,
|
146
173
|
# The query string of the URL that was requested.
|
147
174
|
query: nil
|
148
|
-
)
|
175
|
+
)
|
176
|
+
end
|
177
|
+
|
149
178
|
sig do
|
150
|
-
override
|
151
|
-
|
152
|
-
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
179
|
+
override.returns(
|
180
|
+
{
|
181
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
182
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
183
|
+
host: String,
|
184
|
+
method_:
|
185
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol,
|
186
|
+
path: String,
|
187
|
+
query: T.nilable(String)
|
188
|
+
}
|
189
|
+
)
|
190
|
+
end
|
191
|
+
def to_hash
|
161
192
|
end
|
162
|
-
def to_hash; end
|
163
193
|
|
164
194
|
# The body content that was sent with the request.
|
165
195
|
module Body
|
166
196
|
extend Knockapi::Internal::Type::Union
|
167
197
|
|
168
|
-
|
169
|
-
|
198
|
+
Variants = T.type_alias { T.any(String, T::Hash[Symbol, T.anything]) }
|
199
|
+
|
200
|
+
sig do
|
201
|
+
override.returns(
|
202
|
+
T::Array[Knockapi::MessageDeliveryLog::Request::Body::Variants]
|
203
|
+
)
|
204
|
+
end
|
205
|
+
def self.variants
|
206
|
+
end
|
170
207
|
|
171
208
|
UnionMember1Map =
|
172
209
|
T.let(
|
173
|
-
Knockapi::Internal::Type::HashOf[
|
210
|
+
Knockapi::Internal::Type::HashOf[
|
211
|
+
Knockapi::Internal::Type::Unknown
|
212
|
+
],
|
174
213
|
Knockapi::Internal::Type::Converter
|
175
214
|
)
|
176
215
|
end
|
@@ -179,21 +218,59 @@ module Knockapi
|
|
179
218
|
module Method
|
180
219
|
extend Knockapi::Internal::Type::Enum
|
181
220
|
|
182
|
-
TaggedSymbol =
|
221
|
+
TaggedSymbol =
|
222
|
+
T.type_alias do
|
223
|
+
T.all(Symbol, Knockapi::MessageDeliveryLog::Request::Method)
|
224
|
+
end
|
183
225
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
184
226
|
|
185
|
-
GET =
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
227
|
+
GET =
|
228
|
+
T.let(
|
229
|
+
:GET,
|
230
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
231
|
+
)
|
232
|
+
POST =
|
233
|
+
T.let(
|
234
|
+
:POST,
|
235
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
236
|
+
)
|
237
|
+
PUT =
|
238
|
+
T.let(
|
239
|
+
:PUT,
|
240
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
241
|
+
)
|
242
|
+
DELETE =
|
243
|
+
T.let(
|
244
|
+
:DELETE,
|
245
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
246
|
+
)
|
247
|
+
PATCH =
|
248
|
+
T.let(
|
249
|
+
:PATCH,
|
250
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
251
|
+
)
|
190
252
|
|
191
|
-
sig
|
192
|
-
|
253
|
+
sig do
|
254
|
+
override.returns(
|
255
|
+
T::Array[
|
256
|
+
Knockapi::MessageDeliveryLog::Request::Method::TaggedSymbol
|
257
|
+
]
|
258
|
+
)
|
259
|
+
end
|
260
|
+
def self.values
|
261
|
+
end
|
193
262
|
end
|
194
263
|
end
|
195
264
|
|
196
265
|
class Response < Knockapi::Internal::Type::BaseModel
|
266
|
+
OrHash =
|
267
|
+
T.type_alias do
|
268
|
+
T.any(
|
269
|
+
Knockapi::MessageDeliveryLog::Response,
|
270
|
+
Knockapi::Internal::AnyHash
|
271
|
+
)
|
272
|
+
end
|
273
|
+
|
197
274
|
# The body content that was received with the response.
|
198
275
|
sig { returns(T.nilable(T.any(String, T::Hash[Symbol, T.anything]))) }
|
199
276
|
attr_reader :body
|
@@ -218,8 +295,7 @@ module Knockapi
|
|
218
295
|
body: T.any(String, T::Hash[Symbol, T.anything]),
|
219
296
|
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
220
297
|
status: Integer
|
221
|
-
)
|
222
|
-
.returns(T.attached_class)
|
298
|
+
).returns(T.attached_class)
|
223
299
|
end
|
224
300
|
def self.new(
|
225
301
|
# The body content that was received with the response.
|
@@ -228,29 +304,40 @@ module Knockapi
|
|
228
304
|
headers: nil,
|
229
305
|
# The HTTP status code of the response.
|
230
306
|
status: nil
|
231
|
-
)
|
307
|
+
)
|
308
|
+
end
|
309
|
+
|
232
310
|
sig do
|
233
|
-
override
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
311
|
+
override.returns(
|
312
|
+
{
|
313
|
+
body: T.any(String, T::Hash[Symbol, T.anything]),
|
314
|
+
headers: T.nilable(T::Hash[Symbol, T.anything]),
|
315
|
+
status: Integer
|
316
|
+
}
|
317
|
+
)
|
318
|
+
end
|
319
|
+
def to_hash
|
241
320
|
end
|
242
|
-
def to_hash; end
|
243
321
|
|
244
322
|
# The body content that was received with the response.
|
245
323
|
module Body
|
246
324
|
extend Knockapi::Internal::Type::Union
|
247
325
|
|
248
|
-
|
249
|
-
|
326
|
+
Variants = T.type_alias { T.any(String, T::Hash[Symbol, T.anything]) }
|
327
|
+
|
328
|
+
sig do
|
329
|
+
override.returns(
|
330
|
+
T::Array[Knockapi::MessageDeliveryLog::Response::Body::Variants]
|
331
|
+
)
|
332
|
+
end
|
333
|
+
def self.variants
|
334
|
+
end
|
250
335
|
|
251
336
|
UnionMember1Map =
|
252
337
|
T.let(
|
253
|
-
Knockapi::Internal::Type::HashOf[
|
338
|
+
Knockapi::Internal::Type::HashOf[
|
339
|
+
Knockapi::Internal::Type::Unknown
|
340
|
+
],
|
254
341
|
Knockapi::Internal::Type::Converter
|
255
342
|
)
|
256
343
|
end
|
@@ -3,6 +3,11 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
class MessageEvent < Knockapi::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias do
|
8
|
+
T.any(Knockapi::MessageEvent, Knockapi::Internal::AnyHash)
|
9
|
+
end
|
10
|
+
|
6
11
|
# The unique identifier for the message event.
|
7
12
|
sig { returns(String) }
|
8
13
|
attr_accessor :id
|
@@ -17,11 +22,13 @@ module Knockapi
|
|
17
22
|
|
18
23
|
# A reference to a recipient, either a user identifier (string) or an object
|
19
24
|
# reference (ID, collection).
|
20
|
-
sig
|
25
|
+
sig do
|
26
|
+
returns(T.any(String, Knockapi::RecipientReference::ObjectReference))
|
27
|
+
end
|
21
28
|
attr_accessor :recipient
|
22
29
|
|
23
30
|
# The type of event that occurred.
|
24
|
-
sig { returns(Knockapi::
|
31
|
+
sig { returns(Knockapi::MessageEvent::Type::TaggedSymbol) }
|
25
32
|
attr_accessor :type
|
26
33
|
|
27
34
|
# The data associated with the message event. Only present for some event types.
|
@@ -35,11 +42,14 @@ module Knockapi
|
|
35
42
|
id: String,
|
36
43
|
_typename: String,
|
37
44
|
inserted_at: Time,
|
38
|
-
recipient:
|
39
|
-
|
45
|
+
recipient:
|
46
|
+
T.any(
|
47
|
+
String,
|
48
|
+
Knockapi::RecipientReference::ObjectReference::OrHash
|
49
|
+
),
|
50
|
+
type: Knockapi::MessageEvent::Type::OrSymbol,
|
40
51
|
data: T.nilable(T::Hash[Symbol, T.anything])
|
41
|
-
)
|
42
|
-
.returns(T.attached_class)
|
52
|
+
).returns(T.attached_class)
|
43
53
|
end
|
44
54
|
def self.new(
|
45
55
|
# The unique identifier for the message event.
|
@@ -55,48 +65,87 @@ module Knockapi
|
|
55
65
|
type:,
|
56
66
|
# The data associated with the message event. Only present for some event types.
|
57
67
|
data: nil
|
58
|
-
)
|
68
|
+
)
|
69
|
+
end
|
70
|
+
|
59
71
|
sig do
|
60
|
-
override
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
|
72
|
+
override.returns(
|
73
|
+
{
|
74
|
+
id: String,
|
75
|
+
_typename: String,
|
76
|
+
inserted_at: Time,
|
77
|
+
recipient:
|
78
|
+
T.any(String, Knockapi::RecipientReference::ObjectReference),
|
79
|
+
type: Knockapi::MessageEvent::Type::TaggedSymbol,
|
80
|
+
data: T.nilable(T::Hash[Symbol, T.anything])
|
81
|
+
}
|
82
|
+
)
|
83
|
+
end
|
84
|
+
def to_hash
|
71
85
|
end
|
72
|
-
def to_hash; end
|
73
86
|
|
74
87
|
# The type of event that occurred.
|
75
88
|
module Type
|
76
89
|
extend Knockapi::Internal::Type::Enum
|
77
90
|
|
78
|
-
TaggedSymbol =
|
91
|
+
TaggedSymbol =
|
92
|
+
T.type_alias { T.all(Symbol, Knockapi::MessageEvent::Type) }
|
79
93
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
80
94
|
|
81
|
-
MESSAGE_ARCHIVED =
|
82
|
-
|
83
|
-
|
95
|
+
MESSAGE_ARCHIVED =
|
96
|
+
T.let(:"message.archived", Knockapi::MessageEvent::Type::TaggedSymbol)
|
97
|
+
MESSAGE_BOUNCED =
|
98
|
+
T.let(:"message.bounced", Knockapi::MessageEvent::Type::TaggedSymbol)
|
99
|
+
MESSAGE_DELIVERED =
|
100
|
+
T.let(
|
101
|
+
:"message.delivered",
|
102
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
103
|
+
)
|
84
104
|
MESSAGE_DELIVERY_ATTEMPTED =
|
85
|
-
T.let(
|
86
|
-
|
87
|
-
|
88
|
-
|
89
|
-
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
105
|
+
T.let(
|
106
|
+
:"message.delivery_attempted",
|
107
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
108
|
+
)
|
109
|
+
MESSAGE_INTERACTED =
|
110
|
+
T.let(
|
111
|
+
:"message.interacted",
|
112
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
113
|
+
)
|
114
|
+
MESSAGE_LINK_CLICKED =
|
115
|
+
T.let(
|
116
|
+
:"message.link_clicked",
|
117
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
118
|
+
)
|
119
|
+
MESSAGE_NOT_SENT =
|
120
|
+
T.let(:"message.not_sent", Knockapi::MessageEvent::Type::TaggedSymbol)
|
121
|
+
MESSAGE_QUEUED =
|
122
|
+
T.let(:"message.queued", Knockapi::MessageEvent::Type::TaggedSymbol)
|
123
|
+
MESSAGE_READ =
|
124
|
+
T.let(:"message.read", Knockapi::MessageEvent::Type::TaggedSymbol)
|
125
|
+
MESSAGE_SEEN =
|
126
|
+
T.let(:"message.seen", Knockapi::MessageEvent::Type::TaggedSymbol)
|
127
|
+
MESSAGE_SENT =
|
128
|
+
T.let(:"message.sent", Knockapi::MessageEvent::Type::TaggedSymbol)
|
129
|
+
MESSAGE_UNARCHIVED =
|
130
|
+
T.let(
|
131
|
+
:"message.unarchived",
|
132
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
133
|
+
)
|
134
|
+
MESSAGE_UNDELIVERED =
|
135
|
+
T.let(
|
136
|
+
:"message.undelivered",
|
137
|
+
Knockapi::MessageEvent::Type::TaggedSymbol
|
138
|
+
)
|
139
|
+
MESSAGE_UNREAD =
|
140
|
+
T.let(:"message.unread", Knockapi::MessageEvent::Type::TaggedSymbol)
|
141
|
+
MESSAGE_UNSEEN =
|
142
|
+
T.let(:"message.unseen", Knockapi::MessageEvent::Type::TaggedSymbol)
|
97
143
|
|
98
|
-
sig
|
99
|
-
|
144
|
+
sig do
|
145
|
+
override.returns(T::Array[Knockapi::MessageEvent::Type::TaggedSymbol])
|
146
|
+
end
|
147
|
+
def self.values
|
148
|
+
end
|
100
149
|
end
|
101
150
|
end
|
102
151
|
end
|
@@ -6,14 +6,22 @@ module Knockapi
|
|
6
6
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
7
7
|
include Knockapi::Internal::Type::RequestParameters
|
8
8
|
|
9
|
+
OrHash =
|
10
|
+
T.type_alias do
|
11
|
+
T.any(Knockapi::MessageGetContentParams, Knockapi::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
9
14
|
sig do
|
10
|
-
params(request_options:
|
11
|
-
|
15
|
+
params(request_options: Knockapi::RequestOptions::OrHash).returns(
|
16
|
+
T.attached_class
|
17
|
+
)
|
18
|
+
end
|
19
|
+
def self.new(request_options: {})
|
12
20
|
end
|
13
|
-
def self.new(request_options: {}); end
|
14
21
|
|
15
|
-
sig { override.returns({request_options: Knockapi::RequestOptions}) }
|
16
|
-
def to_hash
|
22
|
+
sig { override.returns({ request_options: Knockapi::RequestOptions }) }
|
23
|
+
def to_hash
|
24
|
+
end
|
17
25
|
end
|
18
26
|
end
|
19
27
|
end
|