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
@@ -15,6 +15,11 @@ module Knockapi
|
|
15
15
|
?request_options: Knockapi::request_opts
|
16
16
|
) -> void
|
17
17
|
|
18
|
+
def to_hash: -> {
|
19
|
+
members: ::Array[Knockapi::AudienceRemoveMembersParams::Member],
|
20
|
+
request_options: Knockapi::RequestOptions
|
21
|
+
}
|
22
|
+
|
18
23
|
type member =
|
19
24
|
{
|
20
25
|
user: Knockapi::AudienceRemoveMembersParams::Member::User,
|
@@ -31,6 +36,11 @@ module Knockapi
|
|
31
36
|
?tenant: String?
|
32
37
|
) -> void
|
33
38
|
|
39
|
+
def to_hash: -> {
|
40
|
+
user: Knockapi::AudienceRemoveMembersParams::Member::User,
|
41
|
+
tenant: String?
|
42
|
+
}
|
43
|
+
|
34
44
|
type user = { id: String }
|
35
45
|
|
36
46
|
class User < Knockapi::Internal::Type::BaseModel
|
@@ -39,6 +49,8 @@ module Knockapi
|
|
39
49
|
def id=: (String) -> String
|
40
50
|
|
41
51
|
def initialize: (?id: String) -> void
|
52
|
+
|
53
|
+
def to_hash: -> { id: String }
|
42
54
|
end
|
43
55
|
end
|
44
56
|
end
|
@@ -8,7 +8,7 @@ module Knockapi
|
|
8
8
|
inserted_at: Time,
|
9
9
|
name: String,
|
10
10
|
processed_rows: Integer,
|
11
|
-
status: Knockapi::BulkOperation::status,
|
11
|
+
status: Knockapi::Models::BulkOperation::status,
|
12
12
|
success_count: Integer,
|
13
13
|
updated_at: Time,
|
14
14
|
completed_at: Time?,
|
@@ -32,7 +32,7 @@ module Knockapi
|
|
32
32
|
|
33
33
|
attr_accessor processed_rows: Integer
|
34
34
|
|
35
|
-
attr_accessor status: Knockapi::BulkOperation::status
|
35
|
+
attr_accessor status: Knockapi::Models::BulkOperation::status
|
36
36
|
|
37
37
|
attr_accessor success_count: Integer
|
38
38
|
|
@@ -65,7 +65,7 @@ module Knockapi
|
|
65
65
|
inserted_at: Time,
|
66
66
|
name: String,
|
67
67
|
processed_rows: Integer,
|
68
|
-
status: Knockapi::BulkOperation::status,
|
68
|
+
status: Knockapi::Models::BulkOperation::status,
|
69
69
|
success_count: Integer,
|
70
70
|
updated_at: Time,
|
71
71
|
?completed_at: Time?,
|
@@ -76,6 +76,24 @@ module Knockapi
|
|
76
76
|
?started_at: Time?
|
77
77
|
) -> void
|
78
78
|
|
79
|
+
def to_hash: -> {
|
80
|
+
id: String,
|
81
|
+
_typename: String,
|
82
|
+
estimated_total_rows: Integer,
|
83
|
+
inserted_at: Time,
|
84
|
+
name: String,
|
85
|
+
processed_rows: Integer,
|
86
|
+
status: Knockapi::Models::BulkOperation::status,
|
87
|
+
success_count: Integer,
|
88
|
+
updated_at: Time,
|
89
|
+
completed_at: Time?,
|
90
|
+
error_count: Integer,
|
91
|
+
error_items: ::Array[Knockapi::BulkOperation::ErrorItem],
|
92
|
+
failed_at: Time?,
|
93
|
+
progress_path: String,
|
94
|
+
started_at: Time?
|
95
|
+
}
|
96
|
+
|
79
97
|
type status = :queued | :processing | :completed | :failed
|
80
98
|
|
81
99
|
module Status
|
@@ -86,7 +104,7 @@ module Knockapi
|
|
86
104
|
COMPLETED: :completed
|
87
105
|
FAILED: :failed
|
88
106
|
|
89
|
-
def self?.values: -> ::Array[Knockapi::BulkOperation::status]
|
107
|
+
def self?.values: -> ::Array[Knockapi::Models::BulkOperation::status]
|
90
108
|
end
|
91
109
|
|
92
110
|
type error_item = { id: String, collection: String? }
|
@@ -97,6 +115,8 @@ module Knockapi
|
|
97
115
|
attr_accessor collection: String?
|
98
116
|
|
99
117
|
def initialize: (id: String, ?collection: String?) -> void
|
118
|
+
|
119
|
+
def to_hash: -> { id: String, collection: String? }
|
100
120
|
end
|
101
121
|
end
|
102
122
|
end
|
@@ -80,6 +80,20 @@ module Knockapi
|
|
80
80
|
?request_options: Knockapi::request_opts
|
81
81
|
) -> void
|
82
82
|
|
83
|
+
def to_hash: -> {
|
84
|
+
archived: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::archived,
|
85
|
+
delivery_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::delivery_status,
|
86
|
+
engagement_status: Knockapi::Models::Channels::BulkUpdateMessageStatusParams::engagement_status,
|
87
|
+
has_tenant: bool,
|
88
|
+
newer_than: Time,
|
89
|
+
older_than: Time,
|
90
|
+
recipient_ids: ::Array[String],
|
91
|
+
tenants: ::Array[String],
|
92
|
+
trigger_data: String,
|
93
|
+
workflows: ::Array[String],
|
94
|
+
request_options: Knockapi::RequestOptions
|
95
|
+
}
|
96
|
+
|
83
97
|
type action =
|
84
98
|
:seen
|
85
99
|
| :unseen
|
@@ -3,23 +3,29 @@ module Knockapi
|
|
3
3
|
type condition =
|
4
4
|
{
|
5
5
|
argument: String?,
|
6
|
-
operator: Knockapi::Condition::operator,
|
6
|
+
operator: Knockapi::Models::Condition::operator,
|
7
7
|
variable: String
|
8
8
|
}
|
9
9
|
|
10
10
|
class Condition < Knockapi::Internal::Type::BaseModel
|
11
11
|
attr_accessor argument: String?
|
12
12
|
|
13
|
-
attr_accessor operator: Knockapi::Condition::operator
|
13
|
+
attr_accessor operator: Knockapi::Models::Condition::operator
|
14
14
|
|
15
15
|
attr_accessor variable: String
|
16
16
|
|
17
17
|
def initialize: (
|
18
18
|
argument: String?,
|
19
|
-
operator: Knockapi::Condition::operator,
|
19
|
+
operator: Knockapi::Models::Condition::operator,
|
20
20
|
variable: String
|
21
21
|
) -> void
|
22
22
|
|
23
|
+
def to_hash: -> {
|
24
|
+
argument: String?,
|
25
|
+
operator: Knockapi::Models::Condition::operator,
|
26
|
+
variable: String
|
27
|
+
}
|
28
|
+
|
23
29
|
type operator =
|
24
30
|
:equal_to
|
25
31
|
| :not_equal_to
|
@@ -62,7 +68,7 @@ module Knockapi
|
|
62
68
|
IS_AUDIENCE_MEMBER: :is_audience_member
|
63
69
|
IS_NOT_AUDIENCE_MEMBER: :is_not_audience_member
|
64
70
|
|
65
|
-
def self?.values: -> ::Array[Knockapi::Condition::operator]
|
71
|
+
def self?.values: -> ::Array[Knockapi::Models::Condition::operator]
|
66
72
|
end
|
67
73
|
end
|
68
74
|
end
|
@@ -43,6 +43,18 @@ module Knockapi
|
|
43
43
|
?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
44
44
|
?timezone: String?
|
45
45
|
) -> void
|
46
|
+
|
47
|
+
def to_hash: -> {
|
48
|
+
avatar: String?,
|
49
|
+
channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
50
|
+
created_at: Time?,
|
51
|
+
email: String?,
|
52
|
+
locale: String?,
|
53
|
+
name: String?,
|
54
|
+
phone_number: String?,
|
55
|
+
preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
56
|
+
timezone: String?
|
57
|
+
}
|
46
58
|
end
|
47
59
|
end
|
48
60
|
end
|
@@ -47,6 +47,19 @@ module Knockapi
|
|
47
47
|
?preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
48
48
|
?timezone: String?
|
49
49
|
) -> void
|
50
|
+
|
51
|
+
def to_hash: -> {
|
52
|
+
id: String,
|
53
|
+
avatar: String?,
|
54
|
+
channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
55
|
+
created_at: Time?,
|
56
|
+
email: String?,
|
57
|
+
locale: String?,
|
58
|
+
name: String?,
|
59
|
+
phone_number: String?,
|
60
|
+
preferences: Knockapi::Models::Recipients::inline_preference_set_request?,
|
61
|
+
timezone: String?
|
62
|
+
}
|
50
63
|
end
|
51
64
|
end
|
52
65
|
end
|
@@ -27,6 +27,14 @@ module Knockapi
|
|
27
27
|
?created_at: Time?,
|
28
28
|
?preferences: Knockapi::Models::Recipients::inline_preference_set_request?
|
29
29
|
) -> void
|
30
|
+
|
31
|
+
def to_hash: -> {
|
32
|
+
id: String,
|
33
|
+
collection: String,
|
34
|
+
channel_data: Knockapi::Models::Recipients::inline_channel_data_request?,
|
35
|
+
created_at: Time?,
|
36
|
+
preferences: Knockapi::Models::Recipients::inline_preference_set_request?
|
37
|
+
}
|
30
38
|
end
|
31
39
|
end
|
32
40
|
end
|
@@ -31,6 +31,14 @@ module Knockapi
|
|
31
31
|
?params: ::Hash[Symbol, top],
|
32
32
|
?request_options: Knockapi::request_opts
|
33
33
|
) -> void
|
34
|
+
|
35
|
+
def to_hash: -> {
|
36
|
+
id: String,
|
37
|
+
jsonrpc: String,
|
38
|
+
method_: String,
|
39
|
+
params: ::Hash[Symbol, top],
|
40
|
+
request_options: Knockapi::RequestOptions
|
41
|
+
}
|
34
42
|
end
|
35
43
|
end
|
36
44
|
end
|
@@ -31,6 +31,14 @@ module Knockapi
|
|
31
31
|
?params: ::Hash[Symbol, top],
|
32
32
|
?request_options: Knockapi::request_opts
|
33
33
|
) -> void
|
34
|
+
|
35
|
+
def to_hash: -> {
|
36
|
+
id: String,
|
37
|
+
jsonrpc: String,
|
38
|
+
method_: String,
|
39
|
+
params: ::Hash[Symbol, top],
|
40
|
+
request_options: Knockapi::RequestOptions
|
41
|
+
}
|
34
42
|
end
|
35
43
|
end
|
36
44
|
end
|
@@ -9,7 +9,7 @@ module Knockapi
|
|
9
9
|
channel_id: String,
|
10
10
|
clicked_at: Time?,
|
11
11
|
data: ::Hash[Symbol, top]?,
|
12
|
-
engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
12
|
+
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
13
13
|
inserted_at: Time,
|
14
14
|
interacted_at: Time?,
|
15
15
|
link_clicked_at: Time?,
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
scheduled_at: Time?,
|
20
20
|
seen_at: Time?,
|
21
21
|
source: Knockapi::Message::Source,
|
22
|
-
status: Knockapi::Message::status,
|
22
|
+
status: Knockapi::Models::Message::status,
|
23
23
|
tenant: String?,
|
24
24
|
updated_at: Time,
|
25
25
|
workflow: String?
|
@@ -50,11 +50,11 @@ module Knockapi
|
|
50
50
|
|
51
51
|
attr_accessor data: ::Hash[Symbol, top]?
|
52
52
|
|
53
|
-
attr_reader engagement_statuses: ::Array[Knockapi::Message::engagement_status]?
|
53
|
+
attr_reader engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status]?
|
54
54
|
|
55
55
|
def engagement_statuses=: (
|
56
|
-
::Array[Knockapi::Message::engagement_status]
|
57
|
-
) -> ::Array[Knockapi::Message::engagement_status]
|
56
|
+
::Array[Knockapi::Models::Message::engagement_status]
|
57
|
+
) -> ::Array[Knockapi::Models::Message::engagement_status]
|
58
58
|
|
59
59
|
attr_reader inserted_at: Time?
|
60
60
|
|
@@ -82,9 +82,11 @@ module Knockapi
|
|
82
82
|
|
83
83
|
def source=: (Knockapi::Message::Source) -> Knockapi::Message::Source
|
84
84
|
|
85
|
-
attr_reader status: Knockapi::Message::status?
|
85
|
+
attr_reader status: Knockapi::Models::Message::status?
|
86
86
|
|
87
|
-
def status=: (
|
87
|
+
def status=: (
|
88
|
+
Knockapi::Models::Message::status
|
89
|
+
) -> Knockapi::Models::Message::status
|
88
90
|
|
89
91
|
attr_accessor tenant: String?
|
90
92
|
|
@@ -102,7 +104,7 @@ module Knockapi
|
|
102
104
|
?channel_id: String,
|
103
105
|
?clicked_at: Time?,
|
104
106
|
?data: ::Hash[Symbol, top]?,
|
105
|
-
?engagement_statuses: ::Array[Knockapi::Message::engagement_status],
|
107
|
+
?engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
106
108
|
?inserted_at: Time,
|
107
109
|
?interacted_at: Time?,
|
108
110
|
?link_clicked_at: Time?,
|
@@ -112,12 +114,36 @@ module Knockapi
|
|
112
114
|
?scheduled_at: Time?,
|
113
115
|
?seen_at: Time?,
|
114
116
|
?source: Knockapi::Message::Source,
|
115
|
-
?status: Knockapi::Message::status,
|
117
|
+
?status: Knockapi::Models::Message::status,
|
116
118
|
?tenant: String?,
|
117
119
|
?updated_at: Time,
|
118
120
|
?workflow: String?
|
119
121
|
) -> void
|
120
122
|
|
123
|
+
def to_hash: -> {
|
124
|
+
id: String,
|
125
|
+
_typename: String,
|
126
|
+
actors: ::Array[Knockapi::Models::recipient_reference],
|
127
|
+
archived_at: Time?,
|
128
|
+
channel_id: String,
|
129
|
+
clicked_at: Time?,
|
130
|
+
data: ::Hash[Symbol, top]?,
|
131
|
+
engagement_statuses: ::Array[Knockapi::Models::Message::engagement_status],
|
132
|
+
inserted_at: Time,
|
133
|
+
interacted_at: Time?,
|
134
|
+
link_clicked_at: Time?,
|
135
|
+
metadata: ::Hash[Symbol, top]?,
|
136
|
+
read_at: Time?,
|
137
|
+
recipient: Knockapi::Models::recipient_reference,
|
138
|
+
scheduled_at: Time?,
|
139
|
+
seen_at: Time?,
|
140
|
+
source: Knockapi::Message::Source,
|
141
|
+
status: Knockapi::Models::Message::status,
|
142
|
+
tenant: String?,
|
143
|
+
updated_at: Time,
|
144
|
+
workflow: String?
|
145
|
+
}
|
146
|
+
|
121
147
|
type engagement_status =
|
122
148
|
:seen | :read | :interacted | :link_clicked | :archived
|
123
149
|
|
@@ -130,7 +156,7 @@ module Knockapi
|
|
130
156
|
LINK_CLICKED: :link_clicked
|
131
157
|
ARCHIVED: :archived
|
132
158
|
|
133
|
-
def self?.values: -> ::Array[Knockapi::Message::engagement_status]
|
159
|
+
def self?.values: -> ::Array[Knockapi::Models::Message::engagement_status]
|
134
160
|
end
|
135
161
|
|
136
162
|
type source =
|
@@ -156,6 +182,13 @@ module Knockapi
|
|
156
182
|
key: String,
|
157
183
|
version_id: String
|
158
184
|
) -> void
|
185
|
+
|
186
|
+
def to_hash: -> {
|
187
|
+
_typename: String,
|
188
|
+
categories: ::Array[String],
|
189
|
+
key: String,
|
190
|
+
version_id: String
|
191
|
+
}
|
159
192
|
end
|
160
193
|
|
161
194
|
type status =
|
@@ -178,7 +211,7 @@ module Knockapi
|
|
178
211
|
NOT_SENT: :not_sent
|
179
212
|
BOUNCED: :bounced
|
180
213
|
|
181
|
-
def self?.values: -> ::Array[Knockapi::Message::status]
|
214
|
+
def self?.values: -> ::Array[Knockapi::Models::Message::status]
|
182
215
|
end
|
183
216
|
end
|
184
217
|
end
|
@@ -36,22 +36,32 @@ module Knockapi
|
|
36
36
|
service_name: String
|
37
37
|
) -> void
|
38
38
|
|
39
|
+
def to_hash: -> {
|
40
|
+
id: String,
|
41
|
+
_typename: String,
|
42
|
+
environment_id: String,
|
43
|
+
inserted_at: String,
|
44
|
+
request: Knockapi::MessageDeliveryLog::Request,
|
45
|
+
response: Knockapi::MessageDeliveryLog::Response,
|
46
|
+
service_name: String
|
47
|
+
}
|
48
|
+
|
39
49
|
type request =
|
40
50
|
{
|
41
|
-
body: Knockapi::MessageDeliveryLog::Request::body,
|
51
|
+
body: Knockapi::Models::MessageDeliveryLog::Request::body,
|
42
52
|
headers: ::Hash[Symbol, top]?,
|
43
53
|
host: String,
|
44
|
-
method_: Knockapi::MessageDeliveryLog::Request::method_,
|
54
|
+
method_: Knockapi::Models::MessageDeliveryLog::Request::method_,
|
45
55
|
path: String,
|
46
56
|
query: String?
|
47
57
|
}
|
48
58
|
|
49
59
|
class Request < Knockapi::Internal::Type::BaseModel
|
50
|
-
attr_reader body: Knockapi::MessageDeliveryLog::Request::body?
|
60
|
+
attr_reader body: Knockapi::Models::MessageDeliveryLog::Request::body?
|
51
61
|
|
52
62
|
def body=: (
|
53
|
-
Knockapi::MessageDeliveryLog::Request::body
|
54
|
-
) -> Knockapi::MessageDeliveryLog::Request::body
|
63
|
+
Knockapi::Models::MessageDeliveryLog::Request::body
|
64
|
+
) -> Knockapi::Models::MessageDeliveryLog::Request::body
|
55
65
|
|
56
66
|
attr_accessor headers: ::Hash[Symbol, top]?
|
57
67
|
|
@@ -59,11 +69,11 @@ module Knockapi
|
|
59
69
|
|
60
70
|
def host=: (String) -> String
|
61
71
|
|
62
|
-
attr_reader method_: Knockapi::MessageDeliveryLog::Request::method_?
|
72
|
+
attr_reader method_: Knockapi::Models::MessageDeliveryLog::Request::method_?
|
63
73
|
|
64
74
|
def method_=: (
|
65
|
-
Knockapi::MessageDeliveryLog::Request::method_
|
66
|
-
) -> Knockapi::MessageDeliveryLog::Request::method_
|
75
|
+
Knockapi::Models::MessageDeliveryLog::Request::method_
|
76
|
+
) -> Knockapi::Models::MessageDeliveryLog::Request::method_
|
67
77
|
|
68
78
|
attr_reader path: String?
|
69
79
|
|
@@ -72,20 +82,29 @@ module Knockapi
|
|
72
82
|
attr_accessor query: String?
|
73
83
|
|
74
84
|
def initialize: (
|
75
|
-
?body: Knockapi::MessageDeliveryLog::Request::body,
|
85
|
+
?body: Knockapi::Models::MessageDeliveryLog::Request::body,
|
76
86
|
?headers: ::Hash[Symbol, top]?,
|
77
87
|
?host: String,
|
78
|
-
?method_: Knockapi::MessageDeliveryLog::Request::method_,
|
88
|
+
?method_: Knockapi::Models::MessageDeliveryLog::Request::method_,
|
79
89
|
?path: String,
|
80
90
|
?query: String?
|
81
91
|
) -> void
|
82
92
|
|
93
|
+
def to_hash: -> {
|
94
|
+
body: Knockapi::Models::MessageDeliveryLog::Request::body,
|
95
|
+
headers: ::Hash[Symbol, top]?,
|
96
|
+
host: String,
|
97
|
+
method_: Knockapi::Models::MessageDeliveryLog::Request::method_,
|
98
|
+
path: String,
|
99
|
+
query: String?
|
100
|
+
}
|
101
|
+
|
83
102
|
type body = String | ::Hash[Symbol, top]
|
84
103
|
|
85
104
|
module Body
|
86
105
|
extend Knockapi::Internal::Type::Union
|
87
106
|
|
88
|
-
def self?.variants: -> ::Array[Knockapi::MessageDeliveryLog::Request::body]
|
107
|
+
def self?.variants: -> ::Array[Knockapi::Models::MessageDeliveryLog::Request::body]
|
89
108
|
|
90
109
|
UnionMember1Map: Knockapi::Internal::Type::Converter
|
91
110
|
end
|
@@ -101,23 +120,23 @@ module Knockapi
|
|
101
120
|
DELETE: :DELETE
|
102
121
|
PATCH: :PATCH
|
103
122
|
|
104
|
-
def self?.values: -> ::Array[Knockapi::MessageDeliveryLog::Request::method_]
|
123
|
+
def self?.values: -> ::Array[Knockapi::Models::MessageDeliveryLog::Request::method_]
|
105
124
|
end
|
106
125
|
end
|
107
126
|
|
108
127
|
type response =
|
109
128
|
{
|
110
|
-
body: Knockapi::MessageDeliveryLog::Response::body,
|
129
|
+
body: Knockapi::Models::MessageDeliveryLog::Response::body,
|
111
130
|
headers: ::Hash[Symbol, top]?,
|
112
131
|
status: Integer
|
113
132
|
}
|
114
133
|
|
115
134
|
class Response < Knockapi::Internal::Type::BaseModel
|
116
|
-
attr_reader body: Knockapi::MessageDeliveryLog::Response::body?
|
135
|
+
attr_reader body: Knockapi::Models::MessageDeliveryLog::Response::body?
|
117
136
|
|
118
137
|
def body=: (
|
119
|
-
Knockapi::MessageDeliveryLog::Response::body
|
120
|
-
) -> Knockapi::MessageDeliveryLog::Response::body
|
138
|
+
Knockapi::Models::MessageDeliveryLog::Response::body
|
139
|
+
) -> Knockapi::Models::MessageDeliveryLog::Response::body
|
121
140
|
|
122
141
|
attr_accessor headers: ::Hash[Symbol, top]?
|
123
142
|
|
@@ -126,17 +145,23 @@ module Knockapi
|
|
126
145
|
def status=: (Integer) -> Integer
|
127
146
|
|
128
147
|
def initialize: (
|
129
|
-
?body: Knockapi::MessageDeliveryLog::Response::body,
|
148
|
+
?body: Knockapi::Models::MessageDeliveryLog::Response::body,
|
130
149
|
?headers: ::Hash[Symbol, top]?,
|
131
150
|
?status: Integer
|
132
151
|
) -> void
|
133
152
|
|
153
|
+
def to_hash: -> {
|
154
|
+
body: Knockapi::Models::MessageDeliveryLog::Response::body,
|
155
|
+
headers: ::Hash[Symbol, top]?,
|
156
|
+
status: Integer
|
157
|
+
}
|
158
|
+
|
134
159
|
type body = String | ::Hash[Symbol, top]
|
135
160
|
|
136
161
|
module Body
|
137
162
|
extend Knockapi::Internal::Type::Union
|
138
163
|
|
139
|
-
def self?.variants: -> ::Array[Knockapi::MessageDeliveryLog::Response::body]
|
164
|
+
def self?.variants: -> ::Array[Knockapi::Models::MessageDeliveryLog::Response::body]
|
140
165
|
|
141
166
|
UnionMember1Map: Knockapi::Internal::Type::Converter
|
142
167
|
end
|
@@ -6,7 +6,7 @@ module Knockapi
|
|
6
6
|
_typename: String,
|
7
7
|
inserted_at: Time,
|
8
8
|
recipient: Knockapi::Models::recipient_reference,
|
9
|
-
type: Knockapi::MessageEvent::type_,
|
9
|
+
type: Knockapi::Models::MessageEvent::type_,
|
10
10
|
data: ::Hash[Symbol, top]?
|
11
11
|
}
|
12
12
|
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
|
20
20
|
attr_accessor recipient: Knockapi::Models::recipient_reference
|
21
21
|
|
22
|
-
attr_accessor type: Knockapi::MessageEvent::type_
|
22
|
+
attr_accessor type: Knockapi::Models::MessageEvent::type_
|
23
23
|
|
24
24
|
attr_accessor data: ::Hash[Symbol, top]?
|
25
25
|
|
@@ -28,10 +28,19 @@ module Knockapi
|
|
28
28
|
_typename: String,
|
29
29
|
inserted_at: Time,
|
30
30
|
recipient: Knockapi::Models::recipient_reference,
|
31
|
-
type: Knockapi::MessageEvent::type_,
|
31
|
+
type: Knockapi::Models::MessageEvent::type_,
|
32
32
|
?data: ::Hash[Symbol, top]?
|
33
33
|
) -> void
|
34
34
|
|
35
|
+
def to_hash: -> {
|
36
|
+
id: String,
|
37
|
+
_typename: String,
|
38
|
+
inserted_at: Time,
|
39
|
+
recipient: Knockapi::Models::recipient_reference,
|
40
|
+
type: Knockapi::Models::MessageEvent::type_,
|
41
|
+
data: ::Hash[Symbol, top]?
|
42
|
+
}
|
43
|
+
|
35
44
|
type type_ =
|
36
45
|
:"message.archived"
|
37
46
|
| :"message.bounced"
|
@@ -68,7 +77,7 @@ module Knockapi
|
|
68
77
|
MESSAGE_UNREAD: :"message.unread"
|
69
78
|
MESSAGE_UNSEEN: :"message.unseen"
|
70
79
|
|
71
|
-
def self?.values: -> ::Array[Knockapi::MessageEvent::type_]
|
80
|
+
def self?.values: -> ::Array[Knockapi::Models::MessageEvent::type_]
|
72
81
|
end
|
73
82
|
end
|
74
83
|
end
|