knockapi 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +61 -0
- data/README.md +101 -49
- data/lib/knockapi/client.rb +4 -4
- data/lib/knockapi/errors.rb +1 -1
- data/lib/knockapi/file_part.rb +2 -2
- data/lib/knockapi/internal/entries_cursor.rb +3 -3
- data/lib/knockapi/internal/items_cursor.rb +3 -3
- data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
- data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
- data/lib/knockapi/internal/transport/base_client.rb +79 -7
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/knockapi/internal/type/array_of.rb +9 -1
- data/lib/knockapi/internal/type/base_model.rb +78 -39
- data/lib/knockapi/internal/type/boolean.rb +8 -0
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +13 -0
- data/lib/knockapi/internal/type/file_input.rb +7 -0
- data/lib/knockapi/internal/type/hash_of.rb +9 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +16 -3
- data/lib/knockapi/internal/type/unknown.rb +8 -0
- data/lib/knockapi/internal/util.rb +119 -2
- data/lib/knockapi/internal.rb +9 -0
- data/lib/knockapi/models/activity.rb +6 -6
- data/lib/knockapi/models/audience_add_members_params.rb +10 -8
- data/lib/knockapi/models/audience_add_members_response.rb +7 -0
- data/lib/knockapi/models/audience_list_members_response.rb +6 -6
- data/lib/knockapi/models/audience_member.rb +5 -6
- data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +7 -8
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
- data/lib/knockapi/models/condition.rb +4 -4
- data/lib/knockapi/models/identify_user_request.rb +16 -17
- data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
- data/lib/knockapi/models/inline_object_request.rb +8 -6
- data/lib/knockapi/models/inline_tenant_request.rb +2 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +18 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_list_params.rb +14 -15
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
- data/lib/knockapi/models/object.rb +9 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
- data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_delete_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_list_messages_params.rb +16 -14
- data/lib/knockapi/models/object_list_params.rb +3 -4
- data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
- data/lib/knockapi/models/object_set_params.rb +15 -13
- data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
- data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
- data/lib/knockapi/models/recipient.rb +3 -3
- data/lib/knockapi/models/recipient_reference.rb +2 -2
- data/lib/knockapi/models/recipient_request.rb +3 -3
- data/lib/knockapi/models/recipients/channel_data.rb +14 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +10 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +24 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/preference_set.rb +34 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +36 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +34 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +12 -10
- data/lib/knockapi/models/recipients/subscription.rb +6 -6
- data/lib/knockapi/models/schedule.rb +11 -12
- data/lib/knockapi/models/schedule_create_params.rb +10 -15
- data/lib/knockapi/models/schedule_create_response.rb +1 -1
- data/lib/knockapi/models/schedule_delete_response.rb +1 -1
- data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
- data/lib/knockapi/models/schedule_update_params.rb +9 -10
- data/lib/knockapi/models/schedule_update_response.rb +1 -1
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
- data/lib/knockapi/models/tenant.rb +13 -16
- data/lib/knockapi/models/tenant_delete_response.rb +7 -0
- data/lib/knockapi/models/tenant_request.rb +20 -20
- data/lib/knockapi/models/tenant_set_params.rb +19 -19
- data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/user.rb +9 -11
- data/lib/knockapi/models/user_delete_response.rb +7 -0
- data/lib/knockapi/models/user_list_messages_params.rb +18 -14
- data/lib/knockapi/models/user_list_params.rb +3 -4
- data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
- data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
- data/lib/knockapi/models/users/feed_list_items_response.rb +6 -6
- data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
- data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
- data/lib/knockapi/models.rb +213 -0
- data/lib/knockapi/request_options.rb +4 -0
- data/lib/knockapi/resources/audiences.rb +4 -4
- data/lib/knockapi/resources/bulk_operations.rb +2 -2
- data/lib/knockapi/resources/channels/bulk.rb +7 -8
- data/lib/knockapi/resources/integrations/census.rb +1 -1
- data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
- data/lib/knockapi/resources/messages/batch.rb +22 -22
- data/lib/knockapi/resources/messages.rb +32 -39
- data/lib/knockapi/resources/objects/bulk.rb +11 -11
- data/lib/knockapi/resources/objects.rb +52 -62
- data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
- data/lib/knockapi/resources/providers/slack.rb +4 -4
- data/lib/knockapi/resources/schedules/bulk.rb +4 -4
- data/lib/knockapi/resources/schedules.rb +18 -23
- data/lib/knockapi/resources/tenants/bulk.rb +7 -7
- data/lib/knockapi/resources/tenants.rb +11 -11
- data/lib/knockapi/resources/users/bulk.rb +11 -11
- data/lib/knockapi/resources/users/feeds.rb +3 -3
- data/lib/knockapi/resources/users/guides.rb +4 -4
- data/lib/knockapi/resources/users.rb +46 -54
- data/lib/knockapi/resources/workflows.rb +6 -11
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +11 -2
- data/rbi/knockapi/client.rbi +5 -4
- data/rbi/knockapi/errors.rbi +35 -16
- data/rbi/knockapi/file_part.rbi +9 -6
- data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
- data/rbi/knockapi/internal/items_cursor.rbi +9 -4
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
- data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
- data/rbi/knockapi/internal/type/array_of.rbi +40 -24
- data/rbi/knockapi/internal/type/base_model.rbi +156 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +22 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +33 -15
- data/rbi/knockapi/internal/type/file_input.rbi +13 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +40 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +60 -19
- data/rbi/knockapi/internal/type/unknown.rbi +22 -6
- data/rbi/knockapi/internal/util.rbi +273 -87
- data/rbi/knockapi/internal.rbi +5 -0
- data/rbi/knockapi/models/activity.rbi +28 -22
- data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
- data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
- data/rbi/knockapi/models/audience_member.rbi +23 -11
- data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +70 -42
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
- data/rbi/knockapi/models/condition.rbi +78 -31
- data/rbi/knockapi/models/identify_user_request.rbi +90 -36
- data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
- data/rbi/knockapi/models/inline_object_request.rbi +76 -22
- data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
- data/rbi/knockapi/models/message.rbi +140 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +175 -72
- data/rbi/knockapi/models/message_event.rbi +83 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +366 -226
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
- data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
- data/rbi/knockapi/models/message_list_params.rbi +162 -58
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +370 -227
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
- data/rbi/knockapi/models/object.rbi +31 -10
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_delete_params.rbi +13 -5
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_get_params.rbi +13 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +185 -61
- data/rbi/knockapi/models/object_list_params.rbi +43 -22
- data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_set_params.rbi +89 -33
- data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/page_info.rbi +22 -11
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/recipient.rbi +5 -2
- data/rbi/knockapi/models/recipient_reference.rbi +22 -5
- data/rbi/knockapi/models/recipient_request.rbi +11 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +113 -55
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/preference_set.rbi +159 -100
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
- data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
- data/rbi/knockapi/models/schedule.rbi +32 -27
- data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
- data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
- data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
- data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
- data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
- data/rbi/knockapi/models/tenant.rbi +71 -45
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
- data/rbi/knockapi/models/tenant_request.rbi +132 -57
- data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/user.rbi +32 -28
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
- data/rbi/knockapi/models/user_list_messages_params.rbi +183 -59
- data/rbi/knockapi/models/user_list_params.rbi +43 -22
- data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
- data/rbi/knockapi/models/user_merge_params.rbi +17 -6
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +199 -108
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
- data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
- data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +18 -7
- data/rbi/knockapi/resources/audiences.rbi +22 -14
- data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
- data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
- data/rbi/knockapi/resources/channels.rbi +2 -1
- data/rbi/knockapi/resources/integrations/census.rbi +8 -4
- data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
- data/rbi/knockapi/resources/integrations.rbi +2 -1
- data/rbi/knockapi/resources/messages/batch.rbi +58 -26
- data/rbi/knockapi/resources/messages.rbi +102 -43
- data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
- data/rbi/knockapi/resources/objects.rbi +177 -107
- data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
- data/rbi/knockapi/resources/providers/slack.rbi +28 -11
- data/rbi/knockapi/resources/providers.rbi +2 -1
- data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
- data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
- data/rbi/knockapi/resources/recipients.rbi +2 -1
- data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
- data/rbi/knockapi/resources/schedules.rbi +44 -33
- data/rbi/knockapi/resources/shared.rbi +2 -1
- data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
- data/rbi/knockapi/resources/tenants.rbi +51 -20
- data/rbi/knockapi/resources/users/bulk.rbi +21 -14
- data/rbi/knockapi/resources/users/feeds.rbi +20 -9
- data/rbi/knockapi/resources/users/guides.rbi +23 -16
- data/rbi/knockapi/resources/users.rbi +160 -91
- data/rbi/knockapi/resources/workflows.rbi +38 -29
- data/sig/knockapi/internal/entries_cursor.rbs +0 -2
- data/sig/knockapi/internal/items_cursor.rbs +0 -2
- data/sig/knockapi/internal/transport/base_client.rbs +16 -1
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/knockapi/internal/type/array_of.rbs +3 -0
- data/sig/knockapi/internal/type/base_model.rbs +13 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/boolean.rbs +3 -0
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +3 -0
- data/sig/knockapi/internal/type/file_input.rbs +2 -0
- data/sig/knockapi/internal/type/hash_of.rbs +3 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +3 -0
- data/sig/knockapi/internal/type/unknown.rbs +3 -0
- data/sig/knockapi/internal/util.rbs +27 -0
- data/sig/knockapi/internal.rbs +4 -0
- data/sig/knockapi/models/activity.rbs +0 -2
- data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
- data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
- data/sig/knockapi/models/audience_member.rbs +3 -5
- data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +9 -13
- data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
- data/sig/knockapi/models/condition.rbs +4 -6
- data/sig/knockapi/models/identify_user_request.rbs +0 -2
- data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
- data/sig/knockapi/models/inline_object_request.rbs +0 -2
- data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
- data/sig/knockapi/models/message.rbs +15 -23
- data/sig/knockapi/models/message_archive_params.rbs +0 -2
- data/sig/knockapi/models/message_delivery_log.rbs +24 -30
- data/sig/knockapi/models/message_event.rbs +4 -6
- data/sig/knockapi/models/message_get_content_params.rbs +0 -2
- data/sig/knockapi/models/message_get_content_response.rbs +2 -24
- data/sig/knockapi/models/message_get_params.rbs +0 -2
- data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
- data/sig/knockapi/models/message_list_events_params.rbs +0 -2
- data/sig/knockapi/models/message_list_params.rbs +30 -24
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +8 -4
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_delete_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_get_params.rbs +0 -2
- data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/object_list_params.rbs +6 -8
- data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
- data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_set_params.rbs +0 -2
- data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
- data/sig/knockapi/models/page_info.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/recipient.rbs +2 -2
- data/sig/knockapi/models/recipient_reference.rbs +2 -4
- data/sig/knockapi/models/recipient_request.rbs +3 -3
- data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
- data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
- data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
- data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/subscription.rbs +3 -5
- data/sig/knockapi/models/schedule.rbs +3 -5
- data/sig/knockapi/models/schedule_create_params.rbs +3 -5
- data/sig/knockapi/models/schedule_create_response.rbs +1 -1
- data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
- data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
- data/sig/knockapi/models/schedule_list_params.rbs +0 -2
- data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
- data/sig/knockapi/models/schedule_update_params.rbs +5 -7
- data/sig/knockapi/models/schedule_update_response.rbs +1 -1
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
- data/sig/knockapi/models/tenant.rbs +9 -15
- data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +0 -2
- data/sig/knockapi/models/tenant_list_params.rbs +0 -2
- data/sig/knockapi/models/tenant_request.rbs +13 -19
- data/sig/knockapi/models/tenant_set_params.rbs +13 -19
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
- data/sig/knockapi/models/user.rbs +0 -2
- data/sig/knockapi/models/user_delete_params.rbs +0 -2
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_get_params.rbs +0 -2
- data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/user_list_params.rbs +6 -8
- data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
- data/sig/knockapi/models/user_merge_params.rbs +0 -2
- data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
- data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
- data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
- data/sig/knockapi/models.rbs +173 -0
- data/sig/knockapi/request_options.rbs +1 -1
- data/sig/knockapi/resources/audiences.rbs +2 -2
- data/sig/knockapi/resources/bulk_operations.rbs +1 -1
- data/sig/knockapi/resources/channels/bulk.rbs +1 -1
- data/sig/knockapi/resources/messages.rbs +15 -17
- data/sig/knockapi/resources/objects/bulk.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +19 -19
- data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
- data/sig/knockapi/resources/providers/slack.rbs +1 -1
- data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
- data/sig/knockapi/resources/schedules.rbs +3 -3
- data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
- data/sig/knockapi/resources/tenants.rbs +4 -4
- data/sig/knockapi/resources/users/bulk.rbs +5 -5
- data/sig/knockapi/resources/users.rbs +19 -19
- metadata +29 -8
- data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
- data/lib/knockapi/resources/messages/activities.rb +0 -47
- data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
- data/rbi/knockapi/resources/messages/activities.rbi +0 -38
- data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
- data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -7,34 +7,65 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# Limits the results to messages with the given archived status.
|
11
|
-
sig
|
19
|
+
sig do
|
20
|
+
returns(
|
21
|
+
T.nilable(
|
22
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol
|
23
|
+
)
|
24
|
+
)
|
25
|
+
end
|
12
26
|
attr_reader :archived
|
13
27
|
|
14
|
-
sig
|
28
|
+
sig do
|
29
|
+
params(
|
30
|
+
archived:
|
31
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol
|
32
|
+
).void
|
33
|
+
end
|
15
34
|
attr_writer :archived
|
16
35
|
|
17
36
|
# Limits the results to messages with the given delivery status.
|
18
|
-
sig
|
37
|
+
sig do
|
38
|
+
returns(
|
39
|
+
T.nilable(
|
40
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol
|
41
|
+
)
|
42
|
+
)
|
43
|
+
end
|
19
44
|
attr_reader :delivery_status
|
20
45
|
|
21
46
|
sig do
|
22
47
|
params(
|
23
|
-
delivery_status:
|
24
|
-
|
25
|
-
|
48
|
+
delivery_status:
|
49
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol
|
50
|
+
).void
|
26
51
|
end
|
27
52
|
attr_writer :delivery_status
|
28
53
|
|
29
54
|
# Limits the results to messages with the given engagement status.
|
30
|
-
sig
|
55
|
+
sig do
|
56
|
+
returns(
|
57
|
+
T.nilable(
|
58
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol
|
59
|
+
)
|
60
|
+
)
|
61
|
+
end
|
31
62
|
attr_reader :engagement_status
|
32
63
|
|
33
64
|
sig do
|
34
65
|
params(
|
35
|
-
engagement_status:
|
36
|
-
|
37
|
-
|
66
|
+
engagement_status:
|
67
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol
|
68
|
+
).void
|
38
69
|
end
|
39
70
|
attr_writer :engagement_status
|
40
71
|
|
@@ -91,9 +122,12 @@ module Knockapi
|
|
91
122
|
|
92
123
|
sig do
|
93
124
|
params(
|
94
|
-
archived:
|
95
|
-
|
96
|
-
|
125
|
+
archived:
|
126
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
|
127
|
+
delivery_status:
|
128
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
|
129
|
+
engagement_status:
|
130
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
|
97
131
|
has_tenant: T::Boolean,
|
98
132
|
newer_than: Time,
|
99
133
|
older_than: Time,
|
@@ -101,9 +135,8 @@ module Knockapi
|
|
101
135
|
tenants: T::Array[String],
|
102
136
|
trigger_data: String,
|
103
137
|
workflows: T::Array[String],
|
104
|
-
request_options:
|
105
|
-
)
|
106
|
-
.returns(T.attached_class)
|
138
|
+
request_options: Knockapi::RequestOptions::OrHash
|
139
|
+
).returns(T.attached_class)
|
107
140
|
end
|
108
141
|
def self.new(
|
109
142
|
# Limits the results to messages with the given archived status.
|
@@ -129,54 +162,104 @@ module Knockapi
|
|
129
162
|
# Limits the results to messages with the given workflow keys.
|
130
163
|
workflows: nil,
|
131
164
|
request_options: {}
|
132
|
-
)
|
165
|
+
)
|
166
|
+
end
|
167
|
+
|
133
168
|
sig do
|
134
|
-
override
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
149
|
-
|
169
|
+
override.returns(
|
170
|
+
{
|
171
|
+
archived:
|
172
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::OrSymbol,
|
173
|
+
delivery_status:
|
174
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::OrSymbol,
|
175
|
+
engagement_status:
|
176
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::OrSymbol,
|
177
|
+
has_tenant: T::Boolean,
|
178
|
+
newer_than: Time,
|
179
|
+
older_than: Time,
|
180
|
+
recipient_ids: T::Array[String],
|
181
|
+
tenants: T::Array[String],
|
182
|
+
trigger_data: String,
|
183
|
+
workflows: T::Array[String],
|
184
|
+
request_options: Knockapi::RequestOptions
|
185
|
+
}
|
186
|
+
)
|
187
|
+
end
|
188
|
+
def to_hash
|
150
189
|
end
|
151
|
-
def to_hash; end
|
152
190
|
|
153
191
|
module Action
|
154
192
|
extend Knockapi::Internal::Type::Enum
|
155
193
|
|
156
194
|
TaggedSymbol =
|
157
|
-
T.type_alias
|
195
|
+
T.type_alias do
|
196
|
+
T.all(
|
197
|
+
Symbol,
|
198
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action
|
199
|
+
)
|
200
|
+
end
|
158
201
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
159
202
|
|
160
|
-
SEEN =
|
161
|
-
|
162
|
-
|
163
|
-
|
203
|
+
SEEN =
|
204
|
+
T.let(
|
205
|
+
:seen,
|
206
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
207
|
+
)
|
208
|
+
UNSEEN =
|
209
|
+
T.let(
|
210
|
+
:unseen,
|
211
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
212
|
+
)
|
213
|
+
READ =
|
214
|
+
T.let(
|
215
|
+
:read,
|
216
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
217
|
+
)
|
218
|
+
UNREAD =
|
219
|
+
T.let(
|
220
|
+
:unread,
|
221
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
222
|
+
)
|
164
223
|
ARCHIVED =
|
165
|
-
T.let(
|
224
|
+
T.let(
|
225
|
+
:archived,
|
226
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
227
|
+
)
|
166
228
|
UNARCHIVED =
|
167
|
-
T.let(
|
229
|
+
T.let(
|
230
|
+
:unarchived,
|
231
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
232
|
+
)
|
168
233
|
INTERACTED =
|
169
|
-
T.let(
|
234
|
+
T.let(
|
235
|
+
:interacted,
|
236
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
237
|
+
)
|
170
238
|
ARCHIVE =
|
171
|
-
T.let(
|
239
|
+
T.let(
|
240
|
+
:archive,
|
241
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
242
|
+
)
|
172
243
|
UNARCHIVE =
|
173
|
-
T.let(
|
174
|
-
|
244
|
+
T.let(
|
245
|
+
:unarchive,
|
246
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
247
|
+
)
|
248
|
+
DELETE =
|
249
|
+
T.let(
|
250
|
+
:delete,
|
251
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
252
|
+
)
|
175
253
|
|
176
254
|
sig do
|
177
|
-
override.returns(
|
255
|
+
override.returns(
|
256
|
+
T::Array[
|
257
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Action::TaggedSymbol
|
258
|
+
]
|
259
|
+
)
|
260
|
+
end
|
261
|
+
def self.values
|
178
262
|
end
|
179
|
-
def self.values; end
|
180
263
|
end
|
181
264
|
|
182
265
|
# Limits the results to messages with the given archived status.
|
@@ -184,20 +267,39 @@ module Knockapi
|
|
184
267
|
extend Knockapi::Internal::Type::Enum
|
185
268
|
|
186
269
|
TaggedSymbol =
|
187
|
-
T.type_alias
|
270
|
+
T.type_alias do
|
271
|
+
T.all(
|
272
|
+
Symbol,
|
273
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived
|
274
|
+
)
|
275
|
+
end
|
188
276
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
189
277
|
|
190
278
|
EXCLUDE =
|
191
|
-
T.let(
|
279
|
+
T.let(
|
280
|
+
:exclude,
|
281
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol
|
282
|
+
)
|
192
283
|
INCLUDE =
|
193
|
-
T.let(
|
194
|
-
|
284
|
+
T.let(
|
285
|
+
:include,
|
286
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol
|
287
|
+
)
|
288
|
+
ONLY =
|
289
|
+
T.let(
|
290
|
+
:only,
|
291
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol
|
292
|
+
)
|
195
293
|
|
196
294
|
sig do
|
197
|
-
override
|
198
|
-
|
295
|
+
override.returns(
|
296
|
+
T::Array[
|
297
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::Archived::TaggedSymbol
|
298
|
+
]
|
299
|
+
)
|
300
|
+
end
|
301
|
+
def self.values
|
199
302
|
end
|
200
|
-
def self.values; end
|
201
303
|
end
|
202
304
|
|
203
305
|
# Limits the results to messages with the given delivery status.
|
@@ -205,35 +307,59 @@ module Knockapi
|
|
205
307
|
extend Knockapi::Internal::Type::Enum
|
206
308
|
|
207
309
|
TaggedSymbol =
|
208
|
-
T.type_alias
|
310
|
+
T.type_alias do
|
311
|
+
T.all(
|
312
|
+
Symbol,
|
313
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus
|
314
|
+
)
|
315
|
+
end
|
209
316
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
210
317
|
|
211
318
|
QUEUED =
|
212
|
-
T.let(
|
319
|
+
T.let(
|
320
|
+
:queued,
|
321
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
322
|
+
)
|
213
323
|
SENT =
|
214
|
-
T.let(
|
324
|
+
T.let(
|
325
|
+
:sent,
|
326
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
327
|
+
)
|
215
328
|
DELIVERED =
|
216
|
-
T.let(
|
329
|
+
T.let(
|
330
|
+
:delivered,
|
331
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
332
|
+
)
|
217
333
|
DELIVERY_ATTEMPTED =
|
218
334
|
T.let(
|
219
335
|
:delivery_attempted,
|
220
|
-
Knockapi::
|
336
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
221
337
|
)
|
222
338
|
UNDELIVERED =
|
223
339
|
T.let(
|
224
340
|
:undelivered,
|
225
|
-
Knockapi::
|
341
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
226
342
|
)
|
227
343
|
NOT_SENT =
|
228
|
-
T.let(
|
344
|
+
T.let(
|
345
|
+
:not_sent,
|
346
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
347
|
+
)
|
229
348
|
BOUNCED =
|
230
|
-
T.let(
|
349
|
+
T.let(
|
350
|
+
:bounced,
|
351
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
352
|
+
)
|
231
353
|
|
232
354
|
sig do
|
233
|
-
override
|
234
|
-
|
355
|
+
override.returns(
|
356
|
+
T::Array[
|
357
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus::TaggedSymbol
|
358
|
+
]
|
359
|
+
)
|
360
|
+
end
|
361
|
+
def self.values
|
235
362
|
end
|
236
|
-
def self.values; end
|
237
363
|
end
|
238
364
|
|
239
365
|
# Limits the results to messages with the given engagement status.
|
@@ -241,45 +367,64 @@ module Knockapi
|
|
241
367
|
extend Knockapi::Internal::Type::Enum
|
242
368
|
|
243
369
|
TaggedSymbol =
|
244
|
-
T.type_alias
|
370
|
+
T.type_alias do
|
371
|
+
T.all(
|
372
|
+
Symbol,
|
373
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus
|
374
|
+
)
|
375
|
+
end
|
245
376
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
246
377
|
|
247
378
|
SEEN =
|
248
|
-
T.let(
|
379
|
+
T.let(
|
380
|
+
:seen,
|
381
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
382
|
+
)
|
249
383
|
UNSEEN =
|
250
|
-
T.let(
|
384
|
+
T.let(
|
385
|
+
:unseen,
|
386
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
387
|
+
)
|
251
388
|
READ =
|
252
|
-
T.let(
|
389
|
+
T.let(
|
390
|
+
:read,
|
391
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
392
|
+
)
|
253
393
|
UNREAD =
|
254
|
-
T.let(
|
394
|
+
T.let(
|
395
|
+
:unread,
|
396
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
397
|
+
)
|
255
398
|
ARCHIVED =
|
256
399
|
T.let(
|
257
400
|
:archived,
|
258
|
-
Knockapi::
|
401
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
259
402
|
)
|
260
403
|
UNARCHIVED =
|
261
404
|
T.let(
|
262
405
|
:unarchived,
|
263
|
-
Knockapi::
|
406
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
264
407
|
)
|
265
408
|
LINK_CLICKED =
|
266
409
|
T.let(
|
267
410
|
:link_clicked,
|
268
|
-
Knockapi::
|
411
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
269
412
|
)
|
270
413
|
INTERACTED =
|
271
414
|
T.let(
|
272
415
|
:interacted,
|
273
|
-
Knockapi::
|
416
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
274
417
|
)
|
275
418
|
|
276
419
|
sig do
|
277
|
-
override
|
278
|
-
|
279
|
-
|
280
|
-
|
420
|
+
override.returns(
|
421
|
+
T::Array[
|
422
|
+
Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus::TaggedSymbol
|
423
|
+
]
|
424
|
+
)
|
425
|
+
end
|
426
|
+
def self.values
|
281
427
|
end
|
282
|
-
def self.values; end
|
283
428
|
end
|
284
429
|
end
|
285
430
|
end
|
@@ -3,12 +3,15 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
class Condition < Knockapi::Internal::Type::BaseModel
|
6
|
+
OrHash =
|
7
|
+
T.type_alias { T.any(Knockapi::Condition, Knockapi::Internal::AnyHash) }
|
8
|
+
|
6
9
|
# The argument value to compare against in the condition.
|
7
10
|
sig { returns(T.nilable(String)) }
|
8
11
|
attr_accessor :argument
|
9
12
|
|
10
13
|
# The operator to use in the condition evaluation.
|
11
|
-
sig { returns(Knockapi::
|
14
|
+
sig { returns(Knockapi::Condition::Operator::OrSymbol) }
|
12
15
|
attr_accessor :operator
|
13
16
|
|
14
17
|
# The variable to be evaluated in the condition.
|
@@ -19,10 +22,9 @@ module Knockapi
|
|
19
22
|
sig do
|
20
23
|
params(
|
21
24
|
argument: T.nilable(String),
|
22
|
-
operator: Knockapi::
|
25
|
+
operator: Knockapi::Condition::Operator::OrSymbol,
|
23
26
|
variable: String
|
24
|
-
)
|
25
|
-
.returns(T.attached_class)
|
27
|
+
).returns(T.attached_class)
|
26
28
|
end
|
27
29
|
def self.new(
|
28
30
|
# The argument value to compare against in the condition.
|
@@ -31,46 +33,91 @@ module Knockapi
|
|
31
33
|
operator:,
|
32
34
|
# The variable to be evaluated in the condition.
|
33
35
|
variable:
|
34
|
-
)
|
36
|
+
)
|
37
|
+
end
|
38
|
+
|
35
39
|
sig do
|
36
|
-
override
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
+
override.returns(
|
41
|
+
{
|
42
|
+
argument: T.nilable(String),
|
43
|
+
operator: Knockapi::Condition::Operator::OrSymbol,
|
44
|
+
variable: String
|
45
|
+
}
|
46
|
+
)
|
47
|
+
end
|
48
|
+
def to_hash
|
40
49
|
end
|
41
|
-
def to_hash; end
|
42
50
|
|
43
51
|
# The operator to use in the condition evaluation.
|
44
52
|
module Operator
|
45
53
|
extend Knockapi::Internal::Type::Enum
|
46
54
|
|
47
|
-
TaggedSymbol =
|
55
|
+
TaggedSymbol =
|
56
|
+
T.type_alias { T.all(Symbol, Knockapi::Condition::Operator) }
|
48
57
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
49
58
|
|
50
|
-
EQUAL_TO = T.let(:equal_to, Knockapi::
|
51
|
-
NOT_EQUAL_TO =
|
52
|
-
|
53
|
-
|
59
|
+
EQUAL_TO = T.let(:equal_to, Knockapi::Condition::Operator::TaggedSymbol)
|
60
|
+
NOT_EQUAL_TO =
|
61
|
+
T.let(:not_equal_to, Knockapi::Condition::Operator::TaggedSymbol)
|
62
|
+
GREATER_THAN =
|
63
|
+
T.let(:greater_than, Knockapi::Condition::Operator::TaggedSymbol)
|
64
|
+
LESS_THAN =
|
65
|
+
T.let(:less_than, Knockapi::Condition::Operator::TaggedSymbol)
|
54
66
|
GREATER_THAN_OR_EQUAL_TO =
|
55
|
-
T.let(
|
67
|
+
T.let(
|
68
|
+
:greater_than_or_equal_to,
|
69
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
70
|
+
)
|
56
71
|
LESS_THAN_OR_EQUAL_TO =
|
57
|
-
T.let(
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
72
|
+
T.let(
|
73
|
+
:less_than_or_equal_to,
|
74
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
75
|
+
)
|
76
|
+
CONTAINS = T.let(:contains, Knockapi::Condition::Operator::TaggedSymbol)
|
77
|
+
NOT_CONTAINS =
|
78
|
+
T.let(:not_contains, Knockapi::Condition::Operator::TaggedSymbol)
|
79
|
+
EMPTY = T.let(:empty, Knockapi::Condition::Operator::TaggedSymbol)
|
80
|
+
NOT_EMPTY =
|
81
|
+
T.let(:not_empty, Knockapi::Condition::Operator::TaggedSymbol)
|
82
|
+
CONTAINS_ALL =
|
83
|
+
T.let(:contains_all, Knockapi::Condition::Operator::TaggedSymbol)
|
84
|
+
IS_TIMESTAMP =
|
85
|
+
T.let(:is_timestamp, Knockapi::Condition::Operator::TaggedSymbol)
|
86
|
+
IS_NOT_TIMESTAMP =
|
87
|
+
T.let(:is_not_timestamp, Knockapi::Condition::Operator::TaggedSymbol)
|
88
|
+
IS_TIMESTAMP_AFTER =
|
89
|
+
T.let(
|
90
|
+
:is_timestamp_after,
|
91
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
92
|
+
)
|
93
|
+
IS_TIMESTAMP_BEFORE =
|
94
|
+
T.let(
|
95
|
+
:is_timestamp_before,
|
96
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
97
|
+
)
|
98
|
+
IS_TIMESTAMP_BETWEEN =
|
99
|
+
T.let(
|
100
|
+
:is_timestamp_between,
|
101
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
102
|
+
)
|
103
|
+
IS_AUDIENCE_MEMBER =
|
104
|
+
T.let(
|
105
|
+
:is_audience_member,
|
106
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
107
|
+
)
|
69
108
|
IS_NOT_AUDIENCE_MEMBER =
|
70
|
-
T.let(
|
109
|
+
T.let(
|
110
|
+
:is_not_audience_member,
|
111
|
+
Knockapi::Condition::Operator::TaggedSymbol
|
112
|
+
)
|
71
113
|
|
72
|
-
sig
|
73
|
-
|
114
|
+
sig do
|
115
|
+
override.returns(
|
116
|
+
T::Array[Knockapi::Condition::Operator::TaggedSymbol]
|
117
|
+
)
|
118
|
+
end
|
119
|
+
def self.values
|
120
|
+
end
|
74
121
|
end
|
75
122
|
end
|
76
123
|
end
|