knockapi 1.2.0 → 1.4.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 +30 -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 +27 -25
- 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 +4 -2
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 312dc7ab8b0d9d30d468bff248ea0264923e2a8110c367e4749f91d92bb76340
|
4
|
+
data.tar.gz: 547f9ca3b9100ea38edd309c267c3dd271dc5385c34d321d317dc1293da242c4
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 159cb78df2015135e471b8a05d7f6cd98c43ef5d6ffa3b917cc427f86b42b3f500614b1c0a2658e01be81078235e9db70d675ff06fab876642e1eb082463f5d9
|
7
|
+
data.tar.gz: 239d8fc677b778f0c7463c6f990ebda591ed4ff36f3bc747f5006efa29d8f894381cfdddc1236fedaf35bfd87fc2c767c588e670f220d76e4e0cdfac80c5b956
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,35 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## 1.4.0 (2025-05-29)
|
4
|
+
|
5
|
+
Full Changelog: [v1.3.0...v1.4.0](https://github.com/knocklabs/knock-ruby/compare/v1.3.0...v1.4.0)
|
6
|
+
|
7
|
+
### Features
|
8
|
+
|
9
|
+
* **api:** api update ([f1d1f0f](https://github.com/knocklabs/knock-ruby/commit/f1d1f0f262a0cecec5f416873be4d3ee6418ec94))
|
10
|
+
|
11
|
+
## 1.3.0 (2025-05-28)
|
12
|
+
|
13
|
+
Full Changelog: [v1.2.0...v1.3.0](https://github.com/knocklabs/knock-ruby/compare/v1.2.0...v1.3.0)
|
14
|
+
|
15
|
+
### Features
|
16
|
+
|
17
|
+
* **api:** api update ([c47c0e6](https://github.com/knocklabs/knock-ruby/commit/c47c0e68992f447af50889cd4435d136e5fa2904))
|
18
|
+
* **api:** api update ([346b571](https://github.com/knocklabs/knock-ruby/commit/346b571779ade48f5954f018ab3f7d8f8dbdbdd9))
|
19
|
+
|
20
|
+
|
21
|
+
### Bug Fixes
|
22
|
+
|
23
|
+
* prevent rubocop from mangling `===` to `is_a?` check ([9ddd5e9](https://github.com/knocklabs/knock-ruby/commit/9ddd5e93e0ffb56f07a5216f64ff7a4eaab43468))
|
24
|
+
* sorbet types for enums, and make tapioca detection ignore `tapioca dsl` ([83ce737](https://github.com/knocklabs/knock-ruby/commit/83ce737225a0be39758aa1affcef2352a7e02502))
|
25
|
+
|
26
|
+
|
27
|
+
### Chores
|
28
|
+
|
29
|
+
* **docs:** grammar improvements ([3913113](https://github.com/knocklabs/knock-ruby/commit/3913113994e8e2e203fe2ab60a6e5fd817a130c5))
|
30
|
+
* force utf-8 locale via `RUBYOPT` when formatting ([ec69c77](https://github.com/knocklabs/knock-ruby/commit/ec69c77c94ba059d577798a05098847bb304b36b))
|
31
|
+
* use fully qualified names for yard annotations and rbs aliases ([ef4ddca](https://github.com/knocklabs/knock-ruby/commit/ef4ddca29f6bfa5d707415ee12e18a08738a3293))
|
32
|
+
|
3
33
|
## 1.2.0 (2025-05-21)
|
4
34
|
|
5
35
|
Full Changelog: [v1.1.0...v1.2.0](https://github.com/knocklabs/knock-ruby/compare/v1.1.0...v1.2.0)
|
data/README.md
CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
|
|
17
17
|
<!-- x-release-please-start-version -->
|
18
18
|
|
19
19
|
```ruby
|
20
|
-
gem "knockapi", "~> 1.
|
20
|
+
gem "knockapi", "~> 1.4.0"
|
21
21
|
```
|
22
22
|
|
23
23
|
<!-- x-release-please-end -->
|
@@ -173,7 +173,7 @@ puts(user[:my_undocumented_property])
|
|
173
173
|
|
174
174
|
#### Undocumented request params
|
175
175
|
|
176
|
-
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request as seen in examples above.
|
176
|
+
If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` under the `request_options:` parameter when making a request, as seen in the examples above.
|
177
177
|
|
178
178
|
#### Undocumented endpoints
|
179
179
|
|
@@ -191,7 +191,7 @@ response = client.request(
|
|
191
191
|
|
192
192
|
### Concurrency & connection pooling
|
193
193
|
|
194
|
-
The `Knockapi::Client` instances are threadsafe, but only are fork-safe when there are no in-flight HTTP requests.
|
194
|
+
The `Knockapi::Client` instances are threadsafe, but are only are fork-safe when there are no in-flight HTTP requests.
|
195
195
|
|
196
196
|
Each instance of `Knockapi::Client` has its own HTTP connection pool with a default size of 99. As such, we recommend instantiating the client once per application in most settings.
|
197
197
|
|
@@ -241,7 +241,7 @@ knock.users.feeds.list_items(
|
|
241
241
|
# …
|
242
242
|
)
|
243
243
|
|
244
|
-
# Literal values
|
244
|
+
# Literal values are also permissible:
|
245
245
|
knock.users.feeds.list_items(
|
246
246
|
archived: :exclude,
|
247
247
|
# …
|
data/SECURITY.md
CHANGED
@@ -16,11 +16,11 @@ before making any information public.
|
|
16
16
|
## Reporting Non-SDK Related Security Issues
|
17
17
|
|
18
18
|
If you encounter security issues that are not directly related to SDKs but pertain to the services
|
19
|
-
or products provided by Knock please follow the respective company's security reporting guidelines.
|
19
|
+
or products provided by Knock, please follow the respective company's security reporting guidelines.
|
20
20
|
|
21
21
|
### Knock Terms and Policies
|
22
22
|
|
23
|
-
Please contact security@knock.app for any questions or concerns regarding security of our services.
|
23
|
+
Please contact security@knock.app for any questions or concerns regarding the security of our services.
|
24
24
|
|
25
25
|
---
|
26
26
|
|
@@ -600,11 +600,13 @@ module Knockapi
|
|
600
600
|
#
|
601
601
|
# @return [Object]
|
602
602
|
def encode_content(headers, body)
|
603
|
+
# rubocop:disable Style/CaseEquality
|
604
|
+
# rubocop:disable Layout/LineLength
|
603
605
|
content_type = headers["content-type"]
|
604
606
|
case [content_type, body]
|
605
607
|
in [Knockapi::Internal::Util::JSON_CONTENT, Hash | Array | -> { primitive?(_1) }]
|
606
608
|
[headers, JSON.generate(body)]
|
607
|
-
in [Knockapi::Internal::Util::JSONL_CONTENT, Enumerable] unless
|
609
|
+
in [Knockapi::Internal::Util::JSONL_CONTENT, Enumerable] unless Knockapi::Internal::Type::FileInput === body
|
608
610
|
[headers, body.lazy.map { JSON.generate(_1) }]
|
609
611
|
in [%r{^multipart/form-data}, Hash | Knockapi::Internal::Type::FileInput]
|
610
612
|
boundary, strio = encode_multipart_streaming(body)
|
@@ -619,6 +621,8 @@ module Knockapi
|
|
619
621
|
else
|
620
622
|
[headers, body]
|
621
623
|
end
|
624
|
+
# rubocop:enable Layout/LineLength
|
625
|
+
# rubocop:enable Style/CaseEquality
|
622
626
|
end
|
623
627
|
|
624
628
|
# @api private
|
@@ -871,8 +875,12 @@ module Knockapi
|
|
871
875
|
case type
|
872
876
|
in Knockapi::Internal::Util::SorbetRuntimeSupport
|
873
877
|
type.to_sorbet_type
|
874
|
-
|
878
|
+
in Class | Module
|
875
879
|
type
|
880
|
+
in true | false
|
881
|
+
T::Boolean
|
882
|
+
else
|
883
|
+
type.class
|
876
884
|
end
|
877
885
|
end
|
878
886
|
end
|
@@ -19,7 +19,7 @@ module Knockapi
|
|
19
19
|
# @!attribute actor
|
20
20
|
# A recipient of a notification, which is either a user or an object.
|
21
21
|
#
|
22
|
-
# @return [Knockapi::User, Knockapi::Object, nil]
|
22
|
+
# @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
|
23
23
|
optional :actor, union: -> { Knockapi::Recipient }, nil?: true
|
24
24
|
|
25
25
|
# @!attribute data
|
@@ -37,7 +37,7 @@ module Knockapi
|
|
37
37
|
# @!attribute recipient
|
38
38
|
# A recipient of a notification, which is either a user or an object.
|
39
39
|
#
|
40
|
-
# @return [Knockapi::User, Knockapi::Object, nil]
|
40
|
+
# @return [Knockapi::Models::User, Knockapi::Models::Object, nil]
|
41
41
|
optional :recipient, union: -> { Knockapi::Recipient }
|
42
42
|
|
43
43
|
# @!attribute updated_at
|
@@ -56,13 +56,13 @@ module Knockapi
|
|
56
56
|
#
|
57
57
|
# @param _typename [String] The typename of the schema.
|
58
58
|
#
|
59
|
-
# @param actor [Knockapi::User, Knockapi::Object, nil] A recipient of a notification, which is either a user or an object.
|
59
|
+
# @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
|
60
60
|
#
|
61
61
|
# @param data [Hash{Symbol=>Object}, nil] The workflow trigger `data` payload associated with the activity.
|
62
62
|
#
|
63
63
|
# @param inserted_at [Time] Timestamp when the activity was created.
|
64
64
|
#
|
65
|
-
# @param recipient [Knockapi::User, Knockapi::Object] A recipient of a notification, which is either a user or an object.
|
65
|
+
# @param recipient [Knockapi::Models::User, Knockapi::Models::Object] A recipient of a notification, which is either a user or an object.
|
66
66
|
#
|
67
67
|
# @param updated_at [Time] Timestamp when the activity was last updated.
|
68
68
|
end
|
@@ -10,11 +10,11 @@ module Knockapi
|
|
10
10
|
# @!attribute members
|
11
11
|
# A list of audience members to add.
|
12
12
|
#
|
13
|
-
# @return [Array<Knockapi::AudienceAddMembersParams::Member>]
|
13
|
+
# @return [Array<Knockapi::Models::AudienceAddMembersParams::Member>]
|
14
14
|
required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceAddMembersParams::Member] }
|
15
15
|
|
16
16
|
# @!method initialize(members:, request_options: {})
|
17
|
-
# @param members [Array<Knockapi::AudienceAddMembersParams::Member>] A list of audience members to add.
|
17
|
+
# @param members [Array<Knockapi::Models::AudienceAddMembersParams::Member>] A list of audience members to add.
|
18
18
|
#
|
19
19
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
20
20
|
|
@@ -22,7 +22,7 @@ module Knockapi
|
|
22
22
|
# @!attribute user
|
23
23
|
# An object containing the user's ID.
|
24
24
|
#
|
25
|
-
# @return [Knockapi::AudienceAddMembersParams::Member::User]
|
25
|
+
# @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
|
26
26
|
required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }
|
27
27
|
|
28
28
|
# @!attribute tenant
|
@@ -34,11 +34,11 @@ module Knockapi
|
|
34
34
|
# @!method initialize(user:, tenant: nil)
|
35
35
|
# An audience member.
|
36
36
|
#
|
37
|
-
# @param user [Knockapi::AudienceAddMembersParams::Member::User] An object containing the user's ID.
|
37
|
+
# @param user [Knockapi::Models::AudienceAddMembersParams::Member::User] An object containing the user's ID.
|
38
38
|
#
|
39
39
|
# @param tenant [String, nil] The unique identifier for the tenant.
|
40
40
|
|
41
|
-
# @see Knockapi::AudienceAddMembersParams::Member#user
|
41
|
+
# @see Knockapi::Models::AudienceAddMembersParams::Member#user
|
42
42
|
class User < Knockapi::Internal::Type::BaseModel
|
43
43
|
# @!attribute id
|
44
44
|
# The ID for the user that you set when identifying them in Knock.
|
@@ -7,21 +7,21 @@ module Knockapi
|
|
7
7
|
# @!attribute entries
|
8
8
|
# A list of audience members.
|
9
9
|
#
|
10
|
-
# @return [Array<Knockapi::AudienceMember>]
|
10
|
+
# @return [Array<Knockapi::Models::AudienceMember>]
|
11
11
|
required :entries, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMember] }
|
12
12
|
|
13
13
|
# @!attribute page_info
|
14
14
|
# Pagination information for a list of resources.
|
15
15
|
#
|
16
|
-
# @return [Knockapi::PageInfo]
|
16
|
+
# @return [Knockapi::Models::PageInfo]
|
17
17
|
required :page_info, -> { Knockapi::PageInfo }
|
18
18
|
|
19
19
|
# @!method initialize(entries:, page_info:)
|
20
20
|
# A paginated list of audience members.
|
21
21
|
#
|
22
|
-
# @param entries [Array<Knockapi::AudienceMember>] A list of audience members.
|
22
|
+
# @param entries [Array<Knockapi::Models::AudienceMember>] A list of audience members.
|
23
23
|
#
|
24
|
-
# @param page_info [Knockapi::PageInfo] Pagination information for a list of resources.
|
24
|
+
# @param page_info [Knockapi::Models::PageInfo] Pagination information for a list of resources.
|
25
25
|
end
|
26
26
|
end
|
27
27
|
end
|
@@ -20,7 +20,7 @@ module Knockapi
|
|
20
20
|
# receive notifications through Knock. Users are the most common recipients of
|
21
21
|
# notifications and are always referenced by your internal identifier.
|
22
22
|
#
|
23
|
-
# @return [Knockapi::User]
|
23
|
+
# @return [Knockapi::Models::User]
|
24
24
|
required :user, -> { Knockapi::User }
|
25
25
|
|
26
26
|
# @!attribute user_id
|
@@ -36,8 +36,8 @@ module Knockapi
|
|
36
36
|
optional :tenant, String, nil?: true
|
37
37
|
|
38
38
|
# @!method initialize(_typename:, added_at:, user:, user_id:, tenant: nil)
|
39
|
-
# Some parameter documentations has been truncated, see
|
40
|
-
# for more details.
|
39
|
+
# Some parameter documentations has been truncated, see
|
40
|
+
# {Knockapi::Models::AudienceMember} for more details.
|
41
41
|
#
|
42
42
|
# An audience member.
|
43
43
|
#
|
@@ -45,7 +45,7 @@ module Knockapi
|
|
45
45
|
#
|
46
46
|
# @param added_at [Time] Timestamp when the resource was created.
|
47
47
|
#
|
48
|
-
# @param user [Knockapi::User] A [User](/concepts/users) represents an individual in your system who can receiv
|
48
|
+
# @param user [Knockapi::Models::User] A [User](/concepts/users) represents an individual in your system who can receiv
|
49
49
|
#
|
50
50
|
# @param user_id [String] The ID for the user that you set when identifying them in Knock.
|
51
51
|
#
|
@@ -10,14 +10,14 @@ module Knockapi
|
|
10
10
|
# @!attribute members
|
11
11
|
# A list of audience members to remove.
|
12
12
|
#
|
13
|
-
# @return [Array<Knockapi::AudienceRemoveMembersParams::Member>]
|
13
|
+
# @return [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>]
|
14
14
|
required :members,
|
15
15
|
-> {
|
16
16
|
Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceRemoveMembersParams::Member]
|
17
17
|
}
|
18
18
|
|
19
19
|
# @!method initialize(members:, request_options: {})
|
20
|
-
# @param members [Array<Knockapi::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
20
|
+
# @param members [Array<Knockapi::Models::AudienceRemoveMembersParams::Member>] A list of audience members to remove.
|
21
21
|
#
|
22
22
|
# @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
|
23
23
|
|
@@ -25,7 +25,7 @@ module Knockapi
|
|
25
25
|
# @!attribute user
|
26
26
|
# An object containing the user's ID.
|
27
27
|
#
|
28
|
-
# @return [Knockapi::AudienceRemoveMembersParams::Member::User]
|
28
|
+
# @return [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
|
29
29
|
required :user, -> { Knockapi::AudienceRemoveMembersParams::Member::User }
|
30
30
|
|
31
31
|
# @!attribute tenant
|
@@ -37,11 +37,11 @@ module Knockapi
|
|
37
37
|
# @!method initialize(user:, tenant: nil)
|
38
38
|
# An audience member.
|
39
39
|
#
|
40
|
-
# @param user [Knockapi::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
|
40
|
+
# @param user [Knockapi::Models::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
|
41
41
|
#
|
42
42
|
# @param tenant [String, nil] The unique identifier for the tenant.
|
43
43
|
|
44
|
-
# @see Knockapi::AudienceRemoveMembersParams::Member#user
|
44
|
+
# @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
|
45
45
|
class User < Knockapi::Internal::Type::BaseModel
|
46
46
|
# @!attribute id
|
47
47
|
# The ID for the user that you set when identifying them in Knock.
|
@@ -43,7 +43,7 @@ module Knockapi
|
|
43
43
|
# @!attribute status
|
44
44
|
# The status of the bulk operation.
|
45
45
|
#
|
46
|
-
# @return [Symbol, Knockapi::BulkOperation::Status]
|
46
|
+
# @return [Symbol, Knockapi::Models::BulkOperation::Status]
|
47
47
|
required :status, enum: -> { Knockapi::BulkOperation::Status }
|
48
48
|
|
49
49
|
# @!attribute success_count
|
@@ -73,7 +73,7 @@ module Knockapi
|
|
73
73
|
# @!attribute error_items
|
74
74
|
# A list of items that failed to be processed.
|
75
75
|
#
|
76
|
-
# @return [Array<Knockapi::BulkOperation::ErrorItem>, nil]
|
76
|
+
# @return [Array<Knockapi::Models::BulkOperation::ErrorItem>, nil]
|
77
77
|
optional :error_items, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::BulkOperation::ErrorItem] }
|
78
78
|
|
79
79
|
# @!attribute failed_at
|
@@ -109,7 +109,7 @@ module Knockapi
|
|
109
109
|
#
|
110
110
|
# @param processed_rows [Integer] The number of rows processed so far.
|
111
111
|
#
|
112
|
-
# @param status [Symbol, Knockapi::BulkOperation::Status] The status of the bulk operation.
|
112
|
+
# @param status [Symbol, Knockapi::Models::BulkOperation::Status] The status of the bulk operation.
|
113
113
|
#
|
114
114
|
# @param success_count [Integer] The number of successful operations.
|
115
115
|
#
|
@@ -119,7 +119,7 @@ module Knockapi
|
|
119
119
|
#
|
120
120
|
# @param error_count [Integer] The number of failed operations.
|
121
121
|
#
|
122
|
-
# @param error_items [Array<Knockapi::BulkOperation::ErrorItem>] A list of items that failed to be processed.
|
122
|
+
# @param error_items [Array<Knockapi::Models::BulkOperation::ErrorItem>] A list of items that failed to be processed.
|
123
123
|
#
|
124
124
|
# @param failed_at [Time, nil] Timestamp when the bulk operation failed.
|
125
125
|
#
|
@@ -129,7 +129,7 @@ module Knockapi
|
|
129
129
|
|
130
130
|
# The status of the bulk operation.
|
131
131
|
#
|
132
|
-
# @see Knockapi::BulkOperation#status
|
132
|
+
# @see Knockapi::Models::BulkOperation#status
|
133
133
|
module Status
|
134
134
|
extend Knockapi::Internal::Type::Enum
|
135
135
|
|
@@ -11,13 +11,13 @@ module Knockapi
|
|
11
11
|
# @!attribute archived
|
12
12
|
# Limits the results to messages with the given archived status.
|
13
13
|
#
|
14
|
-
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived, nil]
|
14
|
+
# @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived, nil]
|
15
15
|
optional :archived, enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::Archived }
|
16
16
|
|
17
17
|
# @!attribute delivery_status
|
18
18
|
# Limits the results to messages with the given delivery status.
|
19
19
|
#
|
20
|
-
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
|
20
|
+
# @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus, nil]
|
21
21
|
optional :delivery_status,
|
22
22
|
enum: -> {
|
23
23
|
Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus
|
@@ -26,7 +26,7 @@ module Knockapi
|
|
26
26
|
# @!attribute engagement_status
|
27
27
|
# Limits the results to messages with the given engagement status.
|
28
28
|
#
|
29
|
-
# @return [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
|
29
|
+
# @return [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus, nil]
|
30
30
|
optional :engagement_status,
|
31
31
|
enum: -> { Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus }
|
32
32
|
|
@@ -78,11 +78,11 @@ module Knockapi
|
|
78
78
|
# Some parameter documentations has been truncated, see
|
79
79
|
# {Knockapi::Models::Channels::BulkUpdateMessageStatusParams} for more details.
|
80
80
|
#
|
81
|
-
# @param archived [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
|
81
|
+
# @param archived [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::Archived] Limits the results to messages with the given archived status.
|
82
82
|
#
|
83
|
-
# @param delivery_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
|
83
|
+
# @param delivery_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::DeliveryStatus] Limits the results to messages with the given delivery status.
|
84
84
|
#
|
85
|
-
# @param engagement_status [Symbol, Knockapi::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
|
85
|
+
# @param engagement_status [Symbol, Knockapi::Models::Channels::BulkUpdateMessageStatusParams::EngagementStatus] Limits the results to messages with the given engagement status.
|
86
86
|
#
|
87
87
|
# @param has_tenant [Boolean] Limits the results to messages that have a tenant or not.
|
88
88
|
#
|
@@ -12,7 +12,7 @@ module Knockapi
|
|
12
12
|
# @!attribute operator
|
13
13
|
# The operator to use in the condition evaluation.
|
14
14
|
#
|
15
|
-
# @return [Symbol, Knockapi::Condition::Operator]
|
15
|
+
# @return [Symbol, Knockapi::Models::Condition::Operator]
|
16
16
|
required :operator, enum: -> { Knockapi::Condition::Operator }
|
17
17
|
|
18
18
|
# @!attribute variable
|
@@ -26,13 +26,13 @@ module Knockapi
|
|
26
26
|
#
|
27
27
|
# @param argument [String, nil] The argument value to compare against in the condition.
|
28
28
|
#
|
29
|
-
# @param operator [Symbol, Knockapi::Condition::Operator] The operator to use in the condition evaluation.
|
29
|
+
# @param operator [Symbol, Knockapi::Models::Condition::Operator] The operator to use in the condition evaluation.
|
30
30
|
#
|
31
31
|
# @param variable [String] The variable to be evaluated in the condition.
|
32
32
|
|
33
33
|
# The operator to use in the condition evaluation.
|
34
34
|
#
|
35
|
-
# @see Knockapi::Condition#operator
|
35
|
+
# @see Knockapi::Models::Condition#operator
|
36
36
|
module Operator
|
37
37
|
extend Knockapi::Internal::Type::Enum
|
38
38
|
|
@@ -12,7 +12,7 @@ module Knockapi
|
|
12
12
|
# @!attribute channel_data
|
13
13
|
# A request to set channel data for a type of channel inline.
|
14
14
|
#
|
15
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
15
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
16
16
|
optional :channel_data,
|
17
17
|
-> {
|
18
18
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
@@ -53,7 +53,7 @@ module Knockapi
|
|
53
53
|
# @!attribute preferences
|
54
54
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
55
55
|
#
|
56
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
56
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
|
57
57
|
optional :preferences,
|
58
58
|
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
59
59
|
nil?: true
|
@@ -69,7 +69,7 @@ module Knockapi
|
|
69
69
|
|
70
70
|
# @!method initialize(avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
|
71
71
|
# Some parameter documentations has been truncated, see
|
72
|
-
# {Knockapi::IdentifyUserRequest} for more details.
|
72
|
+
# {Knockapi::Models::IdentifyUserRequest} for more details.
|
73
73
|
#
|
74
74
|
# A set of parameters to identify a user with. Does not include the user ID, as
|
75
75
|
# that's specified elsewhere in the request. You can supply any additional
|
@@ -77,7 +77,7 @@ module Knockapi
|
|
77
77
|
#
|
78
78
|
# @param avatar [String, nil] URL to the user's avatar image.
|
79
79
|
#
|
80
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
80
|
+
# @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}, nil] A request to set channel data for a type of channel inline.
|
81
81
|
#
|
82
82
|
# @param created_at [Time, nil] The creation date of the user from your system.
|
83
83
|
#
|
@@ -89,7 +89,7 @@ module Knockapi
|
|
89
89
|
#
|
90
90
|
# @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
91
91
|
#
|
92
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
92
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
93
93
|
#
|
94
94
|
# @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
|
95
95
|
end
|
@@ -18,7 +18,7 @@ module Knockapi
|
|
18
18
|
# @!attribute channel_data
|
19
19
|
# A request to set channel data for a type of channel inline.
|
20
20
|
#
|
21
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
22
22
|
optional :channel_data,
|
23
23
|
-> {
|
24
24
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
@@ -59,7 +59,7 @@ module Knockapi
|
|
59
59
|
# @!attribute preferences
|
60
60
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
61
61
|
#
|
62
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
62
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
|
63
63
|
optional :preferences,
|
64
64
|
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
65
65
|
nil?: true
|
@@ -75,7 +75,7 @@ module Knockapi
|
|
75
75
|
|
76
76
|
# @!method initialize(id:, avatar: nil, channel_data: nil, created_at: nil, email: nil, locale: nil, name: nil, phone_number: nil, preferences: nil, timezone: nil)
|
77
77
|
# Some parameter documentations has been truncated, see
|
78
|
-
# {Knockapi::InlineIdentifyUserRequest} for more details.
|
78
|
+
# {Knockapi::Models::InlineIdentifyUserRequest} for more details.
|
79
79
|
#
|
80
80
|
# A set of parameters to inline-identify a user with. Inline identifying the user
|
81
81
|
# will ensure that the user is available before the request is executed in Knock.
|
@@ -86,7 +86,7 @@ module Knockapi
|
|
86
86
|
#
|
87
87
|
# @param avatar [String, nil] URL to the user's avatar image.
|
88
88
|
#
|
89
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
89
|
+
# @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}, nil] A request to set channel data for a type of channel inline.
|
90
90
|
#
|
91
91
|
# @param created_at [Time, nil] The creation date of the user from your system.
|
92
92
|
#
|
@@ -98,7 +98,7 @@ module Knockapi
|
|
98
98
|
#
|
99
99
|
# @param phone_number [String, nil] The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the
|
100
100
|
#
|
101
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
101
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
102
102
|
#
|
103
103
|
# @param timezone [String, nil] The timezone of the user. Must be a valid [tz database time zone string](https:/
|
104
104
|
end
|
@@ -18,7 +18,7 @@ module Knockapi
|
|
18
18
|
# @!attribute channel_data
|
19
19
|
# A request to set channel data for a type of channel inline.
|
20
20
|
#
|
21
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil]
|
21
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PushChannelData, Knockapi::Models::Recipients::OneSignalChannelData, Knockapi::Models::Recipients::SlackChannelData, Knockapi::Models::Recipients::MsTeamsChannelData, Knockapi::Models::Recipients::DiscordChannelData}, nil]
|
22
22
|
optional :channel_data,
|
23
23
|
-> {
|
24
24
|
Knockapi::Internal::Type::HashOf[union: Knockapi::Recipients::InlineChannelDataRequestItem]
|
@@ -34,7 +34,7 @@ module Knockapi
|
|
34
34
|
# @!attribute preferences
|
35
35
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
36
36
|
#
|
37
|
-
# @return [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil]
|
37
|
+
# @return [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil]
|
38
38
|
optional :preferences,
|
39
39
|
-> { Knockapi::Internal::Type::HashOf[Knockapi::Recipients::PreferenceSetRequest] },
|
40
40
|
nil?: true
|
@@ -46,11 +46,11 @@ module Knockapi
|
|
46
46
|
#
|
47
47
|
# @param collection [String] The collection this object belongs to.
|
48
48
|
#
|
49
|
-
# @param channel_data [Hash{Symbol=>Knockapi::Recipients::PushChannelData, Knockapi::Recipients::OneSignalChannelData, Knockapi::Recipients::SlackChannelData, Knockapi::Recipients::MsTeamsChannelData, Knockapi::Recipients::DiscordChannelData}, nil] A request to set channel data for a type of channel inline.
|
49
|
+
# @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}, nil] A request to set channel data for a type of channel inline.
|
50
50
|
#
|
51
51
|
# @param created_at [Time, nil] Timestamp when the resource was created.
|
52
52
|
#
|
53
|
-
# @param preferences [Hash{Symbol=>Knockapi::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
53
|
+
# @param preferences [Hash{Symbol=>Knockapi::Models::Recipients::PreferenceSetRequest}, nil] Inline set preferences for a recipient, where the key is the preference set id.
|
54
54
|
end
|
55
55
|
end
|
56
56
|
end
|