growsurf-ruby 1.20.1 → 1.21.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 (95) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/README.md +1 -1
  4. data/lib/growsurf_ruby/models/campaign/create.rb +13 -1
  5. data/lib/growsurf_ruby/models/campaign/delete_reward_group_response.rb +16 -0
  6. data/lib/growsurf_ruby/models/campaign/participant.rb +22 -1
  7. data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_response.rb +1 -1
  8. data/lib/growsurf_ruby/models/campaign/participant_bulk_move_params.rb +20 -0
  9. data/lib/growsurf_ruby/models/campaign/participant_bulk_move_response.rb +57 -0
  10. data/lib/growsurf_ruby/models/campaign/participant_email_params.rb +2 -2
  11. data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rb +3 -3
  12. data/lib/growsurf_ruby/models/campaign/participant_reward.rb +9 -1
  13. data/lib/growsurf_ruby/models/campaign/participant_send_invites_params.rb +1 -7
  14. data/lib/growsurf_ruby/models/campaign/participant_send_invites_response.rb +11 -1
  15. data/lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb +1 -1
  16. data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +12 -1
  17. data/lib/growsurf_ruby/models/campaign/reward.rb +10 -1
  18. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +12 -1
  19. data/lib/growsurf_ruby/models/campaign/reward_group.rb +46 -0
  20. data/lib/growsurf_ruby/models/campaign/reward_group_create_params.rb +18 -0
  21. data/lib/growsurf_ruby/models/campaign/reward_group_delete_params.rb +14 -0
  22. data/lib/growsurf_ruby/models/campaign/reward_group_list_response.rb +13 -0
  23. data/lib/growsurf_ruby/models/campaign/reward_group_retrieve_params.rb +14 -0
  24. data/lib/growsurf_ruby/models/campaign/reward_group_source.rb +23 -0
  25. data/lib/growsurf_ruby/models/campaign/reward_group_update_params.rb +21 -0
  26. data/lib/growsurf_ruby/models/campaign/reward_list_params.rb +18 -0
  27. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +14 -3
  28. data/lib/growsurf_ruby/models/campaign/webhook_test_response.rb +2 -2
  29. data/lib/growsurf_ruby/models/campaign_list_participants_params.rb +10 -1
  30. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +12 -1
  31. data/lib/growsurf_ruby/resources/campaign/groups.rb +103 -0
  32. data/lib/growsurf_ruby/resources/campaign/participant.rb +51 -15
  33. data/lib/growsurf_ruby/resources/campaign/rewards.rb +19 -6
  34. data/lib/growsurf_ruby/resources/campaign.rb +9 -2
  35. data/lib/growsurf_ruby/version.rb +1 -1
  36. data/lib/growsurf_ruby.rb +12 -0
  37. data/rbi/growsurf_ruby/models/campaign/create.rbi +11 -0
  38. data/rbi/growsurf_ruby/models/campaign/delete_reward_group_response.rbi +39 -0
  39. data/rbi/growsurf_ruby/models/campaign/participant.rbi +26 -0
  40. data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +3 -6
  41. data/rbi/growsurf_ruby/models/campaign/participant_bulk_move_params.rbi +41 -0
  42. data/rbi/growsurf_ruby/models/campaign/participant_bulk_move_response.rbi +172 -0
  43. data/rbi/growsurf_ruby/models/campaign/participant_email_params.rbi +2 -2
  44. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbi +2 -2
  45. data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi +8 -0
  46. data/rbi/growsurf_ruby/models/campaign/participant_send_invites_params.rbi +0 -6
  47. data/rbi/growsurf_ruby/models/campaign/participant_send_invites_response.rbi +22 -3
  48. data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi +2 -2
  49. data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +10 -0
  50. data/rbi/growsurf_ruby/models/campaign/reward.rbi +8 -0
  51. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +10 -0
  52. data/rbi/growsurf_ruby/models/campaign/reward_group.rbi +109 -0
  53. data/rbi/growsurf_ruby/models/campaign/reward_group_create_params.rbi +40 -0
  54. data/rbi/growsurf_ruby/models/campaign/reward_group_delete_params.rbi +37 -0
  55. data/rbi/growsurf_ruby/models/campaign/reward_group_list_response.rbi +27 -0
  56. data/rbi/growsurf_ruby/models/campaign/reward_group_retrieve_params.rbi +37 -0
  57. data/rbi/growsurf_ruby/models/campaign/reward_group_source.rbi +36 -0
  58. data/rbi/growsurf_ruby/models/campaign/reward_group_update_params.rbi +48 -0
  59. data/rbi/growsurf_ruby/models/campaign/reward_list_params.rbi +43 -0
  60. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +12 -2
  61. data/rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi +2 -2
  62. data/rbi/growsurf_ruby/models/campaign_list_participants_params.rbi +13 -0
  63. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +24 -0
  64. data/rbi/growsurf_ruby/resources/campaign/groups.rbi +93 -0
  65. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +39 -9
  66. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +13 -2
  67. data/rbi/growsurf_ruby/resources/campaign.rbi +8 -0
  68. data/sig/growsurf_ruby/models/campaign/create.rbs +5 -0
  69. data/sig/growsurf_ruby/models/campaign/delete_reward_group_response.rbs +16 -0
  70. data/sig/growsurf_ruby/models/campaign/participant.rbs +10 -0
  71. data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbs +4 -6
  72. data/sig/growsurf_ruby/models/campaign/participant_bulk_move_params.rbs +24 -0
  73. data/sig/growsurf_ruby/models/campaign/participant_bulk_move_response.rbs +89 -0
  74. data/sig/growsurf_ruby/models/campaign/participant_reward.rbs +5 -0
  75. data/sig/growsurf_ruby/models/campaign/participant_send_invites_params.rbs +1 -6
  76. data/sig/growsurf_ruby/models/campaign/participant_send_invites_response.rbs +14 -3
  77. data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +5 -0
  78. data/sig/growsurf_ruby/models/campaign/reward.rbs +5 -0
  79. data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +5 -0
  80. data/sig/growsurf_ruby/models/campaign/reward_group.rbs +55 -0
  81. data/sig/growsurf_ruby/models/campaign/reward_group_create_params.rbs +22 -0
  82. data/sig/growsurf_ruby/models/campaign/reward_group_delete_params.rbs +22 -0
  83. data/sig/growsurf_ruby/models/campaign/reward_group_list_response.rbs +13 -0
  84. data/sig/growsurf_ruby/models/campaign/reward_group_retrieve_params.rbs +22 -0
  85. data/sig/growsurf_ruby/models/campaign/reward_group_source.rbs +18 -0
  86. data/sig/growsurf_ruby/models/campaign/reward_group_update_params.rbs +25 -0
  87. data/sig/growsurf_ruby/models/campaign/reward_list_params.rbs +23 -0
  88. data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +5 -0
  89. data/sig/growsurf_ruby/models/campaign_list_participants_params.rbs +7 -0
  90. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +9 -0
  91. data/sig/growsurf_ruby/resources/campaign/groups.rbs +42 -0
  92. data/sig/growsurf_ruby/resources/campaign/participant.rbs +9 -1
  93. data/sig/growsurf_ruby/resources/campaign/rewards.rbs +3 -0
  94. data/sig/growsurf_ruby/resources/campaign.rbs +3 -0
  95. metadata +38 -2
