knockapi 1.2.0 → 1.3.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 +22 -0
- data/README.md +4 -4
- data/SECURITY.md +2 -2
- data/lib/knockapi/internal/items_cursor.rb +2 -2
- data/lib/knockapi/internal/util.rb +10 -2
- data/lib/knockapi/models/activity.rb +4 -4
- data/lib/knockapi/models/audience_add_members_params.rb +5 -5
- data/lib/knockapi/models/audience_list_members_response.rb +4 -4
- data/lib/knockapi/models/audience_member.rb +4 -4
- data/lib/knockapi/models/audience_remove_members_params.rb +5 -5
- data/lib/knockapi/models/bulk_operation.rb +5 -5
- data/lib/knockapi/models/channels/bulk_update_message_status_params.rb +6 -6
- data/lib/knockapi/models/condition.rb +3 -3
- data/lib/knockapi/models/identify_user_request.rb +5 -5
- data/lib/knockapi/models/inline_identify_user_request.rb +5 -5
- data/lib/knockapi/models/inline_object_request.rb +4 -4
- data/lib/knockapi/models/inline_tenant_request.rb +1 -1
- data/lib/knockapi/models/message.rb +14 -14
- data/lib/knockapi/models/message_delivery_log.rb +13 -13
- data/lib/knockapi/models/message_event.rb +7 -7
- data/lib/knockapi/models/message_list_params.rb +6 -6
- 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_add_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/object_delete_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/object_list_messages_params.rb +6 -6
- data/lib/knockapi/models/object_list_params.rb +2 -2
- data/lib/knockapi/models/object_list_subscriptions_params.rb +8 -8
- data/lib/knockapi/models/object_set_params.rb +4 -4
- data/lib/knockapi/models/objects/bulk_add_subscriptions_params.rb +6 -5
- data/lib/knockapi/models/objects/bulk_set_params.rb +2 -2
- data/lib/knockapi/models/providers/ms_team_list_channels_params.rb +4 -3
- data/lib/knockapi/models/providers/ms_team_list_teams_params.rb +4 -3
- data/lib/knockapi/models/providers/slack_list_channels_params.rb +4 -3
- data/lib/knockapi/models/recipient.rb +1 -1
- data/lib/knockapi/models/recipient_reference.rb +1 -1
- data/lib/knockapi/models/recipient_request.rb +1 -1
- data/lib/knockapi/models/recipients/channel_data.rb +7 -7
- data/lib/knockapi/models/recipients/channel_data_request.rb +4 -4
- data/lib/knockapi/models/recipients/discord_channel_data.rb +6 -6
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +1 -1
- data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +6 -6
- data/lib/knockapi/models/recipients/preference_set.rb +17 -17
- data/lib/knockapi/models/recipients/preference_set_channel_type_setting.rb +2 -2
- data/lib/knockapi/models/recipients/preference_set_channel_types.rb +24 -24
- data/lib/knockapi/models/recipients/preference_set_request.rb +17 -17
- data/lib/knockapi/models/recipients/slack_channel_data.rb +6 -6
- data/lib/knockapi/models/recipients/subscription.rb +4 -4
- data/lib/knockapi/models/schedule.rb +13 -10
- data/lib/knockapi/models/schedule_create_params.rb +14 -8
- data/lib/knockapi/models/schedule_repeat_rule.rb +5 -5
- data/lib/knockapi/models/schedule_update_params.rb +11 -8
- data/lib/knockapi/models/schedules/bulk_create_params.rb +16 -13
- data/lib/knockapi/models/tenant.rb +10 -10
- data/lib/knockapi/models/tenant_request.rb +13 -13
- data/lib/knockapi/models/tenant_set_params.rb +12 -12
- data/lib/knockapi/models/tenants/bulk_set_params.rb +2 -2
- data/lib/knockapi/models/user.rb +2 -2
- data/lib/knockapi/models/user_list_messages_params.rb +6 -6
- data/lib/knockapi/models/user_list_params.rb +2 -2
- data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
- data/lib/knockapi/models/users/bulk_identify_params.rb +2 -2
- data/lib/knockapi/models/users/bulk_set_preferences_params.rb +2 -2
- data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
- data/lib/knockapi/models/users/feed_list_items_response.rb +4 -4
- data/lib/knockapi/models/workflow_cancel_params.rb +2 -2
- data/lib/knockapi/models/workflow_trigger_params.rb +11 -8
- data/lib/knockapi/resources/audiences.rb +2 -2
- data/lib/knockapi/resources/bulk_operations.rb +1 -1
- data/lib/knockapi/resources/channels/bulk.rb +5 -5
- data/lib/knockapi/resources/messages/batch.rb +14 -14
- data/lib/knockapi/resources/messages.rb +18 -18
- data/lib/knockapi/resources/objects/bulk.rb +5 -5
- data/lib/knockapi/resources/objects.rb +30 -30
- data/lib/knockapi/resources/providers/ms_teams.rb +2 -2
- data/lib/knockapi/resources/providers/slack.rb +1 -1
- data/lib/knockapi/resources/schedules/bulk.rb +2 -2
- data/lib/knockapi/resources/schedules.rb +15 -12
- data/lib/knockapi/resources/tenants/bulk.rb +3 -3
- data/lib/knockapi/resources/tenants.rb +6 -6
- data/lib/knockapi/resources/users/bulk.rb +5 -5
- data/lib/knockapi/resources/users/feeds.rb +2 -2
- data/lib/knockapi/resources/users.rb +24 -24
- data/lib/knockapi/resources/workflows.rb +5 -5
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +3 -1
- data/rbi/knockapi/models/messages/batch_archive_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_interacted_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_read_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_seen_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unread_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_mark_as_unseen_response.rbi +1 -1
- data/rbi/knockapi/models/messages/batch_unarchive_response.rbi +1 -1
- data/rbi/knockapi/models/schedule.rbi +8 -2
- data/rbi/knockapi/models/schedule_create_params.rbi +8 -2
- data/rbi/knockapi/models/schedule_update_params.rbi +8 -2
- data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -2
- data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -2
- data/rbi/knockapi/resources/messages/batch.rbi +7 -7
- data/rbi/knockapi/resources/messages.rbi +3 -5
- data/rbi/knockapi/resources/objects.rbi +1 -1
- data/rbi/knockapi/resources/schedules.rbi +8 -2
- data/rbi/knockapi/resources/users.rbi +1 -1
- data/rbi/knockapi/resources/workflows.rbi +4 -1
- data/sig/knockapi/internal/entries_cursor.rbs +2 -0
- data/sig/knockapi/internal/items_cursor.rbs +2 -0
- data/sig/knockapi/models/activity.rbs +10 -0
- data/sig/knockapi/models/audience_add_members_params.rbs +12 -0
- data/sig/knockapi/models/audience_list_members_params.rbs +2 -0
- data/sig/knockapi/models/audience_list_members_response.rbs +5 -0
- data/sig/knockapi/models/audience_member.rbs +8 -0
- data/sig/knockapi/models/audience_remove_members_params.rbs +12 -0
- data/sig/knockapi/models/bulk_operation.rbs +24 -4
- data/sig/knockapi/models/bulk_operation_get_params.rbs +2 -0
- data/sig/knockapi/models/channels/bulk_update_message_status_params.rbs +14 -0
- data/sig/knockapi/models/condition.rbs +10 -4
- data/sig/knockapi/models/identify_user_request.rbs +12 -0
- data/sig/knockapi/models/inline_identify_user_request.rbs +13 -0
- data/sig/knockapi/models/inline_object_request.rbs +8 -0
- data/sig/knockapi/models/integrations/census_custom_destination_params.rbs +8 -0
- data/sig/knockapi/models/integrations/census_custom_destination_response.rbs +2 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_params.rbs +8 -0
- data/sig/knockapi/models/integrations/hightouch_embedded_destination_response.rbs +2 -0
- data/sig/knockapi/models/message.rbs +44 -11
- data/sig/knockapi/models/message_archive_params.rbs +2 -0
- data/sig/knockapi/models/message_delivery_log.rbs +43 -18
- data/sig/knockapi/models/message_event.rbs +13 -4
- data/sig/knockapi/models/message_get_content_params.rbs +2 -0
- data/sig/knockapi/models/message_get_content_response.rbs +68 -0
- data/sig/knockapi/models/message_get_params.rbs +2 -0
- data/sig/knockapi/models/message_list_activities_params.rbs +8 -0
- data/sig/knockapi/models/message_list_delivery_logs_params.rbs +7 -0
- data/sig/knockapi/models/message_list_events_params.rbs +7 -0
- data/sig/knockapi/models/message_list_params.rbs +32 -12
- data/sig/knockapi/models/message_mark_as_interacted_params.rbs +5 -0
- data/sig/knockapi/models/message_mark_as_read_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_seen_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_unread_params.rbs +2 -0
- data/sig/knockapi/models/message_mark_as_unseen_params.rbs +2 -0
- data/sig/knockapi/models/message_unarchive_params.rbs +2 -0
- data/sig/knockapi/models/messages/batch_archive_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_archive_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_get_content_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_get_content_response.rbs +72 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_params.rbs +6 -0
- data/sig/knockapi/models/messages/batch_mark_as_interacted_response.rbs +2 -1
- data/sig/knockapi/models/messages/batch_mark_as_read_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_read_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_seen_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_seen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unread_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_unread_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_mark_as_unseen_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_mark_as_unseen_response.rbs +1 -1
- data/sig/knockapi/models/messages/batch_unarchive_params.rbs +5 -0
- data/sig/knockapi/models/messages/batch_unarchive_response.rbs +1 -1
- data/sig/knockapi/models/object.rbs +9 -0
- data/sig/knockapi/models/object_add_subscriptions_params.rbs +6 -0
- data/sig/knockapi/models/object_delete_params.rbs +2 -0
- data/sig/knockapi/models/object_delete_subscriptions_params.rbs +5 -0
- data/sig/knockapi/models/object_get_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/object_get_params.rbs +2 -0
- data/sig/knockapi/models/object_get_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_list_messages_params.rbs +32 -12
- data/sig/knockapi/models/object_list_params.rbs +14 -6
- data/sig/knockapi/models/object_list_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_list_schedules_params.rbs +9 -0
- data/sig/knockapi/models/object_list_subscriptions_params.rbs +19 -6
- data/sig/knockapi/models/object_set_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/object_set_params.rbs +8 -0
- data/sig/knockapi/models/object_set_preferences_params.rbs +2 -0
- data/sig/knockapi/models/object_unset_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/objects/bulk_add_subscriptions_params.rbs +10 -0
- data/sig/knockapi/models/objects/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
- data/sig/knockapi/models/page_info.rbs +7 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_check_auth_response.rbs +6 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_params.rbs +9 -0
- data/sig/knockapi/models/providers/ms_team_list_channels_response.rbs +13 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_params.rbs +13 -0
- data/sig/knockapi/models/providers/ms_team_list_teams_response.rbs +6 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_params.rbs +5 -0
- data/sig/knockapi/models/providers/ms_team_revoke_access_response.rbs +2 -0
- data/sig/knockapi/models/providers/slack_check_auth_params.rbs +5 -0
- data/sig/knockapi/models/providers/slack_check_auth_response.rbs +6 -0
- data/sig/knockapi/models/providers/slack_list_channels_params.rbs +14 -0
- data/sig/knockapi/models/providers/slack_list_channels_response.rbs +8 -0
- data/sig/knockapi/models/providers/slack_revoke_access_params.rbs +5 -0
- data/sig/knockapi/models/providers/slack_revoke_access_response.rbs +2 -0
- data/sig/knockapi/models/recipient_reference.rbs +2 -0
- data/sig/knockapi/models/recipients/channel_data.rbs +17 -10
- data/sig/knockapi/models/recipients/channel_data_request.rbs +8 -4
- data/sig/knockapi/models/recipients/discord_channel_data.rbs +16 -4
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +2 -2
- data/sig/knockapi/models/recipients/ms_teams_channel_data.rbs +22 -4
- data/sig/knockapi/models/recipients/one_signal_channel_data.rbs +2 -0
- data/sig/knockapi/models/recipients/preference_set.rbs +25 -8
- data/sig/knockapi/models/recipients/preference_set_channel_type_setting.rbs +2 -0
- data/sig/knockapi/models/recipients/preference_set_channel_types.rbs +45 -36
- data/sig/knockapi/models/recipients/preference_set_request.rbs +24 -8
- data/sig/knockapi/models/recipients/push_channel_data.rbs +2 -0
- data/sig/knockapi/models/recipients/slack_channel_data.rbs +19 -4
- data/sig/knockapi/models/recipients/subscription.rbs +9 -0
- data/sig/knockapi/models/schedule.rbs +15 -0
- data/sig/knockapi/models/schedule_create_params.rbs +11 -0
- data/sig/knockapi/models/schedule_delete_params.rbs +5 -0
- data/sig/knockapi/models/schedule_list_params.rbs +10 -0
- data/sig/knockapi/models/schedule_repeat_rule.rbs +18 -8
- data/sig/knockapi/models/schedule_update_params.rbs +11 -0
- data/sig/knockapi/models/schedules/bulk_create_params.rbs +16 -0
- data/sig/knockapi/models/tenant.rbs +19 -0
- data/sig/knockapi/models/tenant_delete_params.rbs +2 -0
- data/sig/knockapi/models/tenant_get_params.rbs +2 -0
- data/sig/knockapi/models/tenant_list_params.rbs +9 -0
- data/sig/knockapi/models/tenant_request.rbs +19 -0
- data/sig/knockapi/models/tenant_set_params.rbs +19 -0
- data/sig/knockapi/models/tenants/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/tenants/bulk_set_params.rbs +5 -0
- data/sig/knockapi/models/user.rbs +12 -0
- data/sig/knockapi/models/user_delete_params.rbs +2 -0
- data/sig/knockapi/models/user_get_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_get_params.rbs +2 -0
- data/sig/knockapi/models/user_get_preferences_params.rbs +5 -0
- data/sig/knockapi/models/user_list_messages_params.rbs +32 -12
- data/sig/knockapi/models/user_list_params.rbs +14 -6
- data/sig/knockapi/models/user_list_preferences_params.rbs +2 -0
- data/sig/knockapi/models/user_list_schedules_params.rbs +9 -0
- data/sig/knockapi/models/user_list_subscriptions_params.rbs +15 -6
- data/sig/knockapi/models/user_merge_params.rbs +5 -0
- data/sig/knockapi/models/user_set_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_set_preferences_params.rbs +2 -0
- data/sig/knockapi/models/user_unset_channel_data_params.rbs +2 -0
- data/sig/knockapi/models/user_update_params.rbs +2 -0
- data/sig/knockapi/models/users/bulk_delete_params.rbs +5 -0
- data/sig/knockapi/models/users/bulk_identify_params.rbs +5 -0
- data/sig/knockapi/models/users/bulk_set_preferences_params.rbs +6 -0
- data/sig/knockapi/models/users/feed_get_settings_params.rbs +2 -0
- data/sig/knockapi/models/users/feed_get_settings_response.rbs +6 -0
- data/sig/knockapi/models/users/feed_list_items_params.rbs +14 -0
- data/sig/knockapi/models/users/feed_list_items_response.rbs +43 -0
- data/sig/knockapi/models/users/guide_get_channel_params.rbs +7 -0
- data/sig/knockapi/models/users/guide_get_channel_response.rbs +14 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_archived_response.rbs +2 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_interacted_response.rbs +2 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_params.rbs +13 -0
- data/sig/knockapi/models/users/guide_mark_message_as_seen_response.rbs +2 -0
- data/sig/knockapi/models/workflow_cancel_params.rbs +6 -0
- data/sig/knockapi/models/workflow_trigger_params.rbs +9 -0
- data/sig/knockapi/models/workflow_trigger_response.rbs +2 -0
- data/sig/knockapi/resources/messages.rbs +5 -5
- data/sig/knockapi/resources/objects.rbs +7 -7
- data/sig/knockapi/resources/users.rbs +7 -7
- metadata +2 -2
@@ -21,7 +21,7 @@ module Knockapi
|
|
21
21
|
# that can contain up to 10 actors if the message is produced from a
|
22
22
|
# [batch](/designing-workflows/batch-function).
|
23
23
|
#
|
24
|
-
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
24
|
+
# @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
|
25
25
|
optional :actors, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
26
26
|
|
27
27
|
# @!attribute archived_at
|
@@ -55,7 +55,7 @@ module Knockapi
|
|
55
55
|
# @!attribute engagement_statuses
|
56
56
|
# A list of engagement statuses.
|
57
57
|
#
|
58
|
-
# @return [Array<Symbol, Knockapi::Message::EngagementStatus>, nil]
|
58
|
+
# @return [Array<Symbol, Knockapi::Models::Message::EngagementStatus>, nil]
|
59
59
|
optional :engagement_statuses,
|
60
60
|
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::Message::EngagementStatus] }
|
61
61
|
|
@@ -93,7 +93,7 @@ module Knockapi
|
|
93
93
|
# A reference to a recipient, either a user identifier (string) or an object
|
94
94
|
# reference (ID, collection).
|
95
95
|
#
|
96
|
-
# @return [String, Knockapi::RecipientReference::ObjectReference, nil]
|
96
|
+
# @return [String, Knockapi::Models::RecipientReference::ObjectReference, nil]
|
97
97
|
optional :recipient, union: -> { Knockapi::RecipientReference }
|
98
98
|
|
99
99
|
# @!attribute scheduled_at
|
@@ -111,13 +111,13 @@ module Knockapi
|
|
111
111
|
# @!attribute source
|
112
112
|
# The workflow that triggered the message.
|
113
113
|
#
|
114
|
-
# @return [Knockapi::Message::Source, nil]
|
114
|
+
# @return [Knockapi::Models::Message::Source, nil]
|
115
115
|
optional :source, -> { Knockapi::Message::Source }
|
116
116
|
|
117
117
|
# @!attribute status
|
118
118
|
# The message delivery status.
|
119
119
|
#
|
120
|
-
# @return [Symbol, Knockapi::Message::Status, nil]
|
120
|
+
# @return [Symbol, Knockapi::Models::Message::Status, nil]
|
121
121
|
optional :status, enum: -> { Knockapi::Message::Status }
|
122
122
|
|
123
123
|
# @!attribute tenant
|
@@ -142,8 +142,8 @@ module Knockapi
|
|
142
142
|
optional :workflow, String, nil?: true
|
143
143
|
|
144
144
|
# @!method initialize(id: nil, _typename: nil, actors: nil, archived_at: nil, channel_id: nil, clicked_at: nil, data: nil, engagement_statuses: nil, inserted_at: nil, interacted_at: nil, link_clicked_at: nil, metadata: nil, read_at: nil, recipient: nil, scheduled_at: nil, seen_at: nil, source: nil, status: nil, tenant: nil, updated_at: nil, workflow: nil)
|
145
|
-
# Some parameter documentations has been truncated, see
|
146
|
-
# more details.
|
145
|
+
# Some parameter documentations has been truncated, see
|
146
|
+
# {Knockapi::Models::Message} for more details.
|
147
147
|
#
|
148
148
|
# Represents a single message that was generated by a workflow for a given
|
149
149
|
# channel.
|
@@ -152,7 +152,7 @@ module Knockapi
|
|
152
152
|
#
|
153
153
|
# @param _typename [String] The typename of the schema.
|
154
154
|
#
|
155
|
-
# @param actors [Array<String, Knockapi::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
|
155
|
+
# @param actors [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] One or more actors that are associated with this message. Note: this is a list t
|
156
156
|
#
|
157
157
|
# @param archived_at [Time, nil] Timestamp when the message was archived.
|
158
158
|
#
|
@@ -162,7 +162,7 @@ module Knockapi
|
|
162
162
|
#
|
163
163
|
# @param data [Hash{Symbol=>Object}, nil] Data associated with the message’s workflow run. Includes the workflow trigger r
|
164
164
|
#
|
165
|
-
# @param engagement_statuses [Array<Symbol, Knockapi::Message::EngagementStatus>] A list of engagement statuses.
|
165
|
+
# @param engagement_statuses [Array<Symbol, Knockapi::Models::Message::EngagementStatus>] A list of engagement statuses.
|
166
166
|
#
|
167
167
|
# @param inserted_at [Time] Timestamp when the resource was created.
|
168
168
|
#
|
@@ -174,15 +174,15 @@ module Knockapi
|
|
174
174
|
#
|
175
175
|
# @param read_at [Time, nil] Timestamp when the message was read.
|
176
176
|
#
|
177
|
-
# @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
177
|
+
# @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
178
178
|
#
|
179
179
|
# @param scheduled_at [Time, nil] Timestamp when the message was scheduled to be sent.
|
180
180
|
#
|
181
181
|
# @param seen_at [Time, nil] Timestamp when the message was seen.
|
182
182
|
#
|
183
|
-
# @param source [Knockapi::Message::Source] The workflow that triggered the message.
|
183
|
+
# @param source [Knockapi::Models::Message::Source] The workflow that triggered the message.
|
184
184
|
#
|
185
|
-
# @param status [Symbol, Knockapi::Message::Status] The message delivery status.
|
185
|
+
# @param status [Symbol, Knockapi::Models::Message::Status] The message delivery status.
|
186
186
|
#
|
187
187
|
# @param tenant [String, nil] The ID of the `tenant` associated with the message. Only present when a `tenant`
|
188
188
|
#
|
@@ -205,7 +205,7 @@ module Knockapi
|
|
205
205
|
# @return [Array<Symbol>]
|
206
206
|
end
|
207
207
|
|
208
|
-
# @see Knockapi::Message#source
|
208
|
+
# @see Knockapi::Models::Message#source
|
209
209
|
class Source < Knockapi::Internal::Type::BaseModel
|
210
210
|
# @!attribute _typename
|
211
211
|
#
|
@@ -244,7 +244,7 @@ module Knockapi
|
|
244
244
|
|
245
245
|
# The message delivery status.
|
246
246
|
#
|
247
|
-
# @see Knockapi::Message#status
|
247
|
+
# @see Knockapi::Models::Message#status
|
248
248
|
module Status
|
249
249
|
extend Knockapi::Internal::Type::Enum
|
250
250
|
|
@@ -31,13 +31,13 @@ module Knockapi
|
|
31
31
|
# @!attribute request
|
32
32
|
# A message delivery log request.
|
33
33
|
#
|
34
|
-
# @return [Knockapi::MessageDeliveryLog::Request]
|
34
|
+
# @return [Knockapi::Models::MessageDeliveryLog::Request]
|
35
35
|
required :request, -> { Knockapi::MessageDeliveryLog::Request }
|
36
36
|
|
37
37
|
# @!attribute response
|
38
38
|
# A message delivery log response.
|
39
39
|
#
|
40
|
-
# @return [Knockapi::MessageDeliveryLog::Response]
|
40
|
+
# @return [Knockapi::Models::MessageDeliveryLog::Response]
|
41
41
|
required :response, -> { Knockapi::MessageDeliveryLog::Response }
|
42
42
|
|
43
43
|
# @!attribute service_name
|
@@ -58,13 +58,13 @@ module Knockapi
|
|
58
58
|
#
|
59
59
|
# @param inserted_at [String] Timestamp when the message delivery log was created.
|
60
60
|
#
|
61
|
-
# @param request [Knockapi::MessageDeliveryLog::Request] A message delivery log request.
|
61
|
+
# @param request [Knockapi::Models::MessageDeliveryLog::Request] A message delivery log request.
|
62
62
|
#
|
63
|
-
# @param response [Knockapi::MessageDeliveryLog::Response] A message delivery log response.
|
63
|
+
# @param response [Knockapi::Models::MessageDeliveryLog::Response] A message delivery log response.
|
64
64
|
#
|
65
65
|
# @param service_name [String] The name of the service that processed the delivery.
|
66
66
|
|
67
|
-
# @see Knockapi::MessageDeliveryLog#request
|
67
|
+
# @see Knockapi::Models::MessageDeliveryLog#request
|
68
68
|
class Request < Knockapi::Internal::Type::BaseModel
|
69
69
|
# @!attribute body
|
70
70
|
# The body content that was sent with the request.
|
@@ -87,7 +87,7 @@ module Knockapi
|
|
87
87
|
# @!attribute method_
|
88
88
|
# The HTTP method used for the request.
|
89
89
|
#
|
90
|
-
# @return [Symbol, Knockapi::MessageDeliveryLog::Request::Method, nil]
|
90
|
+
# @return [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method, nil]
|
91
91
|
optional :method_, enum: -> { Knockapi::MessageDeliveryLog::Request::Method }, api_name: :method
|
92
92
|
|
93
93
|
# @!attribute path
|
@@ -111,7 +111,7 @@ module Knockapi
|
|
111
111
|
#
|
112
112
|
# @param host [String] The host to which the request was sent.
|
113
113
|
#
|
114
|
-
# @param method_ [Symbol, Knockapi::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
|
114
|
+
# @param method_ [Symbol, Knockapi::Models::MessageDeliveryLog::Request::Method] The HTTP method used for the request.
|
115
115
|
#
|
116
116
|
# @param path [String] The path of the URL that was requested.
|
117
117
|
#
|
@@ -119,13 +119,13 @@ module Knockapi
|
|
119
119
|
|
120
120
|
# The body content that was sent with the request.
|
121
121
|
#
|
122
|
-
# @see Knockapi::MessageDeliveryLog::Request#body
|
122
|
+
# @see Knockapi::Models::MessageDeliveryLog::Request#body
|
123
123
|
module Body
|
124
124
|
extend Knockapi::Internal::Type::Union
|
125
125
|
|
126
126
|
variant String
|
127
127
|
|
128
|
-
variant -> { Knockapi::MessageDeliveryLog::Request::Body::UnionMember1Map }
|
128
|
+
variant -> { Knockapi::Models::MessageDeliveryLog::Request::Body::UnionMember1Map }
|
129
129
|
|
130
130
|
# @!method self.variants
|
131
131
|
# @return [Array(String, Hash{Symbol=>Object})]
|
@@ -136,7 +136,7 @@ module Knockapi
|
|
136
136
|
|
137
137
|
# The HTTP method used for the request.
|
138
138
|
#
|
139
|
-
# @see Knockapi::MessageDeliveryLog::Request#method_
|
139
|
+
# @see Knockapi::Models::MessageDeliveryLog::Request#method_
|
140
140
|
module Method
|
141
141
|
extend Knockapi::Internal::Type::Enum
|
142
142
|
|
@@ -151,7 +151,7 @@ module Knockapi
|
|
151
151
|
end
|
152
152
|
end
|
153
153
|
|
154
|
-
# @see Knockapi::MessageDeliveryLog#response
|
154
|
+
# @see Knockapi::Models::MessageDeliveryLog#response
|
155
155
|
class Response < Knockapi::Internal::Type::BaseModel
|
156
156
|
# @!attribute body
|
157
157
|
# The body content that was received with the response.
|
@@ -182,13 +182,13 @@ module Knockapi
|
|
182
182
|
|
183
183
|
# The body content that was received with the response.
|
184
184
|
#
|
185
|
-
# @see Knockapi::MessageDeliveryLog::Response#body
|
185
|
+
# @see Knockapi::Models::MessageDeliveryLog::Response#body
|
186
186
|
module Body
|
187
187
|
extend Knockapi::Internal::Type::Union
|
188
188
|
|
189
189
|
variant String
|
190
190
|
|
191
|
-
variant -> { Knockapi::MessageDeliveryLog::Response::Body::UnionMember1Map }
|
191
|
+
variant -> { Knockapi::Models::MessageDeliveryLog::Response::Body::UnionMember1Map }
|
192
192
|
|
193
193
|
# @!method self.variants
|
194
194
|
# @return [Array(String, Hash{Symbol=>Object})]
|
@@ -26,13 +26,13 @@ module Knockapi
|
|
26
26
|
# A reference to a recipient, either a user identifier (string) or an object
|
27
27
|
# reference (ID, collection).
|
28
28
|
#
|
29
|
-
# @return [String, Knockapi::RecipientReference::ObjectReference]
|
29
|
+
# @return [String, Knockapi::Models::RecipientReference::ObjectReference]
|
30
30
|
required :recipient, union: -> { Knockapi::RecipientReference }
|
31
31
|
|
32
32
|
# @!attribute type
|
33
33
|
# The type of event that occurred.
|
34
34
|
#
|
35
|
-
# @return [Symbol, Knockapi::MessageEvent::Type]
|
35
|
+
# @return [Symbol, Knockapi::Models::MessageEvent::Type]
|
36
36
|
required :type, enum: -> { Knockapi::MessageEvent::Type }
|
37
37
|
|
38
38
|
# @!attribute data
|
@@ -42,8 +42,8 @@ module Knockapi
|
|
42
42
|
optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
|
43
43
|
|
44
44
|
# @!method initialize(id:, _typename:, inserted_at:, recipient:, type:, data: nil)
|
45
|
-
# Some parameter documentations has been truncated, see
|
46
|
-
# for more details.
|
45
|
+
# Some parameter documentations has been truncated, see
|
46
|
+
# {Knockapi::Models::MessageEvent} for more details.
|
47
47
|
#
|
48
48
|
# A message event. Occurs when a message
|
49
49
|
# [delivery or engagement status](/send-notifications/message-statuses) changes.
|
@@ -54,15 +54,15 @@ module Knockapi
|
|
54
54
|
#
|
55
55
|
# @param inserted_at [Time] Timestamp when the event was created.
|
56
56
|
#
|
57
|
-
# @param recipient [String, Knockapi::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
57
|
+
# @param recipient [String, Knockapi::Models::RecipientReference::ObjectReference] A reference to a recipient, either a user identifier (string) or an object refer
|
58
58
|
#
|
59
|
-
# @param type [Symbol, Knockapi::MessageEvent::Type] The type of event that occurred.
|
59
|
+
# @param type [Symbol, Knockapi::Models::MessageEvent::Type] The type of event that occurred.
|
60
60
|
#
|
61
61
|
# @param data [Hash{Symbol=>Object}, nil] The data associated with the message event. Only present for some event types.
|
62
62
|
|
63
63
|
# The type of event that occurred.
|
64
64
|
#
|
65
|
-
# @see Knockapi::MessageEvent#type
|
65
|
+
# @see Knockapi::Models::MessageEvent#type
|
66
66
|
module Type
|
67
67
|
extend Knockapi::Internal::Type::Enum
|
68
68
|
|
@@ -28,13 +28,13 @@ 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::MessageListParams::EngagementStatus>, nil]
|
31
|
+
# @return [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
33
|
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::EngagementStatus] }
|
34
34
|
|
35
35
|
# @!attribute inserted_at
|
36
36
|
#
|
37
|
-
# @return [Knockapi::MessageListParams::InsertedAt, nil]
|
37
|
+
# @return [Knockapi::Models::MessageListParams::InsertedAt, nil]
|
38
38
|
optional :inserted_at, -> { Knockapi::MessageListParams::InsertedAt }
|
39
39
|
|
40
40
|
# @!attribute message_ids
|
@@ -59,7 +59,7 @@ module Knockapi
|
|
59
59
|
# @!attribute status
|
60
60
|
# Limits the results to messages with the given delivery status.
|
61
61
|
#
|
62
|
-
# @return [Array<Symbol, Knockapi::MessageListParams::Status>, nil]
|
62
|
+
# @return [Array<Symbol, Knockapi::Models::MessageListParams::Status>, nil]
|
63
63
|
optional :status, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::MessageListParams::Status] }
|
64
64
|
|
65
65
|
# @!attribute tenant
|
@@ -105,9 +105,9 @@ module Knockapi
|
|
105
105
|
#
|
106
106
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
107
107
|
#
|
108
|
-
# @param engagement_status [Array<Symbol, Knockapi::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
108
|
+
# @param engagement_status [Array<Symbol, Knockapi::Models::MessageListParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
109
109
|
#
|
110
|
-
# @param inserted_at [Knockapi::MessageListParams::InsertedAt]
|
110
|
+
# @param inserted_at [Knockapi::Models::MessageListParams::InsertedAt]
|
111
111
|
#
|
112
112
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
113
113
|
#
|
@@ -115,7 +115,7 @@ module Knockapi
|
|
115
115
|
#
|
116
116
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
117
117
|
#
|
118
|
-
# @param status [Array<Symbol, Knockapi::MessageListParams::Status>] Limits the results to messages with the given delivery status.
|
118
|
+
# @param status [Array<Symbol, Knockapi::Models::MessageListParams::Status>] Limits the results to messages with the given delivery status.
|
119
119
|
#
|
120
120
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
121
121
|
#
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchArchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchMarkAsInteractedResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchMarkAsReadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchMarkAsSeenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchMarkAsUnreadResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchMarkAsUnseenResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -4,7 +4,7 @@ module Knockapi
|
|
4
4
|
module Models
|
5
5
|
module Messages
|
6
6
|
# @type [Knockapi::Internal::Type::Converter]
|
7
|
-
BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Message }]
|
7
|
+
BatchUnarchiveResponse = Knockapi::Internal::Type::ArrayOf[-> { Knockapi::Models::Message }]
|
8
8
|
end
|
9
9
|
end
|
10
10
|
end
|
@@ -11,7 +11,7 @@ module Knockapi
|
|
11
11
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
12
12
|
# object at a time.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
14
|
+
# @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
|
15
15
|
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
16
16
|
|
17
17
|
# @!attribute properties
|
@@ -24,7 +24,7 @@ module Knockapi
|
|
24
24
|
# Some parameter documentations has been truncated, see
|
25
25
|
# {Knockapi::Models::ObjectAddSubscriptionsParams} for more details.
|
26
26
|
#
|
27
|
-
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
27
|
+
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
28
28
|
#
|
29
29
|
# @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
|
30
30
|
#
|
@@ -11,14 +11,14 @@ module Knockapi
|
|
11
11
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
12
12
|
# object at a time.
|
13
13
|
#
|
14
|
-
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>]
|
14
|
+
# @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>]
|
15
15
|
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
16
16
|
|
17
17
|
# @!method initialize(recipients:, request_options: {})
|
18
18
|
# Some parameter documentations has been truncated, see
|
19
19
|
# {Knockapi::Models::ObjectDeleteSubscriptionsParams} for more details.
|
20
20
|
#
|
21
|
-
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
21
|
+
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
22
22
|
#
|
23
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
24
24
|
end
|
@@ -28,7 +28,7 @@ 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::ObjectListMessagesParams::EngagementStatus>, nil]
|
31
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>, nil]
|
32
32
|
optional :engagement_status,
|
33
33
|
-> {
|
34
34
|
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::EngagementStatus]
|
@@ -36,7 +36,7 @@ module Knockapi
|
|
36
36
|
|
37
37
|
# @!attribute inserted_at
|
38
38
|
#
|
39
|
-
# @return [Knockapi::ObjectListMessagesParams::InsertedAt, nil]
|
39
|
+
# @return [Knockapi::Models::ObjectListMessagesParams::InsertedAt, nil]
|
40
40
|
optional :inserted_at, -> { Knockapi::ObjectListMessagesParams::InsertedAt }
|
41
41
|
|
42
42
|
# @!attribute message_ids
|
@@ -61,7 +61,7 @@ module Knockapi
|
|
61
61
|
# @!attribute status
|
62
62
|
# Limits the results to messages with the given delivery status.
|
63
63
|
#
|
64
|
-
# @return [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>, nil]
|
64
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>, nil]
|
65
65
|
optional :status,
|
66
66
|
-> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListMessagesParams::Status] }
|
67
67
|
|
@@ -108,9 +108,9 @@ module Knockapi
|
|
108
108
|
#
|
109
109
|
# @param channel_id [String] Limits the results to items with the corresponding channel ID.
|
110
110
|
#
|
111
|
-
# @param engagement_status [Array<Symbol, Knockapi::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
111
|
+
# @param engagement_status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::EngagementStatus>] Limits the results to messages with the given engagement status.
|
112
112
|
#
|
113
|
-
# @param inserted_at [Knockapi::ObjectListMessagesParams::InsertedAt]
|
113
|
+
# @param inserted_at [Knockapi::Models::ObjectListMessagesParams::InsertedAt]
|
114
114
|
#
|
115
115
|
# @param message_ids [Array<String>] Limits the results to only the message IDs given (max 50). Note: when using this
|
116
116
|
#
|
@@ -118,7 +118,7 @@ module Knockapi
|
|
118
118
|
#
|
119
119
|
# @param source [String] Limits the results to messages triggered by the given workflow key.
|
120
120
|
#
|
121
|
-
# @param status [Array<Symbol, Knockapi::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
121
|
+
# @param status [Array<Symbol, Knockapi::Models::ObjectListMessagesParams::Status>] Limits the results to messages with the given delivery status.
|
122
122
|
#
|
123
123
|
# @param tenant [String] Limits the results to items with the corresponding tenant.
|
124
124
|
#
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Includes preferences of the objects in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::ObjectListParams::Include>, nil]
|
25
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListParams::Include>, nil]
|
26
26
|
optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }
|
27
27
|
|
28
28
|
# @!attribute page_size
|
@@ -36,7 +36,7 @@ module Knockapi
|
|
36
36
|
#
|
37
37
|
# @param before [String] The cursor to fetch entries before.
|
38
38
|
#
|
39
|
-
# @param include [Array<Symbol, Knockapi::ObjectListParams::Include>] Includes preferences of the objects in the response.
|
39
|
+
# @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
|
40
40
|
#
|
41
41
|
# @param page_size [Integer] The number of items per page.
|
42
42
|
#
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!attribute include
|
23
23
|
# Additional fields to include in the response.
|
24
24
|
#
|
25
|
-
# @return [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>, nil]
|
25
|
+
# @return [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>, nil]
|
26
26
|
optional :include,
|
27
27
|
-> {
|
28
28
|
Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListSubscriptionsParams::Include]
|
@@ -33,13 +33,13 @@ module Knockapi
|
|
33
33
|
# subscribed to, `object` to list the recipients that subscribe to the provided
|
34
34
|
# object.
|
35
35
|
#
|
36
|
-
# @return [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode, nil]
|
36
|
+
# @return [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode, nil]
|
37
37
|
optional :mode, enum: -> { Knockapi::ObjectListSubscriptionsParams::Mode }
|
38
38
|
|
39
39
|
# @!attribute objects
|
40
40
|
# Objects to filter by (only used if mode is `recipient`).
|
41
41
|
#
|
42
|
-
# @return [Array<Knockapi::ObjectListSubscriptionsParams::Object>, nil]
|
42
|
+
# @return [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>, nil]
|
43
43
|
optional :objects,
|
44
44
|
-> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
|
45
45
|
|
@@ -52,7 +52,7 @@ module Knockapi
|
|
52
52
|
# @!attribute recipients
|
53
53
|
# Recipients to filter by (only used if mode is `object`).
|
54
54
|
#
|
55
|
-
# @return [Array<String, Knockapi::RecipientReference::ObjectReference>, nil]
|
55
|
+
# @return [Array<String, Knockapi::Models::RecipientReference::ObjectReference>, nil]
|
56
56
|
optional :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientReference] }
|
57
57
|
|
58
58
|
# @!method initialize(after: nil, before: nil, include: nil, mode: nil, objects: nil, page_size: nil, recipients: nil, request_options: {})
|
@@ -63,15 +63,15 @@ module Knockapi
|
|
63
63
|
#
|
64
64
|
# @param before [String] The cursor to fetch entries before.
|
65
65
|
#
|
66
|
-
# @param include [Array<Symbol, Knockapi::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
|
66
|
+
# @param include [Array<Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Include>] Additional fields to include in the response.
|
67
67
|
#
|
68
|
-
# @param mode [Symbol, Knockapi::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
|
68
|
+
# @param mode [Symbol, Knockapi::Models::ObjectListSubscriptionsParams::Mode] Mode of the request. `recipient` to list the objects that the provided object is
|
69
69
|
#
|
70
|
-
# @param objects [Array<Knockapi::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
|
70
|
+
# @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
|
71
71
|
#
|
72
72
|
# @param page_size [Integer] The number of items per page.
|
73
73
|
#
|
74
|
-
# @param recipients [Array<String, Knockapi::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
|
74
|
+
# @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
|
75
75
|
#
|
76
76
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
77
77
|
|
@@ -10,7 +10,7 @@ module Knockapi
|
|
10
10
|
# @!attribute channel_data
|
11
11
|
# A request to set channel data for a type of channel inline.
|
12
12
|
#
|
13
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
13
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
14
14
|
optional :channel_data,
|
15
15
|
-> {
|
16
16
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
@@ -26,7 +26,7 @@ module Knockapi
|
|
26
26
|
# @!attribute preferences
|
27
27
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
28
28
|
#
|
29
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
29
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
|
30
30
|
optional :preferences,
|
31
31
|
-> {
|
32
32
|
Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest]
|
@@ -45,11 +45,11 @@ module Knockapi
|
|
45
45
|
# Some parameter documentations has been truncated, see
|
46
46
|
# {Knockapi::Models::ObjectSetParams} for more details.
|
47
47
|
#
|
48
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
|
48
|
+
# @param channel_data [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}] A request to set channel data for a type of channel inline.
|
49
49
|
#
|
50
50
|
# @param locale [String, nil] The locale of the object. Used for [message localization](/concepts/translations
|
51
51
|
#
|
52
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
|
52
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}] Inline set preferences for a recipient, where the key is the preference set id.
|
53
53
|
#
|
54
54
|
# @param timezone [String, nil] The timezone of the object. Must be a valid [tz database time zone string](https
|
55
55
|
#
|
@@ -11,14 +11,14 @@ module Knockapi
|
|
11
11
|
# @!attribute subscriptions
|
12
12
|
# A list of subscriptions.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>]
|
14
|
+
# @return [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>]
|
15
15
|
required :subscriptions,
|
16
16
|
-> {
|
17
17
|
Knockapi::Internal::Type::ArrayOf[Knockapi::Objects::BulkAddSubscriptionsParams::Subscription]
|
18
18
|
}
|
19
19
|
|
20
20
|
# @!method initialize(subscriptions:, request_options: {})
|
21
|
-
# @param subscriptions [Array<Knockapi::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
21
|
+
# @param subscriptions [Array<Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription>] A list of subscriptions.
|
22
22
|
#
|
23
23
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
24
24
|
|
@@ -27,7 +27,7 @@ module Knockapi
|
|
27
27
|
# The recipients of the subscription. You can subscribe up to 100 recipients to an
|
28
28
|
# object at a time.
|
29
29
|
#
|
30
|
-
# @return [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>]
|
30
|
+
# @return [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>]
|
31
31
|
required :recipients, -> { Knockapi::Internal::Type::ArrayOf[union: Knockapi::RecipientRequest] }
|
32
32
|
|
33
33
|
# @!attribute properties
|
@@ -40,9 +40,10 @@ module Knockapi
|
|
40
40
|
|
41
41
|
# @!method initialize(recipients:, properties: nil)
|
42
42
|
# Some parameter documentations has been truncated, see
|
43
|
-
# {Knockapi::Objects::BulkAddSubscriptionsParams::Subscription} for more
|
43
|
+
# {Knockapi::Models::Objects::BulkAddSubscriptionsParams::Subscription} for more
|
44
|
+
# details.
|
44
45
|
#
|
45
|
-
# @param recipients [Array<String, Knockapi::InlineIdentifyUserRequest, Knockapi::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
46
|
+
# @param recipients [Array<String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest>] The recipients of the subscription. You can subscribe up to 100 recipients to an
|
46
47
|
#
|
47
48
|
# @param properties [Hash{Symbol=>Object}, nil] The custom properties associated with the subscription relationship.
|
48
49
|
end
|
@@ -11,11 +11,11 @@ module Knockapi
|
|
11
11
|
# @!attribute objects
|
12
12
|
# A list of objects.
|
13
13
|
#
|
14
|
-
# @return [Array<Knockapi::InlineObjectRequest>]
|
14
|
+
# @return [Array<Knockapi::Models::InlineObjectRequest>]
|
15
15
|
required :objects, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::InlineObjectRequest] }
|
16
16
|
|
17
17
|
# @!method initialize(objects:, request_options: {})
|
18
|
-
# @param objects [Array<Knockapi::InlineObjectRequest>] A list of objects.
|
18
|
+
# @param objects [Array<Knockapi::Models::InlineObjectRequest>] A list of objects.
|
19
19
|
#
|
20
20
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
21
21
|
end
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
|
23
23
|
# @!attribute query_options
|
24
24
|
#
|
25
|
-
# @return [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions, nil]
|
25
|
+
# @return [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions, nil]
|
26
26
|
optional :query_options, -> { Knockapi::Providers::MsTeamListChannelsParams::QueryOptions }
|
27
27
|
|
28
28
|
# @!method initialize(ms_teams_tenant_object:, team_id:, query_options: nil, request_options: {})
|
@@ -30,7 +30,7 @@ module Knockapi
|
|
30
30
|
#
|
31
31
|
# @param team_id [String] Microsoft Teams team ID.
|
32
32
|
#
|
33
|
-
# @param query_options [Knockapi::Providers::MsTeamListChannelsParams::QueryOptions]
|
33
|
+
# @param query_options [Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions]
|
34
34
|
#
|
35
35
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
36
36
|
|
@@ -51,7 +51,8 @@ module Knockapi
|
|
51
51
|
|
52
52
|
# @!method initialize(filter: nil, select_: nil)
|
53
53
|
# Some parameter documentations has been truncated, see
|
54
|
-
# {Knockapi::Providers::MsTeamListChannelsParams::QueryOptions} for more
|
54
|
+
# {Knockapi::Models::Providers::MsTeamListChannelsParams::QueryOptions} for more
|
55
|
+
# details.
|
55
56
|
#
|
56
57
|
# @param filter [String] [OData param](https://learn.microsoft.com/en-us/graph/query-parameters) passed t
|
57
58
|
#
|