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
@@ -4,6 +4,14 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class SlackListChannelsResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::SlackListChannelsResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# A Slack channel ID from the Slack provider.
|
8
16
|
sig { returns(String) }
|
9
17
|
attr_accessor :id
|
@@ -26,8 +34,13 @@ module Knockapi
|
|
26
34
|
|
27
35
|
# A Slack channel.
|
28
36
|
sig do
|
29
|
-
params(
|
30
|
-
|
37
|
+
params(
|
38
|
+
id: String,
|
39
|
+
context_team_id: String,
|
40
|
+
is_im: T::Boolean,
|
41
|
+
is_private: T::Boolean,
|
42
|
+
name: String
|
43
|
+
).returns(T.attached_class)
|
31
44
|
end
|
32
45
|
def self.new(
|
33
46
|
# A Slack channel ID from the Slack provider.
|
@@ -40,18 +53,22 @@ module Knockapi
|
|
40
53
|
is_private:,
|
41
54
|
# Slack channel name.
|
42
55
|
name:
|
43
|
-
)
|
56
|
+
)
|
57
|
+
end
|
58
|
+
|
44
59
|
sig do
|
45
|
-
override
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
60
|
+
override.returns(
|
61
|
+
{
|
62
|
+
id: String,
|
63
|
+
context_team_id: String,
|
64
|
+
is_im: T::Boolean,
|
65
|
+
is_private: T::Boolean,
|
66
|
+
name: String
|
67
|
+
}
|
68
|
+
)
|
69
|
+
end
|
70
|
+
def to_hash
|
53
71
|
end
|
54
|
-
def to_hash; end
|
55
72
|
end
|
56
73
|
end
|
57
74
|
end
|
@@ -7,6 +7,14 @@ module Knockapi
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
9
9
|
|
10
|
+
OrHash =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(
|
13
|
+
Knockapi::Providers::SlackRevokeAccessParams,
|
14
|
+
Knockapi::Internal::AnyHash
|
15
|
+
)
|
16
|
+
end
|
17
|
+
|
10
18
|
# A JSON encoded string containing the access token object reference.
|
11
19
|
sig { returns(String) }
|
12
20
|
attr_accessor :access_token_object
|
@@ -14,17 +22,26 @@ module Knockapi
|
|
14
22
|
sig do
|
15
23
|
params(
|
16
24
|
access_token_object: String,
|
17
|
-
request_options:
|
18
|
-
)
|
19
|
-
.returns(T.attached_class)
|
25
|
+
request_options: Knockapi::RequestOptions::OrHash
|
26
|
+
).returns(T.attached_class)
|
20
27
|
end
|
21
28
|
def self.new(
|
22
29
|
# A JSON encoded string containing the access token object reference.
|
23
30
|
access_token_object:,
|
24
31
|
request_options: {}
|
25
|
-
)
|
26
|
-
|
27
|
-
|
32
|
+
)
|
33
|
+
end
|
34
|
+
|
35
|
+
sig do
|
36
|
+
override.returns(
|
37
|
+
{
|
38
|
+
access_token_object: String,
|
39
|
+
request_options: Knockapi::RequestOptions
|
40
|
+
}
|
41
|
+
)
|
42
|
+
end
|
43
|
+
def to_hash
|
44
|
+
end
|
28
45
|
end
|
29
46
|
end
|
30
47
|
end
|
@@ -4,6 +4,14 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Providers
|
6
6
|
class SlackRevokeAccessResponse < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Models::Providers::SlackRevokeAccessResponse,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# OK response.
|
8
16
|
sig { returns(T.nilable(String)) }
|
9
17
|
attr_reader :ok
|
@@ -16,9 +24,12 @@ module Knockapi
|
|
16
24
|
def self.new(
|
17
25
|
# OK response.
|
18
26
|
ok: nil
|
19
|
-
)
|
20
|
-
|
21
|
-
|
27
|
+
)
|
28
|
+
end
|
29
|
+
|
30
|
+
sig { override.returns({ ok: String }) }
|
31
|
+
def to_hash
|
32
|
+
end
|
22
33
|
end
|
23
34
|
end
|
24
35
|
end
|
@@ -6,8 +6,11 @@ module Knockapi
|
|
6
6
|
module Recipient
|
7
7
|
extend Knockapi::Internal::Type::Union
|
8
8
|
|
9
|
-
|
10
|
-
|
9
|
+
Variants = T.type_alias { T.any(Knockapi::User, Knockapi::Object) }
|
10
|
+
|
11
|
+
sig { override.returns(T::Array[Knockapi::Recipient::Variants]) }
|
12
|
+
def self.variants
|
13
|
+
end
|
11
14
|
end
|
12
15
|
end
|
13
16
|
end
|
@@ -7,7 +7,20 @@ module Knockapi
|
|
7
7
|
module RecipientReference
|
8
8
|
extend Knockapi::Internal::Type::Union
|
9
9
|
|
10
|
+
Variants =
|
11
|
+
T.type_alias do
|
12
|
+
T.any(String, Knockapi::RecipientReference::ObjectReference)
|
13
|
+
end
|
14
|
+
|
10
15
|
class ObjectReference < Knockapi::Internal::Type::BaseModel
|
16
|
+
OrHash =
|
17
|
+
T.type_alias do
|
18
|
+
T.any(
|
19
|
+
Knockapi::RecipientReference::ObjectReference,
|
20
|
+
Knockapi::Internal::AnyHash
|
21
|
+
)
|
22
|
+
end
|
23
|
+
|
11
24
|
# An identifier for the recipient object.
|
12
25
|
sig { returns(T.nilable(String)) }
|
13
26
|
attr_reader :id
|
@@ -29,13 +42,17 @@ module Knockapi
|
|
29
42
|
id: nil,
|
30
43
|
# The collection the recipient object belongs to.
|
31
44
|
collection: nil
|
32
|
-
)
|
33
|
-
|
34
|
-
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
48
|
+
sig { override.returns({ id: String, collection: String }) }
|
49
|
+
def to_hash
|
50
|
+
end
|
35
51
|
end
|
36
52
|
|
37
|
-
sig { override.returns([
|
38
|
-
def self.variants
|
53
|
+
sig { override.returns(T::Array[Knockapi::RecipientReference::Variants]) }
|
54
|
+
def self.variants
|
55
|
+
end
|
39
56
|
end
|
40
57
|
end
|
41
58
|
end
|
@@ -8,11 +8,18 @@ module Knockapi
|
|
8
8
|
module RecipientRequest
|
9
9
|
extend Knockapi::Internal::Type::Union
|
10
10
|
|
11
|
-
|
12
|
-
|
13
|
-
.
|
11
|
+
Variants =
|
12
|
+
T.type_alias do
|
13
|
+
T.any(
|
14
|
+
String,
|
15
|
+
Knockapi::InlineIdentifyUserRequest,
|
16
|
+
Knockapi::InlineObjectRequest
|
17
|
+
)
|
18
|
+
end
|
19
|
+
|
20
|
+
sig { override.returns(T::Array[Knockapi::RecipientRequest::Variants]) }
|
21
|
+
def self.variants
|
14
22
|
end
|
15
|
-
def self.variants; end
|
16
23
|
end
|
17
24
|
end
|
18
25
|
end
|
@@ -4,6 +4,14 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Recipients
|
6
6
|
class RecipientsChannelData < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Recipients::RecipientsChannelData,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# The typename of the schema.
|
8
16
|
sig { returns(String) }
|
9
17
|
attr_accessor :_typename
|
@@ -16,21 +24,32 @@ module Knockapi
|
|
16
24
|
sig do
|
17
25
|
returns(
|
18
26
|
T.any(
|
19
|
-
Knockapi::
|
20
|
-
Knockapi::
|
21
|
-
Knockapi::
|
22
|
-
Knockapi::
|
23
|
-
Knockapi::
|
27
|
+
Knockapi::Recipients::PushChannelData,
|
28
|
+
Knockapi::Recipients::SlackChannelData,
|
29
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
30
|
+
Knockapi::Recipients::DiscordChannelData,
|
31
|
+
Knockapi::Recipients::OneSignalChannelData
|
24
32
|
)
|
25
33
|
)
|
26
34
|
end
|
27
35
|
attr_accessor :data
|
28
36
|
|
29
37
|
# The type of provider.
|
30
|
-
sig
|
38
|
+
sig do
|
39
|
+
returns(
|
40
|
+
T.nilable(
|
41
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
42
|
+
)
|
43
|
+
)
|
44
|
+
end
|
31
45
|
attr_reader :provider
|
32
46
|
|
33
|
-
sig
|
47
|
+
sig do
|
48
|
+
params(
|
49
|
+
provider:
|
50
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol
|
51
|
+
).void
|
52
|
+
end
|
34
53
|
attr_writer :provider
|
35
54
|
|
36
55
|
# Channel data for a given channel type.
|
@@ -38,17 +57,17 @@ module Knockapi
|
|
38
57
|
params(
|
39
58
|
_typename: String,
|
40
59
|
channel_id: String,
|
41
|
-
data:
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
provider:
|
50
|
-
|
51
|
-
|
60
|
+
data:
|
61
|
+
T.any(
|
62
|
+
Knockapi::Recipients::PushChannelData::OrHash,
|
63
|
+
Knockapi::Recipients::SlackChannelData::OrHash,
|
64
|
+
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
65
|
+
Knockapi::Recipients::DiscordChannelData::OrHash,
|
66
|
+
Knockapi::Recipients::OneSignalChannelData::OrHash
|
67
|
+
),
|
68
|
+
provider:
|
69
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::OrSymbol
|
70
|
+
).returns(T.attached_class)
|
52
71
|
end
|
53
72
|
def self.new(
|
54
73
|
# The typename of the schema.
|
@@ -59,37 +78,54 @@ module Knockapi
|
|
59
78
|
data:,
|
60
79
|
# The type of provider.
|
61
80
|
provider: nil
|
62
|
-
)
|
81
|
+
)
|
82
|
+
end
|
83
|
+
|
63
84
|
sig do
|
64
|
-
override
|
65
|
-
|
66
|
-
|
67
|
-
|
68
|
-
|
69
|
-
|
70
|
-
Knockapi::
|
71
|
-
Knockapi::
|
72
|
-
Knockapi::
|
73
|
-
Knockapi::
|
74
|
-
Knockapi::
|
85
|
+
override.returns(
|
86
|
+
{
|
87
|
+
_typename: String,
|
88
|
+
channel_id: String,
|
89
|
+
data:
|
90
|
+
T.any(
|
91
|
+
Knockapi::Recipients::PushChannelData,
|
92
|
+
Knockapi::Recipients::SlackChannelData,
|
93
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
94
|
+
Knockapi::Recipients::DiscordChannelData,
|
95
|
+
Knockapi::Recipients::OneSignalChannelData
|
75
96
|
),
|
76
|
-
|
77
|
-
|
78
|
-
|
97
|
+
provider:
|
98
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
99
|
+
}
|
100
|
+
)
|
101
|
+
end
|
102
|
+
def to_hash
|
79
103
|
end
|
80
|
-
def to_hash; end
|
81
104
|
|
82
105
|
# Channel data for a given channel type.
|
83
106
|
module Data
|
84
107
|
extend Knockapi::Internal::Type::Union
|
85
108
|
|
86
|
-
|
87
|
-
|
88
|
-
.
|
89
|
-
|
109
|
+
Variants =
|
110
|
+
T.type_alias do
|
111
|
+
T.any(
|
112
|
+
Knockapi::Recipients::PushChannelData,
|
113
|
+
Knockapi::Recipients::SlackChannelData,
|
114
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
115
|
+
Knockapi::Recipients::DiscordChannelData,
|
116
|
+
Knockapi::Recipients::OneSignalChannelData
|
90
117
|
)
|
118
|
+
end
|
119
|
+
|
120
|
+
sig do
|
121
|
+
override.returns(
|
122
|
+
T::Array[
|
123
|
+
Knockapi::Recipients::RecipientsChannelData::Data::Variants
|
124
|
+
]
|
125
|
+
)
|
126
|
+
end
|
127
|
+
def self.variants
|
91
128
|
end
|
92
|
-
def self.variants; end
|
93
129
|
end
|
94
130
|
|
95
131
|
# The type of provider.
|
@@ -97,27 +133,64 @@ module Knockapi
|
|
97
133
|
extend Knockapi::Internal::Type::Enum
|
98
134
|
|
99
135
|
TaggedSymbol =
|
100
|
-
T.type_alias
|
136
|
+
T.type_alias do
|
137
|
+
T.all(
|
138
|
+
Symbol,
|
139
|
+
Knockapi::Recipients::RecipientsChannelData::Provider
|
140
|
+
)
|
141
|
+
end
|
101
142
|
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
102
143
|
|
103
|
-
PUSH_FCM =
|
144
|
+
PUSH_FCM =
|
145
|
+
T.let(
|
146
|
+
:push_fcm,
|
147
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
148
|
+
)
|
104
149
|
PUSH_APNS =
|
105
|
-
T.let(
|
150
|
+
T.let(
|
151
|
+
:push_apns,
|
152
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
153
|
+
)
|
106
154
|
PUSH_EXPO =
|
107
|
-
T.let(
|
155
|
+
T.let(
|
156
|
+
:push_expo,
|
157
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
158
|
+
)
|
108
159
|
PUSH_ONE_SIGNAL =
|
109
|
-
T.let(
|
160
|
+
T.let(
|
161
|
+
:push_one_signal,
|
162
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
163
|
+
)
|
110
164
|
CHAT_SLACK =
|
111
|
-
T.let(
|
165
|
+
T.let(
|
166
|
+
:chat_slack,
|
167
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
168
|
+
)
|
112
169
|
CHAT_MS_TEAMS =
|
113
|
-
T.let(
|
170
|
+
T.let(
|
171
|
+
:chat_ms_teams,
|
172
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
173
|
+
)
|
114
174
|
CHAT_DISCORD =
|
115
|
-
T.let(
|
175
|
+
T.let(
|
176
|
+
:chat_discord,
|
177
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
178
|
+
)
|
116
179
|
HTTP_KNOCK_WEBHOOK =
|
117
|
-
T.let(
|
180
|
+
T.let(
|
181
|
+
:http_knock_webhook,
|
182
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
183
|
+
)
|
118
184
|
|
119
|
-
sig
|
120
|
-
|
185
|
+
sig do
|
186
|
+
override.returns(
|
187
|
+
T::Array[
|
188
|
+
Knockapi::Recipients::RecipientsChannelData::Provider::TaggedSymbol
|
189
|
+
]
|
190
|
+
)
|
191
|
+
end
|
192
|
+
def self.values
|
193
|
+
end
|
121
194
|
end
|
122
195
|
end
|
123
196
|
end
|
@@ -4,15 +4,23 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Recipients
|
6
6
|
class ChannelDataRequest < Knockapi::Internal::Type::BaseModel
|
7
|
+
OrHash =
|
8
|
+
T.type_alias do
|
9
|
+
T.any(
|
10
|
+
Knockapi::Recipients::ChannelDataRequest,
|
11
|
+
Knockapi::Internal::AnyHash
|
12
|
+
)
|
13
|
+
end
|
14
|
+
|
7
15
|
# Channel data for a given channel type.
|
8
16
|
sig do
|
9
17
|
returns(
|
10
18
|
T.any(
|
11
|
-
Knockapi::
|
12
|
-
Knockapi::
|
13
|
-
Knockapi::
|
14
|
-
Knockapi::
|
15
|
-
Knockapi::
|
19
|
+
Knockapi::Recipients::PushChannelData,
|
20
|
+
Knockapi::Recipients::OneSignalChannelData,
|
21
|
+
Knockapi::Recipients::SlackChannelData,
|
22
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
23
|
+
Knockapi::Recipients::DiscordChannelData
|
16
24
|
)
|
17
25
|
)
|
18
26
|
end
|
@@ -21,48 +29,61 @@ module Knockapi
|
|
21
29
|
# A request to set channel data for a type of channel.
|
22
30
|
sig do
|
23
31
|
params(
|
24
|
-
data:
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
)
|
33
|
-
.returns(T.attached_class)
|
32
|
+
data:
|
33
|
+
T.any(
|
34
|
+
Knockapi::Recipients::PushChannelData::OrHash,
|
35
|
+
Knockapi::Recipients::OneSignalChannelData::OrHash,
|
36
|
+
Knockapi::Recipients::SlackChannelData::OrHash,
|
37
|
+
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
38
|
+
Knockapi::Recipients::DiscordChannelData::OrHash
|
39
|
+
)
|
40
|
+
).returns(T.attached_class)
|
34
41
|
end
|
35
42
|
def self.new(
|
36
43
|
# Channel data for a given channel type.
|
37
44
|
data:
|
38
|
-
)
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
39
48
|
sig do
|
40
|
-
override
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
Knockapi::
|
45
|
-
Knockapi::
|
46
|
-
Knockapi::
|
47
|
-
Knockapi::
|
48
|
-
Knockapi::
|
49
|
+
override.returns(
|
50
|
+
{
|
51
|
+
data:
|
52
|
+
T.any(
|
53
|
+
Knockapi::Recipients::PushChannelData,
|
54
|
+
Knockapi::Recipients::OneSignalChannelData,
|
55
|
+
Knockapi::Recipients::SlackChannelData,
|
56
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
57
|
+
Knockapi::Recipients::DiscordChannelData
|
49
58
|
)
|
50
|
-
|
51
|
-
|
59
|
+
}
|
60
|
+
)
|
61
|
+
end
|
62
|
+
def to_hash
|
52
63
|
end
|
53
|
-
def to_hash; end
|
54
64
|
|
55
65
|
# Channel data for a given channel type.
|
56
66
|
module Data
|
57
67
|
extend Knockapi::Internal::Type::Union
|
58
68
|
|
59
|
-
|
60
|
-
|
61
|
-
.
|
62
|
-
|
69
|
+
Variants =
|
70
|
+
T.type_alias do
|
71
|
+
T.any(
|
72
|
+
Knockapi::Recipients::PushChannelData,
|
73
|
+
Knockapi::Recipients::OneSignalChannelData,
|
74
|
+
Knockapi::Recipients::SlackChannelData,
|
75
|
+
Knockapi::Recipients::MsTeamsChannelData,
|
76
|
+
Knockapi::Recipients::DiscordChannelData
|
63
77
|
)
|
78
|
+
end
|
79
|
+
|
80
|
+
sig do
|
81
|
+
override.returns(
|
82
|
+
T::Array[Knockapi::Recipients::ChannelDataRequest::Data::Variants]
|
83
|
+
)
|
84
|
+
end
|
85
|
+
def self.variants
|
64
86
|
end
|
65
|
-
def self.variants; end
|
66
87
|
end
|
67
88
|
end
|
68
89
|
end
|