knockapi 1.32.1 → 1.34.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 +44 -0
- data/README.md +1 -1
- data/lib/knockapi/client.rb +13 -0
- data/lib/knockapi/internal/util.rb +31 -0
- data/lib/knockapi/models/audience_add_members_params.rb +8 -1
- data/lib/knockapi/models/audience_list_members_params.rb +7 -1
- data/lib/knockapi/models/audience_remove_members_params.rb +8 -1
- data/lib/knockapi/models/bulk_operation_get_params.rb +7 -1
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +15 -1
- data/lib/knockapi/models/condition.rb +1 -0
- data/lib/knockapi/models/message_archive_params.rb +7 -1
- data/lib/knockapi/models/message_get_content_params.rb +7 -1
- data/lib/knockapi/models/message_get_params.rb +7 -1
- data/lib/knockapi/models/message_list_activities_params.rb +8 -1
- data/lib/knockapi/models/message_list_delivery_logs_params.rb +8 -1
- data/lib/knockapi/models/message_list_events_params.rb +8 -1
- data/lib/knockapi/models/message_mark_as_interacted_params.rb +8 -1
- data/lib/knockapi/models/message_mark_as_read_params.rb +7 -1
- data/lib/knockapi/models/message_mark_as_seen_params.rb +7 -1
- data/lib/knockapi/models/message_mark_as_unread_params.rb +7 -1
- data/lib/knockapi/models/message_mark_as_unseen_params.rb +7 -1
- data/lib/knockapi/models/message_unarchive_params.rb +7 -1
- data/lib/knockapi/models/object_add_subscriptions_params.rb +15 -1
- data/lib/knockapi/models/object_delete_params.rb +13 -1
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +15 -1
- data/lib/knockapi/models/object_get_channel_data_params.rb +19 -1
- data/lib/knockapi/models/object_get_params.rb +13 -1
- data/lib/knockapi/models/object_get_preferences_params.rb +19 -1
- data/lib/knockapi/models/object_list_messages_params.rb +15 -1
- data/lib/knockapi/models/object_list_params.rb +8 -1
- data/lib/knockapi/models/object_list_preferences_params.rb +13 -1
- data/lib/knockapi/models/object_list_schedules_params.rb +15 -1
- data/lib/knockapi/models/object_list_subscriptions_params.rb +15 -1
- data/lib/knockapi/models/object_set_channel_data_params.rb +19 -1
- data/lib/knockapi/models/object_set_params.rb +15 -1
- data/lib/knockapi/models/object_set_preferences_params.rb +19 -1
- data/lib/knockapi/models/object_unset_channel_data_params.rb +19 -1
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +8 -1
- data/lib/knockapi/models/objects/bulk_delete_params.rb +8 -1
- data/lib/knockapi/models/objects/bulk_delete_subscriptions_params.rb +8 -1
- data/lib/knockapi/models/objects/bulk_set_params.rb +8 -1
- data/lib/knockapi/models/providers/ms_team_check_auth_params.rb +8 -1
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +8 -1
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +8 -1
- data/lib/knockapi/models/providers/ms_team_revoke_access_params.rb +8 -1
- data/lib/knockapi/models/providers/slack_check_auth_params.rb +8 -1
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +8 -1
- data/lib/knockapi/models/providers/slack_revoke_access_params.rb +8 -1
- data/lib/knockapi/models/tenant_delete_params.rb +7 -1
- data/lib/knockapi/models/tenant_get_params.rb +8 -1
- data/lib/knockapi/models/tenant_set_params.rb +8 -1
- data/lib/knockapi/models/user_delete_params.rb +7 -1
- data/lib/knockapi/models/user_get_channel_data_params.rb +13 -1
- data/lib/knockapi/models/user_get_params.rb +7 -1
- data/lib/knockapi/models/user_get_preferences_params.rb +15 -1
- data/lib/knockapi/models/user_list_messages_params.rb +8 -1
- data/lib/knockapi/models/user_list_preferences_params.rb +7 -1
- data/lib/knockapi/models/user_list_schedules_params.rb +8 -1
- data/lib/knockapi/models/user_list_subscriptions_params.rb +8 -1
- data/lib/knockapi/models/user_merge_params.rb +8 -1
- data/lib/knockapi/models/user_set_channel_data_params.rb +13 -1
- data/lib/knockapi/models/user_set_preferences_params.rb +13 -1
- data/lib/knockapi/models/user_unset_channel_data_params.rb +13 -1
- data/lib/knockapi/models/user_update_params.rb +7 -1
- data/lib/knockapi/models/users/feed_get_settings_params.rb +13 -1
- data/lib/knockapi/models/users/feed_list_items_params.rb +15 -1
- data/lib/knockapi/models/users/guide_get_channel_params.rb +15 -1
- data/lib/knockapi/models/users/guide_mark_message_as_archived_params.rb +15 -1
- data/lib/knockapi/models/users/guide_mark_message_as_interacted_params.rb +15 -1
- data/lib/knockapi/models/users/guide_mark_message_as_seen_params.rb +15 -1
- data/lib/knockapi/models/workflow_cancel_params.rb +8 -1
- data/lib/knockapi/models/workflow_trigger_params.rb +8 -1
- data/lib/knockapi/resources/audiences.rb +4 -2
- data/lib/knockapi/resources/bulk_operations.rb +2 -0
- data/lib/knockapi/resources/channels/bulk.rb +2 -0
- data/lib/knockapi/resources/channels.rb +2 -0
- data/lib/knockapi/resources/messages/batch.rb +3 -1
- data/lib/knockapi/resources/messages.rb +10 -4
- data/lib/knockapi/resources/objects/bulk.rb +2 -0
- data/lib/knockapi/resources/objects.rb +11 -4
- data/lib/knockapi/resources/providers/ms_teams.rb +10 -4
- data/lib/knockapi/resources/providers/slack.rb +8 -3
- data/lib/knockapi/resources/providers.rb +4 -0
- data/lib/knockapi/resources/schedules/bulk.rb +2 -0
- data/lib/knockapi/resources/schedules.rb +6 -1
- data/lib/knockapi/resources/tenants/bulk.rb +4 -1
- data/lib/knockapi/resources/tenants.rb +11 -4
- data/lib/knockapi/resources/users/bulk.rb +2 -0
- data/lib/knockapi/resources/users/feeds.rb +4 -1
- data/lib/knockapi/resources/users/guides.rb +4 -1
- data/lib/knockapi/resources/users.rb +18 -5
- data/lib/knockapi/resources/workflows.rb +2 -0
- data/lib/knockapi/version.rb +1 -1
- data/rbi/knockapi/client.rbi +13 -0
- data/rbi/knockapi/internal/util.rbi +20 -0
- data/rbi/knockapi/models/audience_add_members_params.rbi +6 -0
- data/rbi/knockapi/models/audience_list_members_params.rbi +13 -5
- data/rbi/knockapi/models/audience_remove_members_params.rbi +6 -0
- data/rbi/knockapi/models/bulk_operation_get_params.rbi +13 -5
- data/rbi/knockapi/models/channels/bulk_update_message_status_params.rbi +18 -0
- data/rbi/knockapi/models/condition.rbi +2 -0
- data/rbi/knockapi/models/message_archive_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_content_params.rbi +13 -5
- data/rbi/knockapi/models/message_get_params.rbi +13 -5
- data/rbi/knockapi/models/message_list_activities_params.rbi +6 -0
- data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +6 -0
- data/rbi/knockapi/models/message_list_events_params.rbi +6 -0
- data/rbi/knockapi/models/message_mark_as_interacted_params.rbi +6 -0
- 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 +13 -5
- data/rbi/knockapi/models/message_mark_as_unseen_params.rbi +13 -5
- data/rbi/knockapi/models/message_unarchive_params.rbi +13 -5
- data/rbi/knockapi/models/object_add_subscriptions_params.rbi +12 -0
- data/rbi/knockapi/models/object_delete_params.rbi +21 -5
- data/rbi/knockapi/models/object_delete_subscriptions_params.rbi +12 -0
- data/rbi/knockapi/models/object_get_channel_data_params.rbi +26 -5
- data/rbi/knockapi/models/object_get_params.rbi +21 -5
- data/rbi/knockapi/models/object_get_preferences_params.rbi +26 -5
- data/rbi/knockapi/models/object_list_messages_params.rbi +12 -0
- data/rbi/knockapi/models/object_list_params.rbi +6 -0
- data/rbi/knockapi/models/object_list_preferences_params.rbi +21 -5
- data/rbi/knockapi/models/object_list_schedules_params.rbi +12 -0
- data/rbi/knockapi/models/object_list_subscriptions_params.rbi +12 -0
- data/rbi/knockapi/models/object_set_channel_data_params.rbi +26 -5
- data/rbi/knockapi/models/object_set_params.rbi +12 -0
- data/rbi/knockapi/models/object_set_preferences_params.rbi +26 -5
- data/rbi/knockapi/models/object_unset_channel_data_params.rbi +26 -5
- data/rbi/knockapi/models/objects/bulk_add_subscriptions_params.rbi +6 -0
- data/rbi/knockapi/models/objects/bulk_delete_params.rbi +6 -0
- data/rbi/knockapi/models/objects/bulk_delete_subscriptions_params.rbi +6 -0
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +6 -0
- data/rbi/knockapi/models/providers/ms_team_check_auth_params.rbi +6 -0
- data/rbi/knockapi/models/providers/ms_team_list_channels_params.rbi +6 -0
- data/rbi/knockapi/models/providers/ms_team_list_teams_params.rbi +6 -0
- data/rbi/knockapi/models/providers/ms_team_revoke_access_params.rbi +6 -0
- data/rbi/knockapi/models/providers/slack_check_auth_params.rbi +6 -0
- data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +6 -0
- data/rbi/knockapi/models/providers/slack_revoke_access_params.rbi +6 -0
- data/rbi/knockapi/models/tenant_delete_params.rbi +13 -5
- data/rbi/knockapi/models/tenant_get_params.rbi +6 -0
- data/rbi/knockapi/models/tenant_set_params.rbi +6 -0
- data/rbi/knockapi/models/user_delete_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_channel_data_params.rbi +21 -5
- data/rbi/knockapi/models/user_get_params.rbi +13 -5
- data/rbi/knockapi/models/user_get_preferences_params.rbi +16 -1
- data/rbi/knockapi/models/user_list_messages_params.rbi +6 -0
- data/rbi/knockapi/models/user_list_preferences_params.rbi +13 -5
- data/rbi/knockapi/models/user_list_schedules_params.rbi +6 -0
- data/rbi/knockapi/models/user_list_subscriptions_params.rbi +6 -0
- data/rbi/knockapi/models/user_merge_params.rbi +10 -1
- data/rbi/knockapi/models/user_set_channel_data_params.rbi +21 -5
- data/rbi/knockapi/models/user_set_preferences_params.rbi +21 -5
- data/rbi/knockapi/models/user_unset_channel_data_params.rbi +21 -5
- data/rbi/knockapi/models/user_update_params.rbi +13 -5
- data/rbi/knockapi/models/users/feed_get_settings_params.rbi +21 -5
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +12 -0
- data/rbi/knockapi/models/users/guide_get_channel_params.rbi +12 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_archived_params.rbi +12 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_interacted_params.rbi +12 -0
- data/rbi/knockapi/models/users/guide_mark_message_as_seen_params.rbi +12 -0
- data/rbi/knockapi/models/workflow_cancel_params.rbi +6 -0
- data/rbi/knockapi/models/workflow_trigger_params.rbi +6 -0
- data/rbi/knockapi/resources/audiences.rbi +1 -0
- data/rbi/knockapi/resources/bulk_operations.rbi +2 -0
- data/rbi/knockapi/resources/channels/bulk.rbi +2 -0
- data/rbi/knockapi/resources/channels.rbi +2 -0
- data/rbi/knockapi/resources/messages/batch.rbi +1 -0
- data/rbi/knockapi/resources/messages.rbi +2 -0
- data/rbi/knockapi/resources/objects/bulk.rbi +2 -0
- data/rbi/knockapi/resources/objects.rbi +3 -0
- data/rbi/knockapi/resources/providers/ms_teams.rbi +2 -0
- data/rbi/knockapi/resources/providers/slack.rbi +2 -0
- data/rbi/knockapi/resources/providers.rbi +4 -0
- data/rbi/knockapi/resources/schedules/bulk.rbi +2 -0
- data/rbi/knockapi/resources/schedules.rbi +4 -0
- data/rbi/knockapi/resources/tenants/bulk.rbi +2 -0
- data/rbi/knockapi/resources/tenants.rbi +4 -0
- data/rbi/knockapi/resources/users/bulk.rbi +2 -0
- data/rbi/knockapi/resources/users/feeds.rbi +2 -0
- data/rbi/knockapi/resources/users/guides.rbi +2 -0
- data/rbi/knockapi/resources/users.rbi +8 -0
- data/rbi/knockapi/resources/workflows.rbi +2 -0
- data/sig/knockapi/internal/util.rbs +10 -0
- data/sig/knockapi/models/audience_add_members_params.rbs +5 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +8 -3
- data/sig/knockapi/models/audience_remove_members_params.rbs +8 -1
- data/sig/knockapi/models/bulk_operation_get_params.rbs +8 -3
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +10 -0
- data/sig/knockapi/models/condition.rbs +2 -0
- data/sig/knockapi/models/message_archive_params.rbs +11 -3
- data/sig/knockapi/models/message_get_content_params.rbs +11 -3
- data/sig/knockapi/models/message_get_params.rbs +11 -3
- data/sig/knockapi/models/message_list_activities_params.rbs +5 -0
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +5 -1
- data/sig/knockapi/models/message_list_events_params.rbs +5 -1
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -1
- data/sig/knockapi/models/message_mark_as_read_params.rbs +11 -3
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +11 -3
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +11 -3
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +11 -3
- data/sig/knockapi/models/message_unarchive_params.rbs +11 -3
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +10 -0
- data/sig/knockapi/models/object_delete_params.rbs +16 -3
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +13 -1
- data/sig/knockapi/models/object_get_channel_data_params.rbs +20 -3
- data/sig/knockapi/models/object_get_params.rbs +17 -3
- data/sig/knockapi/models/object_get_preferences_params.rbs +20 -3
- data/sig/knockapi/models/object_list_messages_params.rbs +10 -0
- data/sig/knockapi/models/object_list_params.rbs +5 -0
- data/sig/knockapi/models/object_list_preferences_params.rbs +16 -3
- data/sig/knockapi/models/object_list_schedules_params.rbs +10 -0
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +10 -0
- data/sig/knockapi/models/object_set_channel_data_params.rbs +26 -3
- data/sig/knockapi/models/object_set_params.rbs +10 -0
- data/sig/knockapi/models/object_set_preferences_params.rbs +26 -3
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +20 -3
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -1
- data/sig/knockapi/models/objects/bulk_delete_subscriptions_params.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +8 -1
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -1
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -1
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -1
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +5 -0
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -1
- data/sig/knockapi/models/tenant_delete_params.rbs +8 -3
- data/sig/knockapi/models/tenant_get_params.rbs +5 -1
- data/sig/knockapi/models/tenant_set_params.rbs +5 -0
- data/sig/knockapi/models/user_delete_params.rbs +11 -3
- data/sig/knockapi/models/user_get_channel_data_params.rbs +16 -3
- data/sig/knockapi/models/user_get_params.rbs +12 -3
- data/sig/knockapi/models/user_get_preferences_params.rbs +10 -1
- data/sig/knockapi/models/user_list_messages_params.rbs +5 -0
- data/sig/knockapi/models/user_list_preferences_params.rbs +11 -3
- data/sig/knockapi/models/user_list_schedules_params.rbs +5 -0
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +5 -0
- data/sig/knockapi/models/user_merge_params.rbs +6 -1
- data/sig/knockapi/models/user_set_channel_data_params.rbs +20 -3
- data/sig/knockapi/models/user_set_preferences_params.rbs +20 -3
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +16 -3
- data/sig/knockapi/models/user_update_params.rbs +13 -3
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +16 -3
- data/sig/knockapi/models/users/feed_list_items_params.rbs +10 -0
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +15 -1
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +10 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +10 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +10 -0
- data/sig/knockapi/models/workflow_cancel_params.rbs +5 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +5 -0
- metadata +2 -2
|
@@ -7,13 +7,27 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!attribute id
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :id, String
|
|
19
|
+
|
|
10
20
|
# @!attribute tenant
|
|
11
21
|
# The unique identifier for the tenant.
|
|
12
22
|
#
|
|
13
23
|
# @return [String, nil]
|
|
14
24
|
optional :tenant, String
|
|
15
25
|
|
|
16
|
-
# @!method initialize(tenant: nil, request_options: {})
|
|
26
|
+
# @!method initialize(user_id:, id:, tenant: nil, request_options: {})
|
|
27
|
+
# @param user_id [String]
|
|
28
|
+
#
|
|
29
|
+
# @param id [String]
|
|
30
|
+
#
|
|
17
31
|
# @param tenant [String] The unique identifier for the tenant.
|
|
18
32
|
#
|
|
19
33
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,6 +7,11 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute after
|
|
11
16
|
# The cursor to fetch entries after.
|
|
12
17
|
#
|
|
@@ -95,10 +100,12 @@ module Knockapi
|
|
|
95
100
|
# @return [String, nil]
|
|
96
101
|
optional :workflow_run_id, String
|
|
97
102
|
|
|
98
|
-
# @!method initialize(after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
|
|
103
|
+
# @!method initialize(user_id:, after: nil, before: nil, channel_id: nil, engagement_status: nil, inserted_at: nil, message_ids: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, workflow_recipient_run_id: nil, workflow_run_id: nil, request_options: {})
|
|
99
104
|
# Some parameter documentations has been truncated, see
|
|
100
105
|
# {Knockapi::Models::UserListMessagesParams} for more details.
|
|
101
106
|
#
|
|
107
|
+
# @param user_id [String]
|
|
108
|
+
#
|
|
102
109
|
# @param after [String] The cursor to fetch entries after.
|
|
103
110
|
#
|
|
104
111
|
# @param before [String] The cursor to fetch entries before.
|
|
@@ -7,7 +7,13 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(user_id:, request_options: {})
|
|
16
|
+
# @param user_id [String]
|
|
11
17
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -7,6 +7,11 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute after
|
|
11
16
|
# The cursor to fetch entries after.
|
|
12
17
|
#
|
|
@@ -37,7 +42,9 @@ module Knockapi
|
|
|
37
42
|
# @return [String, nil]
|
|
38
43
|
optional :workflow, String
|
|
39
44
|
|
|
40
|
-
# @!method initialize(after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
|
|
45
|
+
# @!method initialize(user_id:, after: nil, before: nil, page_size: nil, tenant: nil, workflow: nil, request_options: {})
|
|
46
|
+
# @param user_id [String]
|
|
47
|
+
#
|
|
41
48
|
# @param after [String] The cursor to fetch entries after.
|
|
42
49
|
#
|
|
43
50
|
# @param before [String] The cursor to fetch entries before.
|
|
@@ -7,6 +7,11 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute after
|
|
11
16
|
# The cursor to fetch entries after.
|
|
12
17
|
#
|
|
@@ -38,7 +43,9 @@ module Knockapi
|
|
|
38
43
|
# @return [Integer, nil]
|
|
39
44
|
optional :page_size, Integer
|
|
40
45
|
|
|
41
|
-
# @!method initialize(after: nil, before: nil, include: nil, objects: nil, page_size: nil, request_options: {})
|
|
46
|
+
# @!method initialize(user_id:, after: nil, before: nil, include: nil, objects: nil, page_size: nil, request_options: {})
|
|
47
|
+
# @param user_id [String]
|
|
48
|
+
#
|
|
42
49
|
# @param after [String] The cursor to fetch entries after.
|
|
43
50
|
#
|
|
44
51
|
# @param before [String] The cursor to fetch entries before.
|
|
@@ -7,13 +7,20 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
10
15
|
# @!attribute from_user_id
|
|
11
16
|
# The user ID to merge from.
|
|
12
17
|
#
|
|
13
18
|
# @return [String]
|
|
14
19
|
required :from_user_id, String
|
|
15
20
|
|
|
16
|
-
# @!method initialize(from_user_id:, request_options: {})
|
|
21
|
+
# @!method initialize(user_id:, from_user_id:, request_options: {})
|
|
22
|
+
# @param user_id [String]
|
|
23
|
+
#
|
|
17
24
|
# @param from_user_id [String] The user ID to merge from.
|
|
18
25
|
#
|
|
19
26
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -7,7 +7,19 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!attribute channel_id
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :channel_id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(user_id:, channel_id:, request_options: {})
|
|
21
|
+
# @param user_id [String]
|
|
22
|
+
# @param channel_id [String]
|
|
11
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
12
24
|
end
|
|
13
25
|
end
|
|
@@ -7,7 +7,19 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!attribute id
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(user_id:, id:, request_options: {})
|
|
21
|
+
# @param user_id [String]
|
|
22
|
+
# @param id [String]
|
|
11
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
12
24
|
end
|
|
13
25
|
end
|
|
@@ -7,7 +7,19 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!attribute channel_id
|
|
16
|
+
#
|
|
17
|
+
# @return [String]
|
|
18
|
+
required :channel_id, String
|
|
19
|
+
|
|
20
|
+
# @!method initialize(user_id:, channel_id:, request_options: {})
|
|
21
|
+
# @param user_id [String]
|
|
22
|
+
# @param channel_id [String]
|
|
11
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
12
24
|
end
|
|
13
25
|
end
|
|
@@ -7,7 +7,13 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
-
# @!
|
|
10
|
+
# @!attribute user_id
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :user_id, String
|
|
14
|
+
|
|
15
|
+
# @!method initialize(user_id:, request_options: {})
|
|
16
|
+
# @param user_id [String]
|
|
11
17
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
12
18
|
end
|
|
13
19
|
end
|
|
@@ -8,7 +8,19 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
-
# @!
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :id, String
|
|
20
|
+
|
|
21
|
+
# @!method initialize(user_id:, id:, request_options: {})
|
|
22
|
+
# @param user_id [String]
|
|
23
|
+
# @param id [String]
|
|
12
24
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
|
13
25
|
end
|
|
14
26
|
end
|
|
@@ -8,6 +8,16 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :id, String
|
|
20
|
+
|
|
11
21
|
# @!attribute after
|
|
12
22
|
# The cursor to fetch entries after.
|
|
13
23
|
#
|
|
@@ -99,10 +109,14 @@ module Knockapi
|
|
|
99
109
|
# @return [Array<String>, nil]
|
|
100
110
|
optional :workflow_categories, Knockapi::Internal::Type::ArrayOf[String]
|
|
101
111
|
|
|
102
|
-
# @!method initialize(after: nil, archived: nil, before: nil, exclude: nil, has_tenant: nil, inserted_at: nil, locale: nil, mode: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
|
|
112
|
+
# @!method initialize(user_id:, id:, after: nil, archived: nil, before: nil, exclude: nil, has_tenant: nil, inserted_at: nil, locale: nil, mode: nil, page_size: nil, source: nil, status: nil, tenant: nil, trigger_data: nil, workflow_categories: nil, request_options: {})
|
|
103
113
|
# Some parameter documentations has been truncated, see
|
|
104
114
|
# {Knockapi::Models::Users::FeedListItemsParams} for more details.
|
|
105
115
|
#
|
|
116
|
+
# @param user_id [String]
|
|
117
|
+
#
|
|
118
|
+
# @param id [String]
|
|
119
|
+
#
|
|
106
120
|
# @param after [String] The cursor to fetch entries after.
|
|
107
121
|
#
|
|
108
122
|
# @param archived [Symbol, Knockapi::Models::Users::FeedListItemsParams::Archived] The archived status of the feed items.
|
|
@@ -8,6 +8,16 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute channel_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :channel_id, String
|
|
20
|
+
|
|
11
21
|
# @!attribute data
|
|
12
22
|
# The data (JSON encoded object) to use for targeting and rendering guides.
|
|
13
23
|
#
|
|
@@ -26,7 +36,11 @@ module Knockapi
|
|
|
26
36
|
# @return [String, nil]
|
|
27
37
|
optional :type, String
|
|
28
38
|
|
|
29
|
-
# @!method initialize(data: nil, tenant: nil, type: nil, request_options: {})
|
|
39
|
+
# @!method initialize(user_id:, channel_id:, data: nil, tenant: nil, type: nil, request_options: {})
|
|
40
|
+
# @param user_id [String]
|
|
41
|
+
#
|
|
42
|
+
# @param channel_id [String]
|
|
43
|
+
#
|
|
30
44
|
# @param data [String] The data (JSON encoded object) to use for targeting and rendering guides.
|
|
31
45
|
#
|
|
32
46
|
# @param tenant [String] The tenant ID to use for targeting and rendering guides.
|
|
@@ -8,6 +8,16 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute message_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :message_id, String
|
|
20
|
+
|
|
11
21
|
# @!attribute channel_id
|
|
12
22
|
# The unique identifier for the channel.
|
|
13
23
|
#
|
|
@@ -62,7 +72,11 @@ module Knockapi
|
|
|
62
72
|
# @return [String, nil]
|
|
63
73
|
optional :tenant, String, nil?: true
|
|
64
74
|
|
|
65
|
-
# @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
75
|
+
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
76
|
+
# @param user_id [String]
|
|
77
|
+
#
|
|
78
|
+
# @param message_id [String]
|
|
79
|
+
#
|
|
66
80
|
# @param channel_id [String] The unique identifier for the channel.
|
|
67
81
|
#
|
|
68
82
|
# @param guide_id [String] The unique identifier for the guide.
|
|
@@ -8,6 +8,16 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute message_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :message_id, String
|
|
20
|
+
|
|
11
21
|
# @!attribute channel_id
|
|
12
22
|
# The unique identifier for the channel.
|
|
13
23
|
#
|
|
@@ -62,7 +72,11 @@ module Knockapi
|
|
|
62
72
|
# @return [String, nil]
|
|
63
73
|
optional :tenant, String, nil?: true
|
|
64
74
|
|
|
65
|
-
# @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
75
|
+
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
76
|
+
# @param user_id [String]
|
|
77
|
+
#
|
|
78
|
+
# @param message_id [String]
|
|
79
|
+
#
|
|
66
80
|
# @param channel_id [String] The unique identifier for the channel.
|
|
67
81
|
#
|
|
68
82
|
# @param guide_id [String] The unique identifier for the guide.
|
|
@@ -8,6 +8,16 @@ module Knockapi
|
|
|
8
8
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
9
9
|
include Knockapi::Internal::Type::RequestParameters
|
|
10
10
|
|
|
11
|
+
# @!attribute user_id
|
|
12
|
+
#
|
|
13
|
+
# @return [String]
|
|
14
|
+
required :user_id, String
|
|
15
|
+
|
|
16
|
+
# @!attribute message_id
|
|
17
|
+
#
|
|
18
|
+
# @return [String]
|
|
19
|
+
required :message_id, String
|
|
20
|
+
|
|
11
21
|
# @!attribute channel_id
|
|
12
22
|
# The unique identifier for the channel.
|
|
13
23
|
#
|
|
@@ -62,7 +72,11 @@ module Knockapi
|
|
|
62
72
|
# @return [String, nil]
|
|
63
73
|
optional :tenant, String, nil?: true
|
|
64
74
|
|
|
65
|
-
# @!method initialize(channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
75
|
+
# @!method initialize(user_id:, message_id:, channel_id:, guide_id:, guide_key:, guide_step_ref:, content: nil, data: nil, is_final: nil, metadata: nil, tenant: nil, request_options: {})
|
|
76
|
+
# @param user_id [String]
|
|
77
|
+
#
|
|
78
|
+
# @param message_id [String]
|
|
79
|
+
#
|
|
66
80
|
# @param channel_id [String] The unique identifier for the channel.
|
|
67
81
|
#
|
|
68
82
|
# @param guide_id [String] The unique identifier for the guide.
|
|
@@ -7,6 +7,11 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute key
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :key, String
|
|
14
|
+
|
|
10
15
|
# @!attribute cancellation_key
|
|
11
16
|
# An optional key that is used to reference a specific workflow trigger request
|
|
12
17
|
# when issuing a [workflow cancellation](/send-notifications/canceling-workflows)
|
|
@@ -26,10 +31,12 @@ module Knockapi
|
|
|
26
31
|
-> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] },
|
|
27
32
|
nil?: true
|
|
28
33
|
|
|
29
|
-
# @!method initialize(cancellation_key:, recipients: nil, request_options: {})
|
|
34
|
+
# @!method initialize(key:, cancellation_key:, recipients: nil, request_options: {})
|
|
30
35
|
# Some parameter documentations has been truncated, see
|
|
31
36
|
# {Knockapi::Models::WorkflowCancelParams} for more details.
|
|
32
37
|
#
|
|
38
|
+
# @param key [String]
|
|
39
|
+
#
|
|
33
40
|
# @param cancellation_key [String] An optional key that is used to reference a specific workflow trigger request wh
|
|
34
41
|
#
|
|
35
42
|
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil] A list of recipients to cancel the notification for. If omitted, cancels for all
|
|
@@ -7,6 +7,11 @@ module Knockapi
|
|
|
7
7
|
extend Knockapi::Internal::Type::RequestParameters::Converter
|
|
8
8
|
include Knockapi::Internal::Type::RequestParameters
|
|
9
9
|
|
|
10
|
+
# @!attribute key
|
|
11
|
+
#
|
|
12
|
+
# @return [String]
|
|
13
|
+
required :key, String
|
|
14
|
+
|
|
10
15
|
# @!attribute recipients
|
|
11
16
|
# The recipients to trigger the workflow for. Can inline identify users, objects,
|
|
12
17
|
# or use a list of user IDs. Limited to 1,000 recipients.
|
|
@@ -47,10 +52,12 @@ module Knockapi
|
|
|
47
52
|
# @return [String, Knockapi::Models::TenantRequest, nil]
|
|
48
53
|
optional :tenant, union: -> { Knockapi::InlineTenantRequest }, nil?: true
|
|
49
54
|
|
|
50
|
-
# @!method initialize(recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
|
|
55
|
+
# @!method initialize(key:, recipients:, actor: nil, cancellation_key: nil, data: nil, tenant: nil, request_options: {})
|
|
51
56
|
# Some parameter documentations has been truncated, see
|
|
52
57
|
# {Knockapi::Models::WorkflowTriggerParams} for more details.
|
|
53
58
|
#
|
|
59
|
+
# @param key [String]
|
|
60
|
+
#
|
|
54
61
|
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients to trigger the workflow for. Can inline identify users, objects,
|
|
55
62
|
#
|
|
56
63
|
# @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
|
+
# An Audience is a segment of users.
|
|
5
6
|
class Audiences
|
|
6
7
|
# Some parameter documentations has been truncated, see
|
|
7
8
|
# {Knockapi::Models::AudienceAddMembersParams} for more details.
|
|
@@ -22,12 +23,13 @@ module Knockapi
|
|
|
22
23
|
#
|
|
23
24
|
# @see Knockapi::Models::AudienceAddMembersParams
|
|
24
25
|
def add_members(key, params)
|
|
25
|
-
parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
|
|
26
26
|
query_params = [:create_audience]
|
|
27
|
+
parsed, options = Knockapi::AudienceAddMembersParams.dump_request(params)
|
|
28
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed.slice(*query_params))
|
|
27
29
|
@client.request(
|
|
28
30
|
method: :post,
|
|
29
31
|
path: ["v1/audiences/%1$s/members", key],
|
|
30
|
-
query:
|
|
32
|
+
query: query,
|
|
31
33
|
body: parsed.except(*query_params),
|
|
32
34
|
model: NilClass,
|
|
33
35
|
options: options
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
|
+
# A bulk operation is a set of changes applied across zero or more records
|
|
6
|
+
# triggered via a call to the Knock API and performed asynchronously.
|
|
5
7
|
class BulkOperations
|
|
6
8
|
# Retrieves a bulk operation (if it exists) and displays the current state of it.
|
|
7
9
|
#
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
5
|
class Channels
|
|
6
|
+
# A bulk operation is a set of changes applied across zero or more records
|
|
7
|
+
# triggered via a call to the Knock API and performed asynchronously.
|
|
6
8
|
class Bulk
|
|
7
9
|
# Some parameter documentations has been truncated, see
|
|
8
10
|
# {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
5
|
class Channels
|
|
6
|
+
# A bulk operation is a set of changes applied across zero or more records
|
|
7
|
+
# triggered via a call to the Knock API and performed asynchronously.
|
|
6
8
|
# @return [Knockapi::Resources::Channels::Bulk]
|
|
7
9
|
attr_reader :bulk
|
|
8
10
|
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
5
|
class Messages
|
|
6
|
+
# A message sent to a single recipient on a channel.
|
|
6
7
|
class Batch
|
|
7
8
|
# Marks the given messages as archived. Archived messages are hidden from the
|
|
8
9
|
# default message list in the feed but can still be accessed and unarchived later.
|
|
@@ -40,10 +41,11 @@ module Knockapi
|
|
|
40
41
|
# @see Knockapi::Models::Messages::BatchGetContentParams
|
|
41
42
|
def get_content(params)
|
|
42
43
|
parsed, options = Knockapi::Messages::BatchGetContentParams.dump_request(params)
|
|
44
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
43
45
|
@client.request(
|
|
44
46
|
method: :get,
|
|
45
47
|
path: "v1/messages/batch/content",
|
|
46
|
-
query:
|
|
48
|
+
query: query,
|
|
47
49
|
model: Knockapi::Internal::Type::ArrayOf[Knockapi::Models::Messages::BatchGetContentResponseItem],
|
|
48
50
|
options: options
|
|
49
51
|
)
|
|
@@ -2,7 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
|
+
# A message sent to a single recipient on a channel.
|
|
5
6
|
class Messages
|
|
7
|
+
# A message sent to a single recipient on a channel.
|
|
6
8
|
# @return [Knockapi::Resources::Messages::Batch]
|
|
7
9
|
attr_reader :batch
|
|
8
10
|
|
|
@@ -48,10 +50,11 @@ module Knockapi
|
|
|
48
50
|
# @see Knockapi::Models::MessageListParams
|
|
49
51
|
def list(params = {})
|
|
50
52
|
parsed, options = Knockapi::MessageListParams.dump_request(params)
|
|
53
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
51
54
|
@client.request(
|
|
52
55
|
method: :get,
|
|
53
56
|
path: "v1/messages",
|
|
54
|
-
query:
|
|
57
|
+
query: query,
|
|
55
58
|
page: Knockapi::Internal::ItemsCursor,
|
|
56
59
|
model: Knockapi::Message,
|
|
57
60
|
options: options
|
|
@@ -141,10 +144,11 @@ module Knockapi
|
|
|
141
144
|
# @see Knockapi::Models::MessageListActivitiesParams
|
|
142
145
|
def list_activities(message_id, params = {})
|
|
143
146
|
parsed, options = Knockapi::MessageListActivitiesParams.dump_request(params)
|
|
147
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
144
148
|
@client.request(
|
|
145
149
|
method: :get,
|
|
146
150
|
path: ["v1/messages/%1$s/activities", message_id],
|
|
147
|
-
query:
|
|
151
|
+
query: query,
|
|
148
152
|
page: Knockapi::Internal::ItemsCursor,
|
|
149
153
|
model: Knockapi::Activity,
|
|
150
154
|
options: options
|
|
@@ -170,10 +174,11 @@ module Knockapi
|
|
|
170
174
|
# @see Knockapi::Models::MessageListDeliveryLogsParams
|
|
171
175
|
def list_delivery_logs(message_id, params = {})
|
|
172
176
|
parsed, options = Knockapi::MessageListDeliveryLogsParams.dump_request(params)
|
|
177
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
173
178
|
@client.request(
|
|
174
179
|
method: :get,
|
|
175
180
|
path: ["v1/messages/%1$s/delivery_logs", message_id],
|
|
176
|
-
query:
|
|
181
|
+
query: query,
|
|
177
182
|
page: Knockapi::Internal::ItemsCursor,
|
|
178
183
|
model: Knockapi::MessageDeliveryLog,
|
|
179
184
|
options: options
|
|
@@ -199,10 +204,11 @@ module Knockapi
|
|
|
199
204
|
# @see Knockapi::Models::MessageListEventsParams
|
|
200
205
|
def list_events(message_id, params = {})
|
|
201
206
|
parsed, options = Knockapi::MessageListEventsParams.dump_request(params)
|
|
207
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
202
208
|
@client.request(
|
|
203
209
|
method: :get,
|
|
204
210
|
path: ["v1/messages/%1$s/events", message_id],
|
|
205
|
-
query:
|
|
211
|
+
query: query,
|
|
206
212
|
page: Knockapi::Internal::ItemsCursor,
|
|
207
213
|
model: Knockapi::MessageEvent,
|
|
208
214
|
options: options
|
|
@@ -3,6 +3,8 @@
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
5
|
class Objects
|
|
6
|
+
# A bulk operation is a set of changes applied across zero or more records
|
|
7
|
+
# triggered via a call to the Knock API and performed asynchronously.
|
|
6
8
|
class Bulk
|
|
7
9
|
# Bulk deletes objects from the specified collection.
|
|
8
10
|
#
|
|
@@ -2,7 +2,10 @@
|
|
|
2
2
|
|
|
3
3
|
module Knockapi
|
|
4
4
|
module Resources
|
|
5
|
+
# An object represents a resource in your system that you want to map into Knock.
|
|
5
6
|
class Objects
|
|
7
|
+
# A bulk operation is a set of changes applied across zero or more records
|
|
8
|
+
# triggered via a call to the Knock API and performed asynchronously.
|
|
6
9
|
# @return [Knockapi::Resources::Objects::Bulk]
|
|
7
10
|
attr_reader :bulk
|
|
8
11
|
|
|
@@ -28,10 +31,11 @@ module Knockapi
|
|
|
28
31
|
# @see Knockapi::Models::ObjectListParams
|
|
29
32
|
def list(collection, params = {})
|
|
30
33
|
parsed, options = Knockapi::ObjectListParams.dump_request(params)
|
|
34
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
31
35
|
@client.request(
|
|
32
36
|
method: :get,
|
|
33
37
|
path: ["v1/objects/%1$s", collection],
|
|
34
|
-
query:
|
|
38
|
+
query: query,
|
|
35
39
|
page: Knockapi::Internal::EntriesCursor,
|
|
36
40
|
model: Knockapi::Object,
|
|
37
41
|
options: options
|
|
@@ -244,10 +248,11 @@ module Knockapi
|
|
|
244
248
|
# @see Knockapi::Models::ObjectListMessagesParams
|
|
245
249
|
def list_messages(collection, id, params = {})
|
|
246
250
|
parsed, options = Knockapi::ObjectListMessagesParams.dump_request(params)
|
|
251
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
247
252
|
@client.request(
|
|
248
253
|
method: :get,
|
|
249
254
|
path: ["v1/objects/%1$s/%2$s/messages", collection, id],
|
|
250
|
-
query:
|
|
255
|
+
query: query,
|
|
251
256
|
page: Knockapi::Internal::ItemsCursor,
|
|
252
257
|
model: Knockapi::Message,
|
|
253
258
|
options: options
|
|
@@ -301,10 +306,11 @@ module Knockapi
|
|
|
301
306
|
# @see Knockapi::Models::ObjectListSchedulesParams
|
|
302
307
|
def list_schedules(collection, id, params = {})
|
|
303
308
|
parsed, options = Knockapi::ObjectListSchedulesParams.dump_request(params)
|
|
309
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
304
310
|
@client.request(
|
|
305
311
|
method: :get,
|
|
306
312
|
path: ["v1/objects/%1$s/%2$s/schedules", collection, id],
|
|
307
|
-
query:
|
|
313
|
+
query: query,
|
|
308
314
|
page: Knockapi::Internal::EntriesCursor,
|
|
309
315
|
model: Knockapi::Schedule,
|
|
310
316
|
options: options
|
|
@@ -345,10 +351,11 @@ module Knockapi
|
|
|
345
351
|
# @see Knockapi::Models::ObjectListSubscriptionsParams
|
|
346
352
|
def list_subscriptions(collection, object_id_, params = {})
|
|
347
353
|
parsed, options = Knockapi::ObjectListSubscriptionsParams.dump_request(params)
|
|
354
|
+
query = Knockapi::Internal::Util.encode_query_params(parsed)
|
|
348
355
|
@client.request(
|
|
349
356
|
method: :get,
|
|
350
357
|
path: ["v1/objects/%1$s/%2$s/subscriptions", collection, object_id_],
|
|
351
|
-
query:
|
|
358
|
+
query: query,
|
|
352
359
|
page: Knockapi::Internal::EntriesCursor,
|
|
353
360
|
model: Knockapi::Recipients::Subscription,
|
|
354
361
|
options: options
|