knockapi 1.8.1 → 1.10.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.
Files changed (94) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/internal/transport/base_client.rb +10 -2
  5. data/lib/knockapi/models/audience_add_members_params.rb +2 -2
  6. data/lib/knockapi/models/audience_member.rb +2 -2
  7. data/lib/knockapi/models/audience_remove_members_params.rb +2 -2
  8. data/lib/knockapi/models/identify_user_request.rb +2 -2
  9. data/lib/knockapi/models/inline_identify_user_request.rb +4 -4
  10. data/lib/knockapi/models/message.rb +9 -1
  11. data/lib/knockapi/models/message_get_content_response.rb +2 -2
  12. data/lib/knockapi/models/message_list_activities_params.rb +2 -2
  13. data/lib/knockapi/models/message_list_delivery_logs_params.rb +2 -2
  14. data/lib/knockapi/models/message_list_events_params.rb +2 -2
  15. data/lib/knockapi/models/message_list_params.rb +2 -2
  16. data/lib/knockapi/models/messages/batch_get_content_response.rb +2 -2
  17. data/lib/knockapi/models/object_list_messages_params.rb +2 -2
  18. data/lib/knockapi/models/object_list_params.rb +2 -2
  19. data/lib/knockapi/models/object_list_schedules_params.rb +2 -2
  20. data/lib/knockapi/models/object_list_subscriptions_params.rb +2 -2
  21. data/lib/knockapi/models/page_info.rb +2 -2
  22. data/lib/knockapi/models/providers/slack_list_channels_params.rb +2 -1
  23. data/lib/knockapi/models/recipients/channel_data.rb +3 -3
  24. data/lib/knockapi/models/recipients/channel_data_request.rb +3 -3
  25. data/lib/knockapi/models/recipients/inline_channel_data_request.rb +3 -3
  26. data/lib/knockapi/models/recipients/ms_teams_channel_data.rb +1 -1
  27. data/lib/knockapi/models/recipients/push_channel_data.rb +1 -1
  28. data/lib/knockapi/models/recipients/slack_channel_data.rb +1 -1
  29. data/lib/knockapi/models/schedule.rb +5 -5
  30. data/lib/knockapi/models/schedule_create_params.rb +5 -5
  31. data/lib/knockapi/models/schedule_list_params.rb +2 -2
  32. data/lib/knockapi/models/schedule_update_params.rb +5 -5
  33. data/lib/knockapi/models/schedules/bulk_create_params.rb +5 -5
  34. data/lib/knockapi/models/tenant_list_params.rb +2 -2
  35. data/lib/knockapi/models/user.rb +4 -4
  36. data/lib/knockapi/models/user_list_messages_params.rb +2 -2
  37. data/lib/knockapi/models/user_list_params.rb +2 -2
  38. data/lib/knockapi/models/user_list_schedules_params.rb +2 -2
  39. data/lib/knockapi/models/user_list_subscriptions_params.rb +2 -2
  40. data/lib/knockapi/models/users/feed_list_items_params.rb +4 -4
  41. data/lib/knockapi/models/workflow_trigger_params.rb +5 -5
  42. data/lib/knockapi/resources/messages.rb +4 -4
  43. data/lib/knockapi/resources/objects.rb +4 -4
  44. data/lib/knockapi/resources/schedules.rb +3 -3
  45. data/lib/knockapi/resources/tenants.rb +1 -1
  46. data/lib/knockapi/resources/users/feeds.rb +18 -6
  47. data/lib/knockapi/resources/users/guides.rb +4 -4
  48. data/lib/knockapi/resources/users.rb +15 -15
  49. data/lib/knockapi/resources/workflows.rb +1 -1
  50. data/lib/knockapi/version.rb +1 -1
  51. data/rbi/knockapi/models/audience_add_members_params.rbi +2 -2
  52. data/rbi/knockapi/models/audience_member.rbi +2 -2
  53. data/rbi/knockapi/models/audience_remove_members_params.rbi +2 -2
  54. data/rbi/knockapi/models/identify_user_request.rbi +2 -2
  55. data/rbi/knockapi/models/inline_identify_user_request.rbi +4 -4
  56. data/rbi/knockapi/models/message.rbi +11 -3
  57. data/rbi/knockapi/models/message_get_content_response.rbi +1 -1
  58. data/rbi/knockapi/models/message_list_activities_params.rbi +2 -2
  59. data/rbi/knockapi/models/message_list_delivery_logs_params.rbi +2 -2
  60. data/rbi/knockapi/models/message_list_events_params.rbi +2 -2
  61. data/rbi/knockapi/models/message_list_params.rbi +2 -2
  62. data/rbi/knockapi/models/messages/batch_get_content_response.rbi +1 -1
  63. data/rbi/knockapi/models/object_list_messages_params.rbi +2 -2
  64. data/rbi/knockapi/models/object_list_params.rbi +2 -2
  65. data/rbi/knockapi/models/object_list_schedules_params.rbi +2 -2
  66. data/rbi/knockapi/models/object_list_subscriptions_params.rbi +2 -2
  67. data/rbi/knockapi/models/page_info.rbi +2 -2
  68. data/rbi/knockapi/models/providers/slack_list_channels_params.rbi +4 -2
  69. data/rbi/knockapi/models/recipients/ms_teams_channel_data.rbi +1 -1
  70. data/rbi/knockapi/models/recipients/push_channel_data.rbi +1 -1
  71. data/rbi/knockapi/models/recipients/slack_channel_data.rbi +1 -1
  72. data/rbi/knockapi/models/schedule.rbi +8 -8
  73. data/rbi/knockapi/models/schedule_create_params.rbi +8 -8
  74. data/rbi/knockapi/models/schedule_list_params.rbi +2 -2
  75. data/rbi/knockapi/models/schedule_update_params.rbi +8 -8
  76. data/rbi/knockapi/models/schedules/bulk_create_params.rbi +8 -8
  77. data/rbi/knockapi/models/tenant_list_params.rbi +2 -2
  78. data/rbi/knockapi/models/user.rbi +4 -4
  79. data/rbi/knockapi/models/user_list_messages_params.rbi +2 -2
  80. data/rbi/knockapi/models/user_list_params.rbi +2 -2
  81. data/rbi/knockapi/models/user_list_schedules_params.rbi +2 -2
  82. data/rbi/knockapi/models/user_list_subscriptions_params.rbi +2 -2
  83. data/rbi/knockapi/models/users/feed_list_items_params.rbi +4 -4
  84. data/rbi/knockapi/models/workflow_trigger_params.rbi +8 -8
  85. data/rbi/knockapi/resources/messages.rbi +4 -4
  86. data/rbi/knockapi/resources/objects.rbi +4 -4
  87. data/rbi/knockapi/resources/schedules.rbi +9 -9
  88. data/rbi/knockapi/resources/tenants.rbi +1 -1
  89. data/rbi/knockapi/resources/users/feeds.rbi +18 -6
  90. data/rbi/knockapi/resources/users/guides.rbi +4 -4
  91. data/rbi/knockapi/resources/users.rbi +15 -15
  92. data/rbi/knockapi/resources/workflows.rbi +4 -4
  93. data/sig/knockapi/models/message.rbs +8 -3
  94. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 926958a92b323486fd8828298e0a33c15c38291c3969dca3a695b313d7721fb4
