knockapi 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +41 -0
- data/README.md +101 -49
- data/lib/knockapi/client.rb +4 -4
- data/lib/knockapi/errors.rb +1 -1
- data/lib/knockapi/file_part.rb +2 -2
- data/lib/knockapi/internal/entries_cursor.rb +3 -3
- data/lib/knockapi/internal/items_cursor.rb +3 -3
- data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
- data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
- data/lib/knockapi/internal/transport/base_client.rb +79 -7
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/knockapi/internal/type/array_of.rb +1 -1
- data/lib/knockapi/internal/type/base_model.rb +71 -39
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +1 -0
- data/lib/knockapi/internal/type/hash_of.rb +1 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +4 -3
- data/lib/knockapi/internal/util.rb +74 -2
- data/lib/knockapi/internal.rb +6 -0
- data/lib/knockapi/models/activity.rb +6 -6
- data/lib/knockapi/models/audience_add_members_params.rb +10 -8
- data/lib/knockapi/models/audience_add_members_response.rb +7 -0
- data/lib/knockapi/models/audience_list_members_response.rb +6 -6
- data/lib/knockapi/models/audience_member.rb +5 -6
- data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +7 -8
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
- data/lib/knockapi/models/condition.rb +4 -4
- data/lib/knockapi/models/identify_user_request.rb +16 -17
- data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
- data/lib/knockapi/models/inline_object_request.rb +8 -6
- data/lib/knockapi/models/inline_tenant_request.rb +6 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +26 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_get_content_response.rb +21 -0
- data/lib/knockapi/models/message_list_params.rb +9 -13
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_get_content_response.rb +21 -0
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
- data/lib/knockapi/models/object.rb +9 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
- data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_delete_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_list_messages_params.rb +11 -12
- data/lib/knockapi/models/object_list_params.rb +3 -4
- data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
- data/lib/knockapi/models/object_set_params.rb +15 -13
- data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
- data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
- data/lib/knockapi/models/recipient.rb +7 -3
- data/lib/knockapi/models/recipient_reference.rb +6 -2
- data/lib/knockapi/models/recipient_request.rb +7 -3
- data/lib/knockapi/models/recipients/channel_data.rb +26 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +22 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +36 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +25 -10
- data/lib/knockapi/models/recipients/preference_set.rb +52 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +60 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +52 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +21 -10
- data/lib/knockapi/models/recipients/subscription.rb +6 -6
- data/lib/knockapi/models/schedule.rb +11 -12
- data/lib/knockapi/models/schedule_create_params.rb +10 -15
- data/lib/knockapi/models/schedule_create_response.rb +1 -1
- data/lib/knockapi/models/schedule_delete_response.rb +1 -1
- data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
- data/lib/knockapi/models/schedule_update_params.rb +9 -10
- data/lib/knockapi/models/schedule_update_response.rb +1 -1
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
- data/lib/knockapi/models/tenant.rb +13 -16
- data/lib/knockapi/models/tenant_delete_response.rb +7 -0
- data/lib/knockapi/models/tenant_request.rb +20 -20
- data/lib/knockapi/models/tenant_set_params.rb +19 -19
- data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/user.rb +9 -11
- data/lib/knockapi/models/user_delete_response.rb +7 -0
- data/lib/knockapi/models/user_list_messages_params.rb +13 -12
- data/lib/knockapi/models/user_list_params.rb +3 -4
- data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
- data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
- data/lib/knockapi/models/users/feed_list_items_response.rb +15 -6
- data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
- data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
- data/lib/knockapi/models.rb +202 -0
- data/lib/knockapi/request_options.rb +4 -0
- data/lib/knockapi/resources/audiences.rb +4 -4
- data/lib/knockapi/resources/bulk_operations.rb +2 -2
- data/lib/knockapi/resources/channels/bulk.rb +7 -8
- data/lib/knockapi/resources/integrations/census.rb +1 -1
- data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
- data/lib/knockapi/resources/messages/batch.rb +22 -22
- data/lib/knockapi/resources/messages.rb +32 -39
- data/lib/knockapi/resources/objects/bulk.rb +11 -11
- data/lib/knockapi/resources/objects.rb +52 -62
- data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
- data/lib/knockapi/resources/providers/slack.rb +4 -4
- data/lib/knockapi/resources/schedules/bulk.rb +4 -4
- data/lib/knockapi/resources/schedules.rb +18 -23
- data/lib/knockapi/resources/tenants/bulk.rb +7 -7
- data/lib/knockapi/resources/tenants.rb +11 -11
- data/lib/knockapi/resources/users/bulk.rb +11 -11
- data/lib/knockapi/resources/users/feeds.rb +3 -3
- data/lib/knockapi/resources/users/guides.rb +4 -4
- data/lib/knockapi/resources/users.rb +46 -54
- data/lib/knockapi/resources/workflows.rb +6 -11
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +11 -2
- data/rbi/knockapi/client.rbi +5 -4
- data/rbi/knockapi/errors.rbi +35 -16
- data/rbi/knockapi/file_part.rbi +9 -6
- data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
- data/rbi/knockapi/internal/items_cursor.rbi +9 -4
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
- data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
- data/rbi/knockapi/internal/type/array_of.rbi +34 -24
- data/rbi/knockapi/internal/type/base_model.rbi +151 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +16 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +28 -15
- data/rbi/knockapi/internal/type/file_input.rbi +8 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +34 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +55 -19
- data/rbi/knockapi/internal/type/unknown.rbi +16 -6
- data/rbi/knockapi/internal/util.rbi +239 -87
- data/rbi/knockapi/internal.rbi +2 -0
- data/rbi/knockapi/models/activity.rbi +28 -22
- data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
- data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
- data/rbi/knockapi/models/audience_member.rbi +23 -11
- data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +70 -42
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
- data/rbi/knockapi/models/condition.rbi +78 -31
- data/rbi/knockapi/models/identify_user_request.rbi +90 -36
- data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
- data/rbi/knockapi/models/inline_object_request.rbi +76 -22
- data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
- data/rbi/knockapi/models/message.rbi +156 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +153 -66
- data/rbi/knockapi/models/message_event.rbi +86 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +364 -203
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
- data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
- data/rbi/knockapi/models/message_list_params.rbi +147 -58
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +367 -206
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
- data/rbi/knockapi/models/object.rbi +31 -10
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_delete_params.rbi +13 -5
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_get_params.rbi +13 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +169 -60
- data/rbi/knockapi/models/object_list_params.rbi +43 -22
- data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_set_params.rbi +89 -33
- data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/page_info.rbi +22 -11
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/recipient.rbi +5 -2
- data/rbi/knockapi/models/recipient_reference.rbi +22 -5
- data/rbi/knockapi/models/recipient_request.rbi +11 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +123 -50
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/preference_set.rbi +159 -88
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
- data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
- data/rbi/knockapi/models/schedule.rbi +32 -27
- data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
- data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
- data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
- data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
- data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
- data/rbi/knockapi/models/tenant.rbi +71 -45
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
- data/rbi/knockapi/models/tenant_request.rbi +132 -57
- data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/user.rbi +32 -28
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
- data/rbi/knockapi/models/user_list_messages_params.rbi +168 -59
- data/rbi/knockapi/models/user_list_params.rbi +43 -22
- data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
- data/rbi/knockapi/models/user_merge_params.rbi +17 -6
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +197 -100
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
- data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
- data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +18 -7
- data/rbi/knockapi/resources/audiences.rbi +22 -14
- data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
- data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
- data/rbi/knockapi/resources/channels.rbi +2 -1
- data/rbi/knockapi/resources/integrations/census.rbi +8 -4
- data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
- data/rbi/knockapi/resources/integrations.rbi +2 -1
- data/rbi/knockapi/resources/messages/batch.rbi +58 -26
- data/rbi/knockapi/resources/messages.rbi +102 -43
- data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
- data/rbi/knockapi/resources/objects.rbi +177 -107
- data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
- data/rbi/knockapi/resources/providers/slack.rbi +28 -11
- data/rbi/knockapi/resources/providers.rbi +2 -1
- data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
- data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
- data/rbi/knockapi/resources/recipients.rbi +2 -1
- data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
- data/rbi/knockapi/resources/schedules.rbi +44 -33
- data/rbi/knockapi/resources/shared.rbi +2 -1
- data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
- data/rbi/knockapi/resources/tenants.rbi +51 -20
- data/rbi/knockapi/resources/users/bulk.rbi +21 -14
- data/rbi/knockapi/resources/users/feeds.rbi +20 -9
- data/rbi/knockapi/resources/users/guides.rbi +23 -16
- data/rbi/knockapi/resources/users.rbi +160 -91
- data/rbi/knockapi/resources/workflows.rbi +38 -29
- data/sig/knockapi/internal/entries_cursor.rbs +0 -2
- data/sig/knockapi/internal/items_cursor.rbs +0 -2
- data/sig/knockapi/internal/transport/base_client.rbs +16 -1
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/knockapi/internal/type/base_model.rbs +11 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +1 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +1 -0
- data/sig/knockapi/internal/util.rbs +15 -0
- data/sig/knockapi/internal.rbs +2 -0
- data/sig/knockapi/models/activity.rbs +0 -2
- data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
- data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
- data/sig/knockapi/models/audience_member.rbs +3 -5
- data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +9 -13
- data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
- data/sig/knockapi/models/condition.rbs +4 -6
- data/sig/knockapi/models/identify_user_request.rbs +0 -2
- data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
- data/sig/knockapi/models/inline_object_request.rbs +0 -2
- data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
- data/sig/knockapi/models/message.rbs +15 -23
- data/sig/knockapi/models/message_archive_params.rbs +0 -2
- data/sig/knockapi/models/message_delivery_log.rbs +24 -30
- data/sig/knockapi/models/message_event.rbs +4 -6
- data/sig/knockapi/models/message_get_content_params.rbs +0 -2
- data/sig/knockapi/models/message_get_content_response.rbs +2 -24
- data/sig/knockapi/models/message_get_params.rbs +0 -2
- data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
- data/sig/knockapi/models/message_list_events_params.rbs +0 -2
- data/sig/knockapi/models/message_list_params.rbs +17 -21
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +8 -4
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_delete_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_get_params.rbs +0 -2
- data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_messages_params.rbs +17 -21
- data/sig/knockapi/models/object_list_params.rbs +6 -8
- data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
- data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_set_params.rbs +0 -2
- data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
- data/sig/knockapi/models/page_info.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/recipient.rbs +2 -2
- data/sig/knockapi/models/recipient_reference.rbs +2 -4
- data/sig/knockapi/models/recipient_request.rbs +3 -3
- data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
- data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
- data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
- data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/subscription.rbs +3 -5
- data/sig/knockapi/models/schedule.rbs +3 -5
- data/sig/knockapi/models/schedule_create_params.rbs +3 -5
- data/sig/knockapi/models/schedule_create_response.rbs +1 -1
- data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
- data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
- data/sig/knockapi/models/schedule_list_params.rbs +0 -2
- data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
- data/sig/knockapi/models/schedule_update_params.rbs +5 -7
- data/sig/knockapi/models/schedule_update_response.rbs +1 -1
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
- data/sig/knockapi/models/tenant.rbs +9 -15
- data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +0 -2
- data/sig/knockapi/models/tenant_list_params.rbs +0 -2
- data/sig/knockapi/models/tenant_request.rbs +13 -19
- data/sig/knockapi/models/tenant_set_params.rbs +13 -19
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
- data/sig/knockapi/models/user.rbs +0 -2
- data/sig/knockapi/models/user_delete_params.rbs +0 -2
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_get_params.rbs +0 -2
- data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_messages_params.rbs +17 -21
- data/sig/knockapi/models/user_list_params.rbs +6 -8
- data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
- data/sig/knockapi/models/user_merge_params.rbs +0 -2
- data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
- data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
- data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
- data/sig/knockapi/models.rbs +173 -0
- data/sig/knockapi/request_options.rbs +1 -1
- data/sig/knockapi/resources/audiences.rbs +2 -2
- data/sig/knockapi/resources/bulk_operations.rbs +1 -1
- data/sig/knockapi/resources/channels/bulk.rbs +1 -1
- data/sig/knockapi/resources/messages.rbs +15 -17
- data/sig/knockapi/resources/objects/bulk.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +19 -19
- data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
- data/sig/knockapi/resources/providers/slack.rbs +1 -1
- data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
- data/sig/knockapi/resources/schedules.rbs +3 -3
- data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
- data/sig/knockapi/resources/tenants.rbs +4 -4
- data/sig/knockapi/resources/users/bulk.rbs +5 -5
- data/sig/knockapi/resources/users.rbs +19 -19
- metadata +29 -8
- data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
- data/lib/knockapi/resources/messages/activities.rb +0 -47
- data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
- data/rbi/knockapi/resources/messages/activities.rbi +0 -38
- data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
- data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -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::ObjectGetChannelDataParams,
|
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,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::ObjectGetParams, 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::ObjectGetPreferencesParams,
|
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,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::ObjectListMessagesParams, 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,25 +33,34 @@ 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[
|
40
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
|
41
|
+
]
|
42
|
+
)
|
43
|
+
)
|
44
|
+
end
|
32
45
|
attr_reader :engagement_status
|
33
46
|
|
34
47
|
sig do
|
35
48
|
params(
|
36
|
-
engagement_status:
|
37
|
-
|
38
|
-
|
49
|
+
engagement_status:
|
50
|
+
T::Array[
|
51
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
|
52
|
+
]
|
53
|
+
).void
|
39
54
|
end
|
40
55
|
attr_writer :engagement_status
|
41
56
|
|
42
|
-
sig { returns(T.nilable(Knockapi::
|
57
|
+
sig { returns(T.nilable(Knockapi::ObjectListMessagesParams::InsertedAt)) }
|
43
58
|
attr_reader :inserted_at
|
44
59
|
|
45
60
|
sig do
|
46
61
|
params(
|
47
|
-
inserted_at:
|
48
|
-
)
|
49
|
-
.void
|
62
|
+
inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt::OrHash
|
63
|
+
).void
|
50
64
|
end
|
51
65
|
attr_writer :inserted_at
|
52
66
|
|
@@ -73,10 +87,20 @@ module Knockapi
|
|
73
87
|
attr_writer :source
|
74
88
|
|
75
89
|
# Limits the results to messages with the given delivery status.
|
76
|
-
sig
|
90
|
+
sig do
|
91
|
+
returns(
|
92
|
+
T.nilable(
|
93
|
+
T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol]
|
94
|
+
)
|
95
|
+
)
|
96
|
+
end
|
77
97
|
attr_reader :status
|
78
98
|
|
79
|
-
sig
|
99
|
+
sig do
|
100
|
+
params(
|
101
|
+
status: T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol]
|
102
|
+
).void
|
103
|
+
end
|
80
104
|
attr_writer :status
|
81
105
|
|
82
106
|
# Limits the results to items with the corresponding tenant.
|
@@ -122,20 +146,23 @@ module Knockapi
|
|
122
146
|
after: String,
|
123
147
|
before: String,
|
124
148
|
channel_id: String,
|
125
|
-
engagement_status:
|
126
|
-
|
149
|
+
engagement_status:
|
150
|
+
T::Array[
|
151
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
|
152
|
+
],
|
153
|
+
inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt::OrHash,
|
127
154
|
message_ids: T::Array[String],
|
128
155
|
page_size: Integer,
|
129
156
|
source: String,
|
130
|
-
status:
|
157
|
+
status:
|
158
|
+
T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol],
|
131
159
|
tenant: String,
|
132
160
|
trigger_data: String,
|
133
161
|
workflow_categories: T::Array[String],
|
134
162
|
workflow_recipient_run_id: String,
|
135
163
|
workflow_run_id: String,
|
136
|
-
request_options:
|
137
|
-
)
|
138
|
-
.returns(T.attached_class)
|
164
|
+
request_options: Knockapi::RequestOptions::OrHash
|
165
|
+
).returns(T.attached_class)
|
139
166
|
end
|
140
167
|
def self.new(
|
141
168
|
# The cursor to fetch entries after.
|
@@ -170,51 +197,92 @@ module Knockapi
|
|
170
197
|
# returned by the workflow trigger request.
|
171
198
|
workflow_run_id: nil,
|
172
199
|
request_options: {}
|
173
|
-
)
|
200
|
+
)
|
201
|
+
end
|
202
|
+
|
174
203
|
sig do
|
175
|
-
override
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
204
|
+
override.returns(
|
205
|
+
{
|
206
|
+
after: String,
|
207
|
+
before: String,
|
208
|
+
channel_id: String,
|
209
|
+
engagement_status:
|
210
|
+
T::Array[
|
211
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::OrSymbol
|
212
|
+
],
|
213
|
+
inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt,
|
214
|
+
message_ids: T::Array[String],
|
215
|
+
page_size: Integer,
|
216
|
+
source: String,
|
217
|
+
status:
|
218
|
+
T::Array[Knockapi::ObjectListMessagesParams::Status::OrSymbol],
|
219
|
+
tenant: String,
|
220
|
+
trigger_data: String,
|
221
|
+
workflow_categories: T::Array[String],
|
222
|
+
workflow_recipient_run_id: String,
|
223
|
+
workflow_run_id: String,
|
224
|
+
request_options: Knockapi::RequestOptions
|
225
|
+
}
|
226
|
+
)
|
227
|
+
end
|
228
|
+
def to_hash
|
195
229
|
end
|
196
|
-
def to_hash; end
|
197
230
|
|
198
231
|
module EngagementStatus
|
199
232
|
extend Knockapi::Internal::Type::Enum
|
200
233
|
|
201
234
|
TaggedSymbol =
|
202
|
-
T.type_alias
|
235
|
+
T.type_alias do
|
236
|
+
T.all(Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus)
|
237
|
+
end
|
203
238
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
204
239
|
|
205
|
-
SEEN =
|
206
|
-
|
240
|
+
SEEN =
|
241
|
+
T.let(
|
242
|
+
:seen,
|
243
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
244
|
+
)
|
245
|
+
READ =
|
246
|
+
T.let(
|
247
|
+
:read,
|
248
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
249
|
+
)
|
207
250
|
INTERACTED =
|
208
|
-
T.let(
|
251
|
+
T.let(
|
252
|
+
:interacted,
|
253
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
254
|
+
)
|
209
255
|
LINK_CLICKED =
|
210
|
-
T.let(
|
211
|
-
|
256
|
+
T.let(
|
257
|
+
:link_clicked,
|
258
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
259
|
+
)
|
260
|
+
ARCHIVED =
|
261
|
+
T.let(
|
262
|
+
:archived,
|
263
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
264
|
+
)
|
212
265
|
|
213
|
-
sig
|
214
|
-
|
266
|
+
sig do
|
267
|
+
override.returns(
|
268
|
+
T::Array[
|
269
|
+
Knockapi::ObjectListMessagesParams::EngagementStatus::TaggedSymbol
|
270
|
+
]
|
271
|
+
)
|
272
|
+
end
|
273
|
+
def self.values
|
274
|
+
end
|
215
275
|
end
|
216
276
|
|
217
277
|
class InsertedAt < Knockapi::Internal::Type::BaseModel
|
278
|
+
OrHash =
|
279
|
+
T.type_alias do
|
280
|
+
T.any(
|
281
|
+
Knockapi::ObjectListMessagesParams::InsertedAt,
|
282
|
+
Knockapi::Internal::AnyHash
|
283
|
+
)
|
284
|
+
end
|
285
|
+
|
218
286
|
# Limits the results to messages inserted after the given date.
|
219
287
|
sig { returns(T.nilable(String)) }
|
220
288
|
attr_reader :gt
|
@@ -243,7 +311,11 @@ module Knockapi
|
|
243
311
|
sig { params(lte: String).void }
|
244
312
|
attr_writer :lte
|
245
313
|
|
246
|
-
sig
|
314
|
+
sig do
|
315
|
+
params(gt: String, gte: String, lt: String, lte: String).returns(
|
316
|
+
T.attached_class
|
317
|
+
)
|
318
|
+
end
|
247
319
|
def self.new(
|
248
320
|
# Limits the results to messages inserted after the given date.
|
249
321
|
gt: nil,
|
@@ -253,28 +325,65 @@ module Knockapi
|
|
253
325
|
lt: nil,
|
254
326
|
# Limits the results to messages inserted before or on the given date.
|
255
327
|
lte: nil
|
256
|
-
)
|
257
|
-
|
258
|
-
|
328
|
+
)
|
329
|
+
end
|
330
|
+
|
331
|
+
sig do
|
332
|
+
override.returns({ gt: String, gte: String, lt: String, lte: String })
|
333
|
+
end
|
334
|
+
def to_hash
|
335
|
+
end
|
259
336
|
end
|
260
337
|
|
261
338
|
module Status
|
262
339
|
extend Knockapi::Internal::Type::Enum
|
263
340
|
|
264
|
-
TaggedSymbol =
|
341
|
+
TaggedSymbol =
|
342
|
+
T.type_alias do
|
343
|
+
T.all(Symbol, Knockapi::ObjectListMessagesParams::Status)
|
344
|
+
end
|
265
345
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
266
346
|
|
267
|
-
QUEUED =
|
268
|
-
|
269
|
-
|
347
|
+
QUEUED =
|
348
|
+
T.let(
|
349
|
+
:queued,
|
350
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
351
|
+
)
|
352
|
+
SENT =
|
353
|
+
T.let(:sent, Knockapi::ObjectListMessagesParams::Status::TaggedSymbol)
|
354
|
+
DELIVERED =
|
355
|
+
T.let(
|
356
|
+
:delivered,
|
357
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
358
|
+
)
|
270
359
|
DELIVERY_ATTEMPTED =
|
271
|
-
T.let(
|
272
|
-
|
273
|
-
|
274
|
-
|
360
|
+
T.let(
|
361
|
+
:delivery_attempted,
|
362
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
363
|
+
)
|
364
|
+
UNDELIVERED =
|
365
|
+
T.let(
|
366
|
+
:undelivered,
|
367
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
368
|
+
)
|
369
|
+
NOT_SENT =
|
370
|
+
T.let(
|
371
|
+
:not_sent,
|
372
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
373
|
+
)
|
374
|
+
BOUNCED =
|
375
|
+
T.let(
|
376
|
+
:bounced,
|
377
|
+
Knockapi::ObjectListMessagesParams::Status::TaggedSymbol
|
378
|
+
)
|
275
379
|
|
276
|
-
sig
|
277
|
-
|
380
|
+
sig do
|
381
|
+
override.returns(
|
382
|
+
T::Array[Knockapi::ObjectListMessagesParams::Status::TaggedSymbol]
|
383
|
+
)
|
384
|
+
end
|
385
|
+
def self.values
|
386
|
+
end
|
278
387
|
end
|
279
388
|
end
|
280
389
|
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::ObjectListParams, 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
|
@@ -21,10 +26,18 @@ module Knockapi
|
|
21
26
|
attr_writer :before
|
22
27
|
|
23
28
|
# Includes preferences of the objects in the response.
|
24
|
-
sig
|
29
|
+
sig do
|
30
|
+
returns(
|
31
|
+
T.nilable(T::Array[Knockapi::ObjectListParams::Include::OrSymbol])
|
32
|
+
)
|
33
|
+
end
|
25
34
|
attr_reader :include
|
26
35
|
|
27
|
-
sig
|
36
|
+
sig do
|
37
|
+
params(
|
38
|
+
include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol]
|
39
|
+
).void
|
40
|
+
end
|
28
41
|
attr_writer :include
|
29
42
|
|
30
43
|
# The number of items per page.
|
@@ -38,11 +51,10 @@ module Knockapi
|
|
38
51
|
params(
|
39
52
|
after: String,
|
40
53
|
before: String,
|
41
|
-
include: T::Array[Knockapi::
|
54
|
+
include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol],
|
42
55
|
page_size: Integer,
|
43
|
-
request_options:
|
44
|
-
)
|
45
|
-
.returns(T.attached_class)
|
56
|
+
request_options: Knockapi::RequestOptions::OrHash
|
57
|
+
).returns(T.attached_class)
|
46
58
|
end
|
47
59
|
def self.new(
|
48
60
|
# The cursor to fetch entries after.
|
@@ -54,31 +66,40 @@ module Knockapi
|
|
54
66
|
# The number of items per page.
|
55
67
|
page_size: nil,
|
56
68
|
request_options: {}
|
57
|
-
)
|
69
|
+
)
|
70
|
+
end
|
71
|
+
|
58
72
|
sig do
|
59
|
-
override
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
73
|
+
override.returns(
|
74
|
+
{
|
75
|
+
after: String,
|
76
|
+
before: String,
|
77
|
+
include: T::Array[Knockapi::ObjectListParams::Include::OrSymbol],
|
78
|
+
page_size: Integer,
|
79
|
+
request_options: Knockapi::RequestOptions
|
80
|
+
}
|
81
|
+
)
|
82
|
+
end
|
83
|
+
def to_hash
|
69
84
|
end
|
70
|
-
def to_hash; end
|
71
85
|
|
72
86
|
module Include
|
73
87
|
extend Knockapi::Internal::Type::Enum
|
74
88
|
|
75
|
-
TaggedSymbol =
|
89
|
+
TaggedSymbol =
|
90
|
+
T.type_alias { T.all(Symbol, Knockapi::ObjectListParams::Include) }
|
76
91
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
77
92
|
|
78
|
-
PREFERENCES =
|
93
|
+
PREFERENCES =
|
94
|
+
T.let(:preferences, Knockapi::ObjectListParams::Include::TaggedSymbol)
|
79
95
|
|
80
|
-
sig
|
81
|
-
|
96
|
+
sig do
|
97
|
+
override.returns(
|
98
|
+
T::Array[Knockapi::ObjectListParams::Include::TaggedSymbol]
|
99
|
+
)
|
100
|
+
end
|
101
|
+
def self.values
|
102
|
+
end
|
82
103
|
end
|
83
104
|
end
|
84
105
|
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::ObjectListPreferencesParams,
|
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
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
ObjectListPreferencesResponse =
|
6
6
|
T.let(
|
7
|
-
Knockapi::Internal::Type::ArrayOf[Knockapi::
|
7
|
+
Knockapi::Internal::Type::ArrayOf[Knockapi::Recipients::PreferenceSet],
|
8
8
|
Knockapi::Internal::Type::Converter
|
9
9
|
)
|
10
10
|
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::ObjectListSchedulesParams,
|
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
|
@@ -48,9 +56,8 @@ module Knockapi
|
|
48
56
|
page_size: Integer,
|
49
57
|
tenant: String,
|
50
58
|
workflow: String,
|
51
|
-
request_options:
|
52
|
-
)
|
53
|
-
.returns(T.attached_class)
|
59
|
+
request_options: Knockapi::RequestOptions::OrHash
|
60
|
+
).returns(T.attached_class)
|
54
61
|
end
|
55
62
|
def self.new(
|
56
63
|
# The cursor to fetch entries after.
|
@@ -64,21 +71,23 @@ module Knockapi
|
|
64
71
|
# Filter schedules by workflow id.
|
65
72
|
workflow: nil,
|
66
73
|
request_options: {}
|
67
|
-
)
|
74
|
+
)
|
75
|
+
end
|
76
|
+
|
68
77
|
sig do
|
69
|
-
override
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
78
|
+
override.returns(
|
79
|
+
{
|
80
|
+
after: String,
|
81
|
+
before: String,
|
82
|
+
page_size: Integer,
|
83
|
+
tenant: String,
|
84
|
+
workflow: String,
|
85
|
+
request_options: Knockapi::RequestOptions
|
86
|
+
}
|
87
|
+
)
|
88
|
+
end
|
89
|
+
def to_hash
|
80
90
|
end
|
81
|
-
def to_hash; end
|
82
91
|
end
|
83
92
|
end
|
84
93
|
end
|