@@ -0,0 +1,109 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupRule < GrowsurfRuby::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(RewardGroupRule, GrowsurfRuby::Internal::AnyHash)
10
+ end
11
+
12
+ sig { returns(Type::TaggedSymbol) }
13
+ attr_accessor :type
14
+
15
+ sig { returns(String) }
16
+ attr_accessor :value
17
+
18
+ sig do
19
+ params(type: Type::OrSymbol, value: String).returns(T.attached_class)
20
+ end
21
+ def self.new(type:, value:)
22
+ end
23
+
24
+ sig { override.returns({ type: Type::TaggedSymbol, value: String }) }
25
+ def to_hash
26
+ end
27
+
28
+ module Type
29
+ extend GrowsurfRuby::Internal::Type::Enum
30
+
31
+ TaggedSymbol = T.type_alias { T.all(Symbol, Type) }
32
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
33
+ PARTICIPANT = T.let(:PARTICIPANT, TaggedSymbol)
34
+ EMAIL = T.let(:EMAIL, TaggedSymbol)
35
+ DOMAIN = T.let(:DOMAIN, TaggedSymbol)
36
+ sig { override.returns(T::Array[TaggedSymbol]) }
37
+ def self.values
38
+ end
39
+ end
40
+ end
41
+
42
+ class RewardGroup < GrowsurfRuby::Internal::Type::BaseModel
43
+ OrHash =
44
+ T.type_alias do
45
+ T.any(RewardGroup, GrowsurfRuby::Internal::AnyHash)
46
+ end
47
+
48
+ sig { returns(String) }
49
+ attr_accessor :id
50
+
51
+ sig { returns(String) }
52
+ attr_accessor :name
53
+
54
+ sig { returns(Integer) }
55
+ attr_accessor :order
56
+
57
+ sig { returns(T::Array[RewardGroupRule]) }
58
+ attr_accessor :rules
59
+
60
+ sig { returns(String) }
61
+ attr_accessor :signup_code
62
+
63
+ sig { returns(Integer) }
64
+ attr_accessor :created_at
65
+
66
+ sig { returns(Integer) }
67
+ attr_accessor :updated_at
68
+
69
+ sig do
70
+ params(
71
+ id: String,
72
+ name: String,
73
+ order: Integer,
74
+ rules: T::Array[RewardGroupRule::OrHash],
75
+ signup_code: String,
76
+ created_at: Integer,
77
+ updated_at: Integer
78
+ ).returns(T.attached_class)
79
+ end
80
+ def self.new(
81
+ id:,
82
+ name:,
83
+ order:,
84
+ rules:,
85
+ signup_code:,
86
+ created_at:,
87
+ updated_at:
88
+ )
89
+ end
90
+
91
+ sig do
92
+ override.returns(
93
+ {
94
+ id: String,
95
+ name: String,
96
+ order: Integer,
97
+ rules: T::Array[RewardGroupRule],
98
+ signup_code: String,
99
+ created_at: Integer,
100
+ updated_at: Integer
101
+ }
102
+ )
103
+ end
104
+ def to_hash
105
+ end
106
+ end
107
+ end
108
+ end
109
+ end
@@ -0,0 +1,40 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupCreateParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(RewardGroupCreateParams, GrowsurfRuby::Internal::AnyHash)
13
+ end
14
+
15
+ sig { returns(String) }
16
+ attr_accessor :name
17
+
18
+ sig { returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardGroupRule])) }
19
+ attr_reader :rules
20
+
21
+ sig { params(rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash]).void }
22
+ attr_writer :rules
23
+
24
+ sig do
25
+ params(
26
+ name: String,
27
+ rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash],
28
+ request_options: GrowsurfRuby::RequestOptions::OrHash
29
+ ).returns(T.attached_class)
30
+ end
31
+ def self.new(name:, rules: nil, request_options: {})
32
+ end
33
+
34
+ sig { override.returns(T::Hash[Symbol, T.anything]) }
35
+ def to_hash
36
+ end
37
+ end
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,37 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(RewardGroupDeleteParams, GrowsurfRuby::Internal::AnyHash)
13
+ end
14
+
15
+ sig { returns(String) }
16
+ attr_accessor :id
17
+
18
+ sig do
19
+ params(
20
+ id: String,
21
+ request_options: GrowsurfRuby::RequestOptions::OrHash
22
+ ).returns(T.attached_class)
23
+ end
24
+ def self.new(id:, request_options: {})
25
+ end
26
+
27
+ sig do
28
+ override.returns(
29
+ { id: String, request_options: GrowsurfRuby::RequestOptions }
30
+ )
31
+ end
32
+ def to_hash
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,27 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupListResponse < GrowsurfRuby::Internal::Type::BaseModel
7
+ OrHash =
8
+ T.type_alias do
9
+ T.any(RewardGroupListResponse, GrowsurfRuby::Internal::AnyHash)
10
+ end
11
+
12
+ sig { returns(T::Array[RewardGroup]) }
13
+ attr_accessor :groups
14
+
15
+ sig do
16
+ params(groups: T::Array[RewardGroup::OrHash]).returns(T.attached_class)
17
+ end
18
+ def self.new(groups:)
19
+ end
20
+
21
+ sig { override.returns({ groups: T::Array[RewardGroup] }) }
22
+ def to_hash
23
+ end
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,37 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupRetrieveParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(RewardGroupRetrieveParams, GrowsurfRuby::Internal::AnyHash)
13
+ end
14
+
15
+ sig { returns(String) }
16
+ attr_accessor :id
17
+
18
+ sig do
19
+ params(
20
+ id: String,
21
+ request_options: GrowsurfRuby::RequestOptions::OrHash
22
+ ).returns(T.attached_class)
23
+ end
24
+ def self.new(id:, request_options: {})
25
+ end
26
+
27
+ sig do
28
+ override.returns(
29
+ { id: String, request_options: GrowsurfRuby::RequestOptions }
30
+ )
31
+ end
32
+ def to_hash
33
+ end
34
+ end
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,36 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ # How a participant got into their group. `MANUAL` — a move (a `PARTICIPANT`
7
+ # rule, Update participant, bulk move, or the dashboard), including a move to
8
+ # Default. `LINK` — the group's signup link. `EMAIL` — an `EMAIL` rule.
9
+ # `DOMAIN` — a `DOMAIN` rule.
10
+ module RewardGroupSource
11
+ extend GrowsurfRuby::Internal::Type::Enum
12
+
13
+ TaggedSymbol =
14
+ T.type_alias { T.all(Symbol, GrowsurfRuby::Campaign::RewardGroupSource) }
15
+ OrSymbol = T.type_alias { T.any(Symbol, String) }
16
+
17
+ MANUAL =
18
+ T.let(:MANUAL, GrowsurfRuby::Campaign::RewardGroupSource::TaggedSymbol)
19
+ LINK =
20
+ T.let(:LINK, GrowsurfRuby::Campaign::RewardGroupSource::TaggedSymbol)
21
+ EMAIL =
22
+ T.let(:EMAIL, GrowsurfRuby::Campaign::RewardGroupSource::TaggedSymbol)
23
+ DOMAIN =
24
+ T.let(:DOMAIN, GrowsurfRuby::Campaign::RewardGroupSource::TaggedSymbol)
25
+
26
+ sig do
27
+ override.returns(
28
+ T::Array[GrowsurfRuby::Campaign::RewardGroupSource::TaggedSymbol]
29
+ )
30
+ end
31
+ def self.values
32
+ end
33
+ end
34
+ end
35
+ end
36
+ end
@@ -0,0 +1,48 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardGroupUpdateParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(RewardGroupUpdateParams, GrowsurfRuby::Internal::AnyHash)
13
+ end
14
+
15
+ sig { returns(String) }
16
+ attr_accessor :id
17
+
18
+ sig { returns(T.nilable(String)) }
19
+ attr_accessor :name
20
+
21
+ sig { returns(T.nilable(Integer)) }
22
+ attr_accessor :order
23
+
24
+ sig { returns(T.nilable(T::Array[GrowsurfRuby::Campaign::RewardGroupRule])) }
25
+ attr_reader :rules
26
+
27
+ sig { params(rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash]).void }
28
+ attr_writer :rules
29
+
30
+ sig do
31
+ params(
32
+ id: String,
33
+ name: String,
34
+ order: Integer,
35
+ rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash],
36
+ request_options: GrowsurfRuby::RequestOptions::OrHash
37
+ ).returns(T.attached_class)
38
+ end
39
+ def self.new(id:, name: nil, order: nil, rules: nil, request_options: {})
40
+ end
41
+
42
+ sig { override.returns(T::Hash[Symbol, T.anything]) }
43
+ def to_hash
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,43 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Models
5
+ module Campaign
6
+ class RewardListParams < GrowsurfRuby::Internal::Type::BaseModel
7
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
8
+ include GrowsurfRuby::Internal::Type::RequestParameters
9
+
10
+ OrHash =
11
+ T.type_alias do
12
+ T.any(RewardListParams, GrowsurfRuby::Internal::AnyHash)
13
+ end
14
+
15
+ # Return only this group's rewards. To get Default's rewards, omit `groupId`
16
+ # and keep the rewards whose `groupId` is `null`. An ID that is not a group in this program
17
+ # returns `404`.
18
+ sig { returns(T.nilable(String)) }
19
+ attr_reader :group_id
20
+
21
+ sig { params(group_id: String).void }
22
+ attr_writer :group_id
23
+
24
+ sig do
25
+ params(
26
+ group_id: String,
27
+ request_options: GrowsurfRuby::RequestOptions::OrHash
28
+ ).returns(T.attached_class)
29
+ end
30
+ def self.new(group_id: nil, request_options: {})
31
+ end
32
+
33
+ sig do
34
+ override.returns(
35
+ { group_id: String, request_options: GrowsurfRuby::RequestOptions }
36
+ )
37
+ end
38
+ def to_hash
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -79,6 +79,13 @@ module GrowsurfRuby
79
79
  sig { params(image_url: T.nilable(String)).void }