4
- data.tar.gz: f5865485cb4f021f109f68f31b5a975f846c2a59e535e11a4e70b88bb0487647
3
+ metadata.gz: 15d3524531f301e1bc6912fd6e30877decb6f10e86f3fcecb879a1aaa3e7e34a
4
+ data.tar.gz: 294acbf61c588df5d1060a59a1af639d088b6d85911a963ca924c1caad0795fa
5
5
  SHA512:
6
- metadata.gz: 5e0ac18c360382062090375543be29799a34b399f7626ed20a694a9f609a7ddf5323a917152babff04b9ec0b371d933319aa8837159226b986e845cd12c8df99
7
- data.tar.gz: 8d3228da62dc6e4f04629604d9cfaf56f2918702f3c347b3589378d1c450424dc6772912469489cb480881236a68ba00674bc33aa5dde3dbbdf422bab7182417
6
+ metadata.gz: 519f43929f720e0d191b0259478af9e4f22c5a5f42ee78c2e6c8435af6d3ad3d72caf9e18e4bbd177f6bd5a05f9aad0af33a2d4b74bd7ce4c6332247061c133c
7
+ data.tar.gz: ac2d4483166ecbd8cb89b60987cd3bfb936c8338a8e0130aa79c483ddef7f6c973b72c2f7ce72ed6bceeef561ffe3b9882072f4e00fc16257e64fcb0e6952fab
data/CHANGELOG.md CHANGED
@@ -1,5 +1,34 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.10.0 (2025-07-15)
4
+
5
+ Full Changelog: [v1.9.0...v1.10.0](https://github.com/knocklabs/knock-ruby/compare/v1.9.0...v1.10.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([d8ce1f1](https://github.com/knocklabs/knock-ruby/commit/d8ce1f14fbfd984d72a8eaa81a060659f46eb9b7))
10
+ * **api:** api update ([b3ed2ae](https://github.com/knocklabs/knock-ruby/commit/b3ed2ae46f54a0e046a8bcef0492c6ae6ee2555a))
11
+
12
+
13
+ ### Chores
14
+
15
+ * **ci:** only run for pushes and fork pull requests ([854d6f0](https://github.com/knocklabs/knock-ruby/commit/854d6f0a527695decdb8e0e4a0093bc3d94eff9f))
16
+ * **internal:** allow streams to also be unwrapped on a per-row basis ([f77e1d6](https://github.com/knocklabs/knock-ruby/commit/f77e1d62802fc88dcb62764834ac1c71005d1f87))
17
+
18
+ ## 1.9.0 (2025-06-27)
19
+
20
+ Full Changelog: [v1.8.1...v1.9.0](https://github.com/knocklabs/knock-ruby/compare/v1.8.1...v1.9.0)
21
+
22
+ ### Features
23
+
24
+ * **api:** api update ([fc8b2d2](https://github.com/knocklabs/knock-ruby/commit/fc8b2d240d0ae0185fea80a1be818505f94f1d16))
25
+ * **api:** api update ([f4f2f96](https://github.com/knocklabs/knock-ruby/commit/f4f2f96ded6152ac1d38ddbded881e306cd682ec))
26
+
27
+
28
+ ### Bug Fixes
29
+
30
+ * **ci:** release-doctor — report correct token name ([dd5f4e2](https://github.com/knocklabs/knock-ruby/commit/dd5f4e20bca8d0881af1593f0a164963e31a1bb9))
31
+
3
32
  ## 1.8.1 (2025-06-18)
4
33
 
5
34
  Full Changelog: [v1.8.0...v1.8.1](https://github.com/knocklabs/knock-ruby/compare/v1.8.0...v1.8.1)
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.8.1"
20
+ gem "knockapi", "~> 1.10.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -471,6 +471,7 @@ module Knockapi
471
471
  self.class.validate!(req)
472
472
  model = req.fetch(:model) { Knockapi::Internal::Type::Unknown }
473
473
  opts = req[:options].to_h
474
+ unwrap = req[:unwrap]
474
475
  Knockapi::RequestOptions.validate!(opts)
475
476
  request = build_request(req.except(:options), opts)
476
477
  url = request.fetch(:url)
@@ -487,11 +488,18 @@ module Knockapi
487
488
  decoded = Knockapi::Internal::Util.decode_content(response, stream: stream)
488
489
  case req
489
490
  in {stream: Class => st}
490
- st.new(model: model, url: url, status: status, response: response, stream: decoded)
491
+ st.new(
492
+ model: model,
493
+ url: url,
494
+ status: status,
495
+ response: response,
496
+ unwrap: unwrap,
497
+ stream: decoded
498
+ )
491
499
  in {page: Class => page}
492
500
  page.new(client: self, req: req, headers: response, page_data: decoded)
493
501
  else
494
- unwrapped = Knockapi::Internal::Util.dig(decoded, req[:unwrap])
502
+ unwrapped = Knockapi::Internal::Util.dig(decoded, unwrap)
495
503
  Knockapi::Internal::Type::Converter.coerce(model, unwrapped)
496
504
  end
497
505
  end
@@ -41,7 +41,7 @@ module Knockapi
41
41
  # @see Knockapi::Models::AudienceAddMembersParams::Member#user
42
42
  class User < Knockapi::Internal::Type::BaseModel
43
43
  # @!attribute id
44
- # The ID for the user that you set when identifying them in Knock.
44
+ # The unique identifier of the user.
45
45
  #
46
46
  # @return [String, nil]
47
47
  optional :id, String
@@ -49,7 +49,7 @@ module Knockapi
49
49
  # @!method initialize(id: nil)
50
50
  # An object containing the user's ID.
51
51
  #
52
- # @param id [String] The ID for the user that you set when identifying them in Knock.
52
+ # @param id [String] The unique identifier of the user.
53
53
  end
54
54
  end
55
55
  end
@@ -24,7 +24,7 @@ module Knockapi
24
24
  required :user, -> { Knockapi::User }
25
25
 
26
26
  # @!attribute user_id
27
- # The ID for the user that you set when identifying them in Knock.
27
+ # The unique identifier of the user.
28
28
  #
29
29
  # @return [String]
30
30
  required :user_id, String
@@ -47,7 +47,7 @@ module Knockapi
47
47
  #
48
48
  # @param user [Knockapi::Models::User] A [User](/concepts/users) represents an individual in your system who can receiv
49
49
  #
50
- # @param user_id [String] The ID for the user that you set when identifying them in Knock.
50
+ # @param user_id [String] The unique identifier of the user.
51
51
  #
52
52
  # @param tenant [String, nil] The unique identifier for the tenant.
53
53
  end
@@ -44,7 +44,7 @@ module Knockapi
44
44
  # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
45
45
  class User < Knockapi::Internal::Type::BaseModel
46
46
  # @!attribute id
47
- # The ID for the user that you set when identifying them in Knock.
47
+ # The unique identifier of the user.
48
48
  #
49
49
  # @return [String, nil]
50
50
  optional :id, String
@@ -52,7 +52,7 @@ module Knockapi
52
52
  # @!method initialize(id: nil)
53
53
  # An object containing the user's ID.
54
54
  #
55
- # @param id [String] The ID for the user that you set when identifying them in Knock.
55
+ # @param id [String] The unique identifier of the user.
56
56
  end
57
57
  end
58
58
  end
@@ -4,7 +4,7 @@ module Knockapi
4
4
  module Models
5
5
  class IdentifyUserRequest < Knockapi::Internal::Type::BaseModel
6
6
  # @!attribute avatar
7
- # URL to the user's avatar image.
7
+ # A URL for the avatar of the user.
8
8
  #
9
9
  # @return [String, nil]
10
10
  optional :avatar, String, nil?: true
@@ -77,7 +77,7 @@ module Knockapi
77
77
  # that's specified elsewhere in the request. You can supply any additional
78
78
  # properties you'd like to upsert for the user.
79
79
  #
80
- # @param avatar [String, nil] URL to the user's avatar image.
80
+ # @param avatar [String, nil] A URL for the avatar of the user.
81
81
  #
82
82
  # @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.
83
83
  #
@@ -4,13 +4,13 @@ module Knockapi
4
4
  module Models
5
5
  class InlineIdentifyUserRequest < Knockapi::Internal::Type::BaseModel
6
6
  # @!attribute id
7
- # The ID for the user that you set when identifying them in Knock.
7
+ # The unique identifier of the user.
8
8
  #
9
9
  # @return [String]
10
10
  required :id, String
11
11
 
12
12
  # @!attribute avatar
13
- # URL to the user's avatar image.
13
+ # A URL for the avatar of the user.
14
14
  #
15
15
  # @return [String, nil]
16
16
  optional :avatar, String, nil?: true
@@ -84,9 +84,9 @@ module Knockapi
84
84
  # It will perform an upsert for the user you're supplying, replacing any
85
85
  # properties specified.
86
86
  #
87
- # @param id [String] The ID for the user that you set when identifying them in Knock.
87
+ # @param id [String] The unique identifier of the user.
88
88
  #
89
- # @param avatar [String, nil] URL to the user's avatar image.
89
+ # @param avatar [String, nil] A URL for the avatar of the user.
90
90
  #
91
91
  # @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.
92
92
  #
@@ -230,7 +230,13 @@ module Knockapi
230
230
  # @return [String]
231
231
  required :version_id, String
232
232
 
233
- # @!method initialize(_typename:, categories:, key:, version_id:)
233
+ # @!attribute step_ref
234
+ # The step reference for the step in the workflow that generated the message
235
+ #
236
+ # @return [String, nil]
237
+ optional :step_ref, String, nil?: true
238
+
239
+ # @!method initialize(_typename:, categories:, key:, version_id:, step_ref: nil)
234
240
  # The workflow that triggered the message.
235
241
  #
236
242
  # @param _typename [String]
@@ -240,6 +246,8 @@ module Knockapi
240
246
  # @param key [String] The key of the workflow that triggered the message.
241
247
  #
242
248
  # @param version_id [String] The ID of the version of the workflow that triggered the message.
249
+ #
250
+ # @param step_ref [String, nil] The step reference for the step in the workflow that generated the message
243
251
  end
244
252
 
245
253
  # The message delivery status.
@@ -51,7 +51,7 @@ module Knockapi
51
51
  # The content of an SMS message.
52
52
  variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessageSMSContent }
53
53
 
54
- # The content of a push notification.
54
+ # Push channel data.
55
55
  variant -> { Knockapi::Models::MessageGetContentResponse::Data::MessagePushContent }
56
56
 
57
57
  # The content of a chat message.
@@ -198,7 +198,7 @@ module Knockapi
198
198
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
199
199
 
200
200
  # @!method initialize(token:, _typename:, body:, title:, data: nil)
201
- # The content of a push notification.
201
+ # Push channel data.
202
202
  #
203
203
  # @param token [String] The device token to send the push notification to.
204
204
  #
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :before, String
21
21
 
22
22
  # @!attribute page_size
23
- # The number of items per page.
23
+ # The number of items per page (defaults to 50).
24
24
  #
25
25
  # @return [Integer, nil]
26
26
  optional :page_size, Integer
@@ -36,7 +36,7 @@ module Knockapi
36
36
  #
37
37
  # @param before [String] The cursor to fetch entries before.
38
38
  #
39
- # @param page_size [Integer] The number of items per page.
39
+ # @param page_size [Integer] The number of items per page (defaults to 50).
40
40
  #
41
41
  # @param trigger_data [String] The trigger data to filter activities by.
42
42
  #
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :before, String
21
21
 
22
22
  # @!attribute page_size
23
- # The number of items per page.
23
+ # The number of items per page (defaults to 50).
24
24
  #
25
25
  # @return [Integer, nil]
26
26
  optional :page_size, Integer
@@ -30,7 +30,7 @@ module Knockapi
30
30
  #
31
31
  # @param before [String] The cursor to fetch entries before.
32
32
  #
33
- # @param page_size [Integer] The number of items per page.
33
+ # @param page_size [Integer] The number of items per page (defaults to 50).
34
34
  #
35
35
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
36
36
  end
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :before, String
21
21
 
22
22
  # @!attribute page_size
23
- # The number of items per page.
23
+ # The number of items per page (defaults to 50).
24
24
  #
25
25
  # @return [Integer, nil]
26
26
  optional :page_size, Integer
@@ -30,7 +30,7 @@ module Knockapi
30
30
  #
31
31
  # @param before [String] The cursor to fetch entries before.
32
32
  #
33
- # @param page_size [Integer] The number of items per page.
33
+ # @param page_size [Integer] The number of items per page (defaults to 50).
34
34
  #
35
35
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
36
36
  end
@@ -45,7 +45,7 @@ module Knockapi
45
45
  optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
46
46
 
47
47
  # @!attribute page_size
48
- # The number of items per page.
48
+ # The number of items per page (defaults to 50).
49
49
  #
50
50
  # @return [Integer, nil]
51
51
  optional :page_size, Integer
@@ -111,7 +111,7 @@ module Knockapi
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
  #
114
- # @param page_size [Integer] The number of items per page.
114
+ # @param page_size [Integer] The number of items per page (defaults to 50).
115
115
  #
116
116
  # @param source [String] Limits the results to messages triggered by the given workflow key.
117
117
  #
@@ -51,7 +51,7 @@ module Knockapi
51
51
  # The content of an SMS message.
52
52
  variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessageSMSContent }
53
53
 
54
- # The content of a push notification.
54
+ # Push channel data.
55
55
  variant -> { Knockapi::Models::Messages::BatchGetContentResponseItem::Data::MessagePushContent }
56
56
 
57
57
  # The content of a chat message.
@@ -198,7 +198,7 @@ module Knockapi
198
198
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
199
199
 
200
200
  # @!method initialize(token:, _typename:, body:, title:, data: nil)
201
- # The content of a push notification.
201
+ # Push channel data.
202
202
  #
203
203
  # @param token [String] The device token to send the push notification to.
204
204
  #
@@ -47,7 +47,7 @@ module Knockapi
47
47
  optional :message_ids, Knockapi::Internal::Type::ArrayOf[String]
48
48
 
49
49
  # @!attribute page_size
50
- # The number of items per page.
50
+ # The number of items per page (defaults to 50).
51
51
  #
52
52
  # @return [Integer, nil]
53
53
  optional :page_size, Integer
@@ -114,7 +114,7 @@ module Knockapi
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
  #
117
- # @param page_size [Integer] The number of items per page.
117
+ # @param page_size [Integer] The number of items per page (defaults to 50).
118
118
  #
119
119
  # @param source [String] Limits the results to messages triggered by the given workflow key.
120
120
  #
@@ -26,7 +26,7 @@ module Knockapi
26
26
  optional :include, -> { Knockapi::Internal::Type::ArrayOf[enum: Knockapi::ObjectListParams::Include] }
27
27
 
28
28
  # @!attribute page_size
29
- # The number of items per page.
29
+ # The number of items per page (defaults to 50).
30
30
  #
31
31
  # @return [Integer, nil]
32
32
  optional :page_size, Integer
@@ -38,7 +38,7 @@ module Knockapi
38
38
  #
39
39
  # @param include [Array<Symbol, Knockapi::Models::ObjectListParams::Include>] Includes preferences of the objects in the response.
40
40
  #
41
- # @param page_size [Integer] The number of items per page.
41
+ # @param page_size [Integer] The number of items per page (defaults to 50).
42
42
  #
43
43
  # @param request_options [Knockapi::RequestOptions, Hash{Symbol=>Object}]
44
44
 
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :before, String
21
21
 
22
22
  # @!attribute page_size
23
- # The number of items per page.
23
+ # The number of items per page (defaults to 50).
24
24
  #
25
25
  # @return [Integer, nil]
26
26
  optional :page_size, Integer
@@ -42,7 +42,7 @@ module Knockapi
42
42
  #
43
43
  # @param before [String] The cursor to fetch entries before.
44
44
  #
45
- # @param page_size [Integer] The number of items per page.
45
+ # @param page_size [Integer] The number of items per page (defaults to 50).
46
46
  #
47
47
  # @param tenant [String] Filter schedules by tenant id.
48
48
  #
@@ -44,7 +44,7 @@ module Knockapi
44
44
  -> { Knockapi::Internal::Type::ArrayOf[Knockapi::ObjectListSubscriptionsParams::Object] }
45
45
 
46
46
  # @!attribute page_size
47
- # The number of items per page.
47
+ # The number of items per page (defaults to 50).
48
48
  #
49
49
  # @return [Integer, nil]
50
50
  optional :page_size, Integer
@@ -69,7 +69,7 @@ module Knockapi
69
69
  #
70
70
  # @param objects [Array<Knockapi::Models::ObjectListSubscriptionsParams::Object>] Objects to filter by (only used if mode is `recipient`).
71
71
  #
72
- # @param page_size [Integer] The number of items per page.
72
+ # @param page_size [Integer] The number of items per page (defaults to 50).
73
73
  #
74
74
  # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Recipients to filter by (only used if mode is `object`).
75
75
  #
@@ -10,7 +10,7 @@ module Knockapi
10
10
  required :_typename, String, api_name: :__typename
11
11
 
12
12
  # @!attribute page_size
13
- # The number of items per page.
13
+ # The number of items per page (defaults to 50).
14
14
  #
15
15
  # @return [Integer]
16
16
  required :page_size, Integer
@@ -32,7 +32,7 @@ module Knockapi
32
32
  #
33
33
  # @param _typename [String] The typename of the schema.
34
34
  #
35
- # @param page_size [Integer] The number of items per page.
35
+ # @param page_size [Integer] The number of items per page (defaults to 50).
36
36
  #
37
37
  # @param after [String, nil] The cursor to fetch entries after.
38
38
  #
@@ -57,7 +57,8 @@ module Knockapi
57
57
  # @!attribute types
58
58
  # Mix and match channel types by providing a comma-separated list of any
59
59
  # combination of public_channel, private_channel, mpim, im. Defaults to
60
- # `"public_channel,private_channel"`.
60
+ # `"public_channel,private_channel"`. If the user's Slack ID is unavailable, this
61
+ # option is ignored and only public channels are returned.
61
62
  #
62
63
  # @return [String, nil]
63
64
  optional :types, String
@@ -45,13 +45,13 @@ module Knockapi
45
45
  module Data
46
46
  extend Knockapi::Internal::Type::Union
47
47
 
48
- # The content of a push notification.
48
+ # Push channel data.
49
49
  variant -> { Knockapi::Recipients::PushChannelData }
50
50
 
51
- # Slack channel data
51
+ # Slack channel data.
52
52
  variant -> { Knockapi::Recipients::SlackChannelData }
53
53
 
54
- # Microsoft Teams channel connection.
54
+ # Microsoft Teams channel data.
55
55
  variant -> { Knockapi::Recipients::MsTeamsChannelData }
56
56
 
57
57
  # Discord channel data.
@@ -21,16 +21,16 @@ module Knockapi
21
21
  module Data
22
22
  extend Knockapi::Internal::Type::Union
23
23
 
24
- # The content of a push notification.
24
+ # Push channel data.
25
25
  variant -> { Knockapi::Recipients::PushChannelData }
26
26
 
27
27
  # OneSignal channel data.
28
28
  variant -> { Knockapi::Recipients::OneSignalChannelData }
29
29
 
30
- # Slack channel data
30
+ # Slack channel data.
31
31
  variant -> { Knockapi::Recipients::SlackChannelData }
32
32
 
33
- # Microsoft Teams channel connection.
33
+ # Microsoft Teams channel data.
34
34
  variant -> { Knockapi::Recipients::MsTeamsChannelData }
35
35
 
36
36
  # Discord channel data.
@@ -7,16 +7,16 @@ module Knockapi
7
7
  module InlineChannelDataRequestItem
8
8
  extend Knockapi::Internal::Type::Union
9
9
 
10
- # The content of a push notification.
10
+ # Push channel data.
11
11
  variant -> { Knockapi::Recipients::PushChannelData }
12
12
 
13
13
  # OneSignal channel data.
14
14
  variant -> { Knockapi::Recipients::OneSignalChannelData }
15
15
 
16
- # Slack channel data
16
+ # Slack channel data.
17
17
  variant -> { Knockapi::Recipients::SlackChannelData }
18
18
 
19
- # Microsoft Teams channel connection.
19
+ # Microsoft Teams channel data.
20
20
  variant -> { Knockapi::Recipients::MsTeamsChannelData }
21
21
 
22
22
  # Discord channel data.
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :ms_teams_tenant_id, String, nil?: true
21
21
 
22
22
  # @!method initialize(connections:, ms_teams_tenant_id: nil)
23
- # Microsoft Teams channel connection.
23
+ # Microsoft Teams channel data.
24
24
  #
25
25
  # @param connections [Array<Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsTokenConnection, Knockapi::Models::Recipients::MsTeamsChannelData::Connection::MsTeamsIncomingWebhookConnection>] List of Microsoft Teams connections.
26
26
  #
@@ -11,7 +11,7 @@ module Knockapi
11
11
  required :tokens, Knockapi::Internal::Type::ArrayOf[String]
12
12
 
13
13
  # @!method initialize(tokens:)
14
- # The content of a push notification.
14
+ # Push channel data.
15
15
  #
16
16
  # @param tokens [Array<String>] A list of push channel tokens.
17
17
  end
@@ -20,7 +20,7 @@ module Knockapi
20
20
  optional :token, -> { Knockapi::Recipients::SlackChannelData::Token }, nil?: true
21
21
 
22
22
  # @!method initialize(connections:, token: nil)
23
- # Slack channel data
23
+ # Slack channel data.
24
24
  #
25
25
  # @param connections [Array<Knockapi::Models::Recipients::SlackChannelData::Connection::SlackTokenConnection, Knockapi::Models::Recipients::SlackChannelData::Connection::SlackIncomingWebhookConnection>] List of Slack channel connections.
26
26
  #
@@ -53,10 +53,10 @@ module Knockapi
53
53
  optional :actor, union: -> { Knockapi::Recipient }, nil?: true
54
54
 
55
55
  # @!attribute data
56
- # An optional map of data to pass into the workflow execution. There is a 1024
57
- # byte limit on the size of any single string value (with the exception of
58
- # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
59
- # size of the full `data` payload.
56
+ # An optional map of data to pass into the workflow execution. There is a 10MB
57
+ # limit on the size of the full `data` payload. Any individual string value
58
+ # greater than 1024 bytes in length will be
59
+ # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
60
60
  #
61
61
  # @return [Hash{Symbol=>Object}, nil]
62
62
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -103,7 +103,7 @@ module Knockapi
103
103
  #
104
104
  # @param actor [Knockapi::Models::User, Knockapi::Models::Object, nil] A recipient of a notification, which is either a user or an object.
105
105
  #
106
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
106
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
107
107
  #
108
108
  # @param last_occurrence_at [Time, nil] The last occurrence of the schedule.
109
109
  #
@@ -28,10 +28,10 @@ module Knockapi
28
28
  optional :actor, union: -> { Knockapi::RecipientRequest }, nil?: true
29
29
 
30
30
  # @!attribute data
31
- # An optional map of data to pass into the workflow execution. There is a 1024
32
- # byte limit on the size of any single string value (with the exception of
33
- # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
34
- # size of the full `data` payload.
31
+ # An optional map of data to pass into the workflow execution. There is a 10MB
32
+ # limit on the size of the full `data` payload. Any individual string value
33
+ # greater than 1024 bytes in length will be
34
+ # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
35
35
  #
36
36
  # @return [Hash{Symbol=>Object}, nil]
37
37
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -70,7 +70,7 @@ module Knockapi
70
70
  #
71
71
  # @param actor [String, Knockapi::Models::InlineIdentifyUserRequest, Knockapi::Models::InlineObjectRequest, nil] Specifies a recipient in a request. This can either be a user identifier (string
72
72
  #
73
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
73
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
74
74
  #
75
75
  # @param ending_at [Time, nil] The ending date and time for the schedule.
76
76
  #
@@ -26,7 +26,7 @@ module Knockapi
26
26
  optional :before, String
27
27
 
28
28
  # @!attribute page_size
29
- # The number of items per page.
29
+ # The number of items per page (defaults to 50).
30
30
  #
31
31
  # @return [Integer, nil]
32
32
  optional :page_size, Integer
@@ -50,7 +50,7 @@ module Knockapi
50
50
  #
51
51
  # @param before [String] The cursor to fetch entries before.
52
52
  #
53
- # @param page_size [Integer] The number of items per page.
53
+ # @param page_size [Integer] The number of items per page (defaults to 50).
54
54
  #
55
55
  # @param recipients [Array<String, Knockapi::Models::RecipientReference::ObjectReference>] Filter by recipient references.
56
56
  #
@@ -21,10 +21,10 @@ module Knockapi
21
21
  optional :actor, union: -> { Knockapi::RecipientReference }, nil?: true
22
22
 
23
23
  # @!attribute data
24
- # An optional map of data to pass into the workflow execution. There is a 1024
25
- # byte limit on the size of any single string value (with the exception of
26
- # [email attachments](/integrations/email/attachments)), and a 10MB limit on the
27
- # size of the full `data` payload.
24
+ # An optional map of data to pass into the workflow execution. There is a 10MB
25
+ # limit on the size of the full `data` payload. Any individual string value
26
+ # greater than 1024 bytes in length will be
27
+ # [truncated](/developer-tools/api-logs#log-truncation) in your logs.
28
28
  #
29
29
  # @return [Hash{Symbol=>Object}, nil]
30
30
  optional :data, Knockapi::Internal::Type::HashOf[Knockapi::Internal::Type::Unknown], nil?: true
@@ -61,7 +61,7 @@ module Knockapi
61
61
  #
62
62
  # @param actor [String, Knockapi::Models::RecipientReference::ObjectReference, nil] A reference to a recipient, either a user identifier (string) or an object refer
63
63
  #
64
- # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 1024 byt
64
+ # @param data [Hash{Symbol=>Object}, nil] An optional map of data to pass into the workflow execution. There is a 10MB lim
65
65
  #
66
66
  # @param ending_at [Time, nil] The ending date and time for the schedule.
67
67
  #