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
@@ -0,0 +1,173 @@
|
|
1
|
+
module Knockapi
|
2
|
+
class Activity = Knockapi::Models::Activity
|
3
|
+
|
4
|
+
class AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
|
5
|
+
|
6
|
+
class AudienceListMembersParams = Knockapi::Models::AudienceListMembersParams
|
7
|
+
|
8
|
+
class AudienceMember = Knockapi::Models::AudienceMember
|
9
|
+
|
10
|
+
class AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
|
11
|
+
|
12
|
+
class BulkOperation = Knockapi::Models::BulkOperation
|
13
|
+
|
14
|
+
class BulkOperationGetParams = Knockapi::Models::BulkOperationGetParams
|
15
|
+
|
16
|
+
module Channels = Knockapi::Models::Channels
|
17
|
+
|
18
|
+
class Condition = Knockapi::Models::Condition
|
19
|
+
|
20
|
+
class IdentifyUserRequest = Knockapi::Models::IdentifyUserRequest
|
21
|
+
|
22
|
+
class InlineIdentifyUserRequest = Knockapi::Models::InlineIdentifyUserRequest
|
23
|
+
|
24
|
+
class InlineObjectRequest = Knockapi::Models::InlineObjectRequest
|
25
|
+
|
26
|
+
module InlineTenantRequest = Knockapi::Models::InlineTenantRequest
|
27
|
+
|
28
|
+
module Integrations = Knockapi::Models::Integrations
|
29
|
+
|
30
|
+
class Message = Knockapi::Models::Message
|
31
|
+
|
32
|
+
class MessageArchiveParams = Knockapi::Models::MessageArchiveParams
|
33
|
+
|
34
|
+
class MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
|
35
|
+
|
36
|
+
class MessageEvent = Knockapi::Models::MessageEvent
|
37
|
+
|
38
|
+
class MessageGetContentParams = Knockapi::Models::MessageGetContentParams
|
39
|
+
|
40
|
+
class MessageGetParams = Knockapi::Models::MessageGetParams
|
41
|
+
|
42
|
+
class MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
|
43
|
+
|
44
|
+
class MessageListDeliveryLogsParams = Knockapi::Models::MessageListDeliveryLogsParams
|
45
|
+
|
46
|
+
class MessageListEventsParams = Knockapi::Models::MessageListEventsParams
|
47
|
+
|
48
|
+
class MessageListParams = Knockapi::Models::MessageListParams
|
49
|
+
|
50
|
+
class MessageMarkAsInteractedParams = Knockapi::Models::MessageMarkAsInteractedParams
|
51
|
+
|
52
|
+
class MessageMarkAsReadParams = Knockapi::Models::MessageMarkAsReadParams
|
53
|
+
|
54
|
+
class MessageMarkAsSeenParams = Knockapi::Models::MessageMarkAsSeenParams
|
55
|
+
|
56
|
+
class MessageMarkAsUnreadParams = Knockapi::Models::MessageMarkAsUnreadParams
|
57
|
+
|
58
|
+
class MessageMarkAsUnseenParams = Knockapi::Models::MessageMarkAsUnseenParams
|
59
|
+
|
60
|
+
module Messages = Knockapi::Models::Messages
|
61
|
+
|
62
|
+
class MessageUnarchiveParams = Knockapi::Models::MessageUnarchiveParams
|
63
|
+
|
64
|
+
class Object = Knockapi::Models::Object
|
65
|
+
|
66
|
+
class ObjectAddSubscriptionsParams = Knockapi::Models::ObjectAddSubscriptionsParams
|
67
|
+
|
68
|
+
class ObjectDeleteParams = Knockapi::Models::ObjectDeleteParams
|
69
|
+
|
70
|
+
class ObjectDeleteSubscriptionsParams = Knockapi::Models::ObjectDeleteSubscriptionsParams
|
71
|
+
|
72
|
+
class ObjectGetChannelDataParams = Knockapi::Models::ObjectGetChannelDataParams
|
73
|
+
|
74
|
+
class ObjectGetParams = Knockapi::Models::ObjectGetParams
|
75
|
+
|
76
|
+
class ObjectGetPreferencesParams = Knockapi::Models::ObjectGetPreferencesParams
|
77
|
+
|
78
|
+
class ObjectListMessagesParams = Knockapi::Models::ObjectListMessagesParams
|
79
|
+
|
80
|
+
class ObjectListParams = Knockapi::Models::ObjectListParams
|
81
|
+
|
82
|
+
class ObjectListPreferencesParams = Knockapi::Models::ObjectListPreferencesParams
|
83
|
+
|
84
|
+
class ObjectListSchedulesParams = Knockapi::Models::ObjectListSchedulesParams
|
85
|
+
|
86
|
+
class ObjectListSubscriptionsParams = Knockapi::Models::ObjectListSubscriptionsParams
|
87
|
+
|
88
|
+
module Objects = Knockapi::Models::Objects
|
89
|
+
|
90
|
+
class ObjectSetChannelDataParams = Knockapi::Models::ObjectSetChannelDataParams
|
91
|
+
|
92
|
+
class ObjectSetParams = Knockapi::Models::ObjectSetParams
|
93
|
+
|
94
|
+
class ObjectSetPreferencesParams = Knockapi::Models::ObjectSetPreferencesParams
|
95
|
+
|
96
|
+
class ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
|
97
|
+
|
98
|
+
class PageInfo = Knockapi::Models::PageInfo
|
99
|
+
|
100
|
+
module Providers = Knockapi::Models::Providers
|
101
|
+
|
102
|
+
module Recipient = Knockapi::Models::Recipient
|
103
|
+
|
104
|
+
module RecipientReference = Knockapi::Models::RecipientReference
|
105
|
+
|
106
|
+
module RecipientRequest = Knockapi::Models::RecipientRequest
|
107
|
+
|
108
|
+
module Recipients = Knockapi::Models::Recipients
|
109
|
+
|
110
|
+
class Schedule = Knockapi::Models::Schedule
|
111
|
+
|
112
|
+
class ScheduleCreateParams = Knockapi::Models::ScheduleCreateParams
|
113
|
+
|
114
|
+
class ScheduleDeleteParams = Knockapi::Models::ScheduleDeleteParams
|
115
|
+
|
116
|
+
class ScheduleListParams = Knockapi::Models::ScheduleListParams
|
117
|
+
|
118
|
+
class ScheduleRepeatRule = Knockapi::Models::ScheduleRepeatRule
|
119
|
+
|
120
|
+
module Schedules = Knockapi::Models::Schedules
|
121
|
+
|
122
|
+
class ScheduleUpdateParams = Knockapi::Models::ScheduleUpdateParams
|
123
|
+
|
124
|
+
class Tenant = Knockapi::Models::Tenant
|
125
|
+
|
126
|
+
class TenantDeleteParams = Knockapi::Models::TenantDeleteParams
|
127
|
+
|
128
|
+
class TenantGetParams = Knockapi::Models::TenantGetParams
|
129
|
+
|
130
|
+
class TenantListParams = Knockapi::Models::TenantListParams
|
131
|
+
|
132
|
+
class TenantRequest = Knockapi::Models::TenantRequest
|
133
|
+
|
134
|
+
module Tenants = Knockapi::Models::Tenants
|
135
|
+
|
136
|
+
class TenantSetParams = Knockapi::Models::TenantSetParams
|
137
|
+
|
138
|
+
class User = Knockapi::Models::User
|
139
|
+
|
140
|
+
class UserDeleteParams = Knockapi::Models::UserDeleteParams
|
141
|
+
|
142
|
+
class UserGetChannelDataParams = Knockapi::Models::UserGetChannelDataParams
|
143
|
+
|
144
|
+
class UserGetParams = Knockapi::Models::UserGetParams
|
145
|
+
|
146
|
+
class UserGetPreferencesParams = Knockapi::Models::UserGetPreferencesParams
|
147
|
+
|
148
|
+
class UserListMessagesParams = Knockapi::Models::UserListMessagesParams
|
149
|
+
|
150
|
+
class UserListParams = Knockapi::Models::UserListParams
|
151
|
+
|
152
|
+
class UserListPreferencesParams = Knockapi::Models::UserListPreferencesParams
|
153
|
+
|
154
|
+
class UserListSchedulesParams = Knockapi::Models::UserListSchedulesParams
|
155
|
+
|
156
|
+
class UserListSubscriptionsParams = Knockapi::Models::UserListSubscriptionsParams
|
157
|
+
|
158
|
+
class UserMergeParams = Knockapi::Models::UserMergeParams
|
159
|
+
|
160
|
+
module Users = Knockapi::Models::Users
|
161
|
+
|
162
|
+
class UserSetChannelDataParams = Knockapi::Models::UserSetChannelDataParams
|
163
|
+
|
164
|
+
class UserSetPreferencesParams = Knockapi::Models::UserSetPreferencesParams
|
165
|
+
|
166
|
+
class UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
|
167
|
+
|
168
|
+
class UserUpdateParams = Knockapi::Models::UserUpdateParams
|
169
|
+
|
170
|
+
class WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
|
171
|
+
|
172
|
+
class WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
|
173
|
+
end
|
@@ -3,7 +3,7 @@ module Knockapi
|
|
3
3
|
class Audiences
|
4
4
|
def add_members: (
|
5
5
|
String key,
|
6
|
-
members: ::Array[Knockapi::
|
6
|
+
members: ::Array[Knockapi::AudienceAddMembersParams::Member],
|
7
7
|
?request_options: Knockapi::request_opts
|
8
8
|
) -> String
|
9
9
|
|
@@ -14,7 +14,7 @@ module Knockapi
|
|
14
14
|
|
15
15
|
def remove_members: (
|
16
16
|
String key,
|
17
|
-
members: ::Array[Knockapi::
|
17
|
+
members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
|
18
18
|
?request_options: Knockapi::request_opts
|
19
19
|
) -> String
|
20
20
|
|
@@ -3,35 +3,33 @@ module Knockapi
|
|
3
3
|
class Messages
|
4
4
|
attr_reader batch: Knockapi::Resources::Messages::Batch
|
5
5
|
|
6
|
-
attr_reader activities: Knockapi::Resources::Messages::Activities
|
7
|
-
|
8
6
|
def list: (
|
9
7
|
?after: String,
|
10
8
|
?before: String,
|
11
9
|
?channel_id: String,
|
12
|
-
?engagement_status: ::Array[Knockapi::
|
13
|
-
?inserted_at: Knockapi::
|
10
|
+
?engagement_status: ::Array[Knockapi::MessageListParams::engagement_status],
|
11
|
+
?inserted_at: Knockapi::MessageListParams::InsertedAt,
|
14
12
|
?message_ids: ::Array[String],
|
15
13
|
?page_size: Integer,
|
16
14
|
?source: String,
|
17
|
-
?status: ::Array[Knockapi::
|
15
|
+
?status: ::Array[Knockapi::MessageListParams::status],
|
18
16
|
?tenant: String,
|
19
17
|
?trigger_data: String,
|
20
18
|
?workflow_categories: ::Array[String],
|
21
19
|
?workflow_recipient_run_id: String,
|
22
20
|
?workflow_run_id: String,
|
23
21
|
?request_options: Knockapi::request_opts
|
24
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
22
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
|
25
23
|
|
26
24
|
def archive: (
|
27
25
|
String message_id,
|
28
26
|
?request_options: Knockapi::request_opts
|
29
|
-
) -> Knockapi::
|
27
|
+
) -> Knockapi::Message
|
30
28
|
|
31
29
|
def get: (
|
32
30
|
String message_id,
|
33
31
|
?request_options: Knockapi::request_opts
|
34
|
-
) -> Knockapi::
|
32
|
+
) -> Knockapi::Message
|
35
33
|
|
36
34
|
def get_content: (
|
37
35
|
String message_id,
|
@@ -45,7 +43,7 @@ module Knockapi
|
|
45
43
|
?page_size: Integer,
|
46
44
|
?trigger_data: String,
|
47
45
|
?request_options: Knockapi::request_opts
|
48
|
-
) -> Knockapi::Internal::ItemsCursor[Knockapi::
|
46
|
+
) -> Knockapi::Internal::ItemsCursor[Knockapi::Activity]
|
49
47
|
|
50
48
|
def list_delivery_logs: (
|
51
49
|
String message_id,
|
@@ -53,7 +51,7 @@ module Knockapi
|
|
53
51
|
?before: String,
|
54
52
|
?page_size: Integer,
|
55
53
|
?request_options: Knockapi::request_opts
|
56
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
54
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageDeliveryLog]
|
57
55
|
|
58
56
|
def list_events: (
|
59
57
|
String message_id,
|
@@ -61,38 +59,38 @@ module Knockapi
|
|
61
59
|
?before: String,
|
62
60
|
?page_size: Integer,
|
63
61
|
?request_options: Knockapi::request_opts
|
64
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
62
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::MessageEvent]
|
65
63
|
|
66
64
|
def mark_as_interacted: (
|
67
65
|
String message_id,
|
68
66
|
?metadata: ::Hash[Symbol, top],
|
69
67
|
?request_options: Knockapi::request_opts
|
70
|
-
) -> Knockapi::
|
68
|
+
) -> Knockapi::Message
|
71
69
|
|
72
70
|
def mark_as_read: (
|
73
71
|
String message_id,
|
74
72
|
?request_options: Knockapi::request_opts
|
75
|
-
) -> Knockapi::
|
73
|
+
) -> Knockapi::Message
|
76
74
|
|
77
75
|
def mark_as_seen: (
|
78
76
|
String message_id,
|
79
77
|
?request_options: Knockapi::request_opts
|
80
|
-
) -> Knockapi::
|
78
|
+
) -> Knockapi::Message
|
81
79
|
|
82
80
|
def mark_as_unread: (
|
83
81
|
String message_id,
|
84
82
|
?request_options: Knockapi::request_opts
|
85
|
-
) -> Knockapi::
|
83
|
+
) -> Knockapi::Message
|
86
84
|
|
87
85
|
def mark_as_unseen: (
|
88
86
|
String message_id,
|
89
87
|
?request_options: Knockapi::request_opts
|
90
|
-
) -> Knockapi::
|
88
|
+
) -> Knockapi::Message
|
91
89
|
|
92
90
|
def unarchive: (
|
93
91
|
String message_id,
|
94
92
|
?request_options: Knockapi::request_opts
|
95
|
-
) -> Knockapi::
|
93
|
+
) -> Knockapi::Message
|
96
94
|
|
97
95
|
def initialize: (client: Knockapi::Client) -> void
|
98
96
|
end
|
@@ -6,19 +6,19 @@ module Knockapi
|
|
6
6
|
String collection,
|
7
7
|
object_ids: ::Array[String],
|
8
8
|
?request_options: Knockapi::request_opts
|
9
|
-
) -> Knockapi::
|
9
|
+
) -> Knockapi::BulkOperation
|
10
10
|
|
11
11
|
def add_subscriptions: (
|
12
12
|
String collection,
|
13
|
-
subscriptions: ::Array[Knockapi::
|
13
|
+
subscriptions: ::Array[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription],
|
14
14
|
?request_options: Knockapi::request_opts
|
15
|
-
) -> Knockapi::
|
15
|
+
) -> Knockapi::BulkOperation
|
16
16
|
|
17
17
|
def set: (
|
18
18
|
String collection,
|
19
|
-
objects: ::Array[Knockapi::
|
19
|
+
objects: ::Array[Knockapi::InlineObjectRequest],
|
20
20
|
?request_options: Knockapi::request_opts
|
21
|
-
) -> Knockapi::
|
21
|
+
) -> Knockapi::BulkOperation
|
22
22
|
|
23
23
|
def initialize: (client: Knockapi::Client) -> void
|
24
24
|
end
|
@@ -7,10 +7,10 @@ module Knockapi
|
|
7
7
|
String collection,
|
8
8
|
?after: String,
|
9
9
|
?before: String,
|
10
|
-
?include: ::Array[Knockapi::
|
10
|
+
?include: ::Array[Knockapi::ObjectListParams::include_],
|
11
11
|
?page_size: Integer,
|
12
12
|
?request_options: Knockapi::request_opts
|
13
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
13
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Object]
|
14
14
|
|
15
15
|
def delete: (
|
16
16
|
String collection,
|
@@ -37,21 +37,21 @@ module Knockapi
|
|
37
37
|
String collection,
|
38
38
|
String id,
|
39
39
|
?request_options: Knockapi::request_opts
|
40
|
-
) -> Knockapi::
|
40
|
+
) -> Knockapi::Object
|
41
41
|
|
42
42
|
def get_channel_data: (
|
43
43
|
String collection,
|
44
44
|
String object_id_,
|
45
45
|
String channel_id,
|
46
46
|
?request_options: Knockapi::request_opts
|
47
|
-
) -> Knockapi::
|
47
|
+
) -> Knockapi::Recipients::RecipientsChannelData
|
48
48
|
|
49
49
|
def get_preferences: (
|
50
50
|
String collection,
|
51
51
|
String object_id_,
|
52
52
|
String id,
|
53
53
|
?request_options: Knockapi::request_opts
|
54
|
-
) -> Knockapi::
|
54
|
+
) -> Knockapi::Recipients::PreferenceSet
|
55
55
|
|
56
56
|
def list_messages: (
|
57
57
|
String collection,
|
@@ -59,19 +59,19 @@ module Knockapi
|
|
59
59
|
?after: String,
|
60
60
|
?before: String,
|
61
61
|
?channel_id: String,
|
62
|
-
?engagement_status: ::Array[Knockapi::
|
63
|
-
?inserted_at: Knockapi::
|
62
|
+
?engagement_status: ::Array[Knockapi::ObjectListMessagesParams::engagement_status],
|
63
|
+
?inserted_at: Knockapi::ObjectListMessagesParams::InsertedAt,
|
64
64
|
?message_ids: ::Array[String],
|
65
65
|
?page_size: Integer,
|
66
66
|
?source: String,
|
67
|
-
?status: ::Array[Knockapi::
|
67
|
+
?status: ::Array[Knockapi::ObjectListMessagesParams::status],
|
68
68
|
?tenant: String,
|
69
69
|
?trigger_data: String,
|
70
70
|
?workflow_categories: ::Array[String],
|
71
71
|
?workflow_recipient_run_id: String,
|
72
72
|
?workflow_run_id: String,
|
73
73
|
?request_options: Knockapi::request_opts
|
74
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
74
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Message]
|
75
75
|
|
76
76
|
def list_preferences: (
|
77
77
|
String collection,
|
@@ -88,20 +88,20 @@ module Knockapi
|
|
88
88
|
?tenant: String,
|
89
89
|
?workflow: String,
|
90
90
|
?request_options: Knockapi::request_opts
|
91
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
91
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]
|
92
92
|
|
93
93
|
def list_subscriptions: (
|
94
94
|
String collection,
|
95
95
|
String object_id_,
|
96
96
|
?after: String,
|
97
97
|
?before: String,
|
98
|
-
?include: ::Array[Knockapi::
|
98
|
+
?include: ::Array[Knockapi::ObjectListSubscriptionsParams::include_],
|
99
99
|
?mode: Knockapi::Models::ObjectListSubscriptionsParams::mode,
|
100
|
-
?objects: ::Array[Knockapi::
|
100
|
+
?objects: ::Array[Knockapi::ObjectListSubscriptionsParams::Object],
|
101
101
|
?page_size: Integer,
|
102
102
|
?recipients: ::Array[Knockapi::Models::recipient_reference],
|
103
103
|
?request_options: Knockapi::request_opts
|
104
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
104
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Recipients::Subscription]
|
105
105
|
|
106
106
|
def set: (
|
107
107
|
String collection,
|
@@ -111,7 +111,7 @@ module Knockapi
|
|
111
111
|
?preferences: Knockapi::Models::Recipients::inline_preference_set_request,
|
112
112
|
?timezone: String?,
|
113
113
|
?request_options: Knockapi::request_opts
|
114
|
-
) -> Knockapi::
|
114
|
+
) -> Knockapi::Object
|
115
115
|
|
116
116
|
def set_channel_data: (
|
117
117
|
String collection,
|
@@ -119,17 +119,17 @@ module Knockapi
|
|
119
119
|
String channel_id,
|
120
120
|
data: Knockapi::Models::Recipients::ChannelDataRequest::data,
|
121
121
|
?request_options: Knockapi::request_opts
|
122
|
-
) -> Knockapi::
|
122
|
+
) -> Knockapi::Recipients::RecipientsChannelData
|
123
123
|
|
124
124
|
def set_preferences: (
|
125
125
|
String collection,
|
126
126
|
String object_id_,
|
127
127
|
String id,
|
128
|
-
?categories: ::Hash[Symbol, Knockapi::
|
129
|
-
?channel_types: Knockapi::
|
130
|
-
?workflows: ::Hash[Symbol, Knockapi::
|
128
|
+
?categories: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::category]?,
|
129
|
+
?channel_types: Knockapi::Recipients::PreferenceSetChannelTypes?,
|
130
|
+
?workflows: ::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::workflow]?,
|
131
131
|
?request_options: Knockapi::request_opts
|
132
|
-
) -> Knockapi::
|
132
|
+
) -> Knockapi::Recipients::PreferenceSet
|
133
133
|
|
134
134
|
def unset_channel_data: (
|
135
135
|
String collection,
|
@@ -12,14 +12,14 @@ module Knockapi
|
|
12
12
|
String channel_id,
|
13
13
|
ms_teams_tenant_object: String,
|
14
14
|
team_id: String,
|
15
|
-
?query_options: Knockapi::
|
15
|
+
?query_options: Knockapi::Providers::MsTeamListChannelsParams::QueryOptions,
|
16
16
|
?request_options: Knockapi::request_opts
|
17
17
|
) -> Knockapi::Models::Providers::MsTeamListChannelsResponse
|
18
18
|
|
19
19
|
def list_teams: (
|
20
20
|
String channel_id,
|
21
21
|
ms_teams_tenant_object: String,
|
22
|
-
?query_options: Knockapi::
|
22
|
+
?query_options: Knockapi::Providers::MsTeamListTeamsParams::QueryOptions,
|
23
23
|
?request_options: Knockapi::request_opts
|
24
24
|
) -> Knockapi::Internal::MsTeamsPagination[Knockapi::Models::Providers::MsTeamListTeamsResponse]
|
25
25
|
|
@@ -11,7 +11,7 @@ module Knockapi
|
|
11
11
|
def list_channels: (
|
12
12
|
String channel_id,
|
13
13
|
access_token_object: String,
|
14
|
-
?query_options: Knockapi::
|
14
|
+
?query_options: Knockapi::Providers::SlackListChannelsParams::QueryOptions,
|
15
15
|
?request_options: Knockapi::request_opts
|
16
16
|
) -> Knockapi::Internal::SlackChannelsCursor[Knockapi::Models::Providers::SlackListChannelsResponse]
|
17
17
|
|
@@ -3,9 +3,9 @@ module Knockapi
|
|
3
3
|
class Schedules
|
4
4
|
class Bulk
|
5
5
|
def create: (
|
6
|
-
schedules: ::Array[Knockapi::
|
6
|
+
schedules: ::Array[Knockapi::Schedules::BulkCreateParams::Schedule],
|
7
7
|
?request_options: Knockapi::request_opts
|
8
|
-
) -> Knockapi::
|
8
|
+
) -> Knockapi::BulkOperation
|
9
9
|
|
10
10
|
def initialize: (client: Knockapi::Client) -> void
|
11
11
|
end
|
@@ -5,7 +5,7 @@ module Knockapi
|
|
5
5
|
|
6
6
|
def create: (
|
7
7
|
recipients: ::Array[Knockapi::Models::recipient_request],
|
8
|
-
repeats: ::Array[Knockapi::
|
8
|
+
repeats: ::Array[Knockapi::ScheduleRepeatRule],
|
9
9
|
workflow: String,
|
10
10
|
?data: ::Hash[Symbol, top]?,
|
11
11
|
?ending_at: Time?,
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
?actor: Knockapi::Models::recipient_reference?,
|
20
20
|
?data: ::Hash[Symbol, top]?,
|
21
21
|
?ending_at: Time?,
|
22
|
-
?repeats: ::Array[Knockapi::
|
22
|
+
?repeats: ::Array[Knockapi::ScheduleRepeatRule],
|
23
23
|
?scheduled_at: Time?,
|
24
24
|
?tenant: Knockapi::Models::inline_tenant_request?,
|
25
25
|
?request_options: Knockapi::request_opts
|
@@ -33,7 +33,7 @@ module Knockapi
|
|
33
33
|
?recipients: ::Array[String],
|
34
34
|
?tenant: String,
|
35
35
|
?request_options: Knockapi::request_opts
|
36
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
36
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Schedule]
|
37
37
|
|
38
38
|
def delete: (
|
39
39
|
schedule_ids: ::Array[String],
|
@@ -5,12 +5,12 @@ module Knockapi
|
|
5
5
|
def delete: (
|
6
6
|
tenant_ids: ::Array[String],
|
7
7
|
?request_options: Knockapi::request_opts
|
8
|
-
) -> Knockapi::
|
8
|
+
) -> Knockapi::BulkOperation
|
9
9
|
|
10
10
|
def set: (
|
11
11
|
tenants: ::Array[Knockapi::Models::inline_tenant_request],
|
12
12
|
?request_options: Knockapi::request_opts
|
13
|
-
) -> Knockapi::
|
13
|
+
) -> Knockapi::BulkOperation
|
14
14
|
|
15
15
|
def initialize: (client: Knockapi::Client) -> void
|
16
16
|
end
|
@@ -10,7 +10,7 @@ module Knockapi
|
|
10
10
|
?page_size: Integer,
|
11
11
|
?tenant_id: String,
|
12
12
|
?request_options: Knockapi::request_opts
|
13
|
-
) -> Knockapi::Internal::EntriesCursor[Knockapi::
|
13
|
+
) -> Knockapi::Internal::EntriesCursor[Knockapi::Tenant]
|
14
14
|
|
15
15
|
def delete: (
|
16
16
|
String id,
|
@@ -20,15 +20,15 @@ module Knockapi
|
|
20
20
|
def get: (
|
21
21
|
String id,
|
22
22
|
?request_options: Knockapi::request_opts
|
23
|
-
) -> Knockapi::
|
23
|
+
) -> Knockapi::Tenant
|
24
24
|
|
25
25
|
def set: (
|
26
26
|
String id,
|
27
27
|
?channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
28
28
|
?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
29
|
-
?settings: Knockapi::
|
29
|
+
?settings: Knockapi::TenantSetParams::Settings,
|
30
30
|
?request_options: Knockapi::request_opts
|
31
|
-
) -> Knockapi::
|
31
|
+
) -> Knockapi::Tenant
|
32
32
|
|
33
33
|
def initialize: (client: Knockapi::Client) -> void
|
34
34
|
end
|
@@ -5,18 +5,18 @@ module Knockapi
|
|
5
5
|
def delete: (
|
6
6
|
user_ids: ::Array[String],
|
7
7
|
?request_options: Knockapi::request_opts
|
8
|
-
) -> Knockapi::
|
8
|
+
) -> Knockapi::BulkOperation
|
9
9
|
|
10
10
|
def identify: (
|
11
|
-
users: ::Array[Knockapi::
|
11
|
+
users: ::Array[Knockapi::InlineIdentifyUserRequest],
|
12
12
|
?request_options: Knockapi::request_opts
|
13
|
-
) -> Knockapi::
|
13
|
+
) -> Knockapi::BulkOperation
|
14
14
|
|
15
15
|
def set_preferences: (
|
16
|
-
preferences: Knockapi::
|
16
|
+
preferences: Knockapi::Recipients::PreferenceSetRequest,
|
17
17
|
user_ids: ::Array[String],
|
18
18
|
?request_options: Knockapi::request_opts
|
19
|
-
) -> Knockapi::
|
19
|
+
) -> Knockapi::BulkOperation
|
20
20
|
|
21
21
|
def initialize: (client: Knockapi::Client) -> void
|
22
22
|
end
|