growsurf-ruby 1.20.0 → 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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +1 -1
- data/lib/growsurf_ruby/models/campaign/create.rb +13 -1
- data/lib/growsurf_ruby/models/campaign/delete_reward_group_response.rb +16 -0
- data/lib/growsurf_ruby/models/campaign/participant.rb +22 -1
- data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_response.rb +1 -1
- data/lib/growsurf_ruby/models/campaign/participant_bulk_move_params.rb +20 -0
- data/lib/growsurf_ruby/models/campaign/participant_bulk_move_response.rb +57 -0
- data/lib/growsurf_ruby/models/campaign/participant_email_params.rb +2 -2
- data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rb +3 -3
- data/lib/growsurf_ruby/models/campaign/participant_reward.rb +9 -1
- data/lib/growsurf_ruby/models/campaign/participant_send_invites_params.rb +1 -7
- data/lib/growsurf_ruby/models/campaign/participant_send_invites_response.rb +11 -1
- data/lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb +1 -1
- data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +12 -1
- data/lib/growsurf_ruby/models/campaign/reward.rb +10 -1
- data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +12 -1
- data/lib/growsurf_ruby/models/campaign/reward_group.rb +46 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_create_params.rb +18 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_delete_params.rb +14 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_list_response.rb +13 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_retrieve_params.rb +14 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_source.rb +23 -0
- data/lib/growsurf_ruby/models/campaign/reward_group_update_params.rb +21 -0
- data/lib/growsurf_ruby/models/campaign/reward_list_params.rb +18 -0
- data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +14 -3
- data/lib/growsurf_ruby/models/campaign/webhook_test_response.rb +2 -2
- data/lib/growsurf_ruby/models/campaign_list_participants_params.rb +10 -1
- data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +12 -1
- data/lib/growsurf_ruby/resources/campaign/groups.rb +103 -0
- data/lib/growsurf_ruby/resources/campaign/participant.rb +51 -15
- data/lib/growsurf_ruby/resources/campaign/rewards.rb +19 -6
- data/lib/growsurf_ruby/resources/campaign.rb +9 -2
- data/lib/growsurf_ruby/version.rb +1 -1
- data/lib/growsurf_ruby.rb +13 -0
- data/rbi/growsurf_ruby/models/campaign/create.rbi +11 -0
- data/rbi/growsurf_ruby/models/campaign/delete_reward_group_response.rbi +39 -0
- data/rbi/growsurf_ruby/models/campaign/participant.rbi +26 -0
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +3 -6
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_move_params.rbi +41 -0
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_move_response.rbi +172 -0
- data/rbi/growsurf_ruby/models/campaign/participant_email_params.rbi +2 -2
- data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbi +2 -2
- data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi +8 -0
- data/rbi/growsurf_ruby/models/campaign/participant_send_invites_params.rbi +0 -6
- data/rbi/growsurf_ruby/models/campaign/participant_send_invites_response.rbi +22 -3
- data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi +2 -2
- data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +10 -0
- data/rbi/growsurf_ruby/models/campaign/reward.rbi +8 -0
- data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +10 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group.rbi +109 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_create_params.rbi +40 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_delete_params.rbi +37 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_list_response.rbi +27 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_retrieve_params.rbi +37 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_source.rbi +36 -0
- data/rbi/growsurf_ruby/models/campaign/reward_group_update_params.rbi +48 -0
- data/rbi/growsurf_ruby/models/campaign/reward_list_params.rbi +43 -0
- data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +12 -2
- data/rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi +2 -2
- data/rbi/growsurf_ruby/models/campaign_list_participants_params.rbi +13 -0
- data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +24 -0
- data/rbi/growsurf_ruby/resources/campaign/groups.rbi +93 -0
- data/rbi/growsurf_ruby/resources/campaign/participant.rbi +39 -9
- data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +13 -2
- data/rbi/growsurf_ruby/resources/campaign.rbi +8 -0
- data/sig/growsurf_ruby/models/campaign/create.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign/delete_reward_group_response.rbs +16 -0
- data/sig/growsurf_ruby/models/campaign/participant.rbs +10 -0
- data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbs +4 -6
- data/sig/growsurf_ruby/models/campaign/participant_bulk_move_params.rbs +24 -0
- data/sig/growsurf_ruby/models/campaign/participant_bulk_move_response.rbs +89 -0
- data/sig/growsurf_ruby/models/campaign/participant_reward.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign/participant_send_invites_params.rbs +1 -6
- data/sig/growsurf_ruby/models/campaign/participant_send_invites_response.rbs +14 -3
- data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign/reward.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign/reward_group.rbs +55 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_create_params.rbs +22 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_delete_params.rbs +22 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_list_response.rbs +13 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_retrieve_params.rbs +22 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_source.rbs +18 -0
- data/sig/growsurf_ruby/models/campaign/reward_group_update_params.rbs +25 -0
- data/sig/growsurf_ruby/models/campaign/reward_list_params.rbs +23 -0
- data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +5 -0
- data/sig/growsurf_ruby/models/campaign_list_participants_params.rbs +7 -0
- data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +9 -0
- data/sig/growsurf_ruby/resources/campaign/groups.rbs +42 -0
- data/sig/growsurf_ruby/resources/campaign/participant.rbs +9 -1
- data/sig/growsurf_ruby/resources/campaign/rewards.rbs +3 -0
- data/sig/growsurf_ruby/resources/campaign.rbs +3 -0
- metadata +38 -2
|
@@ -34,6 +34,7 @@ module GrowsurfRuby
|
|
|
34
34
|
GrowsurfRuby::Campaign::ParticipantUpdateParams::AffiliateStatus::OrSymbol,
|
|
35
35
|
email: String,
|
|
36
36
|
first_name: String,
|
|
37
|
+
group_id: T.nilable(String),
|
|
37
38
|
language: T.nilable(GrowsurfRuby::Campaign::Language::OrSymbol),
|
|
38
39
|
last_name: String,
|
|
39
40
|
metadata: T::Hash[Symbol, T.anything],
|
|
@@ -59,6 +60,7 @@ module GrowsurfRuby
|
|
|
59
60
|
email: nil,
|
|
60
61
|
# Body param
|
|
61
62
|
first_name: nil,
|
|
63
|
+
group_id: nil,
|
|
62
64
|
# Body param: The language of the participant's portal and program emails. Must be
|
|
63
65
|
# one of the program's languages (see `languages` in the program options). Send the
|
|
64
66
|
# base language or `null` to use the program's base language.
|
|
@@ -82,7 +84,7 @@ module GrowsurfRuby
|
|
|
82
84
|
)
|
|
83
85
|
end
|
|
84
86
|
|
|
85
|
-
# Removes participant access immediately by GrowSurf participant ID or email address. Related record cleanup completes automatically. Do not repeat a successful deletion to finish cleanup.
|
|
87
|
+
# Removes participant access immediately by GrowSurf participant ID or email address. Related record cleanup completes automatically. Do not repeat a successful deletion to finish cleanup. A `202` response includes pending analytics erasure details.
|
|
86
88
|
sig do
|
|
87
89
|
params(
|
|
88
90
|
participant_id_or_email: String,
|
|
@@ -103,7 +105,7 @@ module GrowsurfRuby
|
|
|
103
105
|
# `participants` is a GrowSurf participant ID or an email address (mixed lists are
|
|
104
106
|
# allowed). Up to `200` entries per request — chunk larger lists across multiple
|
|
105
107
|
# calls. The response reports a per-row `status` for every submitted entry, so a
|
|
106
|
-
# `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention.
|
|
108
|
+
# `200` can include rows that were `NOT_FOUND` or failed. Deletion is permanent. Successful rows lose participant access immediately; related record cleanup completes automatically, subject to required financial record retention. A `202` response also includes `analyticsErasure` when analytics erasure is pending.
|
|
107
109
|
sig do
|
|
108
110
|
params(
|
|
109
111
|
id: String,
|
|
@@ -123,6 +125,35 @@ module GrowsurfRuby
|
|
|
123
125
|
)
|
|
124
126
|
end
|
|
125
127
|
|
|
128
|
+
# Moves a list of participants to a group, or to Default with `groupId: null`.
|
|
129
|
+
# Each entry in `participants` is a GrowSurf participant ID or an email address
|
|
130
|
+
# (mixed lists are allowed). Up to `200` entries per request. The response reports
|
|
131
|
+
# a per-row `status` for every submitted entry, so a `200` can include rows that
|
|
132
|
+
# were `NOT_FOUND`. All found participants move together: if the move fails, no one
|
|
133
|
+
# moves. A move is a manual placement, so the group's email and domain rules do not
|
|
134
|
+
# override it later, and it removes the participant from any other group's
|
|
135
|
+
# `PARTICIPANT` rules. A move applies to new referrals only. Rewards already earned
|
|
136
|
+
# keep their amounts. An ID that is not a group in this program returns `400`.
|
|
137
|
+
sig do
|
|
138
|
+
params(
|
|
139
|
+
id: String,
|
|
140
|
+
participants: T::Array[String],
|
|
141
|
+
group_id: T.nilable(String),
|
|
142
|
+
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
143
|
+
).returns(GrowsurfRuby::Models::Campaign::ParticipantBulkMoveResponse)
|
|
144
|
+
end
|
|
145
|
+
def bulk_move(
|
|
146
|
+
# GrowSurf program ID.
|
|
147
|
+
id,
|
|
148
|
+
# GrowSurf participant IDs and/or email addresses to move. Mixed entries are
|
|
149
|
+
# allowed. 1 to 200 entries.
|
|
150
|
+
participants:,
|
|
151
|
+
# The group to move them to (`grp_…`), or `nil` for Default.
|
|
152
|
+
group_id:,
|
|
153
|
+
request_options: {}
|
|
154
|
+
)
|
|
155
|
+
end
|
|
156
|
+
|
|
126
157
|
# Adds a new participant to the program. If the email already exists, the existing
|
|
127
158
|
# participant is returned unchanged. One exception: if that participant claimed an
|
|
128
159
|
# offer in the Claim Offer Popup and the signup is not complete yet, this call completes
|
|
@@ -140,6 +171,7 @@ module GrowsurfRuby
|
|
|
140
171
|
email: String,
|
|
141
172
|
fingerprint: String,
|
|
142
173
|
first_name: String,
|
|
174
|
+
group_id: T.nilable(String),
|
|
143
175
|
ip_address: String,
|
|
144
176
|
is_affiliate: T::Boolean,
|
|
145
177
|
language: GrowsurfRuby::Campaign::Language::OrSymbol,
|
|
@@ -159,6 +191,7 @@ module GrowsurfRuby
|
|
|
159
191
|
email:,
|
|
160
192
|
fingerprint: nil,
|
|
161
193
|
first_name: nil,
|
|
194
|
+
group_id: nil,
|
|
162
195
|
ip_address: nil,
|
|
163
196
|
# Affiliate programs only. Controls affiliate enrollment for a new participant.
|
|
164
197
|
# `true` enrolls the participant with `affiliateStatus: APPROVED`; `false`
|
|
@@ -494,14 +527,13 @@ module GrowsurfRuby
|
|
|
494
527
|
|
|
495
528
|
# Sends email invites on behalf of a participant to a list of email addresses.
|
|
496
529
|
# Sending invites via the API requires a **verified custom email domain** on the
|
|
497
|
-
# program
|
|
530
|
+
# program. Until one is verified, it returns `success: false`.
|
|
498
531
|
sig do
|
|
499
532
|
params(
|
|
500
533
|
participant_id_or_email: String,
|
|
501
534
|
id: String,
|
|
502
535
|
email_addresses: T::Array[String],
|
|
503
536
|
message_text: String,
|
|
504
|
-
subject_text: String,
|
|
505
537
|
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
506
538
|
).returns(
|
|
507
539
|
GrowsurfRuby::Models::Campaign::ParticipantSendInvitesResponse
|
|
@@ -516,8 +548,6 @@ module GrowsurfRuby
|
|
|
516
548
|
email_addresses:,
|
|
517
549
|
# Body param
|
|
518
550
|
message_text:,
|
|
519
|
-
# Body param
|
|
520
|
-
subject_text:,
|
|
521
551
|
request_options: {}
|
|
522
552
|
)
|
|
523
553
|
end
|
|
@@ -546,7 +576,7 @@ module GrowsurfRuby
|
|
|
546
576
|
# Useful for honoring a refund window before crediting a referrer. Omit this field
|
|
547
577
|
# to award credit immediately. The credit is awarded automatically once the delay
|
|
548
578
|
# elapses, and can be cancelled before then with the Cancel delayed referral
|
|
549
|
-
# trigger request.
|
|
579
|
+
# trigger request. From `0` to `90`; `0` awards credit immediately.
|
|
550
580
|
delay_in_days: nil,
|
|
551
581
|
request_options: {}
|
|
552
582
|
)
|
|
@@ -599,7 +629,7 @@ module GrowsurfRuby
|
|
|
599
629
|
participant_id_or_email,
|
|
600
630
|
# Path param: GrowSurf program ID.
|
|
601
631
|
id:,
|
|
602
|
-
# Body param: HTML body for a free-form email. You can personalize it with
|
|
632
|
+
# Body param: HTML body for a free-form email. When `settings.design.layoutMode` is `INLINE`, include `{{emailFooter}}` in the body; `{{emailHeader}}` is optional. You can personalize it with
|
|
603
633
|
# dynamic text, inserting `{{...}}` tokens like `{{firstName}}` or `{{shareUrl}}`.
|
|
604
634
|
# See [Guide to using dynamic text in GrowSurf emails](https://support.growsurf.com/article/213-guide-to-using-dynamic-text-in-growsurf-emails).
|
|
605
635
|
body: nil,
|
|
@@ -749,7 +779,7 @@ module GrowsurfRuby
|
|
|
749
779
|
participant_id_or_email,
|
|
750
780
|
# Path param: GrowSurf program ID.
|
|
751
781
|
id:,
|
|
752
|
-
# Body param: The payout provider the participant should confirm a destination for.
|
|
782
|
+
# Body param: The payout provider the participant should confirm a destination for. `VENMO` uses a confirmed email and is available only when connected PayPal Payouts and payout-email confirmation are enabled in a USD program. Venmo recipients must be in the United States.
|
|
753
783
|
provider:,
|
|
754
784
|
request_options: {}
|
|
755
785
|
)
|
|
@@ -5,18 +5,25 @@ module GrowsurfRuby
|
|
|
5
5
|
class Campaign
|
|
6
6
|
class Rewards
|
|
7
7
|
# Retrieves configured Campaign Rewards, including switched-off rewards and rewards
|
|
8
|
-
# whose
|
|
8
|
+
# whose reward type is not selected. Deleted rewards are excluded. The campaign response's
|
|
9
9
|
# embedded `rewards` array includes only enabled, visible rewards. A reward can be earned only
|
|
10
|
-
# when it also appears in the campaign response's embedded `rewards` array.
|
|
10
|
+
# when it also appears in the campaign response's embedded `rewards` array. The list includes
|
|
11
|
+
# every group's rewards. Each reward's `groupId` names its group (`null` is Default). Pass
|
|
12
|
+
# `group_id` to return one group's rewards.
|
|
11
13
|
sig do
|
|
12
14
|
params(
|
|
13
15
|
id: String,
|
|
16
|
+
group_id: String,
|
|
14
17
|
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
15
18
|
).returns(GrowsurfRuby::Models::Campaign::CampaignRewardListResponse)
|
|
16
19
|
end
|
|
17
20
|
def list(
|
|
18
21
|
# GrowSurf program ID.
|
|
19
22
|
id,
|
|
23
|
+
# Return only this group's rewards. To get Default's rewards, omit `groupId`
|
|
24
|
+
# and keep the rewards whose `groupId` is `null`. An ID that is not a group in this program
|
|
25
|
+
# returns `404`.
|
|
26
|
+
group_id: nil,
|
|
20
27
|
request_options: {}
|
|
21
28
|
)
|
|
22
29
|
end
|
|
@@ -40,6 +47,7 @@ module GrowsurfRuby
|
|
|
40
47
|
event:
|
|
41
48
|
GrowsurfRuby::Models::Campaign::RewardCreateParams::Event::OrSymbol,
|
|
42
49
|
image_url: T.nilable(String),
|
|
50
|
+
group_id: T.nilable(String),
|
|
43
51
|
image_icon_key:
|
|
44
52
|
T.nilable(
|
|
45
53
|
GrowsurfRuby::Models::Campaign::RewardCreateParams::ImageIconKey::OrSymbol
|
|
@@ -87,6 +95,7 @@ module GrowsurfRuby
|
|
|
87
95
|
event: nil,
|
|
88
96
|
# Body param
|
|
89
97
|
image_url: nil,
|
|
98
|
+
group_id: nil,
|
|
90
99
|
# Body param: The starter icon shown for the reward, or `null` when `imageUrl` is
|
|
91
100
|
# your own image. Participant pages draw this icon in your program's accent color.
|
|
92
101
|
# Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it.
|
|
@@ -170,6 +179,7 @@ module GrowsurfRuby
|
|
|
170
179
|
event:
|
|
171
180
|
GrowsurfRuby::Models::Campaign::RewardUpdateParams::Event::OrSymbol,
|
|
172
181
|
image_url: T.nilable(String),
|
|
182
|
+
group_id: T.nilable(String),
|
|
173
183
|
image_icon_key:
|
|
174
184
|
T.nilable(
|
|
175
185
|
GrowsurfRuby::Models::Campaign::RewardUpdateParams::ImageIconKey::OrSymbol
|
|
@@ -216,6 +226,7 @@ module GrowsurfRuby
|
|
|
216
226
|
event: nil,
|
|
217
227
|
# Body param
|
|
218
228
|
image_url: nil,
|
|
229
|
+
group_id: nil,
|
|
219
230
|
# Body param: The starter icon shown for the reward, or `null` when `imageUrl` is
|
|
220
231
|
# your own image. Participant pages draw this icon in your program's accent color.
|
|
221
232
|
# Also set `imageUrl` to the icon's image so the iOS and Android SDKs can show it.
|
|
@@ -22,6 +22,10 @@ module GrowsurfRuby
|
|
|
22
22
|
sig { returns(GrowsurfRuby::Resources::Campaign::ProgramResources) }
|
|
23
23
|
attr_reader :resources
|
|
24
24
|
|
|
25
|
+
# Group operations. Groups give some participants a different reward list.
|
|
26
|
+
sig { returns(GrowsurfRuby::Resources::Campaign::Groups) }
|
|
27
|
+
attr_reader :groups
|
|
28
|
+
|
|
25
29
|
# Program Editor "Design" tab configuration operations.
|
|
26
30
|
sig { returns(GrowsurfRuby::Resources::Campaign::Design) }
|
|
27
31
|
attr_reader :design
|
|
@@ -368,6 +372,7 @@ module GrowsurfRuby
|
|
|
368
372
|
sig do
|
|
369
373
|
params(
|
|
370
374
|
id: String,
|
|
375
|
+
group_id: String,
|
|
371
376
|
limit: Integer,
|
|
372
377
|
metadata: T::Hash[Symbol, String],
|
|
373
378
|
next_id: String,
|
|
@@ -377,6 +382,9 @@ module GrowsurfRuby
|
|
|
377
382
|
def list_participants(
|
|
378
383
|
# GrowSurf program ID.
|
|
379
384
|
id,
|
|
385
|
+
# Return only this group's members. Default has no ID, so it cannot be named
|
|
386
|
+
# here. An ID that is not a group in this program returns `404`.
|
|
387
|
+
group_id: nil,
|
|
380
388
|
# Number of results to return. Maximum 100.
|
|
381
389
|
limit: nil,
|
|
382
390
|
# Return only participants whose metadata matches every given key and value
|
|
@@ -6,6 +6,7 @@ module GrowsurfRuby
|
|
|
6
6
|
email: String,
|
|
7
7
|
fingerprint: String,
|
|
8
8
|
first_name: String,
|
|
9
|
+
group_id: String?,
|
|
9
10
|
ip_address: String,
|
|
10
11
|
is_affiliate: bool,
|
|
11
12
|
language: GrowsurfRuby::Models::Campaign::language,
|
|
@@ -28,6 +29,8 @@ module GrowsurfRuby
|
|
|
28
29
|
|
|
29
30
|
def first_name=: (String) -> String
|
|
30
31
|
|
|
32
|
+
attr_accessor group_id: String?
|
|
33
|
+
|
|
31
34
|
attr_reader ip_address: String?
|
|
32
35
|
|
|
33
36
|
def ip_address=: (String) -> String
|
|
@@ -70,6 +73,7 @@ module GrowsurfRuby
|
|
|
70
73
|
email: String,
|
|
71
74
|
?fingerprint: String,
|
|
72
75
|
?first_name: String,
|
|
76
|
+
?group_id: String?,
|
|
73
77
|
?ip_address: String,
|
|
74
78
|
?is_affiliate: bool,
|
|
75
79
|
?language: GrowsurfRuby::Models::Campaign::language,
|
|
@@ -85,6 +89,7 @@ module GrowsurfRuby
|
|
|
85
89
|
email: String,
|
|
86
90
|
fingerprint: String,
|
|
87
91
|
first_name: String,
|
|
92
|
+
group_id: String?,
|
|
88
93
|
ip_address: String,
|
|
89
94
|
is_affiliate: bool,
|
|
90
95
|
language: GrowsurfRuby::Models::Campaign::language,
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type delete_reward_group_response =
|
|
5
|
+
{ id: String, moved_to_default: Integer, success: bool }
|
|
6
|
+
|
|
7
|
+
class DeleteRewardGroupResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
8
|
+
attr_accessor id: String
|
|
9
|
+
attr_accessor moved_to_default: Integer
|
|
10
|
+
attr_accessor success: bool
|
|
11
|
+
def initialize: (id: String, moved_to_default: Integer, success: bool) -> void
|
|
12
|
+
def to_hash: -> delete_reward_group_response
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
@@ -19,6 +19,8 @@ module GrowsurfRuby
|
|
|
19
19
|
first_name: String?,
|
|
20
20
|
fraud_reason_code: String,
|
|
21
21
|
fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
|
|
22
|
+
group_id: String?,
|
|
23
|
+
group_source: GrowsurfRuby::Models::Campaign::reward_group_source?,
|
|
22
24
|
impression_count: Integer,
|
|
23
25
|
invite_count: Integer,
|
|
24
26
|
ip_address: String?,
|
|
@@ -97,6 +99,10 @@ module GrowsurfRuby
|
|
|
97
99
|
GrowsurfRuby::Models::Campaign::fraud_risk_level
|
|
98
100
|
) -> GrowsurfRuby::Models::Campaign::fraud_risk_level
|
|
99
101
|
|
|
102
|
+
attr_accessor group_id: String?
|
|
103
|
+
|
|
104
|
+
attr_accessor group_source: GrowsurfRuby::Models::Campaign::reward_group_source?
|
|
105
|
+
|
|
100
106
|
attr_reader impression_count: Integer?
|
|
101
107
|
|
|
102
108
|
def impression_count=: (Integer) -> Integer
|
|
@@ -228,6 +234,8 @@ module GrowsurfRuby
|
|
|
228
234
|
?first_name: String?,
|
|
229
235
|
?fraud_reason_code: String,
|
|
230
236
|
?fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
|
|
237
|
+
?group_id: String?,
|
|
238
|
+
?group_source: GrowsurfRuby::Models::Campaign::reward_group_source?,
|
|
231
239
|
?impression_count: Integer,
|
|
232
240
|
?invite_count: Integer,
|
|
233
241
|
?ip_address: String?,
|
|
@@ -276,6 +284,8 @@ module GrowsurfRuby
|
|
|
276
284
|
first_name: String?,
|
|
277
285
|
fraud_reason_code: String,
|
|
278
286
|
fraud_risk_level: GrowsurfRuby::Models::Campaign::fraud_risk_level,
|
|
287
|
+
group_id: String?,
|
|
288
|
+
group_source: GrowsurfRuby::Models::Campaign::reward_group_source?,
|
|
279
289
|
impression_count: Integer,
|
|
280
290
|
invite_count: Integer,
|
|
281
291
|
ip_address: String?,
|
|
@@ -32,7 +32,7 @@ module GrowsurfRuby
|
|
|
32
32
|
identifier: String,
|
|
33
33
|
index: Integer,
|
|
34
34
|
status: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::status,
|
|
35
|
-
email: String
|
|
35
|
+
email: String?,
|
|
36
36
|
message: String,
|
|
37
37
|
participant_id: String
|
|
38
38
|
}
|
|
@@ -44,9 +44,7 @@ module GrowsurfRuby
|
|
|
44
44
|
|
|
45
45
|
attr_accessor status: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::status
|
|
46
46
|
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
def email=: (String) -> String
|
|
47
|
+
attr_accessor email: String?
|
|
50
48
|
|
|
51
49
|
attr_reader message: String?
|
|
52
50
|
|
|
@@ -60,7 +58,7 @@ module GrowsurfRuby
|
|
|
60
58
|
identifier: String,
|
|
61
59
|
index: Integer,
|
|
62
60
|
status: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::status,
|
|
63
|
-
?email: String
|
|
61
|
+
?email: String?,
|
|
64
62
|
?message: String,
|
|
65
63
|
?participant_id: String
|
|
66
64
|
) -> void
|
|
@@ -69,7 +67,7 @@ module GrowsurfRuby
|
|
|
69
67
|
identifier: String,
|
|
70
68
|
index: Integer,
|
|
71
69
|
status: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::status,
|
|
72
|
-
email: String
|
|
70
|
+
email: String?,
|
|
73
71
|
message: String,
|
|
74
72
|
participant_id: String
|
|
75
73
|
}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type participant_bulk_move_params =
|
|
5
|
+
{ id: String, participants: ::Array[String], group_id: String? }
|
|
6
|
+
& GrowsurfRuby::Internal::Type::request_parameters
|
|
7
|
+
|
|
8
|
+
class ParticipantBulkMoveParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
9
|
+
extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include GrowsurfRuby::Internal::Type::RequestParameters
|
|
11
|
+
attr_accessor id: String
|
|
12
|
+
attr_accessor participants: ::Array[String]
|
|
13
|
+
attr_accessor group_id: String?
|
|
14
|
+
def initialize: (
|
|
15
|
+
id: String,
|
|
16
|
+
participants: ::Array[String],
|
|
17
|
+
group_id: String?,
|
|
18
|
+
?request_options: GrowsurfRuby::request_opts
|
|
19
|
+
) -> void
|
|
20
|
+
def to_hash: -> ::Hash[Symbol, top]
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type participant_bulk_move_response =
|
|
5
|
+
{
|
|
6
|
+
results: ::Array[ParticipantBulkMoveResponse::Result],
|
|
7
|
+
summary: ParticipantBulkMoveResponse::Summary
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
class ParticipantBulkMoveResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
11
|
+
attr_accessor results: ::Array[ParticipantBulkMoveResponse::Result]
|
|
12
|
+
attr_accessor summary: ParticipantBulkMoveResponse::Summary
|
|
13
|
+
def initialize: (
|
|
14
|
+
results: ::Array[ParticipantBulkMoveResponse::Result],
|
|
15
|
+
summary: ParticipantBulkMoveResponse::Summary
|
|
16
|
+
) -> void
|
|
17
|
+
def to_hash: -> participant_bulk_move_response
|
|
18
|
+
|
|
19
|
+
type result =
|
|
20
|
+
{
|
|
21
|
+
identifier: String,
|
|
22
|
+
index: Integer,
|
|
23
|
+
status: ParticipantBulkMoveResponse::Result::status,
|
|
24
|
+
email: String?,
|
|
25
|
+
message: String,
|
|
26
|
+
participant_id: String
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
class Result < GrowsurfRuby::Internal::Type::BaseModel
|
|
30
|
+
attr_accessor identifier: String
|
|
31
|
+
attr_accessor index: Integer
|
|
32
|
+
attr_accessor status: ParticipantBulkMoveResponse::Result::status
|
|
33
|
+
attr_accessor email: String?
|
|
34
|
+
attr_reader message: String?
|
|
35
|
+
def message=: (String) -> String
|
|
36
|
+
attr_reader participant_id: String?
|
|
37
|
+
def participant_id=: (String) -> String
|
|
38
|
+
def initialize: (
|
|
39
|
+
identifier: String,
|
|
40
|
+
index: Integer,
|
|
41
|
+
status: ParticipantBulkMoveResponse::Result::status,
|
|
42
|
+
?email: String?,
|
|
43
|
+
?message: String,
|
|
44
|
+
?participant_id: String
|
|
45
|
+
) -> void
|
|
46
|
+
def to_hash: -> result
|
|
47
|
+
|
|
48
|
+
type status = :MOVED | :NOT_FOUND | :DUPLICATE | :ERROR
|
|
49
|
+
module Status
|
|
50
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
51
|
+
MOVED: :MOVED
|
|
52
|
+
NOT_FOUND: :NOT_FOUND
|
|
53
|
+
DUPLICATE: :DUPLICATE
|
|
54
|
+
ERROR: :ERROR
|
|
55
|
+
def self?.values: -> ::Array[ParticipantBulkMoveResponse::Result::status]
|
|
56
|
+
end
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
type summary =
|
|
60
|
+
{
|
|
61
|
+
duplicate_count: Integer,
|
|
62
|
+
error_count: Integer,
|
|
63
|
+
group_id: String?,
|
|
64
|
+
moved_count: Integer,
|
|
65
|
+
not_found_count: Integer,
|
|
66
|
+
total: Integer
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
class Summary < GrowsurfRuby::Internal::Type::BaseModel
|
|
70
|
+
attr_accessor duplicate_count: Integer
|
|
71
|
+
attr_accessor error_count: Integer
|
|
72
|
+
attr_accessor group_id: String?
|
|
73
|
+
attr_accessor moved_count: Integer
|
|
74
|
+
attr_accessor not_found_count: Integer
|
|
75
|
+
attr_accessor total: Integer
|
|
76
|
+
def initialize: (
|
|
77
|
+
duplicate_count: Integer,
|
|
78
|
+
error_count: Integer,
|
|
79
|
+
group_id: String?,
|
|
80
|
+
moved_count: Integer,
|
|
81
|
+
not_found_count: Integer,
|
|
82
|
+
total: Integer
|
|
83
|
+
) -> void
|
|
84
|
+
def to_hash: -> summary
|
|
85
|
+
end
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
@@ -13,6 +13,7 @@ module GrowsurfRuby
|
|
|
13
13
|
commission_structure: GrowsurfRuby::CommissionStructure?,
|
|
14
14
|
currency_iso: String?,
|
|
15
15
|
fulfilled_at: Integer?,
|
|
16
|
+
group_id: String?,
|
|
16
17
|
is_available: bool,
|
|
17
18
|
is_fulfilled: bool,
|
|
18
19
|
is_referrer: bool,
|
|
@@ -53,6 +54,8 @@ module GrowsurfRuby
|
|
|
53
54
|
|
|
54
55
|
def fulfilled_at=: (Integer?) -> Integer?
|
|
55
56
|
|
|
57
|
+
attr_accessor group_id: String?
|
|
58
|
+
|
|
56
59
|
attr_reader is_available: bool?
|
|
57
60
|
|
|
58
61
|
def is_available=: (bool) -> bool
|
|
@@ -92,6 +95,7 @@ module GrowsurfRuby
|
|
|
92
95
|
?commission_structure: GrowsurfRuby::CommissionStructure?,
|
|
93
96
|
?currency_iso: String?,
|
|
94
97
|
?fulfilled_at: Integer?,
|
|
98
|
+
?group_id: String?,
|
|
95
99
|
?is_available: bool,
|
|
96
100
|
?is_fulfilled: bool,
|
|
97
101
|
?is_referrer: bool,
|
|
@@ -112,6 +116,7 @@ module GrowsurfRuby
|
|
|
112
116
|
commission_structure: GrowsurfRuby::CommissionStructure?,
|
|
113
117
|
currency_iso: String?,
|
|
114
118
|
fulfilled_at: Integer?,
|
|
119
|
+
group_id: String?,
|
|
115
120
|
is_available: bool,
|
|
116
121
|
is_fulfilled: bool,
|
|
117
122
|
is_referrer: bool,
|
|
@@ -6,8 +6,7 @@ module GrowsurfRuby
|
|
|
6
6
|
id: String,
|
|
7
7
|
participant_id_or_email: String,
|
|
8
8
|
email_addresses: ::Array[String],
|
|
9
|
-
message_text: String
|
|
10
|
-
subject_text: String
|
|
9
|
+
message_text: String
|
|
11
10
|
}
|
|
12
11
|
& GrowsurfRuby::Internal::Type::request_parameters
|
|
13
12
|
|
|
@@ -23,14 +22,11 @@ module GrowsurfRuby
|
|
|
23
22
|
|
|
24
23
|
attr_accessor message_text: String
|
|
25
24
|
|
|
26
|
-
attr_accessor subject_text: String
|
|
27
|
-
|
|
28
25
|
def initialize: (
|
|
29
26
|
id: String,
|
|
30
27
|
participant_id_or_email: String,
|
|
31
28
|
email_addresses: ::Array[String],
|
|
32
29
|
message_text: String,
|
|
33
|
-
subject_text: String,
|
|
34
30
|
?request_options: GrowsurfRuby::request_opts
|
|
35
31
|
) -> void
|
|
36
32
|
|
|
@@ -39,7 +35,6 @@ module GrowsurfRuby
|
|
|
39
35
|
participant_id_or_email: String,
|
|
40
36
|
email_addresses: ::Array[String],
|
|
41
37
|
message_text: String,
|
|
42
|
-
subject_text: String,
|
|
43
38
|
request_options: GrowsurfRuby::RequestOptions
|
|
44
39
|
}
|
|
45
40
|
end
|
|
@@ -2,7 +2,12 @@ module GrowsurfRuby
|
|
|
2
2
|
module Models
|
|
3
3
|
module Campaign
|
|
4
4
|
type participant_send_invites_response =
|
|
5
|
-
{
|
|
5
|
+
{
|
|
6
|
+
invites_sent: Integer,
|
|
7
|
+
message_type: String,
|
|
8
|
+
success: bool,
|
|
9
|
+
message: String
|
|
10
|
+
}
|
|
6
11
|
|
|
7
12
|
class ParticipantSendInvitesResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
8
13
|
attr_accessor invites_sent: Integer
|
|
@@ -11,16 +16,22 @@ module GrowsurfRuby
|
|
|
11
16
|
|
|
12
17
|
attr_accessor success: bool
|
|
13
18
|
|
|
19
|
+
attr_reader message: String?
|
|
20
|
+
|
|
21
|
+
def message=: (String) -> String
|
|
22
|
+
|
|
14
23
|
def initialize: (
|
|
15
24
|
invites_sent: Integer,
|
|
16
25
|
message_type: String,
|
|
17
|
-
success: bool
|
|
26
|
+
success: bool,
|
|
27
|
+
?message: String
|
|
18
28
|
) -> void
|
|
19
29
|
|
|
20
30
|
def to_hash: -> {
|
|
21
31
|
invites_sent: Integer,
|
|
22
32
|
message_type: String,
|
|
23
|
-
success: bool
|
|
33
|
+
success: bool,
|
|
34
|
+
message: String
|
|
24
35
|
}
|
|
25
36
|
end
|
|
26
37
|
end
|
|
@@ -8,6 +8,7 @@ module GrowsurfRuby
|
|
|
8
8
|
affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
|
|
9
9
|
email: String,
|
|
10
10
|
first_name: String,
|
|
11
|
+
group_id: String?,
|
|
11
12
|
language: GrowsurfRuby::Models::Campaign::language?,
|
|
12
13
|
last_name: String,
|
|
13
14
|
metadata: ::Hash[Symbol, top],
|
|
@@ -41,6 +42,8 @@ module GrowsurfRuby
|
|
|
41
42
|
|
|
42
43
|
def first_name=: (String) -> String
|
|
43
44
|
|
|
45
|
+
attr_accessor group_id: String?
|
|
46
|
+
|
|
44
47
|
attr_accessor language: GrowsurfRuby::Models::Campaign::language?
|
|
45
48
|
|
|
46
49
|
attr_reader last_name: String?
|
|
@@ -79,6 +82,7 @@ module GrowsurfRuby
|
|
|
79
82
|
?affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
|
|
80
83
|
?email: String,
|
|
81
84
|
?first_name: String,
|
|
85
|
+
?group_id: String?,
|
|
82
86
|
?language: GrowsurfRuby::Models::Campaign::language?,
|
|
83
87
|
?last_name: String,
|
|
84
88
|
?metadata: ::Hash[Symbol, top],
|
|
@@ -96,6 +100,7 @@ module GrowsurfRuby
|
|
|
96
100
|
affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
|
|
97
101
|
email: String,
|
|
98
102
|
first_name: String,
|
|
103
|
+
group_id: String?,
|
|
99
104
|
language: GrowsurfRuby::Models::Campaign::language?,
|
|
100
105
|
last_name: String,
|
|
101
106
|
metadata: ::Hash[Symbol, top],
|
|
@@ -13,6 +13,7 @@ module GrowsurfRuby
|
|
|
13
13
|
description: String?,
|
|
14
14
|
event: GrowsurfRuby::Models::Campaign::Reward::event?,
|
|
15
15
|
image_url: String?,
|
|
16
|
+
group_id: String?,
|
|
16
17
|
image_icon_key: GrowsurfRuby::Models::Campaign::Reward::image_icon_key?,
|
|
17
18
|
is_visible: bool,
|
|
18
19
|
limit: Integer?,
|
|
@@ -50,6 +51,8 @@ module GrowsurfRuby
|
|
|
50
51
|
|
|
51
52
|
attr_accessor image_url: String?
|
|
52
53
|
|
|
54
|
+
attr_accessor group_id: String?
|
|
55
|
+
|
|
53
56
|
attr_accessor image_icon_key: GrowsurfRuby::Models::Campaign::Reward::image_icon_key?
|
|
54
57
|
|
|
55
58
|
attr_reader is_visible: bool?
|
|
@@ -93,6 +96,7 @@ module GrowsurfRuby
|
|
|
93
96
|
?description: String?,
|
|
94
97
|
?event: GrowsurfRuby::Models::Campaign::Reward::event?,
|
|
95
98
|
?image_url: String?,
|
|
99
|
+
?group_id: String?,
|
|
96
100
|
?image_icon_key: GrowsurfRuby::Models::Campaign::Reward::image_icon_key?,
|
|
97
101
|
?is_visible: bool,
|
|
98
102
|
?limit: Integer?,
|
|
@@ -120,6 +124,7 @@ module GrowsurfRuby
|
|
|
120
124
|
description: String?,
|
|
121
125
|
event: GrowsurfRuby::Models::Campaign::Reward::event?,
|
|
122
126
|
image_url: String?,
|
|
127
|
+
group_id: String?,
|
|
123
128
|
image_icon_key: GrowsurfRuby::Models::Campaign::Reward::image_icon_key?,
|
|
124
129
|
is_visible: bool,
|
|
125
130
|
limit: Integer?,
|
|
@@ -10,6 +10,7 @@ module GrowsurfRuby
|
|
|
10
10
|
description: String,
|
|
11
11
|
event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
|
|
12
12
|
image_url: String?,
|
|
13
|
+
group_id: String?,
|
|
13
14
|
image_icon_key: GrowsurfRuby::Models::Campaign::RewardCreateParams::image_icon_key?,
|
|
14
15
|
is_unlimited: bool,
|
|
15
16
|
is_visible: bool,
|
|
@@ -63,6 +64,8 @@ module GrowsurfRuby
|
|
|
63
64
|
|
|
64
65
|
def image_url=: (String?) -> String?
|
|
65
66
|
|
|
67
|
+
attr_accessor group_id: String?
|
|
68
|
+
|
|
66
69
|
attr_reader image_icon_key: GrowsurfRuby::Models::Campaign::RewardCreateParams::image_icon_key?
|
|
67
70
|
|
|
68
71
|
def image_icon_key=: (
|
|
@@ -143,6 +146,7 @@ module GrowsurfRuby
|
|
|
143
146
|
?description: String,
|
|
144
147
|
?event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
|
|
145
148
|
?image_url: String?,
|
|
149
|
+
?group_id: String?,
|
|
146
150
|
?image_icon_key: GrowsurfRuby::Models::Campaign::RewardCreateParams::image_icon_key?,
|
|
147
151
|
?is_unlimited: bool,
|
|
148
152
|
?is_visible: bool,
|
|
@@ -170,6 +174,7 @@ module GrowsurfRuby
|
|
|
170
174
|
description: String,
|
|
171
175
|
event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
|
|
172
176
|
image_url: String?,
|
|
177
|
+
group_id: String?,
|
|
173
178
|
image_icon_key: GrowsurfRuby::Models::Campaign::RewardCreateParams::image_icon_key?,
|
|
174
179
|
is_unlimited: bool,
|
|
175
180
|
is_visible: bool,
|