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
@@ -16,13 +16,13 @@ module Knockapi
|
|
16
16
|
|
17
17
|
# @!attribute query_options
|
18
18
|
#
|
19
|
-
# @return [Knockapi::
|
20
|
-
optional :query_options, -> { Knockapi::
|
19
|
+
# @return [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions, nil]
|
20
|
+
optional :query_options, -> { Knockapi::Providers::MsTeamListTeamsParams::QueryOptions }
|
21
21
|
|
22
22
|
# @!method initialize(ms_teams_tenant_object:, query_options: nil, request_options: {})
|
23
23
|
# @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
|
24
24
|
#
|
25
|
-
# @param query_options [Knockapi::
|
25
|
+
# @param query_options [Knockapi::Providers::MsTeamListTeamsParams::QueryOptions]
|
26
26
|
#
|
27
27
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
28
28
|
|
@@ -57,20 +57,15 @@ module Knockapi
|
|
57
57
|
|
58
58
|
# @!method initialize(filter: nil, select_: nil, skiptoken: nil, top: nil)
|
59
59
|
# Some parameter documentations has been truncated, see
|
60
|
-
# {Knockapi::
|
61
|
-
# details.
|
60
|
+
# {Knockapi::Providers::MsTeamListTeamsParams::QueryOptions} for more details.
|
62
61
|
#
|
63
62
|
# @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
64
|
-
# ...
|
65
63
|
#
|
66
64
|
# @param select_ [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
67
|
-
# ...
|
68
65
|
#
|
69
66
|
# @param skiptoken [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
70
|
-
# ...
|
71
67
|
#
|
72
68
|
# @param top [Integer] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
73
|
-
# ...
|
74
69
|
end
|
75
70
|
end
|
76
71
|
end
|
@@ -16,13 +16,13 @@ module Knockapi
|
|
16
16
|
|
17
17
|
# @!attribute query_options
|
18
18
|
#
|
19
|
-
# @return [Knockapi::
|
20
|
-
optional :query_options, -> { Knockapi::
|
19
|
+
# @return [Knockapi::Providers::SlackListChannelsParams::QueryOptions, nil]
|
20
|
+
optional :query_options, -> { Knockapi::Providers::SlackListChannelsParams::QueryOptions }
|
21
21
|
|
22
22
|
# @!method initialize(access_token_object:, query_options: nil, request_options: {})
|
23
23
|
# @param access_token_object [String] A JSON encoded string containing the access token object reference.
|
24
24
|
#
|
25
|
-
# @param query_options [Knockapi::
|
25
|
+
# @param query_options [Knockapi::Providers::SlackListChannelsParams::QueryOptions]
|
26
26
|
#
|
27
27
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
28
28
|
|
@@ -62,11 +62,9 @@ module Knockapi
|
|
62
62
|
|
63
63
|
# @!method initialize(cursor: nil, exclude_archived: nil, limit: nil, team_id: nil, types: nil)
|
64
64
|
# Some parameter documentations has been truncated, see
|
65
|
-
# {Knockapi::
|
66
|
-
# details.
|
65
|
+
# {Knockapi::Providers::SlackListChannelsParams::QueryOptions} for more details.
|
67
66
|
#
|
68
67
|
# @param cursor [String] Paginate through collections of data by setting the cursor parameter to a next_c
|
69
|
-
# ...
|
70
68
|
#
|
71
69
|
# @param exclude_archived [Boolean] Set to true to exclude archived channels from the list.
|
72
70
|
#
|
@@ -75,7 +73,6 @@ module Knockapi
|
|
75
73
|
# @param team_id [String] Encoded team ID (T1234) to list channels in, required if org token is used.
|
76
74
|
#
|
77
75
|
# @param types [String] Mix and match channel types by providing a comma-separated list of any combinati
|
78
|
-
# ...
|
79
76
|
end
|
80
77
|
end
|
81
78
|
end
|
@@ -7,13 +7,17 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::Union
|
8
8
|
|
9
9
|
# A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.
|
10
|
-
variant -> { Knockapi::
|
10
|
+
variant -> { Knockapi::User }
|
11
11
|
|
12
12
|
# A custom [Object](/concepts/objects) entity which belongs to a collection.
|
13
|
-
variant -> { Knockapi::
|
13
|
+
variant -> { Knockapi::Object }
|
14
14
|
|
15
15
|
# @!method self.variants
|
16
|
-
# @return [Array(Knockapi::
|
16
|
+
# @return [Array(Knockapi::User, Knockapi::Object)]
|
17
|
+
|
18
|
+
define_sorbet_constant!(:Variants) do
|
19
|
+
T.type_alias { T.any(Knockapi::User, Knockapi::Object) }
|
20
|
+
end
|
17
21
|
end
|
18
22
|
end
|
19
23
|
end
|
@@ -11,7 +11,7 @@ module Knockapi
|
|
11
11
|
variant String
|
12
12
|
|
13
13
|
# A reference to a recipient object.
|
14
|
-
variant -> { Knockapi::
|
14
|
+
variant -> { Knockapi::RecipientReference::ObjectReference }
|
15
15
|
|
16
16
|
class ObjectReference < Knockapi::Internal::Type::BaseModel
|
17
17
|
# @!attribute id
|
@@ -35,7 +35,11 @@ module Knockapi
|
|
35
35
|
end
|
36
36
|
|
37
37
|
# @!method self.variants
|
38
|
-
# @return [Array(String, Knockapi::
|
38
|
+
# @return [Array(String, Knockapi::RecipientReference::ObjectReference)]
|
39
|
+
|
40
|
+
define_sorbet_constant!(:Variants) do
|
41
|
+
T.type_alias { T.any(String, Knockapi::RecipientReference::ObjectReference) }
|
42
|
+
end
|
39
43
|
end
|
40
44
|
end
|
41
45
|
end
|
@@ -12,13 +12,17 @@ module Knockapi
|
|
12
12
|
variant String
|
13
13
|
|
14
14
|
# A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock. It will perform an upsert for the user you're supplying, replacing any properties specified.
|
15
|
-
variant -> { Knockapi::
|
15
|
+
variant -> { Knockapi::InlineIdentifyUserRequest }
|
16
16
|
|
17
17
|
# A custom [Object](/concepts/objects) entity which belongs to a collection.
|
18
|
-
variant -> { Knockapi::
|
18
|
+
variant -> { Knockapi::InlineObjectRequest }
|
19
19
|
|
20
20
|
# @!method self.variants
|
21
|
-
# @return [Array(String, Knockapi::
|
21
|
+
# @return [Array(String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest)]
|
22
|
+
|
23
|
+
define_sorbet_constant!(:Variants) do
|
24
|
+
T.type_alias { T.any(String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest) }
|
25
|
+
end
|
22
26
|
end
|
23
27
|
end
|
24
28
|
end
|
@@ -19,14 +19,14 @@ module Knockapi
|
|
19
19
|
# @!attribute data
|
20
20
|
# Channel data for a given channel type.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::
|
23
|
-
required :data, union: -> { Knockapi::
|
22
|
+
# @return [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData]
|
23
|
+
required :data, union: -> { Knockapi::Recipients::RecipientsChannelData::Data }
|
24
24
|
|
25
25
|
# @!attribute provider
|
26
26
|
# The type of provider.
|
27
27
|
#
|
28
|
-
# @return [Symbol, Knockapi::
|
29
|
-
optional :provider, enum: -> { Knockapi::
|
28
|
+
# @return [Symbol, Knockapi::Recipients::RecipientsChannelData::Provider, nil]
|
29
|
+
optional :provider, enum: -> { Knockapi::Recipients::RecipientsChannelData::Provider }
|
30
30
|
|
31
31
|
# @!method initialize(_typename:, channel_id:, data:, provider: nil)
|
32
32
|
# Channel data for a given channel type.
|
@@ -35,38 +35,50 @@ module Knockapi
|
|
35
35
|
#
|
36
36
|
# @param channel_id [String] The unique identifier for the channel.
|
37
37
|
#
|
38
|
-
# @param data [Knockapi::
|
38
|
+
# @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData] Channel data for a given channel type.
|
39
39
|
#
|
40
|
-
# @param provider [Symbol, Knockapi::
|
40
|
+
# @param provider [Symbol, Knockapi::Recipients::RecipientsChannelData::Provider] The type of provider.
|
41
41
|
|
42
42
|
# Channel data for a given channel type.
|
43
43
|
#
|
44
|
-
# @see Knockapi::
|
44
|
+
# @see Knockapi::Recipients::RecipientsChannelData#data
|
45
45
|
module Data
|
46
46
|
extend Knockapi::Internal::Type::Union
|
47
47
|
|
48
48
|
# The content of a push notification.
|
49
|
-
variant -> { Knockapi::
|
49
|
+
variant -> { Knockapi::Recipients::PushChannelData }
|
50
50
|
|
51
51
|
# Slack channel data
|
52
|
-
variant -> { Knockapi::
|
52
|
+
variant -> { Knockapi::Recipients::SlackChannelData }
|
53
53
|
|
54
54
|
# Microsoft Teams channel connection.
|
55
|
-
variant -> { Knockapi::
|
55
|
+
variant -> { Knockapi::Recipients::MsTeamsChannelData }
|
56
56
|
|
57
57
|
# Discord channel data.
|
58
|
-
variant -> { Knockapi::
|
58
|
+
variant -> { Knockapi::Recipients::DiscordChannelData }
|
59
59
|
|
60
60
|
# OneSignal channel data.
|
61
|
-
variant -> { Knockapi::
|
61
|
+
variant -> { Knockapi::Recipients::OneSignalChannelData }
|
62
62
|
|
63
63
|
# @!method self.variants
|
64
|
-
# @return [Array(Knockapi::
|
64
|
+
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData, Knockapi::Recipients::OneSignalChannelData)]
|
65
|
+
|
66
|
+
define_sorbet_constant!(:Variants) do
|
67
|
+
T.type_alias do
|
68
|
+
T.any(
|
69
|
+
Knockapi::Recipients::PushChannelData,
|
70
|
+
Knockapi::Recipients::SlackChannelData,
|
71
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
72
|
+
Knockapi::Recipients::DiscordChannelData,
|
73
|
+
Knockapi::Recipients::OneSignalChannelData
|
74
|
+
)
|
75
|
+
end
|
76
|
+
end
|
65
77
|
end
|
66
78
|
|
67
79
|
# The type of provider.
|
68
80
|
#
|
69
|
-
# @see Knockapi::
|
81
|
+
# @see Knockapi::Recipients::RecipientsChannelData#provider
|
70
82
|
module Provider
|
71
83
|
extend Knockapi::Internal::Type::Enum
|
72
84
|
|
@@ -7,37 +7,49 @@ module Knockapi
|
|
7
7
|
# @!attribute data
|
8
8
|
# Channel data for a given channel type.
|
9
9
|
#
|
10
|
-
# @return [Knockapi::
|
11
|
-
required :data, union: -> { Knockapi::
|
10
|
+
# @return [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData]
|
11
|
+
required :data, union: -> { Knockapi::Recipients::ChannelDataRequest::Data }
|
12
12
|
|
13
13
|
# @!method initialize(data:)
|
14
14
|
# A request to set channel data for a type of channel.
|
15
15
|
#
|
16
|
-
# @param data [Knockapi::
|
16
|
+
# @param data [Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData] Channel data for a given channel type.
|
17
17
|
|
18
18
|
# Channel data for a given channel type.
|
19
19
|
#
|
20
|
-
# @see Knockapi::
|
20
|
+
# @see Knockapi::Recipients::ChannelDataRequest#data
|
21
21
|
module Data
|
22
22
|
extend Knockapi::Internal::Type::Union
|
23
23
|
|
24
24
|
# The content of a push notification.
|
25
|
-
variant -> { Knockapi::
|
25
|
+
variant -> { Knockapi::Recipients::PushChannelData }
|
26
26
|
|
27
27
|
# OneSignal channel data.
|
28
|
-
variant -> { Knockapi::
|
28
|
+
variant -> { Knockapi::Recipients::OneSignalChannelData }
|
29
29
|
|
30
30
|
# Slack channel data
|
31
|
-
variant -> { Knockapi::
|
31
|
+
variant -> { Knockapi::Recipients::SlackChannelData }
|
32
32
|
|
33
33
|
# Microsoft Teams channel connection.
|
34
|
-
variant -> { Knockapi::
|
34
|
+
variant -> { Knockapi::Recipients::MsTeamsChannelData }
|
35
35
|
|
36
36
|
# Discord channel data.
|
37
|
-
variant -> { Knockapi::
|
37
|
+
variant -> { Knockapi::Recipients::DiscordChannelData }
|
38
38
|
|
39
39
|
# @!method self.variants
|
40
|
-
# @return [Array(Knockapi::
|
40
|
+
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData)]
|
41
|
+
|
42
|
+
define_sorbet_constant!(:Variants) do
|
43
|
+
T.type_alias do
|
44
|
+
T.any(
|
45
|
+
Knockapi::Recipients::PushChannelData,
|
46
|
+
Knockapi::Recipients::OneSignalChannelData,
|
47
|
+
Knockapi::Recipients::SlackChannelData,
|
48
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
49
|
+
Knockapi::Recipients::DiscordChannelData
|
50
|
+
)
|
51
|
+
end
|
52
|
+
end
|
41
53
|
end
|
42
54
|
end
|
43
55
|
end
|
@@ -7,14 +7,16 @@ module Knockapi
|
|
7
7
|
# @!attribute connections
|
8
8
|
# List of Discord channel connections.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::
|
10
|
+
# @return [Array<Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>]
|
11
11
|
required :connections,
|
12
|
-
-> {
|
12
|
+
-> {
|
13
|
+
Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::DiscordChannelData::Connection]
|
14
|
+
}
|
13
15
|
|
14
16
|
# @!method initialize(connections:)
|
15
17
|
# Discord channel data.
|
16
18
|
#
|
17
|
-
# @param connections [Array<Knockapi::
|
19
|
+
# @param connections [Array<Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection>] List of Discord channel connections.
|
18
20
|
|
19
21
|
# Discord channel connection, either a channel connection or an incoming webhook
|
20
22
|
# connection.
|
@@ -22,10 +24,12 @@ module Knockapi
|
|
22
24
|
extend Knockapi::Internal::Type::Union
|
23
25
|
|
24
26
|
# Discord channel connection.
|
25
|
-
variant -> { Knockapi::
|
27
|
+
variant -> { Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection }
|
26
28
|
|
27
29
|
# Discord incoming webhook connection.
|
28
|
-
variant -> {
|
30
|
+
variant -> {
|
31
|
+
Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
|
32
|
+
}
|
29
33
|
|
30
34
|
class DiscordChannelConnection < Knockapi::Internal::Type::BaseModel
|
31
35
|
# @!attribute channel_id
|
@@ -44,16 +48,18 @@ module Knockapi
|
|
44
48
|
# @!attribute incoming_webhook
|
45
49
|
# Discord incoming webhook object.
|
46
50
|
#
|
47
|
-
# @return [Knockapi::
|
51
|
+
# @return [Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook]
|
48
52
|
required :incoming_webhook,
|
49
|
-
-> {
|
53
|
+
-> {
|
54
|
+
Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook
|
55
|
+
}
|
50
56
|
|
51
57
|
# @!method initialize(incoming_webhook:)
|
52
58
|
# Discord incoming webhook connection.
|
53
59
|
#
|
54
|
-
# @param incoming_webhook [Knockapi::
|
60
|
+
# @param incoming_webhook [Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection::IncomingWebhook] Discord incoming webhook object.
|
55
61
|
|
56
|
-
# @see Knockapi::
|
62
|
+
# @see Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection#incoming_webhook
|
57
63
|
class IncomingWebhook < Knockapi::Internal::Type::BaseModel
|
58
64
|
# @!attribute url
|
59
65
|
# Incoming webhook URL.
|
@@ -69,7 +75,16 @@ module Knockapi
|
|
69
75
|
end
|
70
76
|
|
71
77
|
# @!method self.variants
|
72
|
-
# @return [Array(Knockapi::
|
78
|
+
# @return [Array(Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection, Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection)]
|
79
|
+
|
80
|
+
define_sorbet_constant!(:Variants) do
|
81
|
+
T.type_alias do
|
82
|
+
T.any(
|
83
|
+
Knockapi::Recipients::DiscordChannelData::Connection::DiscordChannelConnection,
|
84
|
+
Knockapi::Recipients::DiscordChannelData::Connection::DiscordIncomingWebhookConnection
|
85
|
+
)
|
86
|
+
end
|
87
|
+
end
|
73
88
|
end
|
74
89
|
end
|
75
90
|
end
|
@@ -3,9 +3,44 @@
|
|
3
3
|
module Knockapi
|
4
4
|
module Models
|
5
5
|
module Recipients
|
6
|
+
# Channel data for a given channel type.
|
7
|
+
module InlineChannelDataRequestItem
|
8
|
+
extend Knockapi::Internal::Type::Union
|
9
|
+
|
10
|
+
# The content of a push notification.
|
11
|
+
variant -> { Knockapi::Recipients::PushChannelData }
|
12
|
+
|
13
|
+
# OneSignal channel data.
|
14
|
+
variant -> { Knockapi::Recipients::OneSignalChannelData }
|
15
|
+
|
16
|
+
# Slack channel data
|
17
|
+
variant -> { Knockapi::Recipients::SlackChannelData }
|
18
|
+
|
19
|
+
# Microsoft Teams channel connection.
|
20
|
+
variant -> { Knockapi::Recipients::MsTeamsChannelData }
|
21
|
+
|
22
|
+
# Discord channel data.
|
23
|
+
variant -> { Knockapi::Recipients::DiscordChannelData }
|
24
|
+
|
25
|
+
# @!method self.variants
|
26
|
+
# @return [Array(Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData)]
|
27
|
+
|
28
|
+
define_sorbet_constant!(:Variants) do
|
29
|
+
T.type_alias do
|
30
|
+
T.any(
|
31
|
+
Knockapi::Recipients::PushChannelData,
|
32
|
+
Knockapi::Recipients::OneSignalChannelData,
|
33
|
+
Knockapi::Recipients::SlackChannelData,
|
34
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
35
|
+
Knockapi::Recipients::DiscordChannelData
|
36
|
+
)
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
6
41
|
# @type [Knockapi::Internal::Type::Converter]
|
7
42
|
InlineChannelDataRequest =
|
8
|
-
Knockapi::Internal::Type::HashOf[-> { Knockapi::
|
43
|
+
Knockapi::Internal::Type::HashOf[union: -> { Knockapi::Recipients::InlineChannelDataRequestItem }]
|
9
44
|
end
|
10
45
|
end
|
11
46
|
end
|
@@ -5,7 +5,7 @@ module Knockapi
|
|
5
5
|
module Recipients
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
7
|
InlinePreferenceSetRequest =
|
8
|
-
Knockapi::Internal::Type::HashOf[-> { Knockapi::
|
8
|
+
Knockapi::Internal::Type::HashOf[-> { Knockapi::Recipients::PreferenceSetRequest }]
|
9
9
|
end
|
10
10
|
end
|
11
11
|
end
|
@@ -7,9 +7,11 @@ module Knockapi
|
|
7
7
|
# @!attribute connections
|
8
8
|
# List of Microsoft Teams connections.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::
|
10
|
+
# @return [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>]
|
11
11
|
required :connections,
|
12
|
-
-> {
|
12
|
+
-> {
|
13
|
+
Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::MsTeamsChannelData::Connection]
|
14
|
+
}
|
13
15
|
|
14
16
|
# @!attribute ms_teams_tenant_id
|
15
17
|
# Microsoft Teams tenant ID.
|
@@ -20,7 +22,7 @@ module Knockapi
|
|
20
22
|
# @!method initialize(connections:, ms_teams_tenant_id: nil)
|
21
23
|
# Microsoft Teams channel connection.
|
22
24
|
#
|
23
|
-
# @param connections [Array<Knockapi::
|
25
|
+
# @param connections [Array<Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
|
24
26
|
#
|
25
27
|
# @param ms_teams_tenant_id [String, nil] Microsoft Teams tenant ID.
|
26
28
|
|
@@ -29,10 +31,12 @@ module Knockapi
|
|
29
31
|
extend Knockapi::Internal::Type::Union
|
30
32
|
|
31
33
|
# Microsoft Teams token connection.
|
32
|
-
variant -> { Knockapi::
|
34
|
+
variant -> { Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection }
|
33
35
|
|
34
36
|
# Microsoft Teams incoming webhook connection.
|
35
|
-
variant -> {
|
37
|
+
variant -> {
|
38
|
+
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
|
39
|
+
}
|
36
40
|
|
37
41
|
class MsTeamsTokenConnection < Knockapi::Internal::Type::BaseModel
|
38
42
|
# @!attribute ms_teams_channel_id
|
@@ -75,16 +79,18 @@ module Knockapi
|
|
75
79
|
# @!attribute incoming_webhook
|
76
80
|
# Microsoft Teams incoming webhook.
|
77
81
|
#
|
78
|
-
# @return [Knockapi::
|
82
|
+
# @return [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook]
|
79
83
|
required :incoming_webhook,
|
80
|
-
-> {
|
84
|
+
-> {
|
85
|
+
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook
|
86
|
+
}
|
81
87
|
|
82
88
|
# @!method initialize(incoming_webhook:)
|
83
89
|
# Microsoft Teams incoming webhook connection.
|
84
90
|
#
|
85
|
-
# @param incoming_webhook [Knockapi::
|
91
|
+
# @param incoming_webhook [Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection::IncomingWebhook] Microsoft Teams incoming webhook.
|
86
92
|
|
87
|
-
# @see Knockapi::
|
93
|
+
# @see Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection#incoming_webhook
|
88
94
|
class IncomingWebhook < Knockapi::Internal::Type::BaseModel
|
89
95
|
# @!attribute url
|
90
96
|
# Microsoft Teams incoming webhook URL.
|
@@ -100,7 +106,16 @@ module Knockapi
|
|
100
106
|
end
|
101
107
|
|
102
108
|
# @!method self.variants
|
103
|
-
# @return [Array(Knockapi::
|
109
|
+
# @return [Array(Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection)]
|
110
|
+
|
111
|
+
define_sorbet_constant!(:Variants) do
|
112
|
+
T.type_alias do
|
113
|
+
T.any(
|
114
|
+
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection,
|
115
|
+
Knockapi::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection
|
116
|
+
)
|
117
|
+
end
|
118
|
+
end
|
104
119
|
end
|
105
120
|
end
|
106
121
|
end
|