80
80
  attr_writer :image_url
81
81
 
82
+ # The group this reward belongs to (`grp_…`), or `null` for Default. A participant
83
+ # earns only their own group's rewards.
84
+ # `LEADERBOARD` rewards apply to the whole program and cannot be in a group. An ID
85
+ # that is not a group in this program returns `400`.
86
+ sig { returns(T.nilable(String)) }
87
+ attr_accessor :group_id
88
+
82
89
  # The starter icon shown for the reward, or `null` when `imageUrl` is your own
83
90
  # image. Participant pages draw this icon in your program's accent color. Also set
84
91
  # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
@@ -141,7 +148,7 @@ module GrowsurfRuby
141
148
  end
142
149
  attr_writer :limit_duration
143
150
 
144
- # Custom key/value metadata (single-level; values are stored as strings).
151
+ # Custom key/value metadata (single-level; values are stored as strings). Sending `metadata` replaces the stored object.
145
152
  # Each value must be a string, number, or boolean of up to 500 characters. Each
146
153
  # key must have 1 to 40 characters once camelCased, and two keys that camelCase
147
154
  # to the same key are rejected. Up to 50 keys. An entry that breaks these rules
@@ -254,6 +261,7 @@ module GrowsurfRuby
254
261
  event:
255
262
  GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
