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
@@ -485,11 +485,32 @@ module Knockapi
|
|
485
485
|
|
486
486
|
# @!method self.variants
|
487
487
|
# @return [Array(Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)]
|
488
|
+
|
489
|
+
define_sorbet_constant!(:Variants) do
|
490
|
+
T.type_alias do
|
491
|
+
T.any(
|
492
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
|
493
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
|
494
|
+
)
|
495
|
+
end
|
496
|
+
end
|
488
497
|
end
|
489
498
|
end
|
490
499
|
|
491
500
|
# @!method self.variants
|
492
501
|
# @return [Array(Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent, Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent, Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent, Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent, Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent)]
|
502
|
+
|
503
|
+
define_sorbet_constant!(:Variants) do
|
504
|
+
T.type_alias do
|
505
|
+
T.any(
|
506
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageEmailContent,
|
507
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent,
|
508
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent,
|
509
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageChatContent,
|
510
|
+
Knockapi::Models::MessageGetContentResponse::Data::MessageInAppFeedContent
|
511
|
+
)
|
512
|
+
end
|
513
|
+
end
|
493
514
|
end
|
494
515
|
end
|
495
516
|
end
|
@@ -28,14 +28,14 @@ module Knockapi
|
|
28
28
|
# @!attribute engagement_status
|
29
29
|
# Limits the results to messages with the given engagement status.
|
30
30
|
#
|
31
|
-
# @return [Array<Symbol, Knockapi::
|
31
|
+
# @return [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::
|
33
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::EngagementStatus] }
|
34
34
|
|
35
35
|
# @!attribute inserted_at
|
36
36
|
#
|
37
|
-
# @return [Knockapi::
|
38
|
-
optional :inserted_at, -> { Knockapi::
|
37
|
+
# @return [Knockapi::MessageListParams::InsertedAt, nil]
|
38
|
+
optional :inserted_at, -> { Knockapi::MessageListParams::InsertedAt }
|
39
39
|
|
40
40
|
# @!attribute message_ids
|
41
41
|
# Limits the results to only the message IDs given (max 50). Note: when using this
|
@@ -59,9 +59,8 @@ module Knockapi
|
|
59
59
|
# @!attribute status
|
60
60
|
# Limits the results to messages with the given delivery status.
|
61
61
|
#
|
62
|
-
# @return [Array<Symbol, Knockapi::
|
63
|
-
optional :status,
|
64
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::MessageListParams::Status] }
|
62
|
+
# @return [Array<Symbol, Knockapi::MessageListParams::Status>, nil]
|
63
|
+
optional :status, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::Status] }
|
65
64
|
|
66
65
|
# @!attribute tenant
|
67
66
|
# Limits the results to items with the corresponding tenant.
|
@@ -106,30 +105,27 @@ module Knockapi
|
|
106
105
|
#
|
107
106
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
108
107
|
#
|
109
|
-
# @param engagement_status [Array<Symbol, Knockapi::
|
108
|
+
# @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
110
109
|
#
|
111
|
-
# @param inserted_at [Knockapi::
|
110
|
+
# @param inserted_at [Knockapi::MessageListParams::InsertedAt]
|
112
111
|
#
|
113
112
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
114
|
-
# ...
|
115
113
|
#
|
116
114
|
# @param page_size [Integer] The number of items per page.
|
117
115
|
#
|
118
116
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
119
117
|
#
|
120
|
-
# @param status [Array<Symbol, Knockapi::
|
118
|
+
# @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
|
121
119
|
#
|
122
120
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
123
121
|
#
|
124
122
|
# @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
|
125
|
-
# ...
|
126
123
|
#
|
127
124
|
# @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
|
128
125
|
#
|
129
126
|
# @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
|
130
127
|
#
|
131
128
|
# @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
|
132
|
-
# ...
|
133
129
|
#
|
134
130
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
135
131
|
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -488,11 +488,32 @@ module Knockapi
|
|
488
488
|
|
489
489
|
# @!method self.variants
|
490
490
|
# @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock)]
|
491
|
+
|
492
|
+
define_sorbet_constant!(:Variants) do
|
493
|
+
T.type_alias do
|
494
|
+
T.any(
|
495
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedContentBlock,
|
496
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent::Block::MessageInAppFeedButtonSetBlock
|
497
|
+
)
|
498
|
+
end
|
499
|
+
end
|
491
500
|
end
|
492
501
|
end
|
493
502
|
|
494
503
|
# @!method self.variants
|
495
504
|
# @return [Array(Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent, Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent)]
|
505
|
+
|
506
|
+
define_sorbet_constant!(:Variants) do
|
507
|
+
T.type_alias do
|
508
|
+
T.any(
|
509
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageEmailContent,
|
510
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent,
|
511
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent,
|
512
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageChatContent,
|
513
|
+
Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageInAppFeedContent
|
514
|
+
)
|
515
|
+
end
|
516
|
+
end
|
496
517
|
end
|
497
518
|
end
|
498
519
|
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -34,7 +34,13 @@ module Knockapi
|
|
34
34
|
# @return [Time, nil]
|
35
35
|
optional :created_at, Time, nil?: true
|
36
36
|
|
37
|
-
# @!
|
37
|
+
# @!attribute properties
|
38
|
+
# The custom properties associated with the object.
|
39
|
+
#
|
40
|
+
# @return [Hash{Symbol=>Object}, nil]
|
41
|
+
optional :properties, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown]
|
42
|
+
|
43
|
+
# @!method initialize(id:, _typename:, collection:, updated_at:, created_at: nil, properties: nil)
|
38
44
|
# A custom [Object](/concepts/objects) entity which belongs to a collection.
|
39
45
|
#
|
40
46
|
# @param id [String] Unique identifier for the object.
|
@@ -46,6 +52,8 @@ module Knockapi
|
|
46
52
|
# @param updated_at [Time] The timestamp when the resource was last updated.
|
47
53
|
#
|
48
54
|
# @param created_at [Time, nil] Timestamp when the resource was created.
|
55
|
+
#
|
56
|
+
# @param properties [Hash{Symbol=>Object}] The custom properties associated with the object.
|
49
57
|
end
|
50
58
|
end
|
51
59
|
end
|
@@ -11,8 +11,8 @@ module Knockapi
|
|
11
11
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
12
12
|
# object at a time.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::
|
15
|
-
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
14
|
+
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
15
|
+
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
16
16
|
|
17
17
|
# @!attribute properties
|
18
18
|
# The custom properties associated with the subscription relationship.
|
@@ -24,8 +24,7 @@ module Knockapi
|
|
24
24
|
# Some parameter documentations has been truncated, see
|
25
25
|
# {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
|
26
26
|
#
|
27
|
-
# @param recipients [Array<String, Knockapi::
|
28
|
-
# ...
|
27
|
+
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
29
28
|
#
|
30
29
|
# @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
|
31
30
|
#
|
@@ -4,6 +4,6 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
6
|
ObjectAddSubscriptionsResponse =
|
7
|
-
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Recipients::Subscription }]
|
8
8
|
end
|
9
9
|
end
|
@@ -11,16 +11,14 @@ module Knockapi
|
|
11
11
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
12
12
|
# object at a time.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::
|
15
|
-
required :recipients,
|
16
|
-
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
|
14
|
+
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>]
|
15
|
+
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
17
16
|
|
18
17
|
# @!method initialize(recipients:, request_options: {})
|
19
18
|
# Some parameter documentations has been truncated, see
|
20
19
|
# {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
|
21
20
|
#
|
22
|
-
# @param recipients [Array<String, Knockapi::
|
23
|
-
# ...
|
21
|
+
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
24
22
|
#
|
25
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
26
24
|
end
|
@@ -4,6 +4,6 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
6
|
ObjectDeleteSubscriptionsResponse =
|
7
|
-
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Recipients::Subscription }]
|
8
8
|
end
|
9
9
|
end
|
@@ -28,14 +28,16 @@ module Knockapi
|
|
28
28
|
# @!attribute engagement_status
|
29
29
|
# Limits the results to messages with the given engagement status.
|
30
30
|
#
|
31
|
-
# @return [Array<Symbol, Knockapi::
|
31
|
+
# @return [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
|
-
-> {
|
33
|
+
-> {
|
34
|
+
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::EngagementStatus]
|
35
|
+
}
|
34
36
|
|
35
37
|
# @!attribute inserted_at
|
36
38
|
#
|
37
|
-
# @return [Knockapi::
|
38
|
-
optional :inserted_at, -> { Knockapi::
|
39
|
+
# @return [Knockapi::ObjectListMessagesParams::InsertedAt, nil]
|
40
|
+
optional :inserted_at, -> { Knockapi::ObjectListMessagesParams::InsertedAt }
|
39
41
|
|
40
42
|
# @!attribute message_ids
|
41
43
|
# Limits the results to only the message IDs given (max 50). Note: when using this
|
@@ -59,9 +61,9 @@ module Knockapi
|
|
59
61
|
# @!attribute status
|
60
62
|
# Limits the results to messages with the given delivery status.
|
61
63
|
#
|
62
|
-
# @return [Array<Symbol, Knockapi::
|
64
|
+
# @return [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>, nil]
|
63
65
|
optional :status,
|
64
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::
|
66
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::Status] }
|
65
67
|
|
66
68
|
# @!attribute tenant
|
67
69
|
# Limits the results to items with the corresponding tenant.
|
@@ -106,30 +108,27 @@ module Knockapi
|
|
106
108
|
#
|
107
109
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
108
110
|
#
|
109
|
-
# @param engagement_status [Array<Symbol, Knockapi::
|
111
|
+
# @param engagement_status [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
110
112
|
#
|
111
|
-
# @param inserted_at [Knockapi::
|
113
|
+
# @param inserted_at [Knockapi::ObjectListMessagesParams::InsertedAt]
|
112
114
|
#
|
113
115
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
114
|
-
# ...
|
115
116
|
#
|
116
117
|
# @param page_size [Integer] The number of items per page.
|
117
118
|
#
|
118
119
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
119
120
|
#
|
120
|
-
# @param status [Array<Symbol, Knockapi::
|
121
|
+
# @param status [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
121
122
|
#
|
122
123
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
123
124
|
#
|
124
125
|
# @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
|
125
|
-
# ...
|
126
126
|
#
|
127
127
|
# @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
|
128
128
|
#
|
129
129
|
# @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
|
130
130
|
#
|
131
131
|
# @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
|
132
|
-
# ...
|
133
132
|
#
|
134
133
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
135
134
|
|
@@ -22,9 +22,8 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Includes preferences of the objects in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::
|
26
|
-
optional :include,
|
27
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::ObjectListParams::Include] }
|
25
|
+
# @return [Array<Symbol, Knockapi::ObjectListParams::Include>, nil]
|
26
|
+
optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }
|
28
27
|
|
29
28
|
# @!attribute page_size
|
30
29
|
# The number of items per page.
|
@@ -37,7 +36,7 @@ module Knockapi
|
|
37
36
|
#
|
38
37
|
# @param before [String] The cursor to fetch entries before.
|
39
38
|
#
|
40
|
-
# @param include [Array<Symbol, Knockapi::
|
39
|
+
# @param include [Array<Symbol, Knockapi::ObjectListParams::Include>] Includes preferences of the objects in the response.
|
41
40
|
#
|
42
41
|
# @param page_size [Integer] The number of items per page.
|
43
42
|
#
|
@@ -4,6 +4,6 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
# @type [Knockapi::Internal::Type::Converter]
|
6
6
|
ObjectListPreferencesResponse =
|
7
|
-
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Recipients::PreferenceSet }]
|
8
8
|
end
|
9
9
|
end
|
@@ -22,24 +22,26 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Additional fields to include in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::
|
25
|
+
# @return [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>, nil]
|
26
26
|
optional :include,
|
27
|
-
-> {
|
27
|
+
-> {
|
28
|
+
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListSubscriptionsParams::Include]
|
29
|
+
}
|
28
30
|
|
29
31
|
# @!attribute mode
|
30
32
|
# Mode of the request. `recipient` to list the objects that the provided object is
|
31
33
|
# subscribed to, `object` to list the recipients that subscribe to the provided
|
32
34
|
# object.
|
33
35
|
#
|
34
|
-
# @return [Symbol, Knockapi::
|
35
|
-
optional :mode, enum: -> { Knockapi::
|
36
|
+
# @return [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode, nil]
|
37
|
+
optional :mode, enum: -> { Knockapi::ObjectListSubscriptionsParams::Mode }
|
36
38
|
|
37
39
|
# @!attribute objects
|
38
40
|
# Objects to filter by (only used if mode is `recipient`).
|
39
41
|
#
|
40
|
-
# @return [Array<Knockapi::
|
42
|
+
# @return [Array<Knockapi::ObjectListSubscriptionsParams::Object>, nil]
|
41
43
|
optional :objects,
|
42
|
-
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
44
|
+
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
|
43
45
|
|
44
46
|
# @!attribute page_size
|
45
47
|
# The number of items per page.
|
@@ -50,9 +52,8 @@ module Knockapi
|
|
50
52
|
# @!attribute recipients
|
51
53
|
# Recipients to filter by (only used if mode is `object`).
|
52
54
|
#
|
53
|
-
# @return [Array<String, Knockapi::
|
54
|
-
optional :recipients,
|
55
|
-
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Models::RecipientReference] }
|
55
|
+
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
56
|
+
optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
56
57
|
|
57
58
|
# @!method initialize(after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
|
58
59
|
# Some parameter documentations has been truncated, see
|
@@ -62,16 +63,15 @@ module Knockapi
|
|
62
63
|
#
|
63
64
|
# @param before [String] The cursor to fetch entries before.
|
64
65
|
#
|
65
|
-
# @param include [Array<Symbol, Knockapi::
|
66
|
+
# @param include [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
|
66
67
|
#
|
67
|
-
# @param mode [Symbol, Knockapi::
|
68
|
-
# ...
|
68
|
+
# @param mode [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
|
69
69
|
#
|
70
|
-
# @param objects [Array<Knockapi::
|
70
|
+
# @param objects [Array<Knockapi::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
|
71
71
|
#
|
72
72
|
# @param page_size [Integer] The number of items per page.
|
73
73
|
#
|
74
|
-
# @param recipients [Array<String, Knockapi::
|
74
|
+
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
|
75
75
|
#
|
76
76
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
77
77
|
|
@@ -10,9 +10,11 @@ module Knockapi
|
|
10
10
|
# @!attribute channel_data
|
11
11
|
# A request to set channel data for a type of channel inline.
|
12
12
|
#
|
13
|
-
# @return [Hash{Symbol=>Knockapi::
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
14
14
|
optional :channel_data,
|
15
|
-
-> {
|
15
|
+
-> {
|
16
|
+
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
17
|
+
}
|
16
18
|
|
17
19
|
# @!attribute locale
|
18
20
|
# The locale of the object. Used for
|
@@ -24,15 +26,17 @@ module Knockapi
|
|
24
26
|
# @!attribute preferences
|
25
27
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
26
28
|
#
|
27
|
-
# @return [Hash{Symbol=>Knockapi::
|
29
|
+
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
28
30
|
optional :preferences,
|
29
|
-
-> {
|
31
|
+
-> {
|
32
|
+
Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest]
|
33
|
+
}
|
30
34
|
|
31
35
|
# @!attribute timezone
|
32
|
-
# The timezone of the object. Must be a
|
33
|
-
# [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
34
|
-
# Used
|
35
|
-
# [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
36
|
+
# The timezone of the object. Must be a
|
37
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
38
|
+
# Used
|
39
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
36
40
|
#
|
37
41
|
# @return [String, nil]
|
38
42
|
optional :timezone, String, nil?: true
|
@@ -41,15 +45,13 @@ module Knockapi
|
|
41
45
|
# Some parameter documentations has been truncated, see
|
42
46
|
# {Knockapi::Models::ObjectSetParams} for more details.
|
43
47
|
#
|
44
|
-
# @param channel_data [Hash{Symbol=>Knockapi::
|
48
|
+
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
|
45
49
|
#
|
46
50
|
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
47
|
-
# ...
|
48
51
|
#
|
49
|
-
# @param preferences [Hash{Symbol=>Knockapi::
|
52
|
+
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
|
50
53
|
#
|
51
|
-
# @param timezone [String, nil] The timezone of the object. Must be a valid
|
52
|
-
# ...
|
54
|
+
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
53
55
|
#
|
54
56
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
55
57
|
end
|
@@ -11,12 +11,14 @@ module Knockapi
|
|
11
11
|
# @!attribute subscriptions
|
12
12
|
# A list of subscriptions.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::
|
14
|
+
# @return [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>]
|
15
15
|
required :subscriptions,
|
16
|
-
-> {
|
16
|
+
-> {
|
17
|
+
Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription]
|
18
|
+
}
|
17
19
|
|
18
20
|
# @!method initialize(subscriptions:, request_options: {})
|
19
|
-
# @param subscriptions [Array<Knockapi::
|
21
|
+
# @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
20
22
|
#
|
21
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
22
24
|
|
@@ -25,8 +27,8 @@ module Knockapi
|
|
25
27
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
26
28
|
# object at a time.
|
27
29
|
#
|
28
|
-
# @return [Array<String, Knockapi::
|
29
|
-
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
30
|
+
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
31
|
+
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
30
32
|
|
31
33
|
# @!attribute properties
|
32
34
|
# The custom properties associated with the subscription relationship.
|
@@ -38,11 +40,9 @@ module Knockapi
|
|
38
40
|
|
39
41
|
# @!method initialize(recipients:, properties: nil)
|
40
42
|
# Some parameter documentations has been truncated, see
|
41
|
-
# {Knockapi::
|
42
|
-
# details.
|
43
|
+
# {Knockapi::Objects::BulkAddSubscriptionsParams::Subscription} for more details.
|
43
44
|
#
|
44
|
-
# @param recipients [Array<String, Knockapi::
|
45
|
-
# ...
|
45
|
+
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
46
46
|
#
|
47
47
|
# @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
|
48
48
|
end
|
@@ -11,11 +11,11 @@ module Knockapi
|
|
11
11
|
# @!attribute objects
|
12
12
|
# A list of objects.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::
|
15
|
-
required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
14
|
+
# @return [Array<Knockapi::InlineObjectRequest>]
|
15
|
+
required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineObjectRequest] }
|
16
16
|
|
17
17
|
# @!method initialize(objects:, request_options: {})
|
18
|
-
# @param objects [Array<Knockapi::
|
18
|
+
# @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
|
19
19
|
#
|
20
20
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
end
|
@@ -22,15 +22,15 @@ module Knockapi
|
|
22
22
|
|
23
23
|
# @!attribute query_options
|
24
24
|
#
|
25
|
-
# @return [Knockapi::
|
26
|
-
optional :query_options, -> { Knockapi::
|
25
|
+
# @return [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions, nil]
|
26
|
+
optional :query_options, -> { Knockapi::Providers::MsTeamListChannelsParams::QueryOptions }
|
27
27
|
|
28
28
|
# @!method initialize(ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
|
29
29
|
# @param ms_teams_tenant_object [String] A JSON encoded string containing the Microsoft Teams tenant object reference.
|
30
30
|
#
|
31
31
|
# @param team_id [String] Microsoft Teams team ID.
|
32
32
|
#
|
33
|
-
# @param query_options [Knockapi::
|
33
|
+
# @param query_options [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions]
|
34
34
|
#
|
35
35
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
36
36
|
|
@@ -51,14 +51,11 @@ module Knockapi
|
|
51
51
|
|
52
52
|
# @!method initialize(filter: nil, select_: nil)
|
53
53
|
# Some parameter documentations has been truncated, see
|
54
|
-
# {Knockapi::
|
55
|
-
# details.
|
54
|
+
# {Knockapi::Providers::MsTeamListChannelsParams::QueryOptions} for more details.
|
56
55
|
#
|
57
56
|
# @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
58
|
-
# ...
|
59
57
|
#
|
60
58
|
# @param select_ [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
61
|
-
# ...
|
62
59
|
end
|
63
60
|
end
|
64
61
|
end
|