knockapi 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +61 -0
- data/README.md +101 -49
- data/lib/knockapi/client.rb +4 -4
- data/lib/knockapi/errors.rb +1 -1
- data/lib/knockapi/file_part.rb +2 -2
- data/lib/knockapi/internal/entries_cursor.rb +3 -3
- data/lib/knockapi/internal/items_cursor.rb +3 -3
- data/lib/knockapi/internal/ms_teams_pagination.rb +3 -3
- data/lib/knockapi/internal/slack_channels_cursor.rb +3 -3
- data/lib/knockapi/internal/transport/base_client.rb +79 -7
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +17 -1
- data/lib/knockapi/internal/type/array_of.rb +9 -1
- data/lib/knockapi/internal/type/base_model.rb +78 -39
- data/lib/knockapi/internal/type/boolean.rb +8 -0
- data/lib/knockapi/internal/type/converter.rb +18 -0
- data/lib/knockapi/internal/type/enum.rb +13 -0
- data/lib/knockapi/internal/type/file_input.rb +7 -0
- data/lib/knockapi/internal/type/hash_of.rb +9 -1
- data/lib/knockapi/internal/type/request_parameters.rb +6 -12
- data/lib/knockapi/internal/type/union.rb +16 -3
- data/lib/knockapi/internal/type/unknown.rb +8 -0
- data/lib/knockapi/internal/util.rb +119 -2
- data/lib/knockapi/internal.rb +9 -0
- data/lib/knockapi/models/activity.rb +6 -6
- data/lib/knockapi/models/audience_add_members_params.rb +10 -8
- data/lib/knockapi/models/audience_add_members_response.rb +7 -0
- data/lib/knockapi/models/audience_list_members_response.rb +6 -6
- data/lib/knockapi/models/audience_member.rb +5 -6
- data/lib/knockapi/models/audience_remove_members_params.rb +12 -7
- data/lib/knockapi/models/audience_remove_members_response.rb +7 -0
- data/lib/knockapi/models/bulk_operation.rb +7 -8
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +11 -10
- data/lib/knockapi/models/condition.rb +4 -4
- data/lib/knockapi/models/identify_user_request.rb +16 -17
- data/lib/knockapi/models/inline_identify_user_request.rb +64 -7
- data/lib/knockapi/models/inline_object_request.rb +8 -6
- data/lib/knockapi/models/inline_tenant_request.rb +2 -2
- data/lib/knockapi/models/message.rb +19 -23
- data/lib/knockapi/models/message_delivery_log.rb +18 -18
- data/lib/knockapi/models/message_event.rb +9 -10
- data/lib/knockapi/models/message_list_params.rb +14 -15
- data/lib/knockapi/models/messages/batch_archive_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_interacted_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_read_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_seen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unread_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_mark_as_unseen_response.rb +1 -1
- data/lib/knockapi/models/messages/batch_unarchive_response.rb +1 -1
- data/lib/knockapi/models/object.rb +9 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +3 -4
- data/lib/knockapi/models/object_add_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_delete_response.rb +7 -0
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +3 -5
- data/lib/knockapi/models/object_delete_subscriptions_response.rb +1 -1
- data/lib/knockapi/models/object_list_messages_params.rb +16 -14
- data/lib/knockapi/models/object_list_params.rb +3 -4
- data/lib/knockapi/models/object_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +14 -14
- data/lib/knockapi/models/object_set_params.rb +15 -13
- data/lib/knockapi/models/object_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +9 -9
- data/lib/knockapi/models/objects/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -7
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -9
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -7
- data/lib/knockapi/models/recipient.rb +3 -3
- data/lib/knockapi/models/recipient_reference.rb +2 -2
- data/lib/knockapi/models/recipient_request.rb +3 -3
- data/lib/knockapi/models/recipients/channel_data.rb +14 -14
- data/lib/knockapi/models/recipients/channel_data_request.rb +10 -10
- data/lib/knockapi/models/recipients/discord_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +24 -1
- data/lib/knockapi/models/recipients/inline_preference_set_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +16 -10
- data/lib/knockapi/models/recipients/preference_set.rb +34 -28
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +3 -3
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +36 -36
- data/lib/knockapi/models/recipients/preference_set_request.rb +34 -28
- data/lib/knockapi/models/recipients/slack_channel_data.rb +12 -10
- data/lib/knockapi/models/recipients/subscription.rb +6 -6
- data/lib/knockapi/models/schedule.rb +11 -12
- data/lib/knockapi/models/schedule_create_params.rb +10 -15
- data/lib/knockapi/models/schedule_create_response.rb +1 -1
- data/lib/knockapi/models/schedule_delete_response.rb +1 -1
- data/lib/knockapi/models/schedule_repeat_rule.rb +7 -7
- data/lib/knockapi/models/schedule_update_params.rb +9 -10
- data/lib/knockapi/models/schedule_update_response.rb +1 -1
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -18
- data/lib/knockapi/models/tenant.rb +13 -16
- data/lib/knockapi/models/tenant_delete_response.rb +7 -0
- data/lib/knockapi/models/tenant_request.rb +20 -20
- data/lib/knockapi/models/tenant_set_params.rb +19 -19
- data/lib/knockapi/models/tenants/bulk_set_params.rb +3 -3
- data/lib/knockapi/models/user.rb +9 -11
- data/lib/knockapi/models/user_delete_response.rb +7 -0
- data/lib/knockapi/models/user_list_messages_params.rb +18 -14
- data/lib/knockapi/models/user_list_params.rb +3 -4
- data/lib/knockapi/models/user_list_preferences_response.rb +1 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +3 -3
- data/lib/knockapi/models/user_unset_channel_data_response.rb +7 -0
- data/lib/knockapi/models/users/bulk_identify_params.rb +3 -3
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +3 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +6 -6
- data/lib/knockapi/models/users/feed_list_items_response.rb +6 -6
- data/lib/knockapi/models/workflow_cancel_params.rb +3 -5
- data/lib/knockapi/models/workflow_cancel_response.rb +7 -0
- data/lib/knockapi/models/workflow_trigger_params.rb +9 -12
- data/lib/knockapi/models/workflow_trigger_response.rb +0 -1
- data/lib/knockapi/models.rb +213 -0
- data/lib/knockapi/request_options.rb +4 -0
- data/lib/knockapi/resources/audiences.rb +4 -4
- data/lib/knockapi/resources/bulk_operations.rb +2 -2
- data/lib/knockapi/resources/channels/bulk.rb +7 -8
- data/lib/knockapi/resources/integrations/census.rb +1 -1
- data/lib/knockapi/resources/integrations/hightouch.rb +1 -1
- data/lib/knockapi/resources/messages/batch.rb +22 -22
- data/lib/knockapi/resources/messages.rb +32 -39
- data/lib/knockapi/resources/objects/bulk.rb +11 -11
- data/lib/knockapi/resources/objects.rb +52 -62
- data/lib/knockapi/resources/providers/ms_teams.rb +6 -6
- data/lib/knockapi/resources/providers/slack.rb +4 -4
- data/lib/knockapi/resources/schedules/bulk.rb +4 -4
- data/lib/knockapi/resources/schedules.rb +18 -23
- data/lib/knockapi/resources/tenants/bulk.rb +7 -7
- data/lib/knockapi/resources/tenants.rb +11 -11
- data/lib/knockapi/resources/users/bulk.rb +11 -11
- data/lib/knockapi/resources/users/feeds.rb +3 -3
- data/lib/knockapi/resources/users/guides.rb +4 -4
- data/lib/knockapi/resources/users.rb +46 -54
- data/lib/knockapi/resources/workflows.rb +6 -11
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +11 -2
- data/rbi/knockapi/client.rbi +5 -4
- data/rbi/knockapi/errors.rbi +35 -16
- data/rbi/knockapi/file_part.rbi +9 -6
- data/rbi/knockapi/internal/entries_cursor.rbi +9 -4
- data/rbi/knockapi/internal/items_cursor.rbi +9 -4
- data/rbi/knockapi/internal/ms_teams_pagination.rbi +2 -1
- data/rbi/knockapi/internal/slack_channels_cursor.rbi +2 -1
- data/rbi/knockapi/internal/transport/base_client.rbi +158 -78
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +32 -13
- data/rbi/knockapi/internal/type/array_of.rbi +40 -24
- data/rbi/knockapi/internal/type/base_model.rbi +156 -73
- data/rbi/knockapi/internal/type/base_page.rbi +12 -8
- data/rbi/knockapi/internal/type/boolean.rbi +22 -14
- data/rbi/knockapi/internal/type/converter.rbi +70 -28
- data/rbi/knockapi/internal/type/enum.rbi +33 -15
- data/rbi/knockapi/internal/type/file_input.rbi +13 -4
- data/rbi/knockapi/internal/type/hash_of.rbi +40 -24
- data/rbi/knockapi/internal/type/request_parameters.rbi +12 -4
- data/rbi/knockapi/internal/type/union.rbi +60 -19
- data/rbi/knockapi/internal/type/unknown.rbi +22 -6
- data/rbi/knockapi/internal/util.rbi +273 -87
- data/rbi/knockapi/internal.rbi +5 -0
- data/rbi/knockapi/models/activity.rbi +28 -22
- data/rbi/knockapi/models/audience_add_members_params.rbi +62 -27
- data/rbi/knockapi/models/audience_add_members_response.rbi +7 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +16 -5
- data/rbi/knockapi/models/audience_list_members_response.rbi +25 -11
- data/rbi/knockapi/models/audience_member.rbi +23 -11
- data/rbi/knockapi/models/audience_remove_members_params.rbi +65 -28
- data/rbi/knockapi/models/audience_remove_members_response.rbi +7 -0
- data/rbi/knockapi/models/bulk_operation.rbi +70 -42
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +224 -79
- data/rbi/knockapi/models/condition.rbi +78 -31
- data/rbi/knockapi/models/identify_user_request.rbi +90 -36
- data/rbi/knockapi/models/inline_identify_user_request.rbi +135 -22
- data/rbi/knockapi/models/inline_object_request.rbi +76 -22
- data/rbi/knockapi/models/inline_tenant_request.rbi +7 -2
- data/rbi/knockapi/models/integrations/census_custom_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/census_custom_destination_response.rbi +21 -4
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_params.rbi +24 -15
- data/rbi/knockapi/models/integrations/hightouch_embedded_destination_response.rbi +21 -4
- data/rbi/knockapi/models/message.rbi +140 -72
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_delivery_log.rbi +175 -72
- data/rbi/knockapi/models/message_event.rbi +83 -37
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_response.rbi +366 -226
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +24 -15
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +23 -12
- data/rbi/knockapi/models/message_list_events_params.rbi +20 -12
- data/rbi/knockapi/models/message_list_params.rbi +162 -58
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +21 -6
- data/rbi/knockapi/models/message_mark_as_read_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_seen_params.rbi +13 -5
- data/rbi/knockapi/models/message_mark_as_unread_params.rbi +16 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +16 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/messages/batch_archive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_get_content_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_get_content_response.rbi +370 -227
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_params.rbi +22 -13
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +4 -1
- data/rbi/knockapi/models/messages/batch_unarchive_params.rbi +23 -6
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +4 -1
- data/rbi/knockapi/models/object.rbi +31 -10
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +44 -22
- data/rbi/knockapi/models/object_add_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_delete_params.rbi +13 -5
- data/rbi/knockapi/models/object_delete_response.rbi +7 -0
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +36 -14
- data/rbi/knockapi/models/object_delete_subscriptions_response.rbi +1 -1
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_get_params.rbi +13 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +185 -61
- data/rbi/knockapi/models/object_list_params.rbi +43 -22
- data/rbi/knockapi/models/object_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/object_list_schedules_params.rbi +25 -16
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +150 -46
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_set_params.rbi +89 -33
- data/rbi/knockapi/models/object_set_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/object_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +77 -34
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/page_info.rbi +22 -11
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +53 -23
- data/rbi/knockapi/models/providers/ms_team_list_channels_response.rbi +57 -30
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +62 -22
- data/rbi/knockapi/models/providers/ms_team_list_teams_response.rbi +23 -4
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/ms_team_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_check_auth_response.rbi +53 -14
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +58 -30
- data/rbi/knockapi/models/providers/slack_list_channels_response.rbi +29 -12
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +23 -6
- data/rbi/knockapi/models/providers/slack_revoke_access_response.rbi +14 -3
- data/rbi/knockapi/models/recipient.rbi +5 -2
- data/rbi/knockapi/models/recipient_reference.rbi +22 -5
- data/rbi/knockapi/models/recipient_request.rbi +11 -4
- data/rbi/knockapi/models/recipients/channel_data.rbi +113 -55
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +54 -33
- data/rbi/knockapi/models/recipients/discord_channel_data.rbi +100 -53
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +29 -1
- data/rbi/knockapi/models/recipients/inline_preference_set_request.rbi +3 -1
- data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +109 -64
- data/rbi/knockapi/models/recipients/one_signal_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/preference_set.rbi +159 -100
- data/rbi/knockapi/models/recipients/preference_set_channel_type_setting.rbi +18 -6
- data/rbi/knockapi/models/recipients/preference_set_channel_types.rbi +276 -105
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +162 -87
- data/rbi/knockapi/models/recipients/push_channel_data.rbi +14 -3
- data/rbi/knockapi/models/recipients/slack_channel_data.rbi +107 -49
- data/rbi/knockapi/models/recipients/subscription.rbi +29 -20
- data/rbi/knockapi/models/schedule.rbi +32 -27
- data/rbi/knockapi/models/schedule_create_params.rbi +52 -35
- data/rbi/knockapi/models/schedule_create_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_delete_params.rbi +20 -6
- data/rbi/knockapi/models/schedule_delete_response.rbi +4 -1
- data/rbi/knockapi/models/schedule_list_params.rbi +23 -17
- data/rbi/knockapi/models/schedule_repeat_rule.rbi +69 -39
- data/rbi/knockapi/models/schedule_update_params.rbi +48 -27
- data/rbi/knockapi/models/schedule_update_response.rbi +4 -1
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +102 -61
- data/rbi/knockapi/models/tenant.rbi +71 -45
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_delete_response.rbi +7 -0
- data/rbi/knockapi/models/tenant_get_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_list_params.rbi +22 -16
- data/rbi/knockapi/models/tenant_request.rbi +132 -57
- data/rbi/knockapi/models/tenant_set_params.rbi +134 -59
- data/rbi/knockapi/models/tenants/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/tenants/bulk_set_params.rbi +20 -11
- data/rbi/knockapi/models/user.rbi +32 -28
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_delete_response.rbi +7 -0
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +19 -5
- data/rbi/knockapi/models/user_list_messages_params.rbi +183 -59
- data/rbi/knockapi/models/user_list_params.rbi +43 -22
- data/rbi/knockapi/models/user_list_preferences_params.rbi +16 -5
- data/rbi/knockapi/models/user_list_preferences_response.rbi +1 -1
- data/rbi/knockapi/models/user_list_schedules_params.rbi +22 -16
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +61 -23
- data/rbi/knockapi/models/user_merge_params.rbi +17 -6
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +13 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +16 -5
- data/rbi/knockapi/models/user_unset_channel_data_response.rbi +7 -0
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/bulk_delete_params.rbi +23 -6
- data/rbi/knockapi/models/users/bulk_identify_params.rbi +23 -11
- data/rbi/knockapi/models/users/bulk_set_preferences_params.rbi +26 -18
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +16 -5
- data/rbi/knockapi/models/users/feed_get_settings_response.rbi +47 -14
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +119 -41
- data/rbi/knockapi/models/users/feed_list_items_response.rbi +199 -108
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +15 -5
- data/rbi/knockapi/models/users/guide_get_channel_response.rbi +84 -25
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_response.rbi +14 -3
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +29 -20
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_response.rbi +14 -3
- data/rbi/knockapi/models/workflow_cancel_params.rbi +42 -17
- data/rbi/knockapi/models/workflow_cancel_response.rbi +7 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +65 -37
- data/rbi/knockapi/models/workflow_trigger_response.rbi +14 -3
- data/rbi/knockapi/models.rbi +179 -0
- data/rbi/knockapi/request_options.rbi +18 -7
- data/rbi/knockapi/resources/audiences.rbi +22 -14
- data/rbi/knockapi/resources/bulk_operations.rbi +11 -3
- data/rbi/knockapi/resources/channels/bulk.rbi +15 -9
- data/rbi/knockapi/resources/channels.rbi +2 -1
- data/rbi/knockapi/resources/integrations/census.rbi +8 -4
- data/rbi/knockapi/resources/integrations/hightouch.rbi +8 -4
- data/rbi/knockapi/resources/integrations.rbi +2 -1
- data/rbi/knockapi/resources/messages/batch.rbi +58 -26
- data/rbi/knockapi/resources/messages.rbi +102 -43
- data/rbi/knockapi/resources/objects/bulk.rbi +25 -14
- data/rbi/knockapi/resources/objects.rbi +177 -107
- data/rbi/knockapi/resources/providers/ms_teams.rbi +35 -16
- data/rbi/knockapi/resources/providers/slack.rbi +28 -11
- data/rbi/knockapi/resources/providers.rbi +2 -1
- data/rbi/knockapi/resources/recipients/channel_data.rbi +2 -1
- data/rbi/knockapi/resources/recipients/preferences.rbi +2 -1
- data/rbi/knockapi/resources/recipients/subscriptions.rbi +2 -1
- data/rbi/knockapi/resources/recipients.rbi +2 -1
- data/rbi/knockapi/resources/schedules/bulk.rbi +9 -6
- data/rbi/knockapi/resources/schedules.rbi +44 -33
- data/rbi/knockapi/resources/shared.rbi +2 -1
- data/rbi/knockapi/resources/tenants/bulk.rbi +15 -9
- data/rbi/knockapi/resources/tenants.rbi +51 -20
- data/rbi/knockapi/resources/users/bulk.rbi +21 -14
- data/rbi/knockapi/resources/users/feeds.rbi +20 -9
- data/rbi/knockapi/resources/users/guides.rbi +23 -16
- data/rbi/knockapi/resources/users.rbi +160 -91
- data/rbi/knockapi/resources/workflows.rbi +38 -29
- data/sig/knockapi/internal/entries_cursor.rbs +0 -2
- data/sig/knockapi/internal/items_cursor.rbs +0 -2
- data/sig/knockapi/internal/transport/base_client.rbs +16 -1
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -0
- data/sig/knockapi/internal/type/array_of.rbs +3 -0
- data/sig/knockapi/internal/type/base_model.rbs +13 -5
- data/sig/knockapi/internal/type/base_page.rbs +1 -1
- data/sig/knockapi/internal/type/boolean.rbs +3 -0
- data/sig/knockapi/internal/type/converter.rbs +2 -0
- data/sig/knockapi/internal/type/enum.rbs +3 -0
- data/sig/knockapi/internal/type/file_input.rbs +2 -0
- data/sig/knockapi/internal/type/hash_of.rbs +3 -0
- data/sig/knockapi/internal/type/request_parameters.rbs +3 -1
- data/sig/knockapi/internal/type/union.rbs +3 -0
- data/sig/knockapi/internal/type/unknown.rbs +3 -0
- data/sig/knockapi/internal/util.rbs +27 -0
- data/sig/knockapi/internal.rbs +4 -0
- data/sig/knockapi/models/activity.rbs +0 -2
- data/sig/knockapi/models/audience_add_members_params.rbs +6 -12
- data/sig/knockapi/models/audience_add_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +0 -2
- data/sig/knockapi/models/audience_list_members_response.rbs +6 -8
- data/sig/knockapi/models/audience_member.rbs +3 -5
- data/sig/knockapi/models/audience_remove_members_params.rbs +6 -14
- data/sig/knockapi/models/audience_remove_members_response.rbs +5 -0
- data/sig/knockapi/models/bulk_operation.rbs +9 -13
- data/sig/knockapi/models/bulk_operation_get_params.rbs +0 -2
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +0 -2
- data/sig/knockapi/models/condition.rbs +4 -6
- data/sig/knockapi/models/identify_user_request.rbs +0 -2
- data/sig/knockapi/models/inline_identify_user_request.rbs +26 -4
- data/sig/knockapi/models/inline_object_request.rbs +0 -2
- data/sig/knockapi/models/inline_tenant_request.rbs +2 -2
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +0 -2
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +0 -2
- data/sig/knockapi/models/message.rbs +15 -23
- data/sig/knockapi/models/message_archive_params.rbs +0 -2
- data/sig/knockapi/models/message_delivery_log.rbs +24 -30
- data/sig/knockapi/models/message_event.rbs +4 -6
- data/sig/knockapi/models/message_get_content_params.rbs +0 -2
- data/sig/knockapi/models/message_get_content_response.rbs +2 -24
- data/sig/knockapi/models/message_get_params.rbs +0 -2
- data/sig/knockapi/models/message_list_activities_params.rbs +0 -2
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +0 -2
- data/sig/knockapi/models/message_list_events_params.rbs +0 -2
- data/sig/knockapi/models/message_list_params.rbs +30 -24
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/message_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +2 -24
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +1 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +0 -2
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +8 -4
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_add_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_delete_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_response.rbs +5 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +0 -2
- data/sig/knockapi/models/object_delete_subscriptions_response.rbs +1 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_get_params.rbs +0 -2
- data/sig/knockapi/models/object_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/object_list_params.rbs +6 -8
- data/sig/knockapi/models/object_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/object_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +11 -15
- data/sig/knockapi/models/object_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_set_params.rbs +0 -2
- data/sig/knockapi/models/object_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/object_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +3 -7
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/objects/bulk_set_params.rbs +3 -5
- data/sig/knockapi/models/page_info.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +0 -4
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -9
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +0 -4
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -9
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +0 -2
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +0 -2
- data/sig/knockapi/models/recipient.rbs +2 -2
- data/sig/knockapi/models/recipient_reference.rbs +2 -4
- data/sig/knockapi/models/recipient_request.rbs +3 -3
- data/sig/knockapi/models/recipients/channel_data.rbs +15 -17
- data/sig/knockapi/models/recipients/channel_data_request.rbs +9 -11
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +14 -1
- data/sig/knockapi/models/recipients/inline_preference_set_request.rbs +1 -1
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -31
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +3 -7
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +42 -48
- data/sig/knockapi/models/recipients/preference_set_request.rbs +25 -31
- data/sig/knockapi/models/recipients/push_channel_data.rbs +0 -2
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +9 -17
- data/sig/knockapi/models/recipients/subscription.rbs +3 -5
- data/sig/knockapi/models/schedule.rbs +3 -5
- data/sig/knockapi/models/schedule_create_params.rbs +3 -5
- data/sig/knockapi/models/schedule_create_response.rbs +1 -1
- data/sig/knockapi/models/schedule_delete_params.rbs +0 -2
- data/sig/knockapi/models/schedule_delete_response.rbs +1 -1
- data/sig/knockapi/models/schedule_list_params.rbs +0 -2
- data/sig/knockapi/models/schedule_repeat_rule.rbs +8 -10
- data/sig/knockapi/models/schedule_update_params.rbs +5 -7
- data/sig/knockapi/models/schedule_update_response.rbs +1 -1
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +8 -14
- data/sig/knockapi/models/tenant.rbs +9 -15
- data/sig/knockapi/models/tenant_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenant_delete_response.rbs +5 -0
- data/sig/knockapi/models/tenant_get_params.rbs +0 -2
- data/sig/knockapi/models/tenant_list_params.rbs +0 -2
- data/sig/knockapi/models/tenant_request.rbs +13 -19
- data/sig/knockapi/models/tenant_set_params.rbs +13 -19
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +0 -2
- data/sig/knockapi/models/user.rbs +0 -2
- data/sig/knockapi/models/user_delete_params.rbs +0 -2
- data/sig/knockapi/models/user_delete_response.rbs +5 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_get_params.rbs +0 -2
- data/sig/knockapi/models/user_get_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_messages_params.rbs +30 -24
- data/sig/knockapi/models/user_list_params.rbs +6 -8
- data/sig/knockapi/models/user_list_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_list_preferences_response.rbs +1 -1
- data/sig/knockapi/models/user_list_schedules_params.rbs +0 -2
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +6 -8
- data/sig/knockapi/models/user_merge_params.rbs +0 -2
- data/sig/knockapi/models/user_set_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_set_preferences_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +0 -2
- data/sig/knockapi/models/user_unset_channel_data_response.rbs +5 -0
- data/sig/knockapi/models/user_update_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_delete_params.rbs +0 -2
- data/sig/knockapi/models/users/bulk_identify_params.rbs +3 -5
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +3 -5
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +0 -4
- data/sig/knockapi/models/users/feed_list_items_params.rbs +0 -2
- data/sig/knockapi/models/users/feed_list_items_response.rbs +4 -14
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +0 -6
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +0 -2
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_params.rbs +0 -2
- data/sig/knockapi/models/workflow_cancel_response.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +0 -2
- data/sig/knockapi/models/workflow_trigger_response.rbs +0 -2
- data/sig/knockapi/models.rbs +173 -0
- data/sig/knockapi/request_options.rbs +1 -1
- data/sig/knockapi/resources/audiences.rbs +2 -2
- data/sig/knockapi/resources/bulk_operations.rbs +1 -1
- data/sig/knockapi/resources/channels/bulk.rbs +1 -1
- data/sig/knockapi/resources/messages.rbs +15 -17
- data/sig/knockapi/resources/objects/bulk.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +19 -19
- data/sig/knockapi/resources/providers/ms_teams.rbs +2 -2
- data/sig/knockapi/resources/providers/slack.rbs +1 -1
- data/sig/knockapi/resources/schedules/bulk.rbs +2 -2
- data/sig/knockapi/resources/schedules.rbs +3 -3
- data/sig/knockapi/resources/tenants/bulk.rbs +2 -2
- data/sig/knockapi/resources/tenants.rbs +4 -4
- data/sig/knockapi/resources/users/bulk.rbs +5 -5
- data/sig/knockapi/resources/users.rbs +19 -19
- metadata +29 -8
- data/lib/knockapi/models/messages/activity_list_params.rb +0 -48
- data/lib/knockapi/resources/messages/activities.rb +0 -47
- data/rbi/knockapi/models/messages/activity_list_params.rbi +0 -75
- data/rbi/knockapi/resources/messages/activities.rbi +0 -38
- data/sig/knockapi/models/messages/activity_list_params.rbs +0 -45
- data/sig/knockapi/resources/messages/activities.rbs +0 -18
@@ -14,42 +14,44 @@ module Knockapi
|
|
14
14
|
# An object where the key is the category and the values are the preference
|
15
15
|
# settings for that category.
|
16
16
|
#
|
17
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::
|
17
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
18
18
|
optional :categories,
|
19
|
-
-> {
|
19
|
+
-> {
|
20
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Category]
|
21
|
+
},
|
20
22
|
nil?: true
|
21
23
|
|
22
24
|
# @!attribute channel_types
|
23
25
|
# Channel type preferences.
|
24
26
|
#
|
25
|
-
# @return [Knockapi::
|
26
|
-
optional :channel_types, -> { Knockapi::
|
27
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
28
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
27
29
|
|
28
30
|
# @!attribute workflows
|
29
31
|
# An object where the key is the workflow key and the values are the preference
|
30
32
|
# settings for that workflow.
|
31
33
|
#
|
32
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::
|
34
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
33
35
|
optional :workflows,
|
34
|
-
-> {
|
36
|
+
-> {
|
37
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSet::Workflow]
|
38
|
+
},
|
35
39
|
nil?: true
|
36
40
|
|
37
41
|
# @!method initialize(id:, categories: nil, channel_types: nil, workflows: nil)
|
38
42
|
# Some parameter documentations has been truncated, see
|
39
|
-
# {Knockapi::
|
43
|
+
# {Knockapi::Recipients::PreferenceSet} for more details.
|
40
44
|
#
|
41
45
|
# A preference set represents a specific set of notification preferences for a
|
42
46
|
# recipient. A recipient can have multiple preference sets.
|
43
47
|
#
|
44
48
|
# @param id [String] Unique identifier for the preference set.
|
45
49
|
#
|
46
|
-
# @param categories [Hash{Symbol=>Boolean, Knockapi::
|
47
|
-
# ...
|
50
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
48
51
|
#
|
49
|
-
# @param channel_types [Knockapi::
|
52
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
50
53
|
#
|
51
|
-
# @param workflows [Hash{Symbol=>Boolean, Knockapi::
|
52
|
-
# ...
|
54
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
53
55
|
|
54
56
|
# Workflow or category preferences within a preference set
|
55
57
|
module Category
|
@@ -58,32 +60,34 @@ module Knockapi
|
|
58
60
|
variant Knockapi::Internal::Type::Boolean
|
59
61
|
|
60
62
|
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
61
|
-
variant -> {
|
63
|
+
variant -> {
|
64
|
+
Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject
|
65
|
+
}
|
62
66
|
|
63
67
|
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
64
68
|
# @!attribute channel_types
|
65
69
|
# Channel type preferences.
|
66
70
|
#
|
67
|
-
# @return [Knockapi::
|
68
|
-
optional :channel_types, -> { Knockapi::
|
71
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
72
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
69
73
|
|
70
74
|
# @!attribute conditions
|
71
75
|
# A list of conditions to apply to a channel type.
|
72
76
|
#
|
73
|
-
# @return [Array<Knockapi::
|
74
|
-
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
77
|
+
# @return [Array<Knockapi::Condition>, nil]
|
78
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
75
79
|
|
76
80
|
# @!method initialize(channel_types: nil, conditions: nil)
|
77
81
|
# The settings object for a workflow or category, where you can specify channel
|
78
82
|
# types or conditions.
|
79
83
|
#
|
80
|
-
# @param channel_types [Knockapi::
|
84
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
81
85
|
#
|
82
|
-
# @param conditions [Array<Knockapi::
|
86
|
+
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
83
87
|
end
|
84
88
|
|
85
89
|
# @!method self.variants
|
86
|
-
# @return [Array(Boolean, Knockapi::
|
90
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Category::PreferenceSetWorkflowCategorySettingObject)]
|
87
91
|
end
|
88
92
|
|
89
93
|
# Workflow or category preferences within a preference set
|
@@ -93,32 +97,34 @@ module Knockapi
|
|
93
97
|
variant Knockapi::Internal::Type::Boolean
|
94
98
|
|
95
99
|
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
96
|
-
variant -> {
|
100
|
+
variant -> {
|
101
|
+
Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject
|
102
|
+
}
|
97
103
|
|
98
104
|
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
99
105
|
# @!attribute channel_types
|
100
106
|
# Channel type preferences.
|
101
107
|
#
|
102
|
-
# @return [Knockapi::
|
103
|
-
optional :channel_types, -> { Knockapi::
|
108
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
109
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
104
110
|
|
105
111
|
# @!attribute conditions
|
106
112
|
# A list of conditions to apply to a channel type.
|
107
113
|
#
|
108
|
-
# @return [Array<Knockapi::
|
109
|
-
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
114
|
+
# @return [Array<Knockapi::Condition>, nil]
|
115
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
110
116
|
|
111
117
|
# @!method initialize(channel_types: nil, conditions: nil)
|
112
118
|
# The settings object for a workflow or category, where you can specify channel
|
113
119
|
# types or conditions.
|
114
120
|
#
|
115
|
-
# @param channel_types [Knockapi::
|
121
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
116
122
|
#
|
117
|
-
# @param conditions [Array<Knockapi::
|
123
|
+
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
118
124
|
end
|
119
125
|
|
120
126
|
# @!method self.variants
|
121
|
-
# @return [Array(Boolean, Knockapi::
|
127
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSet::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
122
128
|
end
|
123
129
|
end
|
124
130
|
end
|
@@ -7,14 +7,14 @@ module Knockapi
|
|
7
7
|
# @!attribute conditions
|
8
8
|
# A list of conditions to apply to a channel type.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::
|
11
|
-
required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
10
|
+
# @return [Array<Knockapi::Condition>]
|
11
|
+
required :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }
|
12
12
|
|
13
13
|
# @!method initialize(conditions:)
|
14
14
|
# A set of settings for a channel type. Currently, this can only be a list of
|
15
15
|
# conditions to apply.
|
16
16
|
#
|
17
|
-
# @param conditions [Array<Knockapi::
|
17
|
+
# @param conditions [Array<Knockapi::Condition>] A list of conditions to apply to a channel type.
|
18
18
|
end
|
19
19
|
end
|
20
20
|
end
|
@@ -7,142 +7,142 @@ module Knockapi
|
|
7
7
|
# @!attribute chat
|
8
8
|
# Whether the channel type is enabled for the preference set.
|
9
9
|
#
|
10
|
-
# @return [Boolean, Knockapi::
|
11
|
-
optional :chat, union: -> { Knockapi::
|
10
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
11
|
+
optional :chat, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Chat }
|
12
12
|
|
13
13
|
# @!attribute email
|
14
14
|
# Whether the channel type is enabled for the preference set.
|
15
15
|
#
|
16
|
-
# @return [Boolean, Knockapi::
|
17
|
-
optional :email, union: -> { Knockapi::
|
16
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
17
|
+
optional :email, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Email }
|
18
18
|
|
19
19
|
# @!attribute http
|
20
20
|
# Whether the channel type is enabled for the preference set.
|
21
21
|
#
|
22
|
-
# @return [Boolean, Knockapi::
|
23
|
-
optional :http, union: -> { Knockapi::
|
22
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
23
|
+
optional :http, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::HTTP }
|
24
24
|
|
25
25
|
# @!attribute in_app_feed
|
26
26
|
# Whether the channel type is enabled for the preference set.
|
27
27
|
#
|
28
|
-
# @return [Boolean, Knockapi::
|
29
|
-
optional :in_app_feed, union: -> { Knockapi::
|
28
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
29
|
+
optional :in_app_feed, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::InAppFeed }
|
30
30
|
|
31
31
|
# @!attribute push
|
32
32
|
# Whether the channel type is enabled for the preference set.
|
33
33
|
#
|
34
|
-
# @return [Boolean, Knockapi::
|
35
|
-
optional :push, union: -> { Knockapi::
|
34
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
35
|
+
optional :push, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::Push }
|
36
36
|
|
37
37
|
# @!attribute sms
|
38
38
|
# Whether the channel type is enabled for the preference set.
|
39
39
|
#
|
40
|
-
# @return [Boolean, Knockapi::
|
41
|
-
optional :sms, union: -> { Knockapi::
|
40
|
+
# @return [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting, nil]
|
41
|
+
optional :sms, union: -> { Knockapi::Recipients::PreferenceSetChannelTypes::SMS }
|
42
42
|
|
43
43
|
# @!method initialize(chat: nil, email: nil, http: nil, in_app_feed: nil, push: nil, sms: nil)
|
44
44
|
# Channel type preferences.
|
45
45
|
#
|
46
|
-
# @param chat [Boolean, Knockapi::
|
46
|
+
# @param chat [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
47
47
|
#
|
48
|
-
# @param email [Boolean, Knockapi::
|
48
|
+
# @param email [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
49
49
|
#
|
50
|
-
# @param http [Boolean, Knockapi::
|
50
|
+
# @param http [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
51
51
|
#
|
52
|
-
# @param in_app_feed [Boolean, Knockapi::
|
52
|
+
# @param in_app_feed [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
53
53
|
#
|
54
|
-
# @param push [Boolean, Knockapi::
|
54
|
+
# @param push [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
55
55
|
#
|
56
|
-
# @param sms [Boolean, Knockapi::
|
56
|
+
# @param sms [Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting] Whether the channel type is enabled for the preference set.
|
57
57
|
|
58
58
|
# Whether the channel type is enabled for the preference set.
|
59
59
|
#
|
60
|
-
# @see Knockapi::
|
60
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#chat
|
61
61
|
module Chat
|
62
62
|
extend Knockapi::Internal::Type::Union
|
63
63
|
|
64
64
|
variant Knockapi::Internal::Type::Boolean
|
65
65
|
|
66
66
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
67
|
-
variant -> { Knockapi::
|
67
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
68
68
|
|
69
69
|
# @!method self.variants
|
70
|
-
# @return [Array(Boolean, Knockapi::
|
70
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
71
71
|
end
|
72
72
|
|
73
73
|
# Whether the channel type is enabled for the preference set.
|
74
74
|
#
|
75
|
-
# @see Knockapi::
|
75
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#email
|
76
76
|
module Email
|
77
77
|
extend Knockapi::Internal::Type::Union
|
78
78
|
|
79
79
|
variant Knockapi::Internal::Type::Boolean
|
80
80
|
|
81
81
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
82
|
-
variant -> { Knockapi::
|
82
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
83
83
|
|
84
84
|
# @!method self.variants
|
85
|
-
# @return [Array(Boolean, Knockapi::
|
85
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
86
86
|
end
|
87
87
|
|
88
88
|
# Whether the channel type is enabled for the preference set.
|
89
89
|
#
|
90
|
-
# @see Knockapi::
|
90
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#http
|
91
91
|
module HTTP
|
92
92
|
extend Knockapi::Internal::Type::Union
|
93
93
|
|
94
94
|
variant Knockapi::Internal::Type::Boolean
|
95
95
|
|
96
96
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
97
|
-
variant -> { Knockapi::
|
97
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
98
98
|
|
99
99
|
# @!method self.variants
|
100
|
-
# @return [Array(Boolean, Knockapi::
|
100
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
101
101
|
end
|
102
102
|
|
103
103
|
# Whether the channel type is enabled for the preference set.
|
104
104
|
#
|
105
|
-
# @see Knockapi::
|
105
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#in_app_feed
|
106
106
|
module InAppFeed
|
107
107
|
extend Knockapi::Internal::Type::Union
|
108
108
|
|
109
109
|
variant Knockapi::Internal::Type::Boolean
|
110
110
|
|
111
111
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
112
|
-
variant -> { Knockapi::
|
112
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
113
113
|
|
114
114
|
# @!method self.variants
|
115
|
-
# @return [Array(Boolean, Knockapi::
|
115
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
116
116
|
end
|
117
117
|
|
118
118
|
# Whether the channel type is enabled for the preference set.
|
119
119
|
#
|
120
|
-
# @see Knockapi::
|
120
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#push
|
121
121
|
module Push
|
122
122
|
extend Knockapi::Internal::Type::Union
|
123
123
|
|
124
124
|
variant Knockapi::Internal::Type::Boolean
|
125
125
|
|
126
126
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
127
|
-
variant -> { Knockapi::
|
127
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
128
128
|
|
129
129
|
# @!method self.variants
|
130
|
-
# @return [Array(Boolean, Knockapi::
|
130
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
131
131
|
end
|
132
132
|
|
133
133
|
# Whether the channel type is enabled for the preference set.
|
134
134
|
#
|
135
|
-
# @see Knockapi::
|
135
|
+
# @see Knockapi::Recipients::PreferenceSetChannelTypes#sms
|
136
136
|
module SMS
|
137
137
|
extend Knockapi::Internal::Type::Union
|
138
138
|
|
139
139
|
variant Knockapi::Internal::Type::Boolean
|
140
140
|
|
141
141
|
# A set of settings for a channel type. Currently, this can only be a list of conditions to apply.
|
142
|
-
variant -> { Knockapi::
|
142
|
+
variant -> { Knockapi::Recipients::PreferenceSetChannelTypeSetting }
|
143
143
|
|
144
144
|
# @!method self.variants
|
145
|
-
# @return [Array(Boolean, Knockapi::
|
145
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetChannelTypeSetting)]
|
146
146
|
end
|
147
147
|
end
|
148
148
|
end
|
@@ -8,39 +8,41 @@ module Knockapi
|
|
8
8
|
# An object where the key is the category and the values are the preference
|
9
9
|
# settings for that category.
|
10
10
|
#
|
11
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::
|
11
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil]
|
12
12
|
optional :categories,
|
13
|
-
-> {
|
13
|
+
-> {
|
14
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Category]
|
15
|
+
},
|
14
16
|
nil?: true
|
15
17
|
|
16
18
|
# @!attribute channel_types
|
17
19
|
# Channel type preferences.
|
18
20
|
#
|
19
|
-
# @return [Knockapi::
|
20
|
-
optional :channel_types, -> { Knockapi::
|
21
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
22
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
21
23
|
|
22
24
|
# @!attribute workflows
|
23
25
|
# An object where the key is the workflow key and the values are the preference
|
24
26
|
# settings for that workflow.
|
25
27
|
#
|
26
|
-
# @return [Hash{Symbol=>Boolean, Knockapi::
|
28
|
+
# @return [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil]
|
27
29
|
optional :workflows,
|
28
|
-
-> {
|
30
|
+
-> {
|
31
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::PreferenceSetRequest::Workflow]
|
32
|
+
},
|
29
33
|
nil?: true
|
30
34
|
|
31
35
|
# @!method initialize(categories: nil, channel_types: nil, workflows: nil)
|
32
36
|
# Some parameter documentations has been truncated, see
|
33
|
-
# {Knockapi::
|
37
|
+
# {Knockapi::Recipients::PreferenceSetRequest} for more details.
|
34
38
|
#
|
35
39
|
# A request to set a preference set for a recipient.
|
36
40
|
#
|
37
|
-
# @param categories [Hash{Symbol=>Boolean, Knockapi::
|
38
|
-
# ...
|
41
|
+
# @param categories [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the category and the values are the preference settin
|
39
42
|
#
|
40
|
-
# @param channel_types [Knockapi::
|
43
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
41
44
|
#
|
42
|
-
# @param workflows [Hash{Symbol=>Boolean, Knockapi::
|
43
|
-
# ...
|
45
|
+
# @param workflows [Hash{Symbol=>Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject}, nil] An object where the key is the workflow key and the values are the preference se
|
44
46
|
|
45
47
|
# Workflow or category preferences within a preference set
|
46
48
|
module Category
|
@@ -49,32 +51,34 @@ module Knockapi
|
|
49
51
|
variant Knockapi::Internal::Type::Boolean
|
50
52
|
|
51
53
|
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
52
|
-
variant -> {
|
54
|
+
variant -> {
|
55
|
+
Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject
|
56
|
+
}
|
53
57
|
|
54
58
|
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
55
59
|
# @!attribute channel_types
|
56
60
|
# Channel type preferences.
|
57
61
|
#
|
58
|
-
# @return [Knockapi::
|
59
|
-
optional :channel_types, -> { Knockapi::
|
62
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
63
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
60
64
|
|
61
65
|
# @!attribute conditions
|
62
66
|
# A list of conditions to apply to a channel type.
|
63
67
|
#
|
64
|
-
# @return [Array<Knockapi::
|
65
|
-
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
68
|
+
# @return [Array<Knockapi::Condition>, nil]
|
69
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
66
70
|
|
67
71
|
# @!method initialize(channel_types: nil, conditions: nil)
|
68
72
|
# The settings object for a workflow or category, where you can specify channel
|
69
73
|
# types or conditions.
|
70
74
|
#
|
71
|
-
# @param channel_types [Knockapi::
|
75
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
72
76
|
#
|
73
|
-
# @param conditions [Array<Knockapi::
|
77
|
+
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
74
78
|
end
|
75
79
|
|
76
80
|
# @!method self.variants
|
77
|
-
# @return [Array(Boolean, Knockapi::
|
81
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject)]
|
78
82
|
end
|
79
83
|
|
80
84
|
# Workflow or category preferences within a preference set
|
@@ -84,32 +88,34 @@ module Knockapi
|
|
84
88
|
variant Knockapi::Internal::Type::Boolean
|
85
89
|
|
86
90
|
# The settings object for a workflow or category, where you can specify channel types or conditions.
|
87
|
-
variant -> {
|
91
|
+
variant -> {
|
92
|
+
Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject
|
93
|
+
}
|
88
94
|
|
89
95
|
class PreferenceSetWorkflowCategorySettingObject < Knockapi::Internal::Type::BaseModel
|
90
96
|
# @!attribute channel_types
|
91
97
|
# Channel type preferences.
|
92
98
|
#
|
93
|
-
# @return [Knockapi::
|
94
|
-
optional :channel_types, -> { Knockapi::
|
99
|
+
# @return [Knockapi::Recipients::PreferenceSetChannelTypes, nil]
|
100
|
+
optional :channel_types, -> { Knockapi::Recipients::PreferenceSetChannelTypes }, nil?: true
|
95
101
|
|
96
102
|
# @!attribute conditions
|
97
103
|
# A list of conditions to apply to a channel type.
|
98
104
|
#
|
99
|
-
# @return [Array<Knockapi::
|
100
|
-
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
105
|
+
# @return [Array<Knockapi::Condition>, nil]
|
106
|
+
optional :conditions, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Condition] }, nil?: true
|
101
107
|
|
102
108
|
# @!method initialize(channel_types: nil, conditions: nil)
|
103
109
|
# The settings object for a workflow or category, where you can specify channel
|
104
110
|
# types or conditions.
|
105
111
|
#
|
106
|
-
# @param channel_types [Knockapi::
|
112
|
+
# @param channel_types [Knockapi::Recipients::PreferenceSetChannelTypes, nil] Channel type preferences.
|
107
113
|
#
|
108
|
-
# @param conditions [Array<Knockapi::
|
114
|
+
# @param conditions [Array<Knockapi::Condition>, nil] A list of conditions to apply to a channel type.
|
109
115
|
end
|
110
116
|
|
111
117
|
# @!method self.variants
|
112
|
-
# @return [Array(Boolean, Knockapi::
|
118
|
+
# @return [Array(Boolean, Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject)]
|
113
119
|
end
|
114
120
|
end
|
115
121
|
end
|
@@ -7,32 +7,34 @@ module Knockapi
|
|
7
7
|
# @!attribute connections
|
8
8
|
# List of Slack channel connections.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::
|
10
|
+
# @return [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>]
|
11
11
|
required :connections,
|
12
|
-
-> {
|
12
|
+
-> {
|
13
|
+
Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipients::SlackChannelData::Connection]
|
14
|
+
}
|
13
15
|
|
14
16
|
# @!attribute token
|
15
17
|
# A Slack connection token.
|
16
18
|
#
|
17
|
-
# @return [Knockapi::
|
18
|
-
optional :token, -> { Knockapi::
|
19
|
+
# @return [Knockapi::Recipients::SlackChannelData::Token, nil]
|
20
|
+
optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
|
19
21
|
|
20
22
|
# @!method initialize(connections:, token: nil)
|
21
23
|
# Slack channel data
|
22
24
|
#
|
23
|
-
# @param connections [Array<Knockapi::
|
25
|
+
# @param connections [Array<Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
|
24
26
|
#
|
25
|
-
# @param token [Knockapi::
|
27
|
+
# @param token [Knockapi::Recipients::SlackChannelData::Token, nil] A Slack connection token.
|
26
28
|
|
27
29
|
# A Slack connection, either an access token or an incoming webhook
|
28
30
|
module Connection
|
29
31
|
extend Knockapi::Internal::Type::Union
|
30
32
|
|
31
33
|
# A Slack connection token.
|
32
|
-
variant -> { Knockapi::
|
34
|
+
variant -> { Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection }
|
33
35
|
|
34
36
|
# A Slack connection incoming webhook.
|
35
|
-
variant -> { Knockapi::
|
37
|
+
variant -> { Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection }
|
36
38
|
|
37
39
|
class SlackTokenConnection < Knockapi::Internal::Type::BaseModel
|
38
40
|
# @!attribute access_token
|
@@ -77,10 +79,10 @@ module Knockapi
|
|
77
79
|
end
|
78
80
|
|
79
81
|
# @!method self.variants
|
80
|
-
# @return [Array(Knockapi::
|
82
|
+
# @return [Array(Knockapi::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection)]
|
81
83
|
end
|
82
84
|
|
83
|
-
# @see Knockapi::
|
85
|
+
# @see Knockapi::Recipients::SlackChannelData#token
|
84
86
|
class Token < Knockapi::Internal::Type::BaseModel
|
85
87
|
# @!attribute access_token
|
86
88
|
# A Slack access token.
|
@@ -19,14 +19,14 @@ module Knockapi
|
|
19
19
|
# @!attribute object
|
20
20
|
# A custom [Object](/concepts/objects) entity which belongs to a collection.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::
|
23
|
-
required :object, -> { Knockapi::
|
22
|
+
# @return [Knockapi::Object]
|
23
|
+
required :object, -> { Knockapi::Object }
|
24
24
|
|
25
25
|
# @!attribute recipient
|
26
26
|
# A recipient of a notification, which is either a user or an object.
|
27
27
|
#
|
28
|
-
# @return [Knockapi::
|
29
|
-
required :recipient, union: -> { Knockapi::
|
28
|
+
# @return [Knockapi::User, Knockapi::Object]
|
29
|
+
required :recipient, union: -> { Knockapi::Recipient }
|
30
30
|
|
31
31
|
# @!attribute updated_at
|
32
32
|
# The timestamp when the resource was last updated.
|
@@ -47,9 +47,9 @@ module Knockapi
|
|
47
47
|
#
|
48
48
|
# @param inserted_at [Time] Timestamp when the resource was created.
|
49
49
|
#
|
50
|
-
# @param object [Knockapi::
|
50
|
+
# @param object [Knockapi::Object] A custom [Object](/concepts/objects) entity which belongs to a collection.
|
51
51
|
#
|
52
|
-
# @param recipient [Knockapi::
|
52
|
+
# @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
|
53
53
|
#
|
54
54
|
# @param updated_at [Time] The timestamp when the resource was last updated.
|
55
55
|
#
|
@@ -19,14 +19,14 @@ module Knockapi
|
|
19
19
|
# @!attribute recipient
|
20
20
|
# A recipient of a notification, which is either a user or an object.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::
|
23
|
-
required :recipient, union: -> { Knockapi::
|
22
|
+
# @return [Knockapi::User, Knockapi::Object]
|
23
|
+
required :recipient, union: -> { Knockapi::Recipient }
|
24
24
|
|
25
25
|
# @!attribute repeats
|
26
26
|
# The repeat rule for the schedule.
|
27
27
|
#
|
28
|
-
# @return [Array<Knockapi::
|
29
|
-
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
28
|
+
# @return [Array<Knockapi::ScheduleRepeatRule>]
|
29
|
+
required :repeats, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ScheduleRepeatRule] }
|
30
30
|
|
31
31
|
# @!attribute updated_at
|
32
32
|
# The timestamp when the resource was last updated.
|
@@ -49,8 +49,8 @@ module Knockapi
|
|
49
49
|
# @!attribute actor
|
50
50
|
# A recipient of a notification, which is either a user or an object.
|
51
51
|
#
|
52
|
-
# @return [Knockapi::
|
53
|
-
optional :actor, union: -> { Knockapi::
|
52
|
+
# @return [Knockapi::User, Knockapi::Object, nil]
|
53
|
+
optional :actor, union: -> { Knockapi::Recipient }, nil?: true
|
54
54
|
|
55
55
|
# @!attribute data
|
56
56
|
# An optional map of data to pass into the workflow execution.
|
@@ -79,8 +79,8 @@ module Knockapi
|
|
79
79
|
optional :tenant, String, nil?: true
|
80
80
|
|
81
81
|
# @!method initialize(id:, inserted_at:, recipient:, repeats:, updated_at:, workflow:, _typename: nil, actor: nil, data: nil, last_occurrence_at: nil, next_occurrence_at: nil, tenant: nil)
|
82
|
-
# Some parameter documentations has been truncated, see
|
83
|
-
#
|
82
|
+
# Some parameter documentations has been truncated, see {Knockapi::Schedule} for
|
83
|
+
# more details.
|
84
84
|
#
|
85
85
|
# A schedule represents a recurring workflow execution.
|
86
86
|
#
|
@@ -88,9 +88,9 @@ module Knockapi
|
|
88
88
|
#
|
89
89
|
# @param inserted_at [Time] Timestamp when the resource was created.
|
90
90
|
#
|
91
|
-
# @param recipient [Knockapi::
|
91
|
+
# @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
|
92
92
|
#
|
93
|
-
# @param repeats [Array<Knockapi::
|
93
|
+
# @param repeats [Array<Knockapi::ScheduleRepeatRule>] The repeat rule for the schedule.
|
94
94
|
#
|
95
95
|
# @param updated_at [Time] The timestamp when the resource was last updated.
|
96
96
|
#
|
@@ -98,7 +98,7 @@ module Knockapi
|
|
98
98
|
#
|
99
99
|
# @param _typename [String] The typename of the schema.
|
100
100
|
#
|
101
|
-
# @param actor [Knockapi::
|
101
|
+
# @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
|
102
102
|
#
|
103
103
|
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
104
104
|
#
|
@@ -107,7 +107,6 @@ module Knockapi
|
|
107
107
|
# @param next_occurrence_at [Time, nil] The next occurrence of the schedule.
|
108
108
|
#
|
109
109
|
# @param tenant [String, nil] The tenant to trigger the workflow for. Triggering with a tenant will use any te
|
110
|
-
# ...
|
111
110
|
end
|
112
111
|
end
|
113
112
|
end
|