256
263
  image_url: T.nilable(String),
264
+ group_id: T.nilable(String),
257
265
  image_icon_key:
258
266
  T.nilable(
259
267
  GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
@@ -294,6 +302,7 @@ module GrowsurfRuby
294
302
  # `MILESTONE` rewards. When omitted, the stored event is preserved.
295
303
  event: nil,
296
304
  image_url: nil,
305
+ group_id: nil,
297
306
  # The starter icon shown for the reward, or `null` when `imageUrl` is your own
298
307
  # image. Participant pages draw this icon in your program's accent color. Also set
299
308
  # `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
@@ -307,7 +316,7 @@ module GrowsurfRuby
307
316
  is_visible: nil,
308
317
  limit: nil,
309
318
  limit_duration: nil,
310
- # Custom key/value metadata (single-level; values are stored as strings).
319
+ # Custom key/value metadata (single-level; values are stored as strings). Sending `metadata` replaces the stored object.
311
320
  # Each value must be a string, number, or boolean of up to 500 characters.
312
321
  # Each key must have 1 to 40 characters once camelCased, and two keys that
313
322
  # camelCase to the same key are rejected. Up to 50 keys. An entry that breaks
@@ -361,6 +370,7 @@ module GrowsurfRuby
361
370
  event:
362
371
  GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
363
372
  image_url: T.nilable(String),
373
+ group_id: T.nilable(String),
364
374
  image_icon_key:
365
375
  T.nilable(
366
376
  GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
@@ -15,7 +15,7 @@ module GrowsurfRuby
15
15
  sig { returns(T::Boolean) }
16
16
  attr_accessor :success
17
17
 
18
- # The mock event payload that was sent.
18
+ # The mock event payload that was sent. `id` is the event ID.
19
19
  sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
20
20
  attr_reader :payload
21
21
 
@@ -47,7 +47,7 @@ module GrowsurfRuby
47
47
  end
48
48
  def self.new(
49
49
  success:,
50
- # The mock event payload that was sent.
50
+ # The mock event payload that was sent. `id` is the event ID.
51
51
  payload: nil,
52
52
  response: nil
53
53
  )
@@ -17,6 +17,14 @@ module GrowsurfRuby
17
17
  sig { returns(String) }
18
18
  attr_accessor :id
19
19
 
20
+ # Return only this group's members. Default has no ID, so it cannot be named
21
+ # here. An ID that is not a group in this program returns `404`.
22
+ sig { returns(T.nilable(String)) }
23
+ attr_reader :group_id
24
+
25
+ sig { params(group_id: String).void }
26
+ attr_writer :group_id
27
+
20
28
  # Number of results to return. Maximum 100.
21
29
  sig { returns(T.nilable(Integer)) }
22
30
  attr_reader :limit
@@ -43,6 +51,7 @@ module GrowsurfRuby
43
51
  sig do
44
52
  params(
45
53
  id: String,
54
+ group_id: String,
46
55
  limit: Integer,
47
56
  metadata: T::Hash[Symbol, String],
48
57
  next_id: String,
@@ -51,6 +60,9 @@ module GrowsurfRuby
51
60
  end
52
61
  def self.new(
53
62
  id:,
63
+ # Return only this group's members. Default has no ID, so it cannot be named
64
+ # here. An ID that is not a group in this program returns `404`.
65
+ group_id: nil,
54
66
  # Number of results to return. Maximum 100.
55
67
  limit: nil,
56
68
  # Return only participants whose metadata matches every given key and value
@@ -67,6 +79,7 @@ module GrowsurfRuby
67
79
  override.returns(
68
80
  {
69
81
  id: String,
82
+ group_id: String,
70
83
  limit: Integer,
71
84
  metadata: T::Hash[Symbol, String],
72
85
  next_id: String,
@@ -1202,6 +1202,24 @@ module GrowsurfRuby
1202
1202
  )
1203
1203
  end
1204
1204
 
1205
+ # Queued or issued Wise payouts that are paused until a refund is confirmed.
1206
+ sig do
1207
+ returns(
1208
+ T.nilable(
1209
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
1210
+ )
1211
+ )
1212
+ end
1213
+ attr_reader :attention
1214
+
1215
+ sig do
1216
+ params(
1217
+ attention:
1218
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash
1219
+ ).void
1220
+ end
1221
+ attr_writer :attention
1222
+
1205
1223
  sig do
1206
1224
  returns(
1207
1225
  T.nilable(
@@ -1290,6 +1308,8 @@ module GrowsurfRuby
1290
1308
  # Affiliate only. Payout counts and amounts by status.
1291
1309
  sig do
1292
1310
  params(
1311
+ attention:
1312
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash,
1293
1313
  failed:
1294
1314
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric::OrHash,
1295
1315
  issued:
@@ -1303,6 +1323,8 @@ module GrowsurfRuby
1303
1323
  ).returns(T.attached_class)
1304
1324
  end
1305
1325
  def self.new(
1326
+ # Queued or issued Wise payouts that are paused until a refund is confirmed.
1327
+ attention: nil,
1306
1328
  failed: nil,
1307
1329
  issued: nil,
1308
1330
  queued: nil,
@@ -1314,6 +1336,8 @@ module GrowsurfRuby
1314
1336
  sig do
1315
1337
  override.returns(
1316
1338
  {
1339
+ attention:
1340
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
1317
1341
  failed:
1318
1342
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
1319
1343
  issued:
@@ -0,0 +1,93 @@
1
+ # typed: strong
2
+
3
+ module GrowsurfRuby
4
+ module Resources
5
+ class Campaign
6
+ class Groups
7
+ # Lists the program's groups in display order. Groups give some participants a
8
+ # different reward list. Each participant is in one group, and `groupId: null` is
9
+ # Default, which holds the program's standard rewards and is
10
+ # not in this list. A group's rewards replace Default's whole reward list for its
11
+ # members' new referrals. Leaderboard rewards stay program-wide.
12
+ sig do
13
+ params(
14
+ id: String,
15
+ request_options: GrowsurfRuby::RequestOptions::OrHash
16
+ ).returns(GrowsurfRuby::Campaign::RewardGroupListResponse)
17
+ end
18
+ def list(id, request_options: {})
19
+ end
20
+
21
+ # Creates an empty group. Add Campaign Rewards with its `groupId` before adding
22
+ # participants or rules. Omit `rules` or send an empty array; nonempty rules return `400`.
23
+ # Group names must be unique, ignoring case. Duplicate names return `409`; "Default" returns `400`.
24
+ sig do
25
+ params(
26
+ id: String,
27
+ name: String,
28
+ rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash],
29
+ request_options: GrowsurfRuby::RequestOptions::OrHash
30
+ ).returns(GrowsurfRuby::Campaign::RewardGroup)
31
+ end
32
+ def create(id, name:, rules: nil, request_options: {})
33
+ end
34
+
35
+ # Retrieves one of the program's groups.
36
+ sig do
37
+ params(
38
+ group_id: String,
39
+ id: String,
40
+ request_options: GrowsurfRuby::RequestOptions::OrHash
41
+ ).returns(GrowsurfRuby::Campaign::RewardGroup)
42
+ end
43
+ def retrieve(group_id, id:, request_options: {})
44
+ end
45
+
46
+ # Renames, reorders, or changes the rules of a group. Sending `rules` replaces the
47
+ # whole list. An added `PARTICIPANT` rule moves that participant in now; a removed
48
+ # one moves them back to Default if they are still in this group. Email and domain
49
+ # rule changes move no one. To change the group's rewards, update its Campaign
50
+ # Rewards. Group names must be unique in the program, ignoring case. A name that
51
+ # another group uses returns `409`, and "Default" returns `400`.
52
+ sig do
53
+ params(
54
+ group_id: String,
55
+ id: String,
56
+ name: String,
57
+ order: Integer,
58
+ rules: T::Array[GrowsurfRuby::Campaign::RewardGroupRule::OrHash],
59
+ request_options: GrowsurfRuby::RequestOptions::OrHash
60
+ ).returns(GrowsurfRuby::Campaign::RewardGroup)
61
+ end
62
+ def update(
63
+ group_id,
64
+ id:,
65
+ name: nil,
66
+ order: nil,
67
+ rules: nil,
68
+ request_options: {}
69
+ )
70
+ end
71
+
72
+ # Deletes a group. Its members move to Default, and its Campaign Rewards are
73
+ # removed from the program, so they no longer appear in
74
+ # `GET /campaign/{id}/reward-configs`. Rewards already earned keep their amounts
75
+ # and can still be sent.
76
+ sig do
77
+ params(
78
+ group_id: String,
79
+ id: String,
80
+ request_options: GrowsurfRuby::RequestOptions::OrHash
81
+ ).returns(GrowsurfRuby::Campaign::DeleteRewardGroupResponse)
82
+ end
83
+ def delete(group_id, id:, request_options: {})
84
+ end
85
+
86
+ # @api private
87
+ sig { params(client: GrowsurfRuby::Client).returns(T.attached_class) }
88
+ def self.new(client:)
89
+ end
90
+ end
91
+ end
92
+ end
93
+ end