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
@@ -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::MessageGetParams, 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
|
@@ -6,6 +6,14 @@ 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(
|
12
|
+
Knockapi::MessageListActivitiesParams,
|
13
|
+
Knockapi::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
# The cursor to fetch entries after.
|
10
18
|
sig { returns(T.nilable(String)) }
|
11
19
|
attr_reader :after
|
@@ -40,9 +48,8 @@ module Knockapi
|
|
40
48
|
before: String,
|
41
49
|
page_size: Integer,
|
42
50
|
trigger_data: String,
|
43
|
-
request_options:
|
44
|
-
)
|
45
|
-
.returns(T.attached_class)
|
51
|
+
request_options: Knockapi::RequestOptions::OrHash
|
52
|
+
).returns(T.attached_class)
|
46
53
|
end
|
47
54
|
def self.new(
|
48
55
|
# The cursor to fetch entries after.
|
@@ -54,20 +61,22 @@ module Knockapi
|
|
54
61
|
# The trigger data to filter activities by.
|
55
62
|
trigger_data: nil,
|
56
63
|
request_options: {}
|
57
|
-
)
|
64
|
+
)
|
65
|
+
end
|
66
|
+
|
58
67
|
sig do
|
59
|
-
override
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
68
|
+
override.returns(
|
69
|
+
{
|
70
|
+
after: String,
|
71
|
+
before: String,
|
72
|
+
page_size: Integer,
|
73
|
+
trigger_data: String,
|
74
|
+
request_options: Knockapi::RequestOptions
|
75
|
+
}
|
76
|
+
)
|
77
|
+
end
|
78
|
+
def to_hash
|
69
79
|
end
|
70
|
-
def to_hash; end
|
71
80
|
end
|
72
81
|
end
|
73
82
|
end
|
@@ -6,6 +6,14 @@ 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(
|
12
|
+
Knockapi::MessageListDeliveryLogsParams,
|
13
|
+
Knockapi::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
# The cursor to fetch entries after.
|
10
18
|
sig { returns(T.nilable(String)) }
|
11
19
|
attr_reader :after
|
@@ -32,9 +40,8 @@ module Knockapi
|
|
32
40
|
after: String,
|
33
41
|
before: String,
|
34
42
|
page_size: Integer,
|
35
|
-
request_options:
|
36
|
-
)
|
37
|
-
.returns(T.attached_class)
|
43
|
+
request_options: Knockapi::RequestOptions::OrHash
|
44
|
+
).returns(T.attached_class)
|
38
45
|
end
|
39
46
|
def self.new(
|
40
47
|
# The cursor to fetch entries after.
|
@@ -44,17 +51,21 @@ module Knockapi
|
|
44
51
|
# The number of items per page.
|
45
52
|
page_size: nil,
|
46
53
|
request_options: {}
|
47
|
-
)
|
54
|
+
)
|
55
|
+
end
|
56
|
+
|
48
57
|
sig do
|
49
|
-
override
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
58
|
+
override.returns(
|
59
|
+
{
|
60
|
+
after: String,
|
61
|
+
before: String,
|
62
|
+
page_size: Integer,
|
63
|
+
request_options: Knockapi::RequestOptions
|
64
|
+
}
|
65
|
+
)
|
66
|
+
end
|
67
|
+
def to_hash
|
56
68
|
end
|
57
|
-
def to_hash; end
|
58
69
|
end
|
59
70
|
end
|
60
71
|
end
|
@@ -6,6 +6,11 @@ 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::MessageListEventsParams, Knockapi::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
9
14
|
# The cursor to fetch entries after.
|
10
15
|
sig { returns(T.nilable(String)) }
|
11
16
|
attr_reader :after
|
@@ -32,9 +37,8 @@ module Knockapi
|
|
32
37
|
after: String,
|
33
38
|
before: String,
|
34
39
|
page_size: Integer,
|
35
|
-
request_options:
|
36
|
-
)
|
37
|
-
.returns(T.attached_class)
|
40
|
+
request_options: Knockapi::RequestOptions::OrHash
|
41
|
+
).returns(T.attached_class)
|
38
42
|
end
|
39
43
|
def self.new(
|
40
44
|
# The cursor to fetch entries after.
|
@@ -44,17 +48,21 @@ module Knockapi
|
|
44
48
|
# The number of items per page.
|
45
49
|
page_size: nil,
|
46
50
|
request_options: {}
|
47
|
-
)
|
51
|
+
)
|
52
|
+
end
|
53
|
+
|
48
54
|
sig do
|
49
|
-
override
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
|
55
|
+
override.returns(
|
56
|
+
{
|
57
|
+
after: String,
|
58
|
+
before: String,
|
59
|
+
page_size: Integer,
|
60
|
+
request_options: Knockapi::RequestOptions
|
61
|
+
}
|
62
|
+
)
|
63
|
+
end
|
64
|
+
def to_hash
|
56
65
|
end
|
57
|
-
def to_hash; end
|
58
66
|
end
|
59
67
|
end
|
60
68
|
end
|
@@ -6,6 +6,11 @@ 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::MessageListParams, Knockapi::Internal::AnyHash)
|
12
|
+
end
|
13
|
+
|
9
14
|
# The cursor to fetch entries after.
|
10
15
|
sig { returns(T.nilable(String)) }
|
11
16
|
attr_reader :after
|
@@ -28,18 +33,30 @@ module Knockapi
|
|
28
33
|
attr_writer :channel_id
|
29
34
|
|
30
35
|
# Limits the results to messages with the given engagement status.
|
31
|
-
sig
|
36
|
+
sig do
|
37
|
+
returns(
|
38
|
+
T.nilable(
|
39
|
+
T::Array[Knockapi::MessageListParams::EngagementStatus::OrSymbol]
|
40
|
+
)
|
41
|
+
)
|
42
|
+
end
|
32
43
|
attr_reader :engagement_status
|
33
44
|
|
34
|
-
sig
|
45
|
+
sig do
|
46
|
+
params(
|
47
|
+
engagement_status:
|
48
|
+
T::Array[Knockapi::MessageListParams::EngagementStatus::OrSymbol]
|
49
|
+
).void
|
50
|
+
end
|
35
51
|
attr_writer :engagement_status
|
36
52
|
|
37
|
-
sig { returns(T.nilable(Knockapi::
|
53
|
+
sig { returns(T.nilable(Knockapi::MessageListParams::InsertedAt)) }
|
38
54
|
attr_reader :inserted_at
|
39
55
|
|
40
56
|
sig do
|
41
|
-
params(
|
42
|
-
|
57
|
+
params(
|
58
|
+
inserted_at: Knockapi::MessageListParams::InsertedAt::OrHash
|
59
|
+
).void
|
43
60
|
end
|
44
61
|
attr_writer :inserted_at
|
45
62
|
|
@@ -66,10 +83,18 @@ module Knockapi
|
|
66
83
|
attr_writer :source
|
67
84
|
|
68
85
|
# Limits the results to messages with the given delivery status.
|
69
|
-
sig
|
86
|
+
sig do
|
87
|
+
returns(
|
88
|
+
T.nilable(T::Array[Knockapi::MessageListParams::Status::OrSymbol])
|
89
|
+
)
|
90
|
+
end
|
70
91
|
attr_reader :status
|
71
92
|
|
72
|
-
sig
|
93
|
+
sig do
|
94
|
+
params(
|
95
|
+
status: T::Array[Knockapi::MessageListParams::Status::OrSymbol]
|
96
|
+
).void
|
97
|
+
end
|
73
98
|
attr_writer :status
|
74
99
|
|
75
100
|
# Limits the results to items with the corresponding tenant.
|
@@ -115,20 +140,20 @@ module Knockapi
|
|
115
140
|
after: String,
|
116
141
|
before: String,
|
117
142
|
channel_id: String,
|
118
|
-
engagement_status:
|
119
|
-
|
143
|
+
engagement_status:
|
144
|
+
T::Array[Knockapi::MessageListParams::EngagementStatus::OrSymbol],
|
145
|
+
inserted_at: Knockapi::MessageListParams::InsertedAt::OrHash,
|
120
146
|
message_ids: T::Array[String],
|
121
147
|
page_size: Integer,
|
122
148
|
source: String,
|
123
|
-
status: T::Array[Knockapi::
|
149
|
+
status: T::Array[Knockapi::MessageListParams::Status::OrSymbol],
|
124
150
|
tenant: String,
|
125
151
|
trigger_data: String,
|
126
152
|
workflow_categories: T::Array[String],
|
127
153
|
workflow_recipient_run_id: String,
|
128
154
|
workflow_run_id: String,
|
129
|
-
request_options:
|
130
|
-
)
|
131
|
-
.returns(T.attached_class)
|
155
|
+
request_options: Knockapi::RequestOptions::OrHash
|
156
|
+
).returns(T.attached_class)
|
132
157
|
end
|
133
158
|
def self.new(
|
134
159
|
# The cursor to fetch entries after.
|
@@ -163,48 +188,104 @@ module Knockapi
|
|
163
188
|
# returned by the workflow trigger request.
|
164
189
|
workflow_run_id: nil,
|
165
190
|
request_options: {}
|
166
|
-
)
|
191
|
+
)
|
192
|
+
end
|
193
|
+
|
167
194
|
sig do
|
168
|
-
override
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
173
|
-
|
174
|
-
|
175
|
-
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
195
|
+
override.returns(
|
196
|
+
{
|
197
|
+
after: String,
|
198
|
+
before: String,
|
199
|
+
channel_id: String,
|
200
|
+
engagement_status:
|
201
|
+
T::Array[Knockapi::MessageListParams::EngagementStatus::OrSymbol],
|
202
|
+
inserted_at: Knockapi::MessageListParams::InsertedAt,
|
203
|
+
message_ids: T::Array[String],
|
204
|
+
page_size: Integer,
|
205
|
+
source: String,
|
206
|
+
status: T::Array[Knockapi::MessageListParams::Status::OrSymbol],
|
207
|
+
tenant: String,
|
208
|
+
trigger_data: String,
|
209
|
+
workflow_categories: T::Array[String],
|
210
|
+
workflow_recipient_run_id: String,
|
211
|
+
workflow_run_id: String,
|
212
|
+
request_options: Knockapi::RequestOptions
|
213
|
+
}
|
214
|
+
)
|
215
|
+
end
|
216
|
+
def to_hash
|
188
217
|
end
|
189
|
-
def to_hash; end
|
190
218
|
|
191
219
|
module EngagementStatus
|
192
220
|
extend Knockapi::Internal::Type::Enum
|
193
221
|
|
194
|
-
TaggedSymbol =
|
222
|
+
TaggedSymbol =
|
223
|
+
T.type_alias do
|
224
|
+
T.all(Symbol, Knockapi::MessageListParams::EngagementStatus)
|
225
|
+
end
|
195
226
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
196
227
|
|
197
|
-
SEEN =
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
|
228
|
+
SEEN =
|
229
|
+
T.let(
|
230
|
+
:seen,
|
231
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
232
|
+
)
|
233
|
+
UNSEEN =
|
234
|
+
T.let(
|
235
|
+
:unseen,
|
236
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
237
|
+
)
|
238
|
+
READ =
|
239
|
+
T.let(
|
240
|
+
:read,
|
241
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
242
|
+
)
|
243
|
+
UNREAD =
|
244
|
+
T.let(
|
245
|
+
:unread,
|
246
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
247
|
+
)
|
248
|
+
ARCHIVED =
|
249
|
+
T.let(
|
250
|
+
:archived,
|
251
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
252
|
+
)
|
253
|
+
UNARCHIVED =
|
254
|
+
T.let(
|
255
|
+
:unarchived,
|
256
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
257
|
+
)
|
258
|
+
LINK_CLICKED =
|
259
|
+
T.let(
|
260
|
+
:link_clicked,
|
261
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
262
|
+
)
|
263
|
+
INTERACTED =
|
264
|
+
T.let(
|
265
|
+
:interacted,
|
266
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
267
|
+
)
|
202
268
|
|
203
|
-
sig
|
204
|
-
|
269
|
+
sig do
|
270
|
+
override.returns(
|
271
|
+
T::Array[
|
272
|
+
Knockapi::MessageListParams::EngagementStatus::TaggedSymbol
|
273
|
+
]
|
274
|
+
)
|
275
|
+
end
|
276
|
+
def self.values
|
277
|
+
end
|
205
278
|
end
|
206
279
|
|
207
280
|
class InsertedAt < Knockapi::Internal::Type::BaseModel
|
281
|
+
OrHash =
|
282
|
+
T.type_alias do
|
283
|
+
T.any(
|
284
|
+
Knockapi::MessageListParams::InsertedAt,
|
285
|
+
Knockapi::Internal::AnyHash
|
286
|
+
)
|
287
|
+
end
|
288
|
+
|
208
289
|
# Limits the results to messages inserted after the given date.
|
209
290
|
sig { returns(T.nilable(String)) }
|
210
291
|
attr_reader :gt
|
@@ -233,7 +314,11 @@ module Knockapi
|
|
233
314
|
sig { params(lte: String).void }
|
234
315
|
attr_writer :lte
|
235
316
|
|
236
|
-
sig
|
317
|
+
sig do
|
318
|
+
params(gt: String, gte: String, lt: String, lte: String).returns(
|
319
|
+
T.attached_class
|
320
|
+
)
|
321
|
+
end
|
237
322
|
def self.new(
|
238
323
|
# Limits the results to messages inserted after the given date.
|
239
324
|
gt: nil,
|
@@ -243,28 +328,47 @@ module Knockapi
|
|
243
328
|
lt: nil,
|
244
329
|
# Limits the results to messages inserted before or on the given date.
|
245
330
|
lte: nil
|
246
|
-
)
|
247
|
-
|
248
|
-
|
331
|
+
)
|
332
|
+
end
|
333
|
+
|
334
|
+
sig do
|
335
|
+
override.returns({ gt: String, gte: String, lt: String, lte: String })
|
336
|
+
end
|
337
|
+
def to_hash
|
338
|
+
end
|
249
339
|
end
|
250
340
|
|
251
341
|
module Status
|
252
342
|
extend Knockapi::Internal::Type::Enum
|
253
343
|
|
254
|
-
TaggedSymbol =
|
344
|
+
TaggedSymbol =
|
345
|
+
T.type_alias { T.all(Symbol, Knockapi::MessageListParams::Status) }
|
255
346
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
256
347
|
|
257
|
-
QUEUED =
|
258
|
-
|
259
|
-
|
348
|
+
QUEUED =
|
349
|
+
T.let(:queued, Knockapi::MessageListParams::Status::TaggedSymbol)
|
350
|
+
SENT = T.let(:sent, Knockapi::MessageListParams::Status::TaggedSymbol)
|
351
|
+
DELIVERED =
|
352
|
+
T.let(:delivered, Knockapi::MessageListParams::Status::TaggedSymbol)
|
260
353
|
DELIVERY_ATTEMPTED =
|
261
|
-
T.let(
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
354
|
+
T.let(
|
355
|
+
:delivery_attempted,
|
356
|
+
Knockapi::MessageListParams::Status::TaggedSymbol
|
357
|
+
)
|
358
|
+
UNDELIVERED =
|
359
|
+
T.let(:undelivered, Knockapi::MessageListParams::Status::TaggedSymbol)
|
360
|
+
NOT_SENT =
|
361
|
+
T.let(:not_sent, Knockapi::MessageListParams::Status::TaggedSymbol)
|
362
|
+
BOUNCED =
|
363
|
+
T.let(:bounced, Knockapi::MessageListParams::Status::TaggedSymbol)
|
364
|
+
|
365
|
+
sig do
|
366
|
+
override.returns(
|
367
|
+
T::Array[Knockapi::MessageListParams::Status::TaggedSymbol]
|
368
|
+
)
|
369
|
+
end
|
370
|
+
def self.values
|
371
|
+
end
|
268
372
|
end
|
269
373
|
end
|
270
374
|
end
|
@@ -6,6 +6,14 @@ 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(
|
12
|
+
Knockapi::MessageMarkAsInteractedParams,
|
13
|
+
Knockapi::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
# Metadata about the interaction.
|
10
18
|
sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
|
11
19
|
attr_reader :metadata
|
@@ -16,19 +24,26 @@ module Knockapi
|
|
16
24
|
sig do
|
17
25
|
params(
|
18
26
|
metadata: T::Hash[Symbol, T.anything],
|
19
|
-
request_options:
|
20
|
-
)
|
21
|
-
.returns(T.attached_class)
|
27
|
+
request_options: Knockapi::RequestOptions::OrHash
|
28
|
+
).returns(T.attached_class)
|
22
29
|
end
|
23
30
|
def self.new(
|
24
31
|
# Metadata about the interaction.
|
25
32
|
metadata: nil,
|
26
33
|
request_options: {}
|
27
|
-
)
|
34
|
+
)
|
35
|
+
end
|
36
|
+
|
28
37
|
sig do
|
29
|
-
override.returns(
|
38
|
+
override.returns(
|
39
|
+
{
|
40
|
+
metadata: T::Hash[Symbol, T.anything],
|
41
|
+
request_options: Knockapi::RequestOptions
|
42
|
+
}
|
43
|
+
)
|
44
|
+
end
|
45
|
+
def to_hash
|
30
46
|
end
|
31
|
-
def to_hash; end
|
32
47
|
end
|
33
48
|
end
|
34
49
|
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::MessageMarkAsReadParams, 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
|
@@ -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::MessageMarkAsSeenParams, 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
|
@@ -6,14 +6,25 @@ 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(
|
12
|
+
Knockapi::MessageMarkAsUnreadParams,
|
13
|
+
Knockapi::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
sig do
|
10
|
-
params(request_options:
|
11
|
-
|
18
|
+
params(request_options: Knockapi::RequestOptions::OrHash).returns(
|
19
|
+
T.attached_class
|
20
|
+
)
|
21
|
+
end
|
22
|
+
def self.new(request_options: {})
|
12
23
|
end
|
13
|
-
def self.new(request_options: {}); end
|
14
24
|
|
15
|
-
sig { override.returns({request_options: Knockapi::RequestOptions}) }
|
16
|
-
def to_hash
|
25
|
+
sig { override.returns({ request_options: Knockapi::RequestOptions }) }
|
26
|
+
def to_hash
|
27
|
+
end
|
17
28
|
end
|
18
29
|
end
|
19
30
|
end
|
@@ -6,14 +6,25 @@ 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(
|
12
|
+
Knockapi::MessageMarkAsUnseenParams,
|
13
|
+
Knockapi::Internal::AnyHash
|
14
|
+
)
|
15
|
+
end
|
16
|
+
|
9
17
|
sig do
|
10
|
-
params(request_options:
|
11
|
-
|
18
|
+
params(request_options: Knockapi::RequestOptions::OrHash).returns(
|
19
|
+
T.attached_class
|
20
|
+
)
|
21
|
+
end
|
22
|
+
def self.new(request_options: {})
|
12
23
|
end
|
13
|
-
def self.new(request_options: {}); end
|
14
24
|
|
15
|
-
sig { override.returns({request_options: Knockapi::RequestOptions}) }
|
16
|
-
def to_hash
|
25
|
+
sig { override.returns({ request_options: Knockapi::RequestOptions }) }
|
26
|
+
def to_hash
|
27
|
+
end
|
17
28
|
end
|
18
29
|
end
|
19
30
|
end
|