growsurf-ruby 1.14.1 → 1.15.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 +8 -0
- data/README.md +1 -1
- data/lib/growsurf_ruby/models/campaign/reward.rb +44 -1
- data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +46 -1
- data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +46 -1
- data/lib/growsurf_ruby/models/campaign.rb +44 -1
- data/lib/growsurf_ruby/resources/campaign/rewards.rb +6 -2
- data/lib/growsurf_ruby/version.rb +1 -1
- data/rbi/growsurf_ruby/models/campaign/reward.rbi +156 -0
- data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +170 -0
- data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +170 -0
- data/rbi/growsurf_ruby/models/campaign.rbi +156 -0
- data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +18 -0
- data/sig/growsurf_ruby/models/campaign/reward.rbs +58 -0
- data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +62 -0
- data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +62 -0
- data/sig/growsurf_ruby/models/campaign.rbs +58 -0
- data/sig/growsurf_ruby/resources/campaign/rewards.rbs +2 -0
- 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: a92bc11a3304bcfbf0a6b3e304698b4e3fd522a0e170f08bdbe96a3a83a3f8fa
|
|
4
|
+
data.tar.gz: f2e96dfde9474b90a5437e55840d3ffc1bfa005c321dbb8f4c18fb0aee3f05cf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: bfede3fbe36f45a13f78d0b064634fafab928da30fc4315c09541fc0eaab59ad91f95af462953ca842959eca0ed06dbce9a33f0b1d566fd590f94203c24009a7
|
|
7
|
+
data.tar.gz: f8801a4c1c5eb935b89e0df6e736f4fc8effbf28a6965b2d7147e2b12a70b25e16df9c209814b1bf3c7966b450785072b73d6fd61005e9befffb08a337de64ff
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.15.0](https://github.com/growsurf/growsurf-ruby/compare/v1.14.1...v1.15.0) (2026-10-19)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* support reward image icon keys ([a51d974](https://github.com/growsurf/growsurf-ruby/commit/a51d9748c1073120d2ecc2a4b2facbe0618d62aa))
|
|
9
|
+
* support reward image icon keys ([a0290fa](https://github.com/growsurf/growsurf-ruby/commit/a0290fa507bd49a413d6d1969446eab5ba09a7c2))
|
|
10
|
+
|
|
3
11
|
## [1.14.1](https://github.com/growsurf/growsurf-ruby/compare/v1.14.0...v1.14.1) (2026-10-18)
|
|
4
12
|
|
|
5
13
|
|
data/README.md
CHANGED
|
@@ -65,6 +65,16 @@ module GrowsurfRuby
|
|
|
65
65
|
# @return [String, nil]
|
|
66
66
|
optional :image_url, String, api_name: :imageUrl, nil?: true
|
|
67
67
|
|
|
68
|
+
# @!attribute image_icon_key
|
|
69
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
70
|
+
# image.
|
|
71
|
+
#
|
|
72
|
+
# @return [Symbol, GrowsurfRuby::Models::Campaign::Reward::ImageIconKey, nil]
|
|
73
|
+
optional :image_icon_key,
|
|
74
|
+
enum: -> { GrowsurfRuby::Campaign::Reward::ImageIconKey },
|
|
75
|
+
api_name: :imageIconKey,
|
|
76
|
+
nil?: true
|
|
77
|
+
|
|
68
78
|
# @!attribute is_visible
|
|
69
79
|
# Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
70
80
|
# participants and no longer awarded, including those who already earned it.
|
|
@@ -153,7 +163,7 @@ module GrowsurfRuby
|
|
|
153
163
|
# @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
|
|
154
164
|
optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
|
|
155
165
|
|
|
156
|
-
# @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_visible: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil)
|
|
166
|
+
# @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, is_visible: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil)
|
|
157
167
|
# @param id [String]
|
|
158
168
|
#
|
|
159
169
|
# @param is_unlimited [Boolean]
|
|
@@ -174,6 +184,8 @@ module GrowsurfRuby
|
|
|
174
184
|
#
|
|
175
185
|
# @param image_url [String, nil]
|
|
176
186
|
#
|
|
187
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::Campaign::Reward::ImageIconKey, nil] The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
|
|
188
|
+
#
|
|
177
189
|
# @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
178
190
|
#
|
|
179
191
|
# @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
|
|
@@ -236,6 +248,37 @@ module GrowsurfRuby
|
|
|
236
248
|
# @!method self.values
|
|
237
249
|
# @return [Array<Symbol>]
|
|
238
250
|
end
|
|
251
|
+
|
|
252
|
+
# @see GrowsurfRuby::Models::Campaign::Reward#image_icon_key
|
|
253
|
+
module ImageIconKey
|
|
254
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
255
|
+
|
|
256
|
+
GIFT_1 = :GIFT_1
|
|
257
|
+
GIFT_2 = :GIFT_2
|
|
258
|
+
GIFT_3 = :GIFT_3
|
|
259
|
+
GIFT_4 = :GIFT_4
|
|
260
|
+
GIFT_5 = :GIFT_5
|
|
261
|
+
GIFT_6 = :GIFT_6
|
|
262
|
+
GIFT_CARD = :GIFT_CARD
|
|
263
|
+
CASH = :CASH
|
|
264
|
+
COIN = :COIN
|
|
265
|
+
CARD = :CARD
|
|
266
|
+
STAR_1 = :STAR_1
|
|
267
|
+
STAR_2 = :STAR_2
|
|
268
|
+
STAR_3 = :STAR_3
|
|
269
|
+
TROPHY = :TROPHY
|
|
270
|
+
CROWN = :CROWN
|
|
271
|
+
SEAL = :SEAL
|
|
272
|
+
HEART_1 = :HEART_1
|
|
273
|
+
HEART_2 = :HEART_2
|
|
274
|
+
TAG = :TAG
|
|
275
|
+
DIAMOND = :DIAMOND
|
|
276
|
+
CONFETTI = :CONFETTI
|
|
277
|
+
ROCKET = :ROCKET
|
|
278
|
+
|
|
279
|
+
# @!method self.values
|
|
280
|
+
# @return [Array<Symbol>]
|
|
281
|
+
end
|
|
239
282
|
end
|
|
240
283
|
end
|
|
241
284
|
end
|
|
@@ -52,6 +52,18 @@ module GrowsurfRuby
|
|
|
52
52
|
# @return [String, nil]
|
|
53
53
|
optional :image_url, String, api_name: :imageUrl, nil?: true
|
|
54
54
|
|
|
55
|
+
# @!attribute image_icon_key
|
|
56
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
57
|
+
# image. Participant pages draw this icon in your program's accent color. Also set
|
|
58
|
+
# `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
|
|
59
|
+
# `imageUrl` without `imageIconKey` clears it.
|
|
60
|
+
#
|
|
61
|
+
# @return [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey, nil]
|
|
62
|
+
optional :image_icon_key,
|
|
63
|
+
enum: -> { GrowsurfRuby::Campaign::RewardCreateParams::ImageIconKey },
|
|
64
|
+
api_name: :imageIconKey,
|
|
65
|
+
nil?: true
|
|
66
|
+
|
|
55
67
|
# @!attribute is_unlimited
|
|
56
68
|
# Whether the reward can be earned an unlimited number of times. Defaults to
|
|
57
69
|
# `true`, except `MILESTONE` rewards, which can only be earned once.
|
|
@@ -153,7 +165,7 @@ module GrowsurfRuby
|
|
|
153
165
|
# @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
|
|
154
166
|
optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
|
|
155
167
|
|
|
156
|
-
# @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
168
|
+
# @!method initialize(type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
157
169
|
# Some parameter documentations has been truncated, see
|
|
158
170
|
# {GrowsurfRuby::Models::Campaign::RewardCreateParams} for more details.
|
|
159
171
|
#
|
|
@@ -171,6 +183,8 @@ module GrowsurfRuby
|
|
|
171
183
|
#
|
|
172
184
|
# @param image_url [String]
|
|
173
185
|
#
|
|
186
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey, nil] The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
|
|
187
|
+
#
|
|
174
188
|
# @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
|
|
175
189
|
#
|
|
176
190
|
# @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
@@ -239,6 +253,37 @@ module GrowsurfRuby
|
|
|
239
253
|
# @!method self.values
|
|
240
254
|
# @return [Array<Symbol>]
|
|
241
255
|
end
|
|
256
|
+
|
|
257
|
+
# @see GrowsurfRuby::Models::Campaign::RewardCreateParams#image_icon_key
|
|
258
|
+
module ImageIconKey
|
|
259
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
260
|
+
|
|
261
|
+
GIFT_1 = :GIFT_1
|
|
262
|
+
GIFT_2 = :GIFT_2
|
|
263
|
+
GIFT_3 = :GIFT_3
|
|
264
|
+
GIFT_4 = :GIFT_4
|
|
265
|
+
GIFT_5 = :GIFT_5
|
|
266
|
+
GIFT_6 = :GIFT_6
|
|
267
|
+
GIFT_CARD = :GIFT_CARD
|
|
268
|
+
CASH = :CASH
|
|
269
|
+
COIN = :COIN
|
|
270
|
+
CARD = :CARD
|
|
271
|
+
STAR_1 = :STAR_1
|
|
272
|
+
STAR_2 = :STAR_2
|
|
273
|
+
STAR_3 = :STAR_3
|
|
274
|
+
TROPHY = :TROPHY
|
|
275
|
+
CROWN = :CROWN
|
|
276
|
+
SEAL = :SEAL
|
|
277
|
+
HEART_1 = :HEART_1
|
|
278
|
+
HEART_2 = :HEART_2
|
|
279
|
+
TAG = :TAG
|
|
280
|
+
DIAMOND = :DIAMOND
|
|
281
|
+
CONFETTI = :CONFETTI
|
|
282
|
+
ROCKET = :ROCKET
|
|
283
|
+
|
|
284
|
+
# @!method self.values
|
|
285
|
+
# @return [Array<Symbol>]
|
|
286
|
+
end
|
|
242
287
|
end
|
|
243
288
|
end
|
|
244
289
|
end
|
|
@@ -57,6 +57,18 @@ module GrowsurfRuby
|
|
|
57
57
|
# @return [String, nil]
|
|
58
58
|
optional :image_url, String, api_name: :imageUrl, nil?: true
|
|
59
59
|
|
|
60
|
+
# @!attribute image_icon_key
|
|
61
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
62
|
+
# image. Participant pages draw this icon in your program's accent color. Also set
|
|
63
|
+
# `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending
|
|
64
|
+
# `imageUrl` without `imageIconKey` clears it.
|
|
65
|
+
#
|
|
66
|
+
# @return [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey, nil]
|
|
67
|
+
optional :image_icon_key,
|
|
68
|
+
enum: -> { GrowsurfRuby::Campaign::RewardUpdateParams::ImageIconKey },
|
|
69
|
+
api_name: :imageIconKey,
|
|
70
|
+
nil?: true
|
|
71
|
+
|
|
60
72
|
# @!attribute is_unlimited
|
|
61
73
|
# Whether the reward can be earned an unlimited number of times. Defaults to
|
|
62
74
|
# `true`, except `MILESTONE` rewards, which can only be earned once.
|
|
@@ -158,7 +170,7 @@ module GrowsurfRuby
|
|
|
158
170
|
# @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
|
|
159
171
|
optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
|
|
160
172
|
|
|
161
|
-
# @!method initialize(id:, campaign_reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
173
|
+
# @!method initialize(id:, campaign_reward_id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
162
174
|
# Some parameter documentations has been truncated, see
|
|
163
175
|
# {GrowsurfRuby::Models::Campaign::RewardUpdateParams} for more details.
|
|
164
176
|
#
|
|
@@ -178,6 +190,8 @@ module GrowsurfRuby
|
|
|
178
190
|
#
|
|
179
191
|
# @param image_url [String]
|
|
180
192
|
#
|
|
193
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey, nil] The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
|
|
194
|
+
#
|
|
181
195
|
# @param is_unlimited [Boolean] Whether the reward can be earned an unlimited number of times. Defaults to `true
|
|
182
196
|
#
|
|
183
197
|
# @param is_visible [Boolean] Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
@@ -232,6 +246,37 @@ module GrowsurfRuby
|
|
|
232
246
|
# @!method self.values
|
|
233
247
|
# @return [Array<Symbol>]
|
|
234
248
|
end
|
|
249
|
+
|
|
250
|
+
# @see GrowsurfRuby::Models::Campaign::RewardUpdateParams#image_icon_key
|
|
251
|
+
module ImageIconKey
|
|
252
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
253
|
+
|
|
254
|
+
GIFT_1 = :GIFT_1
|
|
255
|
+
GIFT_2 = :GIFT_2
|
|
256
|
+
GIFT_3 = :GIFT_3
|
|
257
|
+
GIFT_4 = :GIFT_4
|
|
258
|
+
GIFT_5 = :GIFT_5
|
|
259
|
+
GIFT_6 = :GIFT_6
|
|
260
|
+
GIFT_CARD = :GIFT_CARD
|
|
261
|
+
CASH = :CASH
|
|
262
|
+
COIN = :COIN
|
|
263
|
+
CARD = :CARD
|
|
264
|
+
STAR_1 = :STAR_1
|
|
265
|
+
STAR_2 = :STAR_2
|
|
266
|
+
STAR_3 = :STAR_3
|
|
267
|
+
TROPHY = :TROPHY
|
|
268
|
+
CROWN = :CROWN
|
|
269
|
+
SEAL = :SEAL
|
|
270
|
+
HEART_1 = :HEART_1
|
|
271
|
+
HEART_2 = :HEART_2
|
|
272
|
+
TAG = :TAG
|
|
273
|
+
DIAMOND = :DIAMOND
|
|
274
|
+
CONFETTI = :CONFETTI
|
|
275
|
+
ROCKET = :ROCKET
|
|
276
|
+
|
|
277
|
+
# @!method self.values
|
|
278
|
+
# @return [Array<Symbol>]
|
|
279
|
+
end
|
|
235
280
|
end
|
|
236
281
|
end
|
|
237
282
|
end
|
|
@@ -133,6 +133,16 @@ module GrowsurfRuby
|
|
|
133
133
|
# @return [String, nil]
|
|
134
134
|
optional :image_url, String, api_name: :imageUrl, nil?: true
|
|
135
135
|
|
|
136
|
+
# @!attribute image_icon_key
|
|
137
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
138
|
+
# image.
|
|
139
|
+
#
|
|
140
|
+
# @return [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::ImageIconKey, nil]
|
|
141
|
+
optional :image_icon_key,
|
|
142
|
+
enum: -> { GrowsurfRuby::CampaignAPI::Reward::ImageIconKey },
|
|
143
|
+
api_name: :imageIconKey,
|
|
144
|
+
nil?: true
|
|
145
|
+
|
|
136
146
|
# @!attribute limit
|
|
137
147
|
# `-1` represents an unlimited reward in REST responses.
|
|
138
148
|
#
|
|
@@ -208,7 +218,7 @@ module GrowsurfRuby
|
|
|
208
218
|
# @return [GrowsurfRuby::Models::RewardTaxValuation, nil]
|
|
209
219
|
optional :value, -> { GrowsurfRuby::RewardTaxValuation }, nil?: true
|
|
210
220
|
|
|
211
|
-
# @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, value: nil)
|
|
221
|
+
# @!method initialize(id:, is_unlimited:, metadata:, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, limit: nil, limit_duration: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, value: nil)
|
|
212
222
|
# @param id [String]
|
|
213
223
|
#
|
|
214
224
|
# @param is_unlimited [Boolean]
|
|
@@ -229,6 +239,8 @@ module GrowsurfRuby
|
|
|
229
239
|
#
|
|
230
240
|
# @param image_url [String, nil]
|
|
231
241
|
#
|
|
242
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::ImageIconKey, nil] The starter icon shown for the reward, or `null` when `imageUrl` is your own image.
|
|
243
|
+
#
|
|
232
244
|
# @param limit [Integer, nil] `-1` represents an unlimited reward in REST responses.
|
|
233
245
|
#
|
|
234
246
|
# @param limit_duration [Symbol, GrowsurfRuby::Models::CampaignAPI::Reward::LimitDuration, nil]
|
|
@@ -286,6 +298,37 @@ module GrowsurfRuby
|
|
|
286
298
|
# @!method self.values
|
|
287
299
|
# @return [Array<Symbol>]
|
|
288
300
|
end
|
|
301
|
+
|
|
302
|
+
# @see GrowsurfRuby::Models::CampaignAPI::Reward#image_icon_key
|
|
303
|
+
module ImageIconKey
|
|
304
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
305
|
+
|
|
306
|
+
GIFT_1 = :GIFT_1
|
|
307
|
+
GIFT_2 = :GIFT_2
|
|
308
|
+
GIFT_3 = :GIFT_3
|
|
309
|
+
GIFT_4 = :GIFT_4
|
|
310
|
+
GIFT_5 = :GIFT_5
|
|
311
|
+
GIFT_6 = :GIFT_6
|
|
312
|
+
GIFT_CARD = :GIFT_CARD
|
|
313
|
+
CASH = :CASH
|
|
314
|
+
COIN = :COIN
|
|
315
|
+
CARD = :CARD
|
|
316
|
+
STAR_1 = :STAR_1
|
|
317
|
+
STAR_2 = :STAR_2
|
|
318
|
+
STAR_3 = :STAR_3
|
|
319
|
+
TROPHY = :TROPHY
|
|
320
|
+
CROWN = :CROWN
|
|
321
|
+
SEAL = :SEAL
|
|
322
|
+
HEART_1 = :HEART_1
|
|
323
|
+
HEART_2 = :HEART_2
|
|
324
|
+
TAG = :TAG
|
|
325
|
+
DIAMOND = :DIAMOND
|
|
326
|
+
CONFETTI = :CONFETTI
|
|
327
|
+
ROCKET = :ROCKET
|
|
328
|
+
|
|
329
|
+
# @!method self.values
|
|
330
|
+
# @return [Array<Symbol>]
|
|
331
|
+
end
|
|
289
332
|
end
|
|
290
333
|
|
|
291
334
|
# @see GrowsurfRuby::Models::CampaignAPI#status
|
|
@@ -33,7 +33,7 @@ module GrowsurfRuby
|
|
|
33
33
|
# requires a `FIXED` commission with a positive `amount`.
|
|
34
34
|
# A concurrent edit can return `409`; reload the program before retrying.
|
|
35
35
|
#
|
|
36
|
-
# @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
36
|
+
# @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
37
37
|
#
|
|
38
38
|
# @param id [String] Path param: GrowSurf program ID.
|
|
39
39
|
#
|
|
@@ -51,6 +51,8 @@ module GrowsurfRuby
|
|
|
51
51
|
#
|
|
52
52
|
# @param image_url [String] Body param
|
|
53
53
|
#
|
|
54
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey, nil] Body param: The starter icon shown for the reward, or `null` when `imageUrl` is your own image. Participant pages draw this icon in your program's accent color. Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending `imageUrl` without `imageIconKey` clears it.
|
|
55
|
+
#
|
|
54
56
|
# @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
|
|
55
57
|
#
|
|
56
58
|
# @param is_visible [Boolean] Body param: Whether the reward is enabled. When `false` the reward is disabled: hi
|
|
@@ -108,7 +110,7 @@ module GrowsurfRuby
|
|
|
108
110
|
# response saves the change. A concurrent edit can return `409`; reload the
|
|
109
111
|
# program before retrying.
|
|
110
112
|
#
|
|
111
|
-
# @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
113
|
+
# @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, image_icon_key: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
112
114
|
#
|
|
113
115
|
# @param campaign_reward_id [String] Path param: Campaign reward ID.
|
|
114
116
|
#
|
|
@@ -126,6 +128,8 @@ module GrowsurfRuby
|
|
|
126
128
|
#
|
|
127
129
|
# @param image_url [String] Body param
|
|
128
130
|
#
|
|
131
|
+
# @param image_icon_key [Symbol, GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey, nil] Body param: The starter icon shown for the reward, or `null` when `imageUrl` is your own image. Participant pages draw this icon in your program's accent color. Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it. Sending `imageUrl` without `imageIconKey` clears it.
|
|
132
|
+
#
|
|
129
133
|
# @param is_unlimited [Boolean] Body param: Whether the reward can be earned an unlimited number of times. Defaul
|
|
130
134
|
#
|
|
131
135
|
# @param is_visible [Boolean] Body param: Whether the reward is enabled. When `false` the reward is disabled: hi
|
|
@@ -65,6 +65,17 @@ module GrowsurfRuby
|
|
|
65
65
|
sig { returns(T.nilable(String)) }
|
|
66
66
|
attr_accessor :image_url
|
|
67
67
|
|
|
68
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
69
|
+
# image.
|
|
70
|
+
sig do
|
|
71
|
+
returns(
|
|
72
|
+
T.nilable(
|
|
73
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
74
|
+
)
|
|
75
|
+
)
|
|
76
|
+
end
|
|
77
|
+
attr_accessor :image_icon_key
|
|
78
|
+
|
|
68
79
|
# Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
69
80
|
# participants and no longer awarded, including those who already earned it.
|
|
70
81
|
sig { returns(T.nilable(T::Boolean)) }
|
|
@@ -161,6 +172,10 @@ module GrowsurfRuby
|
|
|
161
172
|
GrowsurfRuby::Models::Campaign::Reward::Event::OrSymbol
|
|
162
173
|
),
|
|
163
174
|
image_url: T.nilable(String),
|
|
175
|
+
image_icon_key:
|
|
176
|
+
T.nilable(
|
|
177
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::OrSymbol
|
|
178
|
+
),
|
|
164
179
|
is_visible: T::Boolean,
|
|
165
180
|
limit: T.nilable(Integer),
|
|
166
181
|
limit_duration:
|
|
@@ -197,6 +212,9 @@ module GrowsurfRuby
|
|
|
197
212
|
# Rewards return `CONVERSION`.
|
|
198
213
|
event: nil,
|
|
199
214
|
image_url: nil,
|
|
215
|
+
# The starter icon shown for the reward, or `null` when `imageUrl` is your own
|
|
216
|
+
# image.
|
|
217
|
+
image_icon_key: nil,
|
|
200
218
|
# Whether the reward is enabled. When `false` the reward is disabled: hidden from
|
|
201
219
|
# participants and no longer awarded, including those who already earned it.
|
|
202
220
|
is_visible: nil,
|
|
@@ -245,6 +263,10 @@ module GrowsurfRuby
|
|
|
245
263
|
GrowsurfRuby::Models::Campaign::Reward::Event::TaggedSymbol
|
|
246
264
|
),
|
|
247
265
|
image_url: T.nilable(String),
|
|
266
|
+
image_icon_key:
|
|
267
|
+
T.nilable(
|
|
268
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
269
|
+
),
|
|
248
270
|
is_visible: T::Boolean,
|
|
249
271
|
limit: T.nilable(Integer),
|
|
250
272
|
limit_duration:
|
|
@@ -382,6 +404,140 @@ module GrowsurfRuby
|
|
|
382
404
|
def self.values
|
|
383
405
|
end
|
|
384
406
|
end
|
|
407
|
+
|
|
408
|
+
module ImageIconKey
|
|
409
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
410
|
+
|
|
411
|
+
TaggedSymbol =
|
|
412
|
+
T.type_alias do
|
|
413
|
+
T.all(
|
|
414
|
+
Symbol,
|
|
415
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey
|
|
416
|
+
)
|
|
417
|
+
end
|
|
418
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
419
|
+
|
|
420
|
+
GIFT_1 =
|
|
421
|
+
T.let(
|
|
422
|
+
:GIFT_1,
|
|
423
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
424
|
+
)
|
|
425
|
+
GIFT_2 =
|
|
426
|
+
T.let(
|
|
427
|
+
:GIFT_2,
|
|
428
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
429
|
+
)
|
|
430
|
+
GIFT_3 =
|
|
431
|
+
T.let(
|
|
432
|
+
:GIFT_3,
|
|
433
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
434
|
+
)
|
|
435
|
+
GIFT_4 =
|
|
436
|
+
T.let(
|
|
437
|
+
:GIFT_4,
|
|
438
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
439
|
+
)
|
|
440
|
+
GIFT_5 =
|
|
441
|
+
T.let(
|
|
442
|
+
:GIFT_5,
|
|
443
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
444
|
+
)
|
|
445
|
+
GIFT_6 =
|
|
446
|
+
T.let(
|
|
447
|
+
:GIFT_6,
|
|
448
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
449
|
+
)
|
|
450
|
+
GIFT_CARD =
|
|
451
|
+
T.let(
|
|
452
|
+
:GIFT_CARD,
|
|
453
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
454
|
+
)
|
|
455
|
+
CASH =
|
|
456
|
+
T.let(
|
|
457
|
+
:CASH,
|
|
458
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
459
|
+
)
|
|
460
|
+
COIN =
|
|
461
|
+
T.let(
|
|
462
|
+
:COIN,
|
|
463
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
464
|
+
)
|
|
465
|
+
CARD =
|
|
466
|
+
T.let(
|
|
467
|
+
:CARD,
|
|
468
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
469
|
+
)
|
|
470
|
+
STAR_1 =
|
|
471
|
+
T.let(
|
|
472
|
+
:STAR_1,
|
|
473
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
474
|
+
)
|
|
475
|
+
STAR_2 =
|
|
476
|
+
T.let(
|
|
477
|
+
:STAR_2,
|
|
478
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
479
|
+
)
|
|
480
|
+
STAR_3 =
|
|
481
|
+
T.let(
|
|
482
|
+
:STAR_3,
|
|
483
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
484
|
+
)
|
|
485
|
+
TROPHY =
|
|
486
|
+
T.let(
|
|
487
|
+
:TROPHY,
|
|
488
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
489
|
+
)
|
|
490
|
+
CROWN =
|
|
491
|
+
T.let(
|
|
492
|
+
:CROWN,
|
|
493
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
494
|
+
)
|
|
495
|
+
SEAL =
|
|
496
|
+
T.let(
|
|
497
|
+
:SEAL,
|
|
498
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
499
|
+
)
|
|
500
|
+
HEART_1 =
|
|
501
|
+
T.let(
|
|
502
|
+
:HEART_1,
|
|
503
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
504
|
+
)
|
|
505
|
+
HEART_2 =
|
|
506
|
+
T.let(
|
|
507
|
+
:HEART_2,
|
|
508
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
509
|
+
)
|
|
510
|
+
TAG =
|
|
511
|
+
T.let(
|
|
512
|
+
:TAG,
|
|
513
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
514
|
+
)
|
|
515
|
+
DIAMOND =
|
|
516
|
+
T.let(
|
|
517
|
+
:DIAMOND,
|
|
518
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
519
|
+
)
|
|
520
|
+
CONFETTI =
|
|
521
|
+
T.let(
|
|
522
|
+
:CONFETTI,
|
|
523
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
524
|
+
)
|
|
525
|
+
ROCKET =
|
|
526
|
+
T.let(
|
|
527
|
+
:ROCKET,
|
|
528
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
529
|
+
)
|
|
530
|
+
|
|
531
|
+
sig do
|
|
532
|
+
override.returns(
|
|
533
|
+
T::Array[
|
|
534
|
+
GrowsurfRuby::Models::Campaign::Reward::ImageIconKey::TaggedSymbol
|
|
535
|
+
]
|
|
536
|
+
)
|
|
537
|
+
end
|
|
538
|
+
def self.values
|
|
539
|
+
end
|
|
540
|
+
end
|
|
385
541
|
end
|
|
386
542
|
end
|
|
387
543
|
end
|