knockapi 1.18.0 → 1.19.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 +23 -0
- data/README.md +1 -1
- data/lib/knockapi/client.rb +12 -0
- data/lib/knockapi/internal/transport/base_client.rb +7 -1
- data/lib/knockapi/internal/transport/pooled_net_requester.rb +6 -2
- data/lib/knockapi/models/identify_user_request.rb +2 -2
- data/lib/knockapi/models/inline_identify_user_request.rb +2 -2
- data/lib/knockapi/models/inline_object_request.rb +11 -3
- data/lib/knockapi/models/object_set_params.rb +11 -3
- data/lib/knockapi/models/objects/bulk_set_params.rb +11 -3
- data/lib/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rb +63 -0
- data/lib/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rb +25 -0
- data/lib/knockapi/models/recipients/channel_data.rb +4 -17
- data/lib/knockapi/models/recipients/channel_data_request.rb +8 -162
- data/lib/knockapi/models/recipients/inline_channel_data_request.rb +6 -160
- data/lib/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rb +20 -0
- data/lib/knockapi/models/recipients/preference_set.rb +12 -54
- data/lib/knockapi/models/recipients/preference_set_channel_setting.rb +21 -0
- data/lib/knockapi/models/recipients/preference_set_request.rb +12 -54
- data/lib/knockapi/models/recipients/push_channel_data_devices_only.rb +60 -0
- data/lib/knockapi/models/recipients/push_channel_data_tokens_only.rb +20 -0
- data/lib/knockapi/models/tenant_request.rb +11 -3
- data/lib/knockapi/models/tenant_set_params.rb +11 -3
- data/lib/knockapi/models/users/feed_list_items_params.rb +15 -1
- data/lib/knockapi/resources/objects.rb +6 -4
- data/lib/knockapi/resources/tenants.rb +4 -2
- data/lib/knockapi/resources/users/feeds.rb +6 -1
- data/lib/knockapi/resources/users.rb +3 -3
- data/lib/knockapi/version.rb +1 -1
- data/lib/knockapi.rb +7 -0
- data/manifest.yaml +1 -0
- data/rbi/knockapi/client.rbi +7 -0
- data/rbi/knockapi/internal/transport/base_client.rbi +5 -0
- data/rbi/knockapi/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/knockapi/internal/type/base_model.rbi +8 -4
- data/rbi/knockapi/models/identify_user_request.rbi +15 -15
- data/rbi/knockapi/models/inline_identify_user_request.rbi +15 -15
- data/rbi/knockapi/models/inline_object_request.rbi +23 -15
- data/rbi/knockapi/models/object_set_params.rbi +28 -20
- data/rbi/knockapi/models/objects/bulk_set_params.rbi +23 -15
- data/rbi/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbi +120 -0
- data/rbi/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbi +35 -0
- data/rbi/knockapi/models/recipients/channel_data.rbi +2 -30
- data/rbi/knockapi/models/recipients/channel_data_request.rbi +20 -326
- data/rbi/knockapi/models/recipients/inline_channel_data_request.rbi +5 -309
- data/rbi/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbi +33 -0
- data/rbi/knockapi/models/recipients/preference_set.rbi +6 -109
- data/rbi/knockapi/models/recipients/preference_set_channel_setting.rbi +38 -0
- data/rbi/knockapi/models/recipients/preference_set_request.rbi +12 -115
- data/rbi/knockapi/models/recipients/push_channel_data_devices_only.rbi +114 -0
- data/rbi/knockapi/models/recipients/push_channel_data_tokens_only.rbi +33 -0
- data/rbi/knockapi/models/tenant_request.rbi +23 -15
- data/rbi/knockapi/models/tenant_set_params.rbi +23 -15
- data/rbi/knockapi/models/users/feed_list_items_params.rbi +17 -0
- data/rbi/knockapi/resources/objects.rbi +14 -11
- data/rbi/knockapi/resources/tenants.rbi +8 -5
- data/rbi/knockapi/resources/users/feeds.rbi +6 -0
- data/rbi/knockapi/resources/users.rbi +11 -11
- data/sig/knockapi/client.rbs +3 -0
- data/sig/knockapi/internal/transport/base_client.rbs +2 -0
- data/sig/knockapi/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/knockapi/models/inline_object_request.rbs +5 -0
- data/sig/knockapi/models/object_set_params.rbs +5 -0
- data/sig/knockapi/models/objects/bulk_set_params.rbs +5 -0
- data/sig/knockapi/models/recipients/aws_sns_push_channel_data_devices_only.rbs +44 -0
- data/sig/knockapi/models/recipients/aws_sns_push_channel_data_target_arns_only.rbs +16 -0
- data/sig/knockapi/models/recipients/channel_data.rbs +1 -12
- data/sig/knockapi/models/recipients/channel_data_request.rbs +5 -116
- data/sig/knockapi/models/recipients/inline_channel_data_request.rbs +5 -116
- data/sig/knockapi/models/recipients/one_signal_channel_data_player_ids_only.rbs +16 -0
- data/sig/knockapi/models/recipients/preference_set.rbs +3 -44
- data/sig/knockapi/models/recipients/preference_set_channel_setting.rbs +16 -0
- data/sig/knockapi/models/recipients/preference_set_request.rbs +3 -44
- data/sig/knockapi/models/recipients/push_channel_data_devices_only.rbs +40 -0
- data/sig/knockapi/models/recipients/push_channel_data_tokens_only.rbs +15 -0
- data/sig/knockapi/models/tenant_request.rbs +5 -0
- data/sig/knockapi/models/tenant_set_params.rbs +5 -0
- data/sig/knockapi/models/users/feed_list_items_params.rbs +7 -0
- data/sig/knockapi/resources/objects.rbs +1 -0
- data/sig/knockapi/resources/tenants.rbs +1 -0
- data/sig/knockapi/resources/users/feeds.rbs +1 -0
- metadata +20 -2
|
@@ -70,7 +70,7 @@ module Knockapi
|
|
|
70
70
|
Symbol,
|
|
71
71
|
T.any(
|
|
72
72
|
T::Boolean,
|
|
73
|
-
Knockapi::Recipients::
|
|
73
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
74
74
|
)
|
|
75
75
|
]
|
|
76
76
|
)
|
|
@@ -125,7 +125,7 @@ module Knockapi
|
|
|
125
125
|
Symbol,
|
|
126
126
|
T.any(
|
|
127
127
|
T::Boolean,
|
|
128
|
-
Knockapi::Recipients::
|
|
128
|
+
Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
|
|
129
129
|
)
|
|
130
130
|
]
|
|
131
131
|
),
|
|
@@ -185,7 +185,7 @@ module Knockapi
|
|
|
185
185
|
Symbol,
|
|
186
186
|
T.any(
|
|
187
187
|
T::Boolean,
|
|
188
|
-
Knockapi::Recipients::
|
|
188
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
189
189
|
)
|
|
190
190
|
]
|
|
191
191
|
),
|
|
@@ -289,7 +289,7 @@ module Knockapi
|
|
|
289
289
|
Symbol,
|
|
290
290
|
T.any(
|
|
291
291
|
T::Boolean,
|
|
292
|
-
Knockapi::Recipients::
|
|
292
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
293
293
|
)
|
|
294
294
|
]
|
|
295
295
|
)
|
|
@@ -315,7 +315,7 @@ module Knockapi
|
|
|
315
315
|
Symbol,
|
|
316
316
|
T.any(
|
|
317
317
|
T::Boolean,
|
|
318
|
-
Knockapi::Recipients::
|
|
318
|
+
Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
|
|
319
319
|
)
|
|
320
320
|
]
|
|
321
321
|
),
|
|
@@ -343,7 +343,7 @@ module Knockapi
|
|
|
343
343
|
Symbol,
|
|
344
344
|
T.any(
|
|
345
345
|
T::Boolean,
|
|
346
|
-
Knockapi::Recipients::
|
|
346
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
347
347
|
)
|
|
348
348
|
]
|
|
349
349
|
),
|
|
@@ -363,45 +363,10 @@ module Knockapi
|
|
|
363
363
|
T.type_alias do
|
|
364
364
|
T.any(
|
|
365
365
|
T::Boolean,
|
|
366
|
-
Knockapi::Recipients::
|
|
366
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
367
367
|
)
|
|
368
368
|
end
|
|
369
369
|
|
|
370
|
-
class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
|
|
371
|
-
OrHash =
|
|
372
|
-
T.type_alias do
|
|
373
|
-
T.any(
|
|
374
|
-
Knockapi::Recipients::PreferenceSetRequest::Category::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting,
|
|
375
|
-
Knockapi::Internal::AnyHash
|
|
376
|
-
)
|
|
377
|
-
end
|
|
378
|
-
|
|
379
|
-
# A list of conditions to apply to a specific channel.
|
|
380
|
-
sig { returns(T::Array[Knockapi::Condition]) }
|
|
381
|
-
attr_accessor :conditions
|
|
382
|
-
|
|
383
|
-
# A set of settings for a specific channel. Currently, this can only be a list of
|
|
384
|
-
# conditions to apply.
|
|
385
|
-
sig do
|
|
386
|
-
params(
|
|
387
|
-
conditions: T::Array[Knockapi::Condition::OrHash]
|
|
388
|
-
).returns(T.attached_class)
|
|
389
|
-
end
|
|
390
|
-
def self.new(
|
|
391
|
-
# A list of conditions to apply to a specific channel.
|
|
392
|
-
conditions:
|
|
393
|
-
)
|
|
394
|
-
end
|
|
395
|
-
|
|
396
|
-
sig do
|
|
397
|
-
override.returns(
|
|
398
|
-
{ conditions: T::Array[Knockapi::Condition] }
|
|
399
|
-
)
|
|
400
|
-
end
|
|
401
|
-
def to_hash
|
|
402
|
-
end
|
|
403
|
-
end
|
|
404
|
-
|
|
405
370
|
sig do
|
|
406
371
|
override.returns(
|
|
407
372
|
T::Array[
|
|
@@ -434,42 +399,9 @@ module Knockapi
|
|
|
434
399
|
T.type_alias do
|
|
435
400
|
T.any(
|
|
436
401
|
T::Boolean,
|
|
437
|
-
Knockapi::Recipients::
|
|
438
|
-
)
|
|
439
|
-
end
|
|
440
|
-
|
|
441
|
-
class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
|
|
442
|
-
OrHash =
|
|
443
|
-
T.type_alias do
|
|
444
|
-
T.any(
|
|
445
|
-
Knockapi::Recipients::PreferenceSetRequest::Channel::PreferenceSetChannelSetting,
|
|
446
|
-
Knockapi::Internal::AnyHash
|
|
447
|
-
)
|
|
448
|
-
end
|
|
449
|
-
|
|
450
|
-
# A list of conditions to apply to a specific channel.
|
|
451
|
-
sig { returns(T::Array[Knockapi::Condition]) }
|
|
452
|
-
attr_accessor :conditions
|
|
453
|
-
|
|
454
|
-
# A set of settings for a specific channel. Currently, this can only be a list of
|
|
455
|
-
# conditions to apply.
|
|
456
|
-
sig do
|
|
457
|
-
params(conditions: T::Array[Knockapi::Condition::OrHash]).returns(
|
|
458
|
-
T.attached_class
|
|
402
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
459
403
|
)
|
|
460
404
|
end
|
|
461
|
-
def self.new(
|
|
462
|
-
# A list of conditions to apply to a specific channel.
|
|
463
|
-
conditions:
|
|
464
|
-
)
|
|
465
|
-
end
|
|
466
|
-
|
|
467
|
-
sig do
|
|
468
|
-
override.returns({ conditions: T::Array[Knockapi::Condition] })
|
|
469
|
-
end
|
|
470
|
-
def to_hash
|
|
471
|
-
end
|
|
472
|
-
end
|
|
473
405
|
|
|
474
406
|
sig do
|
|
475
407
|
override.returns(
|
|
@@ -529,7 +461,7 @@ module Knockapi
|
|
|
529
461
|
Symbol,
|
|
530
462
|
T.any(
|
|
531
463
|
T::Boolean,
|
|
532
|
-
Knockapi::Recipients::
|
|
464
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
533
465
|
)
|
|
534
466
|
]
|
|
535
467
|
)
|
|
@@ -555,7 +487,7 @@ module Knockapi
|
|
|
555
487
|
Symbol,
|
|
556
488
|
T.any(
|
|
557
489
|
T::Boolean,
|
|
558
|
-
Knockapi::Recipients::
|
|
490
|
+
Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
|
|
559
491
|
)
|
|
560
492
|
]
|
|
561
493
|
),
|
|
@@ -583,7 +515,7 @@ module Knockapi
|
|
|
583
515
|
Symbol,
|
|
584
516
|
T.any(
|
|
585
517
|
T::Boolean,
|
|
586
|
-
Knockapi::Recipients::
|
|
518
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
587
519
|
)
|
|
588
520
|
]
|
|
589
521
|
),
|
|
@@ -603,45 +535,10 @@ module Knockapi
|
|
|
603
535
|
T.type_alias do
|
|
604
536
|
T.any(
|
|
605
537
|
T::Boolean,
|
|
606
|
-
Knockapi::Recipients::
|
|
538
|
+
Knockapi::Recipients::PreferenceSetChannelSetting
|
|
607
539
|
)
|
|
608
540
|
end
|
|
609
541
|
|
|
610
|
-
class PreferenceSetChannelSetting < Knockapi::Internal::Type::BaseModel
|
|
611
|
-
OrHash =
|
|
612
|
-
T.type_alias do
|
|
613
|
-
T.any(
|
|
614
|
-
Knockapi::Recipients::PreferenceSetRequest::Workflow::PreferenceSetWorkflowCategorySettingObject::Channel::PreferenceSetChannelSetting,
|
|
615
|
-
Knockapi::Internal::AnyHash
|
|
616
|
-
)
|
|
617
|
-
end
|
|
618
|
-
|
|
619
|
-
# A list of conditions to apply to a specific channel.
|
|
620
|
-
sig { returns(T::Array[Knockapi::Condition]) }
|
|
621
|
-
attr_accessor :conditions
|
|
622
|
-
|
|
623
|
-
# A set of settings for a specific channel. Currently, this can only be a list of
|
|
624
|
-
# conditions to apply.
|
|
625
|
-
sig do
|
|
626
|
-
params(
|
|
627
|
-
conditions: T::Array[Knockapi::Condition::OrHash]
|
|
628
|
-
).returns(T.attached_class)
|
|
629
|
-
end
|
|
630
|
-
def self.new(
|
|
631
|
-
# A list of conditions to apply to a specific channel.
|
|
632
|
-
conditions:
|
|
633
|
-
)
|
|
634
|
-
end
|
|
635
|
-
|
|
636
|
-
sig do
|
|
637
|
-
override.returns(
|
|
638
|
-
{ conditions: T::Array[Knockapi::Condition] }
|
|
639
|
-
)
|
|
640
|
-
end
|
|
641
|
-
def to_hash
|
|
642
|
-
end
|
|
643
|
-
end
|
|
644
|
-
|
|
645
542
|
sig do
|
|
646
543
|
override.returns(
|
|
647
544
|
T::Array[
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Knockapi
|
|
4
|
+
module Models
|
|
5
|
+
module Recipients
|
|
6
|
+
class PushChannelDataDevicesOnly < Knockapi::Internal::Type::BaseModel
|
|
7
|
+
OrHash =
|
|
8
|
+
T.type_alias do
|
|
9
|
+
T.any(
|
|
10
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly,
|
|
11
|
+
Knockapi::Internal::AnyHash
|
|
12
|
+
)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# A list of devices. Each device contains a token, and optionally a locale and
|
|
16
|
+
# timezone.
|
|
17
|
+
sig do
|
|
18
|
+
returns(
|
|
19
|
+
T::Array[Knockapi::Recipients::PushChannelDataDevicesOnly::Device]
|
|
20
|
+
)
|
|
21
|
+
end
|
|
22
|
+
attr_accessor :devices
|
|
23
|
+
|
|
24
|
+
# Push channel data.
|
|
25
|
+
sig do
|
|
26
|
+
params(
|
|
27
|
+
devices:
|
|
28
|
+
T::Array[
|
|
29
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::Device::OrHash
|
|
30
|
+
]
|
|
31
|
+
).returns(T.attached_class)
|
|
32
|
+
end
|
|
33
|
+
def self.new(
|
|
34
|
+
# A list of devices. Each device contains a token, and optionally a locale and
|
|
35
|
+
# timezone.
|
|
36
|
+
devices:
|
|
37
|
+
)
|
|
38
|
+
end
|
|
39
|
+
|
|
40
|
+
sig do
|
|
41
|
+
override.returns(
|
|
42
|
+
{
|
|
43
|
+
devices:
|
|
44
|
+
T::Array[
|
|
45
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::Device
|
|
46
|
+
]
|
|
47
|
+
}
|
|
48
|
+
)
|
|
49
|
+
end
|
|
50
|
+
def to_hash
|
|
51
|
+
end
|
|
52
|
+
|
|
53
|
+
class Device < Knockapi::Internal::Type::BaseModel
|
|
54
|
+
OrHash =
|
|
55
|
+
T.type_alias do
|
|
56
|
+
T.any(
|
|
57
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::Device,
|
|
58
|
+
Knockapi::Internal::AnyHash
|
|
59
|
+
)
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# The device token to send the push notification to.
|
|
63
|
+
sig { returns(String) }
|
|
64
|
+
attr_accessor :token
|
|
65
|
+
|
|
66
|
+
# The locale of the object. Used for
|
|
67
|
+
# [message localization](/concepts/translations).
|
|
68
|
+
sig { returns(T.nilable(String)) }
|
|
69
|
+
attr_accessor :locale
|
|
70
|
+
|
|
71
|
+
# The timezone of the object. Must be a
|
|
72
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
73
|
+
# Used
|
|
74
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
75
|
+
sig { returns(T.nilable(String)) }
|
|
76
|
+
attr_accessor :timezone
|
|
77
|
+
|
|
78
|
+
sig do
|
|
79
|
+
params(
|
|
80
|
+
token: String,
|
|
81
|
+
locale: T.nilable(String),
|
|
82
|
+
timezone: T.nilable(String)
|
|
83
|
+
).returns(T.attached_class)
|
|
84
|
+
end
|
|
85
|
+
def self.new(
|
|
86
|
+
# The device token to send the push notification to.
|
|
87
|
+
token:,
|
|
88
|
+
# The locale of the object. Used for
|
|
89
|
+
# [message localization](/concepts/translations).
|
|
90
|
+
locale: nil,
|
|
91
|
+
# The timezone of the object. Must be a
|
|
92
|
+
# valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
|
93
|
+
# Used
|
|
94
|
+
# for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients).
|
|
95
|
+
timezone: nil
|
|
96
|
+
)
|
|
97
|
+
end
|
|
98
|
+
|
|
99
|
+
sig do
|
|
100
|
+
override.returns(
|
|
101
|
+
{
|
|
102
|
+
token: String,
|
|
103
|
+
locale: T.nilable(String),
|
|
104
|
+
timezone: T.nilable(String)
|
|
105
|
+
}
|
|
106
|
+
)
|
|
107
|
+
end
|
|
108
|
+
def to_hash
|
|
109
|
+
end
|
|
110
|
+
end
|
|
111
|
+
end
|
|
112
|
+
end
|
|
113
|
+
end
|
|
114
|
+
end
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module Knockapi
|
|
4
|
+
module Models
|
|
5
|
+
module Recipients
|
|
6
|
+
class PushChannelDataTokensOnly < Knockapi::Internal::Type::BaseModel
|
|
7
|
+
OrHash =
|
|
8
|
+
T.type_alias do
|
|
9
|
+
T.any(
|
|
10
|
+
Knockapi::Recipients::PushChannelDataTokensOnly,
|
|
11
|
+
Knockapi::Internal::AnyHash
|
|
12
|
+
)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# A list of push channel tokens.
|
|
16
|
+
sig { returns(T::Array[String]) }
|
|
17
|
+
attr_accessor :tokens
|
|
18
|
+
|
|
19
|
+
# Push channel data.
|
|
20
|
+
sig { params(tokens: T::Array[String]).returns(T.attached_class) }
|
|
21
|
+
def self.new(
|
|
22
|
+
# A list of push channel tokens.
|
|
23
|
+
tokens:
|
|
24
|
+
)
|
|
25
|
+
end
|
|
26
|
+
|
|
27
|
+
sig { override.returns({ tokens: T::Array[String] }) }
|
|
28
|
+
def to_hash
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
@@ -19,11 +19,11 @@ module Knockapi
|
|
|
19
19
|
T::Hash[
|
|
20
20
|
Symbol,
|
|
21
21
|
T.any(
|
|
22
|
-
Knockapi::Recipients::
|
|
23
|
-
Knockapi::Recipients::
|
|
24
|
-
Knockapi::Recipients::
|
|
25
|
-
Knockapi::Recipients::
|
|
26
|
-
Knockapi::Recipients::
|
|
22
|
+
Knockapi::Recipients::PushChannelDataTokensOnly,
|
|
23
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly,
|
|
24
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly,
|
|
25
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly,
|
|
26
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly,
|
|
27
27
|
Knockapi::Recipients::SlackChannelData,
|
|
28
28
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
29
29
|
Knockapi::Recipients::DiscordChannelData
|
|
@@ -34,6 +34,10 @@ module Knockapi
|
|
|
34
34
|
end
|
|
35
35
|
attr_accessor :channel_data
|
|
36
36
|
|
|
37
|
+
# An optional name for the tenant.
|
|
38
|
+
sig { returns(T.nilable(String)) }
|
|
39
|
+
attr_accessor :name
|
|
40
|
+
|
|
37
41
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
|
38
42
|
# Preferences that are set inline will be merged into any existing preferences
|
|
39
43
|
# rather than replacing them.
|
|
@@ -61,17 +65,18 @@ module Knockapi
|
|
|
61
65
|
T::Hash[
|
|
62
66
|
Symbol,
|
|
63
67
|
T.any(
|
|
64
|
-
Knockapi::Recipients::
|
|
65
|
-
Knockapi::Recipients::
|
|
66
|
-
Knockapi::Recipients::
|
|
67
|
-
Knockapi::Recipients::
|
|
68
|
-
Knockapi::Recipients::
|
|
68
|
+
Knockapi::Recipients::PushChannelDataTokensOnly::OrHash,
|
|
69
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::OrHash,
|
|
70
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly::OrHash,
|
|
71
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::OrHash,
|
|
72
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
69
73
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
70
74
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
71
75
|
Knockapi::Recipients::DiscordChannelData::OrHash
|
|
72
76
|
)
|
|
73
77
|
]
|
|
74
78
|
),
|
|
79
|
+
name: T.nilable(String),
|
|
75
80
|
preferences:
|
|
76
81
|
T.nilable(
|
|
77
82
|
T::Hash[
|
|
@@ -87,6 +92,8 @@ module Knockapi
|
|
|
87
92
|
id:,
|
|
88
93
|
# A request to set channel data for a type of channel inline.
|
|
89
94
|
channel_data: nil,
|
|
95
|
+
# An optional name for the tenant.
|
|
96
|
+
name: nil,
|
|
90
97
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
|
91
98
|
# Preferences that are set inline will be merged into any existing preferences
|
|
92
99
|
# rather than replacing them.
|
|
@@ -105,17 +112,18 @@ module Knockapi
|
|
|
105
112
|
T::Hash[
|
|
106
113
|
Symbol,
|
|
107
114
|
T.any(
|
|
108
|
-
Knockapi::Recipients::
|
|
109
|
-
Knockapi::Recipients::
|
|
110
|
-
Knockapi::Recipients::
|
|
111
|
-
Knockapi::Recipients::
|
|
112
|
-
Knockapi::Recipients::
|
|
115
|
+
Knockapi::Recipients::PushChannelDataTokensOnly,
|
|
116
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly,
|
|
117
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly,
|
|
118
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly,
|
|
119
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly,
|
|
113
120
|
Knockapi::Recipients::SlackChannelData,
|
|
114
121
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
115
122
|
Knockapi::Recipients::DiscordChannelData
|
|
116
123
|
)
|
|
117
124
|
]
|
|
118
125
|
),
|
|
126
|
+
name: T.nilable(String),
|
|
119
127
|
preferences:
|
|
120
128
|
T.nilable(
|
|
121
129
|
T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest]
|
|
@@ -18,11 +18,11 @@ module Knockapi
|
|
|
18
18
|
T::Hash[
|
|
19
19
|
Symbol,
|
|
20
20
|
T.any(
|
|
21
|
-
Knockapi::Recipients::
|
|
22
|
-
Knockapi::Recipients::
|
|
23
|
-
Knockapi::Recipients::
|
|
24
|
-
Knockapi::Recipients::
|
|
25
|
-
Knockapi::Recipients::
|
|
21
|
+
Knockapi::Recipients::PushChannelDataTokensOnly,
|
|
22
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly,
|
|
23
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly,
|
|
24
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly,
|
|
25
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly,
|
|
26
26
|
Knockapi::Recipients::SlackChannelData,
|
|
27
27
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
28
28
|
Knockapi::Recipients::DiscordChannelData
|
|
@@ -33,6 +33,10 @@ module Knockapi
|
|
|
33
33
|
end
|
|
34
34
|
attr_accessor :channel_data
|
|
35
35
|
|
|
36
|
+
# An optional name for the tenant.
|
|
37
|
+
sig { returns(T.nilable(String)) }
|
|
38
|
+
attr_accessor :name
|
|
39
|
+
|
|
36
40
|
# The settings for the tenant. Includes branding and preference set.
|
|
37
41
|
sig { returns(T.nilable(Knockapi::TenantSetParams::Settings)) }
|
|
38
42
|
attr_reader :settings
|
|
@@ -47,17 +51,18 @@ module Knockapi
|
|
|
47
51
|
T::Hash[
|
|
48
52
|
Symbol,
|
|
49
53
|
T.any(
|
|
50
|
-
Knockapi::Recipients::
|
|
51
|
-
Knockapi::Recipients::
|
|
52
|
-
Knockapi::Recipients::
|
|
53
|
-
Knockapi::Recipients::
|
|
54
|
-
Knockapi::Recipients::
|
|
54
|
+
Knockapi::Recipients::PushChannelDataTokensOnly::OrHash,
|
|
55
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::OrHash,
|
|
56
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly::OrHash,
|
|
57
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::OrHash,
|
|
58
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
55
59
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
56
60
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
57
61
|
Knockapi::Recipients::DiscordChannelData::OrHash
|
|
58
62
|
)
|
|
59
63
|
]
|
|
60
64
|
),
|
|
65
|
+
name: T.nilable(String),
|
|
61
66
|
settings: Knockapi::TenantSetParams::Settings::OrHash,
|
|
62
67
|
request_options: Knockapi::RequestOptions::OrHash
|
|
63
68
|
).returns(T.attached_class)
|
|
@@ -65,6 +70,8 @@ module Knockapi
|
|
|
65
70
|
def self.new(
|
|
66
71
|
# A request to set channel data for a type of channel inline.
|
|
67
72
|
channel_data: nil,
|
|
73
|
+
# An optional name for the tenant.
|
|
74
|
+
name: nil,
|
|
68
75
|
# The settings for the tenant. Includes branding and preference set.
|
|
69
76
|
settings: nil,
|
|
70
77
|
request_options: {}
|
|
@@ -79,17 +86,18 @@ module Knockapi
|
|
|
79
86
|
T::Hash[
|
|
80
87
|
Symbol,
|
|
81
88
|
T.any(
|
|
82
|
-
Knockapi::Recipients::
|
|
83
|
-
Knockapi::Recipients::
|
|
84
|
-
Knockapi::Recipients::
|
|
85
|
-
Knockapi::Recipients::
|
|
86
|
-
Knockapi::Recipients::
|
|
89
|
+
Knockapi::Recipients::PushChannelDataTokensOnly,
|
|
90
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly,
|
|
91
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly,
|
|
92
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly,
|
|
93
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly,
|
|
87
94
|
Knockapi::Recipients::SlackChannelData,
|
|
88
95
|
Knockapi::Recipients::MsTeamsChannelData,
|
|
89
96
|
Knockapi::Recipients::DiscordChannelData
|
|
90
97
|
)
|
|
91
98
|
]
|
|
92
99
|
),
|
|
100
|
+
name: T.nilable(String),
|
|
93
101
|
settings: Knockapi::TenantSetParams::Settings,
|
|
94
102
|
request_options: Knockapi::RequestOptions
|
|
95
103
|
}
|
|
@@ -51,6 +51,16 @@ module Knockapi
|
|
|
51
51
|
sig { params(has_tenant: T::Boolean).void }
|
|
52
52
|
attr_writer :has_tenant
|
|
53
53
|
|
|
54
|
+
# The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
|
|
55
|
+
# `en-US`). When not provided, will default to the locale that the feed items were
|
|
56
|
+
# rendered in. Only available for enterprise plan customers using custom
|
|
57
|
+
# translations.
|
|
58
|
+
sig { returns(T.nilable(String)) }
|
|
59
|
+
attr_reader :locale
|
|
60
|
+
|
|
61
|
+
sig { params(locale: String).void }
|
|
62
|
+
attr_writer :locale
|
|
63
|
+
|
|
54
64
|
# The number of items per page (defaults to 50).
|
|
55
65
|
sig { returns(T.nilable(Integer)) }
|
|
56
66
|
attr_reader :page_size
|
|
@@ -107,6 +117,7 @@ module Knockapi
|
|
|
107
117
|
archived: Knockapi::Users::FeedListItemsParams::Archived::OrSymbol,
|
|
108
118
|
before: String,
|
|
109
119
|
has_tenant: T::Boolean,
|
|
120
|
+
locale: String,
|
|
110
121
|
page_size: Integer,
|
|
111
122
|
source: String,
|
|
112
123
|
status: Knockapi::Users::FeedListItemsParams::Status::OrSymbol,
|
|
@@ -125,6 +136,11 @@ module Knockapi
|
|
|
125
136
|
before: nil,
|
|
126
137
|
# Whether the feed items have a tenant.
|
|
127
138
|
has_tenant: nil,
|
|
139
|
+
# The locale to render the feed items in. Must be in the IETF 5646 format (e.g.
|
|
140
|
+
# `en-US`). When not provided, will default to the locale that the feed items were
|
|
141
|
+
# rendered in. Only available for enterprise plan customers using custom
|
|
142
|
+
# translations.
|
|
143
|
+
locale: nil,
|
|
128
144
|
# The number of items per page (defaults to 50).
|
|
129
145
|
page_size: nil,
|
|
130
146
|
# The workflow key associated with the message in the feed.
|
|
@@ -149,6 +165,7 @@ module Knockapi
|
|
|
149
165
|
Knockapi::Users::FeedListItemsParams::Archived::OrSymbol,
|
|
150
166
|
before: String,
|
|
151
167
|
has_tenant: T::Boolean,
|
|
168
|
+
locale: String,
|
|
152
169
|
page_size: Integer,
|
|
153
170
|
source: String,
|
|
154
171
|
status: Knockapi::Users::FeedListItemsParams::Status::OrSymbol,
|
|
@@ -353,17 +353,18 @@ module Knockapi
|
|
|
353
353
|
T::Hash[
|
|
354
354
|
Symbol,
|
|
355
355
|
T.any(
|
|
356
|
-
Knockapi::Recipients::
|
|
357
|
-
Knockapi::Recipients::
|
|
358
|
-
Knockapi::Recipients::
|
|
359
|
-
Knockapi::Recipients::
|
|
360
|
-
Knockapi::Recipients::
|
|
356
|
+
Knockapi::Recipients::PushChannelDataTokensOnly::OrHash,
|
|
357
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::OrHash,
|
|
358
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly::OrHash,
|
|
359
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::OrHash,
|
|
360
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
361
361
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
362
362
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
363
363
|
Knockapi::Recipients::DiscordChannelData::OrHash
|
|
364
364
|
)
|
|
365
365
|
],
|
|
366
366
|
locale: T.nilable(String),
|
|
367
|
+
name: T.nilable(String),
|
|
367
368
|
preferences:
|
|
368
369
|
T::Hash[Symbol, Knockapi::Recipients::PreferenceSetRequest::OrHash],
|
|
369
370
|
timezone: T.nilable(String),
|
|
@@ -380,6 +381,8 @@ module Knockapi
|
|
|
380
381
|
# The locale of the object. Used for
|
|
381
382
|
# [message localization](/concepts/translations).
|
|
382
383
|
locale: nil,
|
|
384
|
+
# An optional name for the object.
|
|
385
|
+
name: nil,
|
|
383
386
|
# Inline set preferences for a recipient, where the key is the preference set id.
|
|
384
387
|
# Preferences that are set inline will be merged into any existing preferences
|
|
385
388
|
# rather than replacing them.
|
|
@@ -403,11 +406,11 @@ module Knockapi
|
|
|
403
406
|
channel_id: String,
|
|
404
407
|
data:
|
|
405
408
|
T.any(
|
|
406
|
-
Knockapi::Recipients::
|
|
407
|
-
Knockapi::Recipients::
|
|
408
|
-
Knockapi::Recipients::
|
|
409
|
-
Knockapi::Recipients::
|
|
410
|
-
Knockapi::Recipients::
|
|
409
|
+
Knockapi::Recipients::PushChannelDataTokensOnly::OrHash,
|
|
410
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::OrHash,
|
|
411
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly::OrHash,
|
|
412
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::OrHash,
|
|
413
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
411
414
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
412
415
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
413
416
|
Knockapi::Recipients::DiscordChannelData::OrHash
|
|
@@ -461,7 +464,7 @@ module Knockapi
|
|
|
461
464
|
Symbol,
|
|
462
465
|
T.any(
|
|
463
466
|
T::Boolean,
|
|
464
|
-
Knockapi::Recipients::
|
|
467
|
+
Knockapi::Recipients::PreferenceSetChannelSetting::OrHash
|
|
465
468
|
)
|
|
466
469
|
]
|
|
467
470
|
),
|
|
@@ -70,17 +70,18 @@ module Knockapi
|
|
|
70
70
|
T::Hash[
|
|
71
71
|
Symbol,
|
|
72
72
|
T.any(
|
|
73
|
-
Knockapi::Recipients::
|
|
74
|
-
Knockapi::Recipients::
|
|
75
|
-
Knockapi::Recipients::
|
|
76
|
-
Knockapi::Recipients::
|
|
77
|
-
Knockapi::Recipients::
|
|
73
|
+
Knockapi::Recipients::PushChannelDataTokensOnly::OrHash,
|
|
74
|
+
Knockapi::Recipients::PushChannelDataDevicesOnly::OrHash,
|
|
75
|
+
Knockapi::Recipients::AwsSnsPushChannelDataTargetArnsOnly::OrHash,
|
|
76
|
+
Knockapi::Recipients::AwsSnsPushChannelDataDevicesOnly::OrHash,
|
|
77
|
+
Knockapi::Recipients::OneSignalChannelDataPlayerIDsOnly::OrHash,
|
|
78
78
|
Knockapi::Recipients::SlackChannelData::OrHash,
|
|
79
79
|
Knockapi::Recipients::MsTeamsChannelData::OrHash,
|
|
80
80
|
Knockapi::Recipients::DiscordChannelData::OrHash
|
|
81
81
|
)
|
|
82
82
|
]
|
|
83
83
|
),
|
|
84
|
+
name: T.nilable(String),
|
|
84
85
|
settings: Knockapi::TenantSetParams::Settings::OrHash,
|
|
85
86
|
request_options: Knockapi::RequestOptions::OrHash
|
|
86
87
|
).returns(Knockapi::Tenant)
|
|
@@ -90,6 +91,8 @@ module Knockapi
|
|
|
90
91
|
id,
|
|
91
92
|
# A request to set channel data for a type of channel inline.
|
|
92
93
|
channel_data: nil,
|
|
94
|
+
# An optional name for the tenant.
|
|
95
|
+
name: nil,
|
|
93
96
|
# The settings for the tenant. Includes branding and preference set.
|
|
94
97
|
settings: nil,
|
|
95
98
|
request_options: {}
|