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
@@ -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::UserListMessagesParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
|
-
-> {
|
33
|
+
-> {
|
34
|
+
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::EngagementStatus]
|
35
|
+
}
|
34
36
|
|
35
37
|
# @!attribute inserted_at
|
36
38
|
#
|
37
|
-
# @return [Knockapi::
|
38
|
-
optional :inserted_at, -> { Knockapi::
|
39
|
+
# @return [Knockapi::UserListMessagesParams::InsertedAt, nil]
|
40
|
+
optional :inserted_at, -> { Knockapi::UserListMessagesParams::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,11 @@ 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::UserListMessagesParams::Status>, nil]
|
63
65
|
optional :status,
|
64
|
-
-> {
|
66
|
+
-> {
|
67
|
+
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListMessagesParams::Status]
|
68
|
+
}
|
65
69
|
|
66
70
|
# @!attribute tenant
|
67
71
|
# Limits the results to items with the corresponding tenant.
|
@@ -106,30 +110,27 @@ module Knockapi
|
|
106
110
|
#
|
107
111
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
108
112
|
#
|
109
|
-
# @param engagement_status [Array<Symbol, Knockapi::
|
113
|
+
# @param engagement_status [Array<Symbol, Knockapi::UserListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
110
114
|
#
|
111
|
-
# @param inserted_at [Knockapi::
|
115
|
+
# @param inserted_at [Knockapi::UserListMessagesParams::InsertedAt]
|
112
116
|
#
|
113
117
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
114
|
-
# ...
|
115
118
|
#
|
116
119
|
# @param page_size [Integer] The number of items per page.
|
117
120
|
#
|
118
121
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
119
122
|
#
|
120
|
-
# @param status [Array<Symbol, Knockapi::
|
123
|
+
# @param status [Array<Symbol, Knockapi::UserListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
121
124
|
#
|
122
125
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
123
126
|
#
|
124
127
|
# @param trigger_data [String] Limits the results to only messages that were generated with the given data. See
|
125
|
-
# ...
|
126
128
|
#
|
127
129
|
# @param workflow_categories [Array<String>] Limits the results to messages related to any of the provided categories.
|
128
130
|
#
|
129
131
|
# @param workflow_recipient_run_id [String] Limits the results to messages for a specific recipient's workflow run.
|
130
132
|
#
|
131
133
|
# @param workflow_run_id [String] Limits the results to messages associated with the top-level workflow run ID ret
|
132
|
-
# ...
|
133
134
|
#
|
134
135
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
135
136
|
|
@@ -137,10 +138,13 @@ module Knockapi
|
|
137
138
|
extend Knockapi::Internal::Type::Enum
|
138
139
|
|
139
140
|
SEEN = :seen
|
141
|
+
UNSEEN = :unseen
|
140
142
|
READ = :read
|
141
|
-
|
142
|
-
LINK_CLICKED = :link_clicked
|
143
|
+
UNREAD = :unread
|
143
144
|
ARCHIVED = :archived
|
145
|
+
UNARCHIVED = :unarchived
|
146
|
+
LINK_CLICKED = :link_clicked
|
147
|
+
INTERACTED = :interacted
|
144
148
|
|
145
149
|
# @!method self.values
|
146
150
|
# @return [Array<Symbol>]
|
@@ -22,9 +22,8 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Associated resources to include in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::
|
26
|
-
optional :include,
|
27
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Models::UserListParams::Include] }
|
25
|
+
# @return [Array<Symbol, Knockapi::UserListParams::Include>, nil]
|
26
|
+
optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListParams::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::UserListParams::Include>] Associated resources to include 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
|
UserListPreferencesResponse =
|
7
|
-
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::
|
7
|
+
Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Recipients::PreferenceSet }]
|
8
8
|
end
|
9
9
|
end
|
@@ -22,9 +22,9 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Associated resources to include in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::
|
25
|
+
# @return [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>, nil]
|
26
26
|
optional :include,
|
27
|
-
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::
|
27
|
+
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::UserListSubscriptionsParams::Include] }
|
28
28
|
|
29
29
|
# @!attribute objects
|
30
30
|
# Only returns subscriptions for the specified object GIDs.
|
@@ -43,7 +43,7 @@ module Knockapi
|
|
43
43
|
#
|
44
44
|
# @param before [String] The cursor to fetch entries before.
|
45
45
|
#
|
46
|
-
# @param include [Array<Symbol, Knockapi::
|
46
|
+
# @param include [Array<Symbol, Knockapi::UserListSubscriptionsParams::Include>] Associated resources to include in the response.
|
47
47
|
#
|
48
48
|
# @param objects [Array<String>] Only returns subscriptions for the specified object GIDs.
|
49
49
|
#
|
@@ -11,11 +11,11 @@ module Knockapi
|
|
11
11
|
# @!attribute users
|
12
12
|
# A list of users.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::
|
15
|
-
required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
14
|
+
# @return [Array<Knockapi::InlineIdentifyUserRequest>]
|
15
|
+
required :users, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineIdentifyUserRequest] }
|
16
16
|
|
17
17
|
# @!method initialize(users:, request_options: {})
|
18
|
-
# @param users [Array<Knockapi::
|
18
|
+
# @param users [Array<Knockapi::InlineIdentifyUserRequest>] A list of users.
|
19
19
|
#
|
20
20
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
end
|
@@ -11,8 +11,8 @@ module Knockapi
|
|
11
11
|
# @!attribute preferences
|
12
12
|
# A request to set a preference set for a recipient.
|
13
13
|
#
|
14
|
-
# @return [Knockapi::
|
15
|
-
required :preferences, -> { Knockapi::
|
14
|
+
# @return [Knockapi::Recipients::PreferenceSetRequest]
|
15
|
+
required :preferences, -> { Knockapi::Recipients::PreferenceSetRequest }
|
16
16
|
|
17
17
|
# @!attribute user_ids
|
18
18
|
# A list of user IDs.
|
@@ -21,7 +21,7 @@ module Knockapi
|
|
21
21
|
required :user_ids, Knockapi::Internal::Type::ArrayOf[String]
|
22
22
|
|
23
23
|
# @!method initialize(preferences:, user_ids:, request_options: {})
|
24
|
-
# @param preferences [Knockapi::
|
24
|
+
# @param preferences [Knockapi::Recipients::PreferenceSetRequest] A request to set a preference set for a recipient.
|
25
25
|
#
|
26
26
|
# @param user_ids [Array<String>] A list of user IDs.
|
27
27
|
#
|
@@ -17,8 +17,8 @@ module Knockapi
|
|
17
17
|
# @!attribute archived
|
18
18
|
# The archived status of the feed items.
|
19
19
|
#
|
20
|
-
# @return [Symbol, Knockapi::
|
21
|
-
optional :archived, enum: -> { Knockapi::
|
20
|
+
# @return [Symbol, Knockapi::Users::FeedListItemsParams::Archived, nil]
|
21
|
+
optional :archived, enum: -> { Knockapi::Users::FeedListItemsParams::Archived }
|
22
22
|
|
23
23
|
# @!attribute before
|
24
24
|
# The cursor to fetch entries before.
|
@@ -47,8 +47,8 @@ module Knockapi
|
|
47
47
|
# @!attribute status
|
48
48
|
# The status of the feed items.
|
49
49
|
#
|
50
|
-
# @return [Symbol, Knockapi::
|
51
|
-
optional :status, enum: -> { Knockapi::
|
50
|
+
# @return [Symbol, Knockapi::Users::FeedListItemsParams::Status, nil]
|
51
|
+
optional :status, enum: -> { Knockapi::Users::FeedListItemsParams::Status }
|
52
52
|
|
53
53
|
# @!attribute tenant
|
54
54
|
# The tenant associated with the feed items.
|
@@ -71,7 +71,7 @@ module Knockapi
|
|
71
71
|
# @!method initialize(after: nil, archived: nil, before: nil, has_tenant: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
|
72
72
|
# @param after [String] The cursor to fetch entries after.
|
73
73
|
#
|
74
|
-
# @param archived [Symbol, Knockapi::
|
74
|
+
# @param archived [Symbol, Knockapi::Users::FeedListItemsParams::Archived] The archived status of the feed items.
|
75
75
|
#
|
76
76
|
# @param before [String] The cursor to fetch entries before.
|
77
77
|
#
|
@@ -81,7 +81,7 @@ module Knockapi
|
|
81
81
|
#
|
82
82
|
# @param source [String] The source of the feed items.
|
83
83
|
#
|
84
|
-
# @param status [Symbol, Knockapi::
|
84
|
+
# @param status [Symbol, Knockapi::Users::FeedListItemsParams::Status] The status of the feed items.
|
85
85
|
#
|
86
86
|
# @param tenant [String] The tenant associated with the feed items.
|
87
87
|
#
|
@@ -20,14 +20,14 @@ module Knockapi
|
|
20
20
|
# @!attribute activities
|
21
21
|
# List of activities associated with this feed item.
|
22
22
|
#
|
23
|
-
# @return [Array<Knockapi::
|
24
|
-
required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::
|
23
|
+
# @return [Array<Knockapi::Activity>]
|
24
|
+
required :activities, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::Activity] }
|
25
25
|
|
26
26
|
# @!attribute actors
|
27
27
|
# List of actors associated with this feed item.
|
28
28
|
#
|
29
|
-
# @return [Array<Knockapi::
|
30
|
-
required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
29
|
+
# @return [Array<Knockapi::User, Knockapi::Object>]
|
30
|
+
required :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::Recipient] }
|
31
31
|
|
32
32
|
# @!attribute blocks
|
33
33
|
# Content blocks that make up the feed item.
|
@@ -121,9 +121,9 @@ module Knockapi
|
|
121
121
|
#
|
122
122
|
# @param _typename [String] The typename of the schema.
|
123
123
|
#
|
124
|
-
# @param activities [Array<Knockapi::
|
124
|
+
# @param activities [Array<Knockapi::Activity>] List of activities associated with this feed item.
|
125
125
|
#
|
126
|
-
# @param actors [Array<Knockapi::
|
126
|
+
# @param actors [Array<Knockapi::User, Knockapi::Object>] List of actors associated with this feed item.
|
127
127
|
#
|
128
128
|
# @param blocks [Array<Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedContentBlock, Knockapi::Models::Users::FeedListItemsResponse::Block::MessageInAppFeedButtonSetBlock>] Content blocks that make up the feed item.
|
129
129
|
#
|
@@ -21,9 +21,9 @@ module Knockapi
|
|
21
21
|
# A list of recipients to cancel the notification for. If omitted, cancels for all
|
22
22
|
# recipients associated with the cancellation key.
|
23
23
|
#
|
24
|
-
# @return [Array<String, Knockapi::
|
24
|
+
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
25
25
|
optional :recipients,
|
26
|
-
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::
|
26
|
+
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
|
27
27
|
nil?: true
|
28
28
|
|
29
29
|
# @!method initialize(cancellation_key:, recipients: nil, request_options: {})
|
@@ -31,10 +31,8 @@ module Knockapi
|
|
31
31
|
# {Knockapi::Models::WorkflowCancelParams} for more details.
|
32
32
|
#
|
33
33
|
# @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
|
34
|
-
# ...
|
35
34
|
#
|
36
|
-
# @param recipients [Array<String, Knockapi::
|
37
|
-
# ...
|
35
|
+
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
38
36
|
#
|
39
37
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
40
38
|
end
|
@@ -11,16 +11,16 @@ module Knockapi
|
|
11
11
|
# The recipients to trigger the workflow for. Can inline identify users, objects,
|
12
12
|
# or use a list of user IDs. Limited to 1,000 recipients.
|
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 actor
|
18
18
|
# Specifies a recipient in a request. This can either be a user identifier
|
19
19
|
# (string), an inline user request (object), or an inline object request, which is
|
20
20
|
# determined by the presence of a `collection` property.
|
21
21
|
#
|
22
|
-
# @return [String, Knockapi::
|
23
|
-
optional :actor, union: -> { Knockapi::
|
22
|
+
# @return [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil]
|
23
|
+
optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
|
24
24
|
|
25
25
|
# @!attribute cancellation_key
|
26
26
|
# An optional key that is used to reference a specific workflow trigger request
|
@@ -41,25 +41,22 @@ module Knockapi
|
|
41
41
|
# @!attribute tenant
|
42
42
|
# An request to set a tenant inline.
|
43
43
|
#
|
44
|
-
# @return [String, Knockapi::
|
45
|
-
optional :tenant, union: -> { Knockapi::
|
44
|
+
# @return [String, Knockapi::TenantRequest, nil]
|
45
|
+
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
46
46
|
|
47
47
|
# @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
|
48
48
|
# Some parameter documentations has been truncated, see
|
49
49
|
# {Knockapi::Models::WorkflowTriggerParams} for more details.
|
50
50
|
#
|
51
|
-
# @param recipients [Array<String, Knockapi::
|
52
|
-
# ...
|
51
|
+
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
53
52
|
#
|
54
|
-
# @param actor [String, Knockapi::
|
55
|
-
# ...
|
53
|
+
# @param actor [String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
56
54
|
#
|
57
55
|
# @param cancellation_key [String, nil] An optional key that is used to reference a specific workflow trigger request wh
|
58
|
-
# ...
|
59
56
|
#
|
60
57
|
# @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution.
|
61
58
|
#
|
62
|
-
# @param tenant [String, Knockapi::
|
59
|
+
# @param tenant [String, Knockapi::TenantRequest, nil] An request to set a tenant inline.
|
63
60
|
#
|
64
61
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
65
62
|
end
|
@@ -0,0 +1,213 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Knockapi
|
4
|
+
[Knockapi::Internal::Type::BaseModel, *Knockapi::Internal::Type::BaseModel.subclasses].each do |cls|
|
5
|
+
cls.define_sorbet_constant!(:OrHash) { T.type_alias { T.any(cls, Knockapi::Internal::AnyHash) } }
|
6
|
+
end
|
7
|
+
|
8
|
+
Knockapi::Internal::Util.walk_namespaces(Knockapi::Models).each do |mod|
|
9
|
+
case mod
|
10
|
+
in Knockapi::Internal::Type::Enum | Knockapi::Internal::Type::Union
|
11
|
+
mod.constants.each do |name|
|
12
|
+
case mod.const_get(name)
|
13
|
+
in true | false
|
14
|
+
mod.define_sorbet_constant!(:TaggedBoolean) { T.type_alias { T.all(T::Boolean, mod) } }
|
15
|
+
mod.define_sorbet_constant!(:OrBoolean) { T.type_alias { T::Boolean } }
|
16
|
+
in Integer
|
17
|
+
mod.define_sorbet_constant!(:TaggedInteger) { T.type_alias { T.all(Integer, mod) } }
|
18
|
+
mod.define_sorbet_constant!(:OrInteger) { T.type_alias { Integer } }
|
19
|
+
in Float
|
20
|
+
mod.define_sorbet_constant!(:TaggedFloat) { T.type_alias { T.all(Float, mod) } }
|
21
|
+
mod.define_sorbet_constant!(:OrFloat) { T.type_alias { Float } }
|
22
|
+
in Symbol
|
23
|
+
mod.define_sorbet_constant!(:TaggedSymbol) { T.type_alias { T.all(Symbol, mod) } }
|
24
|
+
mod.define_sorbet_constant!(:OrSymbol) { T.type_alias { T.any(Symbol, String) } }
|
25
|
+
else
|
26
|
+
end
|
27
|
+
end
|
28
|
+
else
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
Knockapi::Internal::Util.walk_namespaces(Knockapi::Models)
|
33
|
+
.lazy
|
34
|
+
.grep(Knockapi::Internal::Type::Union)
|
35
|
+
.each do |mod|
|
36
|
+
const = :Variants
|
37
|
+
next if mod.sorbet_constant_defined?(const)
|
38
|
+
|
39
|
+
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
40
|
+
end
|
41
|
+
|
42
|
+
Activity = Knockapi::Models::Activity
|
43
|
+
|
44
|
+
AudienceAddMembersParams = Knockapi::Models::AudienceAddMembersParams
|
45
|
+
|
46
|
+
AudienceListMembersParams = Knockapi::Models::AudienceListMembersParams
|
47
|
+
|
48
|
+
AudienceMember = Knockapi::Models::AudienceMember
|
49
|
+
|
50
|
+
AudienceRemoveMembersParams = Knockapi::Models::AudienceRemoveMembersParams
|
51
|
+
|
52
|
+
BulkOperation = Knockapi::Models::BulkOperation
|
53
|
+
|
54
|
+
BulkOperationGetParams = Knockapi::Models::BulkOperationGetParams
|
55
|
+
|
56
|
+
Channels = Knockapi::Models::Channels
|
57
|
+
|
58
|
+
Condition = Knockapi::Models::Condition
|
59
|
+
|
60
|
+
IdentifyUserRequest = Knockapi::Models::IdentifyUserRequest
|
61
|
+
|
62
|
+
InlineIdentifyUserRequest = Knockapi::Models::InlineIdentifyUserRequest
|
63
|
+
|
64
|
+
InlineObjectRequest = Knockapi::Models::InlineObjectRequest
|
65
|
+
|
66
|
+
InlineTenantRequest = Knockapi::Models::InlineTenantRequest
|
67
|
+
|
68
|
+
Integrations = Knockapi::Models::Integrations
|
69
|
+
|
70
|
+
Message = Knockapi::Models::Message
|
71
|
+
|
72
|
+
MessageArchiveParams = Knockapi::Models::MessageArchiveParams
|
73
|
+
|
74
|
+
MessageDeliveryLog = Knockapi::Models::MessageDeliveryLog
|
75
|
+
|
76
|
+
MessageEvent = Knockapi::Models::MessageEvent
|
77
|
+
|
78
|
+
MessageGetContentParams = Knockapi::Models::MessageGetContentParams
|
79
|
+
|
80
|
+
MessageGetParams = Knockapi::Models::MessageGetParams
|
81
|
+
|
82
|
+
MessageListActivitiesParams = Knockapi::Models::MessageListActivitiesParams
|
83
|
+
|
84
|
+
MessageListDeliveryLogsParams = Knockapi::Models::MessageListDeliveryLogsParams
|
85
|
+
|
86
|
+
MessageListEventsParams = Knockapi::Models::MessageListEventsParams
|
87
|
+
|
88
|
+
MessageListParams = Knockapi::Models::MessageListParams
|
89
|
+
|
90
|
+
MessageMarkAsInteractedParams = Knockapi::Models::MessageMarkAsInteractedParams
|
91
|
+
|
92
|
+
MessageMarkAsReadParams = Knockapi::Models::MessageMarkAsReadParams
|
93
|
+
|
94
|
+
MessageMarkAsSeenParams = Knockapi::Models::MessageMarkAsSeenParams
|
95
|
+
|
96
|
+
MessageMarkAsUnreadParams = Knockapi::Models::MessageMarkAsUnreadParams
|
97
|
+
|
98
|
+
MessageMarkAsUnseenParams = Knockapi::Models::MessageMarkAsUnseenParams
|
99
|
+
|
100
|
+
Messages = Knockapi::Models::Messages
|
101
|
+
|
102
|
+
MessageUnarchiveParams = Knockapi::Models::MessageUnarchiveParams
|
103
|
+
|
104
|
+
Object = Knockapi::Models::Object
|
105
|
+
|
106
|
+
ObjectAddSubscriptionsParams = Knockapi::Models::ObjectAddSubscriptionsParams
|
107
|
+
|
108
|
+
ObjectDeleteParams = Knockapi::Models::ObjectDeleteParams
|
109
|
+
|
110
|
+
ObjectDeleteSubscriptionsParams = Knockapi::Models::ObjectDeleteSubscriptionsParams
|
111
|
+
|
112
|
+
ObjectGetChannelDataParams = Knockapi::Models::ObjectGetChannelDataParams
|
113
|
+
|
114
|
+
ObjectGetParams = Knockapi::Models::ObjectGetParams
|
115
|
+
|
116
|
+
ObjectGetPreferencesParams = Knockapi::Models::ObjectGetPreferencesParams
|
117
|
+
|
118
|
+
ObjectListMessagesParams = Knockapi::Models::ObjectListMessagesParams
|
119
|
+
|
120
|
+
ObjectListParams = Knockapi::Models::ObjectListParams
|
121
|
+
|
122
|
+
ObjectListPreferencesParams = Knockapi::Models::ObjectListPreferencesParams
|
123
|
+
|
124
|
+
ObjectListSchedulesParams = Knockapi::Models::ObjectListSchedulesParams
|
125
|
+
|
126
|
+
ObjectListSubscriptionsParams = Knockapi::Models::ObjectListSubscriptionsParams
|
127
|
+
|
128
|
+
Objects = Knockapi::Models::Objects
|
129
|
+
|
130
|
+
ObjectSetChannelDataParams = Knockapi::Models::ObjectSetChannelDataParams
|
131
|
+
|
132
|
+
ObjectSetParams = Knockapi::Models::ObjectSetParams
|
133
|
+
|
134
|
+
ObjectSetPreferencesParams = Knockapi::Models::ObjectSetPreferencesParams
|
135
|
+
|
136
|
+
ObjectUnsetChannelDataParams = Knockapi::Models::ObjectUnsetChannelDataParams
|
137
|
+
|
138
|
+
PageInfo = Knockapi::Models::PageInfo
|
139
|
+
|
140
|
+
Providers = Knockapi::Models::Providers
|
141
|
+
|
142
|
+
Recipient = Knockapi::Models::Recipient
|
143
|
+
|
144
|
+
RecipientReference = Knockapi::Models::RecipientReference
|
145
|
+
|
146
|
+
RecipientRequest = Knockapi::Models::RecipientRequest
|
147
|
+
|
148
|
+
Recipients = Knockapi::Models::Recipients
|
149
|
+
|
150
|
+
Schedule = Knockapi::Models::Schedule
|
151
|
+
|
152
|
+
ScheduleCreateParams = Knockapi::Models::ScheduleCreateParams
|
153
|
+
|
154
|
+
ScheduleDeleteParams = Knockapi::Models::ScheduleDeleteParams
|
155
|
+
|
156
|
+
ScheduleListParams = Knockapi::Models::ScheduleListParams
|
157
|
+
|
158
|
+
ScheduleRepeatRule = Knockapi::Models::ScheduleRepeatRule
|
159
|
+
|
160
|
+
Schedules = Knockapi::Models::Schedules
|
161
|
+
|
162
|
+
ScheduleUpdateParams = Knockapi::Models::ScheduleUpdateParams
|
163
|
+
|
164
|
+
Tenant = Knockapi::Models::Tenant
|
165
|
+
|
166
|
+
TenantDeleteParams = Knockapi::Models::TenantDeleteParams
|
167
|
+
|
168
|
+
TenantGetParams = Knockapi::Models::TenantGetParams
|
169
|
+
|
170
|
+
TenantListParams = Knockapi::Models::TenantListParams
|
171
|
+
|
172
|
+
TenantRequest = Knockapi::Models::TenantRequest
|
173
|
+
|
174
|
+
Tenants = Knockapi::Models::Tenants
|
175
|
+
|
176
|
+
TenantSetParams = Knockapi::Models::TenantSetParams
|
177
|
+
|
178
|
+
User = Knockapi::Models::User
|
179
|
+
|
180
|
+
UserDeleteParams = Knockapi::Models::UserDeleteParams
|
181
|
+
|
182
|
+
UserGetChannelDataParams = Knockapi::Models::UserGetChannelDataParams
|
183
|
+
|
184
|
+
UserGetParams = Knockapi::Models::UserGetParams
|
185
|
+
|
186
|
+
UserGetPreferencesParams = Knockapi::Models::UserGetPreferencesParams
|
187
|
+
|
188
|
+
UserListMessagesParams = Knockapi::Models::UserListMessagesParams
|
189
|
+
|
190
|
+
UserListParams = Knockapi::Models::UserListParams
|
191
|
+
|
192
|
+
UserListPreferencesParams = Knockapi::Models::UserListPreferencesParams
|
193
|
+
|
194
|
+
UserListSchedulesParams = Knockapi::Models::UserListSchedulesParams
|
195
|
+
|
196
|
+
UserListSubscriptionsParams = Knockapi::Models::UserListSubscriptionsParams
|
197
|
+
|
198
|
+
UserMergeParams = Knockapi::Models::UserMergeParams
|
199
|
+
|
200
|
+
Users = Knockapi::Models::Users
|
201
|
+
|
202
|
+
UserSetChannelDataParams = Knockapi::Models::UserSetChannelDataParams
|
203
|
+
|
204
|
+
UserSetPreferencesParams = Knockapi::Models::UserSetPreferencesParams
|
205
|
+
|
206
|
+
UserUnsetChannelDataParams = Knockapi::Models::UserUnsetChannelDataParams
|
207
|
+
|
208
|
+
UserUpdateParams = Knockapi::Models::UserUpdateParams
|
209
|
+
|
210
|
+
WorkflowCancelParams = Knockapi::Models::WorkflowCancelParams
|
211
|
+
|
212
|
+
WorkflowTriggerParams = Knockapi::Models::WorkflowTriggerParams
|
213
|
+
end
|
@@ -9,7 +9,7 @@ module Knockapi
|
|
9
9
|
#
|
10
10
|
# @param key [String] The key of the audience.
|
11
11
|
#
|
12
|
-
# @param members [Array<Knockapi::
|
12
|
+
# @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
|
13
13
|
#
|
14
14
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
15
15
|
#
|
@@ -17,7 +17,7 @@ module Knockapi
|
|
17
17
|
#
|
18
18
|
# @see Knockapi::Models::AudienceAddMembersParams
|
19
19
|
def add_members(key, params)
|
20
|
-
parsed, options = Knockapi::
|
20
|
+
parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
|
21
21
|
@client.request(
|
22
22
|
method: :post,
|
23
23
|
path: ["v1/audiences/%1$s/members", key],
|
@@ -53,7 +53,7 @@ module Knockapi
|
|
53
53
|
#
|
54
54
|
# @param key [String] The key of the audience.
|
55
55
|
#
|
56
|
-
# @param members [Array<Knockapi::
|
56
|
+
# @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
57
57
|
#
|
58
58
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
59
59
|
#
|
@@ -61,7 +61,7 @@ module Knockapi
|
|
61
61
|
#
|
62
62
|
# @see Knockapi::Models::AudienceRemoveMembersParams
|
63
63
|
def remove_members(key, params)
|
64
|
-
parsed, options = Knockapi::
|
64
|
+
parsed, options = Knockapi::AudienceRemoveMembersParams.dump_request(params)
|
65
65
|
@client.request(
|
66
66
|
method: :delete,
|
67
67
|
path: ["v1/audiences/%1$s/members", key],
|
@@ -11,14 +11,14 @@ module Knockapi
|
|
11
11
|
#
|
12
12
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}, nil]
|
13
13
|
#
|
14
|
-
# @return [Knockapi::
|
14
|
+
# @return [Knockapi::BulkOperation]
|
15
15
|
#
|
16
16
|
# @see Knockapi::Models::BulkOperationGetParams
|
17
17
|
def get(id, params = {})
|
18
18
|
@client.request(
|
19
19
|
method: :get,
|
20
20
|
path: ["v1/bulk_operations/%1$s", id],
|
21
|
-
model: Knockapi::
|
21
|
+
model: Knockapi::BulkOperation,
|
22
22
|
options: params[:request_options]
|
23
23
|
)
|
24
24
|
end
|