growsurf-ruby 1.2.1 → 1.3.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 (118) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/LICENSE +201 -0
  4. data/README.md +1 -1
  5. data/lib/growsurf_ruby/internal/transport/base_client.rb +21 -4
  6. data/lib/growsurf_ruby/models/affiliate_application.rb +249 -0
  7. data/lib/growsurf_ruby/models/affiliate_application_list_response.rb +42 -0
  8. data/lib/growsurf_ruby/models/affiliate_invite.rb +109 -0
  9. data/lib/growsurf_ruby/models/affiliate_invite_list_response.rb +41 -0
  10. data/lib/growsurf_ruby/models/campaign/create.rb +12 -1
  11. data/lib/growsurf_ruby/models/campaign/participant.rb +79 -4
  12. data/lib/growsurf_ruby/models/campaign/participant_analytics_response.rb +28 -17
  13. data/lib/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rb +28 -0
  14. data/lib/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rb +126 -0
  15. data/lib/growsurf_ruby/models/campaign/participant_list_payouts_params.rb +1 -0
  16. data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rb +50 -0
  17. data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rb +56 -0
  18. data/lib/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rb +14 -17
  19. data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +25 -9
  20. data/lib/growsurf_ruby/models/campaign/referral_source.rb +3 -0
  21. data/lib/growsurf_ruby/models/campaign/reward.rb +20 -3
  22. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +3 -3
  23. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +3 -3
  24. data/lib/growsurf_ruby/models/campaign.rb +2 -2
  25. data/lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb +45 -0
  26. data/lib/growsurf_ruby/models/campaign_list_affiliate_applications_params.rb +57 -0
  27. data/lib/growsurf_ruby/models/campaign_list_affiliate_invites_params.rb +58 -0
  28. data/lib/growsurf_ruby/models/campaign_list_payouts_params.rb +1 -0
  29. data/lib/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rb +26 -0
  30. data/lib/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rb +26 -0
  31. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +9 -6
  32. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +59 -11
  33. data/lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb +94 -0
  34. data/lib/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rb +26 -0
  35. data/lib/growsurf_ruby/models/email_analytics.rb +41 -0
  36. data/lib/growsurf_ruby/models/participant_payout_list.rb +8 -1
  37. data/lib/growsurf_ruby/models/reward_tax_valuation.rb +24 -9
  38. data/lib/growsurf_ruby/models.rb +19 -0
  39. data/lib/growsurf_ruby/resources/campaign/design.rb +14 -12
  40. data/lib/growsurf_ruby/resources/campaign/options.rb +7 -7
  41. data/lib/growsurf_ruby/resources/campaign/participant.rb +96 -11
  42. data/lib/growsurf_ruby/resources/campaign/rewards.rb +2 -2
  43. data/lib/growsurf_ruby/resources/campaign.rb +231 -4
  44. data/lib/growsurf_ruby/version.rb +1 -1
  45. data/lib/growsurf_ruby.rb +16 -0
  46. data/rbi/growsurf_ruby/models/affiliate_application.rbi +431 -0
  47. data/rbi/growsurf_ruby/models/affiliate_application_list_response.rbi +70 -0
  48. data/rbi/growsurf_ruby/models/affiliate_invite.rbi +167 -0
  49. data/rbi/growsurf_ruby/models/affiliate_invite_list_response.rbi +70 -0
  50. data/rbi/growsurf_ruby/models/campaign/create.rbi +17 -0
  51. data/rbi/growsurf_ruby/models/campaign/participant.rbi +169 -3
  52. data/rbi/growsurf_ruby/models/campaign/participant_activity_logs_response.rbi +3 -5
  53. data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi +35 -20
  54. data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +3 -1
  55. data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rbi +48 -0
  56. data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbi +243 -0
  57. data/rbi/growsurf_ruby/models/campaign/participant_list_payouts_params.rbi +5 -0
  58. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbi +100 -0
  59. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbi +118 -0
  60. data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi +22 -52
  61. data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +67 -11
  62. data/rbi/growsurf_ruby/models/campaign/referral_source.rbi +9 -0
  63. data/rbi/growsurf_ruby/models/campaign/reward.rbi +23 -2
  64. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +4 -4
  65. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +4 -4
  66. data/rbi/growsurf_ruby/models/campaign.rbi +2 -2
  67. data/rbi/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbi +74 -0
  68. data/rbi/growsurf_ruby/models/campaign_list_affiliate_applications_params.rbi +130 -0
  69. data/rbi/growsurf_ruby/models/campaign_list_affiliate_invites_params.rbi +135 -0
  70. data/rbi/growsurf_ruby/models/campaign_list_payouts_params.rbi +5 -0
  71. data/rbi/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rbi +46 -0
  72. data/rbi/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbi +46 -0
  73. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +15 -10
  74. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +68 -18
  75. data/rbi/growsurf_ruby/models/campaign_review_affiliate_application_params.rbi +167 -0
  76. data/rbi/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbi +46 -0
  77. data/rbi/growsurf_ruby/models/email_analytics.rbi +200 -0
  78. data/rbi/growsurf_ruby/models/participant_payout_list.rbi +17 -3
  79. data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi +66 -9
  80. data/rbi/growsurf_ruby/models.rbi +25 -0
  81. data/rbi/growsurf_ruby/resources/campaign/design.rbi +9 -8
  82. data/rbi/growsurf_ruby/resources/campaign/options.rbi +7 -7
  83. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +89 -13
  84. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +4 -4
  85. data/rbi/growsurf_ruby/resources/campaign.rbi +188 -10
  86. data/sig/growsurf_ruby/models/affiliate_application.rbs +192 -0
  87. data/sig/growsurf_ruby/models/affiliate_application_list_response.rbs +39 -0
  88. data/sig/growsurf_ruby/models/affiliate_invite.rbs +92 -0
  89. data/sig/growsurf_ruby/models/affiliate_invite_list_response.rbs +39 -0
  90. data/sig/growsurf_ruby/models/campaign/create.rbs +7 -0
  91. data/sig/growsurf_ruby/models/campaign/participant.rbs +62 -2
  92. data/sig/growsurf_ruby/models/campaign/participant_activity_logs_response.rbs +2 -11
  93. data/sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs +12 -12
  94. data/sig/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rbs +30 -0
  95. data/sig/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbs +107 -0
  96. data/sig/growsurf_ruby/models/campaign/participant_list_payouts_params.rbs +2 -1
  97. data/sig/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbs +49 -0
  98. data/sig/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbs +57 -0
  99. data/sig/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbs +5 -13
  100. data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +21 -7
  101. data/sig/growsurf_ruby/models/campaign/referral_source.rbs +4 -1
  102. data/sig/growsurf_ruby/models/campaign/reward.rbs +12 -0
  103. data/sig/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbs +40 -0
  104. data/sig/growsurf_ruby/models/campaign_list_affiliate_applications_params.rbs +61 -0
  105. data/sig/growsurf_ruby/models/campaign_list_affiliate_invites_params.rbs +62 -0
  106. data/sig/growsurf_ruby/models/campaign_list_payouts_params.rbs +2 -1
  107. data/sig/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rbs +28 -0
  108. data/sig/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbs +28 -0
  109. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +36 -16
  110. data/sig/growsurf_ruby/models/campaign_review_affiliate_application_params.rbs +79 -0
  111. data/sig/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbs +28 -0
  112. data/sig/growsurf_ruby/models/email_analytics.rbs +92 -0
  113. data/sig/growsurf_ruby/models/participant_payout_list.rbs +12 -4
  114. data/sig/growsurf_ruby/models/reward_tax_valuation.rbs +26 -4
  115. data/sig/growsurf_ruby/models.rbs +18 -0
  116. data/sig/growsurf_ruby/resources/campaign/participant.rbs +16 -2
  117. data/sig/growsurf_ruby/resources/campaign.rbs +53 -0
  118. metadata +54 -3
@@ -11,6 +11,8 @@ module GrowsurfRuby
11
11
  referral_count: Integer,
12
12
  rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
13
13
  share_url: String,
14
+ affiliate_enrollment_source: String?,
15
+ affiliate_status: String?,
14
16
  all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
15
17
  created_at: Integer,
16
18
  fingerprint: String?,
@@ -20,6 +22,7 @@ module GrowsurfRuby
20
22
  impression_count: Integer,
21
23
  invite_count: Integer,
22
24
  ip_address: String?,
25
+ is_affiliate: bool,
23
26
  is_new: bool,
24
27
  is_winner: bool,
25
28
  last_name: String?,
@@ -27,6 +30,7 @@ module GrowsurfRuby
27
30
  mobile_instance_id: String?,
28
31
  monthly_referrals: ::Array[String],
29
32
  notes: String?,
33
+ payout_settings: GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings,
30
34
  paypal_email_address: String,
31
35
  prev_monthly_rank: Integer,
32
36
  prev_monthly_referral_count: Integer,
@@ -58,7 +62,13 @@ module GrowsurfRuby
58
62
 
59
63
  attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
60
64
 
61
- attr_accessor share_url: String
65
+ attr_reader share_url: String?
66
+
67
+ def share_url=: (String) -> String
68
+
69
+ attr_accessor affiliate_enrollment_source: String?
70
+
71
+ attr_accessor affiliate_status: String?
62
72
 
63
73
  attr_reader all_matching_fraudsters: ::Array[::Hash[Symbol, top]]?
64
74
 
@@ -94,6 +104,10 @@ module GrowsurfRuby
94
104
 
95
105
  attr_accessor ip_address: String?
96
106
 
107
+ attr_reader is_affiliate: bool?
108
+
109
+ def is_affiliate=: (bool) -> bool
110
+
97
111
  attr_reader is_new: bool?
98
112
 
99
113
  def is_new=: (bool) -> bool
@@ -116,6 +130,12 @@ module GrowsurfRuby
116
130
 
117
131
  attr_accessor notes: String?
118
132
 
133
+ attr_reader payout_settings: GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings?
134
+
135
+ def payout_settings=: (
136
+ GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings
137
+ ) -> GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings
138
+
119
139
  attr_reader paypal_email_address: String?
120
140
 
121
141
  def paypal_email_address=: (String) -> String
@@ -182,7 +202,9 @@ module GrowsurfRuby
182
202
  rank: Integer,
183
203
  referral_count: Integer,
184
204
  rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
185
- share_url: String,
205
+ ?share_url: String,
206
+ ?affiliate_enrollment_source: String?,
207
+ ?affiliate_status: String?,
186
208
  ?all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
187
209
  ?created_at: Integer,
188
210
  ?fingerprint: String?,
@@ -192,6 +214,7 @@ module GrowsurfRuby
192
214
  ?impression_count: Integer,
193
215
  ?invite_count: Integer,
194
216
  ?ip_address: String?,
217
+ ?is_affiliate: bool,
195
218
  ?is_new: bool,
196
219
  ?is_winner: bool,
197
220
  ?last_name: String?,
@@ -199,6 +222,7 @@ module GrowsurfRuby
199
222
  ?mobile_instance_id: String?,
200
223
  ?monthly_referrals: ::Array[String],
201
224
  ?notes: String?,
225
+ ?payout_settings: GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings,
202
226
  ?paypal_email_address: String,
203
227
  ?prev_monthly_rank: Integer,
204
228
  ?prev_monthly_referral_count: Integer,
@@ -224,6 +248,8 @@ module GrowsurfRuby
224
248
  referral_count: Integer,
225
249
  rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward],
226
250
  share_url: String,
251
+ affiliate_enrollment_source: String?,
252
+ affiliate_status: String?,
227
253
  all_matching_fraudsters: ::Array[::Hash[Symbol, top]],
228
254
  created_at: Integer,
229
255
  fingerprint: String?,
@@ -233,6 +259,7 @@ module GrowsurfRuby
233
259
  impression_count: Integer,
234
260
  invite_count: Integer,
235
261
  ip_address: String?,
262
+ is_affiliate: bool,
236
263
  is_new: bool,
237
264
  is_winner: bool,
238
265
  last_name: String?,
@@ -240,6 +267,7 @@ module GrowsurfRuby
240
267
  mobile_instance_id: String?,
241
268
  monthly_referrals: ::Array[String],
242
269
  notes: String?,
270
+ payout_settings: GrowsurfRuby::Campaign::CampaignParticipant::PayoutSettings,
243
271
  paypal_email_address: String,
244
272
  prev_monthly_rank: Integer,
245
273
  prev_monthly_referral_count: Integer,
@@ -256,6 +284,38 @@ module GrowsurfRuby
256
284
  vanity_keys: ::Array[String]
257
285
  }
258
286
 
287
+ type payout_settings =
288
+ {
289
+ required_actions: ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
290
+ }
291
+
292
+ class PayoutSettings < GrowsurfRuby::Internal::Type::BaseModel
293
+ attr_reader required_actions: ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]?
294
+
295
+ def required_actions=: (
296
+ ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
297
+ ) -> ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
298
+
299
+ def initialize: (
300
+ ?required_actions: ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
301
+ ) -> void
302
+
303
+ def to_hash: -> {
304
+ required_actions: ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
305
+ }
306
+
307
+ type required_action = :PAYOUT_DESTINATION | :TAX_INFO
308
+
309
+ module RequiredAction
310
+ extend GrowsurfRuby::Internal::Type::Enum
311
+
312
+ PAYOUT_DESTINATION: :PAYOUT_DESTINATION
313
+ TAX_INFO: :TAX_INFO
314
+
315
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::CampaignParticipant::PayoutSettings::required_action]
316
+ end
317
+ end
318
+
259
319
  type referrer =
260
320
  {
261
321
  id: String,
@@ -27,12 +27,7 @@ module GrowsurfRuby
27
27
  offset: Integer?
28
28
  }
29
29
 
30
- type activity_log =
31
- {
32
- created_at: Integer,
33
- text: String,
34
- type: String
35
- }
30
+ type activity_log = { created_at: Integer, text: String, type: String }
36
31
 
37
32
  class ActivityLog < GrowsurfRuby::Internal::Type::BaseModel
38
33
  attr_accessor created_at: Integer
@@ -47,11 +42,7 @@ module GrowsurfRuby
47
42
  type: String
48
43
  ) -> void
49
44
 
50
- def to_hash: -> {
51
- created_at: Integer,
52
- text: String,
53
- type: String
54
- }
45
+ def to_hash: -> { created_at: Integer, text: String, type: String }
55
46
  end
56
47
  end
57
48
  end
@@ -58,10 +58,9 @@ module GrowsurfRuby
58
58
  invites_sent: Integer,
59
59
  leads: Integer,
60
60
  monthly_referrals: Integer,
61
- pending_rewards: Integer,
62
61
  referral_revenue: Integer,
63
62
  referrals: Integer,
64
- rewards_earned: Integer,
63
+ reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus,
65
64
  total_commissions: Integer,
66
65
  total_paid_out: Integer,
67
66
  unique_impressions: Integer,
@@ -93,9 +92,9 @@ module GrowsurfRuby
93
92
 
94
93
  def monthly_referrals=: (Integer) -> Integer
95
94
 
96
- attr_reader pending_rewards: Integer?
95
+ attr_reader reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus?
97
96
 
98
- def pending_rewards=: (Integer) -> Integer
97
+ def reward_status=: (GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
99
98
 
100
99
  attr_reader referral_revenue: Integer?
101
100
 
@@ -105,10 +104,6 @@ module GrowsurfRuby
105
104
 
106
105
  def referrals=: (Integer) -> Integer
107
106
 
108
- attr_reader rewards_earned: Integer?
109
-
110
- def rewards_earned=: (Integer) -> Integer
111
-
112
107
  attr_reader total_commissions: Integer?
113
108
 
114
109
  def total_commissions=: (Integer) -> Integer
@@ -132,10 +127,9 @@ module GrowsurfRuby
132
127
  ?invites_sent: Integer,
133
128
  ?leads: Integer,
134
129
  ?monthly_referrals: Integer,
135
- ?pending_rewards: Integer,
136
130
  ?referral_revenue: Integer,
137
131
  ?referrals: Integer,
138
- ?rewards_earned: Integer,
132
+ ?reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus,
139
133
  ?total_commissions: Integer,
140
134
  ?total_paid_out: Integer,
141
135
  ?unique_impressions: Integer,
@@ -149,10 +143,9 @@ module GrowsurfRuby
149
143
  invites_sent: Integer,
150
144
  leads: Integer,
151
145
  monthly_referrals: Integer,
152
- pending_rewards: Integer,
153
146
  referral_revenue: Integer,
154
147
  referrals: Integer,
155
- rewards_earned: Integer,
148
+ reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus,
156
149
  total_commissions: Integer,
157
150
  total_paid_out: Integer,
158
151
  unique_impressions: Integer,
@@ -215,6 +208,7 @@ module GrowsurfRuby
215
208
  total_revenue: Integer,
216
209
  tumblr_shares: Integer,
217
210
  twitter_shares: Integer,
211
+ unique_commission_referrals: Integer,
218
212
  unique_impressions: Integer,
219
213
  wechat_shares: Integer,
220
214
  whats_app_shares: Integer
@@ -325,6 +319,10 @@ module GrowsurfRuby
325
319
 
326
320
  def twitter_shares=: (Integer) -> Integer
327
321
 
322
+ attr_reader unique_commission_referrals: Integer?
323
+
324
+ def unique_commission_referrals=: (Integer) -> Integer
325
+
328
326
  attr_reader unique_impressions: Integer?
329
327
 
330
328
  def unique_impressions=: (Integer) -> Integer
@@ -364,6 +362,7 @@ module GrowsurfRuby
364
362
  ?total_revenue: Integer,
365
363
  ?tumblr_shares: Integer,
366
364
  ?twitter_shares: Integer,
365
+ ?unique_commission_referrals: Integer,
367
366
  ?unique_impressions: Integer,
368
367
  ?wechat_shares: Integer,
369
368
  ?whats_app_shares: Integer
@@ -396,6 +395,7 @@ module GrowsurfRuby
396
395
  total_revenue: Integer,
397
396
  tumblr_shares: Integer,
398
397
  twitter_shares: Integer,
398
+ unique_commission_referrals: Integer,
399
399
  unique_impressions: Integer,
400
400
  wechat_shares: Integer,
401
401
  whats_app_shares: Integer
@@ -0,0 +1,30 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_get_payout_destination_params =
5
+ { id: String, participant_id_or_email: String }
6
+ & GrowsurfRuby::Internal::Type::request_parameters
7
+
8
+ class ParticipantGetPayoutDestinationParams < GrowsurfRuby::Internal::Type::BaseModel
9
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
10
+ include GrowsurfRuby::Internal::Type::RequestParameters
11
+
12
+ attr_accessor id: String
13
+
14
+ attr_accessor participant_id_or_email: String
15
+
16
+ def initialize: (
17
+ id: String,
18
+ participant_id_or_email: String,
19
+ ?request_options: GrowsurfRuby::request_opts
20
+ ) -> void
21
+
22
+ def to_hash: -> {
23
+ id: String,
24
+ participant_id_or_email: String,
25
+ request_options: GrowsurfRuby::RequestOptions
26
+ }
27
+ end
28
+ end
29
+ end
30
+ end
@@ -0,0 +1,107 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_get_payout_destination_response =
5
+ {
6
+ active_provider: String?,
7
+ destinations: ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination],
8
+ enabled_providers: ::Array[String]
9
+ }
10
+
11
+ class ParticipantGetPayoutDestinationResponse < GrowsurfRuby::Internal::Type::BaseModel
12
+ attr_accessor active_provider: String?
13
+
14
+ attr_reader destinations: ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination]?
15
+
16
+ def destinations=: (
17
+ ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination]
18
+ ) -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination]
19
+
20
+ attr_reader enabled_providers: ::Array[String]?
21
+
22
+ def enabled_providers=: (
23
+ ::Array[String]
24
+ ) -> ::Array[String]
25
+
26
+ def initialize: (
27
+ ?active_provider: String?,
28
+ ?destinations: ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination],
29
+ ?enabled_providers: ::Array[String]
30
+ ) -> void
31
+
32
+ def to_hash: -> {
33
+ active_provider: String?,
34
+ destinations: ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination],
35
+ enabled_providers: ::Array[String]
36
+ }
37
+
38
+ type destination =
39
+ {
40
+ claim_email: String?,
41
+ confirmed_at: Integer?,
42
+ legal_entity_type: GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::legal_entity_type?,
43
+ needs_repair_reason: String?,
44
+ provider: String,
45
+ provider_display_name: String,
46
+ status: String
47
+ }
48
+
49
+ class Destination < GrowsurfRuby::Internal::Type::BaseModel
50
+ attr_accessor claim_email: String?
51
+
52
+ attr_accessor confirmed_at: Integer?
53
+
54
+ attr_accessor legal_entity_type: GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::legal_entity_type?
55
+
56
+ attr_accessor needs_repair_reason: String?
57
+
58
+ attr_reader provider: String?
59
+
60
+ def provider=: (
61
+ String
62
+ ) -> String
63
+
64
+ attr_reader provider_display_name: String?
65
+
66
+ def provider_display_name=: (String) -> String
67
+
68
+ attr_reader status: String?
69
+
70
+ def status=: (String) -> String
71
+
72
+ def initialize: (
73
+ ?claim_email: String?,
74
+ ?confirmed_at: Integer?,
75
+ ?legal_entity_type: GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::legal_entity_type?,
76
+ ?needs_repair_reason: String?,
77
+ ?provider: String,
78
+ ?provider_display_name: String,
79
+ ?status: String
80
+ ) -> void
81
+
82
+ def to_hash: -> {
83
+ claim_email: String?,
84
+ confirmed_at: Integer?,
85
+ legal_entity_type: GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::legal_entity_type?,
86
+ needs_repair_reason: String?,
87
+ provider: String,
88
+ provider_display_name: String,
89
+ status: String
90
+ }
91
+
92
+ type legal_entity_type = :INDIVIDUAL | :BUSINESS
93
+
94
+ module LegalEntityType
95
+ extend GrowsurfRuby::Internal::Type::Enum
96
+
97
+ INDIVIDUAL: :INDIVIDUAL
98
+ BUSINESS: :BUSINESS
99
+
100
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantGetPayoutDestinationResponse::Destination::legal_entity_type]
101
+ end
102
+
103
+ end
104
+ end
105
+ end
106
+ end
107
+ end
@@ -51,7 +51,7 @@ module GrowsurfRuby
51
51
  request_options: GrowsurfRuby::RequestOptions
52
52
  }
53
53
 
54
- type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
54
+ type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED | :REVERSED
55
55
 
56
56
  module Status
57
57
  extend GrowsurfRuby::Internal::Type::Enum
@@ -60,6 +60,7 @@ module GrowsurfRuby
60
60
  QUEUED: :QUEUED
61
61
  ISSUED: :ISSUED
62
62
  FAILED: :FAILED
63
+ REVERSED: :REVERSED
63
64
 
64
65
  def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status]
65
66
  end
@@ -0,0 +1,49 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_request_payout_destination_confirmation_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ provider: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider
9
+ }
10
+ & GrowsurfRuby::Internal::Type::request_parameters
11
+
12
+ class ParticipantRequestPayoutDestinationConfirmationParams < GrowsurfRuby::Internal::Type::BaseModel
13
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
14
+ include GrowsurfRuby::Internal::Type::RequestParameters
15
+
16
+ attr_accessor id: String
17
+
18
+ attr_accessor participant_id_or_email: String
19
+
20
+ attr_accessor provider: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider
21
+
22
+ def initialize: (
23
+ id: String,
24
+ participant_id_or_email: String,
25
+ provider: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider,
26
+ ?request_options: GrowsurfRuby::request_opts
27
+ ) -> void
28
+
29
+ def to_hash: -> {
30
+ id: String,
31
+ participant_id_or_email: String,
32
+ provider: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider,
33
+ request_options: GrowsurfRuby::RequestOptions
34
+ }
35
+
36
+ type provider = :PAYPAL | :WISECOM
37
+
38
+ module Provider
39
+ extend GrowsurfRuby::Internal::Type::Enum
40
+
41
+ PAYPAL: :PAYPAL
42
+ WISECOM: :WISECOM
43
+
44
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationParams::provider]
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,57 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_request_payout_destination_confirmation_response =
5
+ {
6
+ expires_at: Integer?,
7
+ provider: String,
8
+ provider_display_name: String,
9
+ status: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status
10
+ }
11
+
12
+ class ParticipantRequestPayoutDestinationConfirmationResponse < GrowsurfRuby::Internal::Type::BaseModel
13
+ attr_accessor expires_at: Integer?
14
+
15
+ attr_reader provider: String?
16
+
17
+ def provider=: (
18
+ String
19
+ ) -> String
20
+
21
+ attr_reader provider_display_name: String?
22
+
23
+ def provider_display_name=: (String) -> String
24
+
25
+ attr_reader status: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status?
26
+
27
+ def status=: (
28
+ GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status
29
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status
30
+
31
+ def initialize: (
32
+ ?expires_at: Integer?,
33
+ ?provider: String,
34
+ ?provider_display_name: String,
35
+ ?status: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status
36
+ ) -> void
37
+
38
+ def to_hash: -> {
39
+ expires_at: Integer?,
40
+ provider: String,
41
+ provider_display_name: String,
42
+ status: GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status
43
+ }
44
+
45
+ type status = :CONFIRMATION_REQUESTED
46
+
47
+ module Status
48
+ extend GrowsurfRuby::Internal::Type::Enum
49
+
50
+ CONFIRMATION_REQUESTED: :CONFIRMATION_REQUESTED
51
+
52
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRequestPayoutDestinationConfirmationResponse::status]
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -7,7 +7,7 @@ module GrowsurfRuby
7
7
  participant_id_or_email: String,
8
8
  days: Integer,
9
9
  end_date: Integer,
10
- include: :series,
10
+ include: String,
11
11
  interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
12
12
  start_date: Integer
13
13
  }
@@ -29,9 +29,9 @@ module GrowsurfRuby
29
29
 
30
30
  def end_date=: (Integer) -> Integer
31
31
 
32
- attr_reader include: :series?
32
+ attr_reader include: String?
33
33
 
34
- def include=: (:series) -> :series
34
+ def include=: (String) -> String
35
35
 
36
36
  attr_reader interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval?
37
37
 
@@ -48,7 +48,7 @@ module GrowsurfRuby
48
48
  participant_id_or_email: String,
49
49
  ?days: Integer,
50
50
  ?end_date: Integer,
51
- ?include: :series,
51
+ ?include: String,
52
52
  ?interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
53
53
  ?start_date: Integer,
54
54
  ?request_options: GrowsurfRuby::request_opts
@@ -59,20 +59,12 @@ module GrowsurfRuby
59
59
  participant_id_or_email: String,
60
60
  days: Integer,
61
61
  end_date: Integer,
62
- include: :series,
62
+ include: String,
63
63
  interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
64
64
  start_date: Integer,
65
65
  request_options: GrowsurfRuby::RequestOptions
66
66
  }
67
67
 
68
- module Include
69
- extend GrowsurfRuby::Internal::Type::Enum
70
-
71
- SERIES: :series
72
-
73
- def self?.values: -> ::Array[:series]
74
- end
75
-
76
68
  type interval = :day | :week | :month
77
69
 
78
70
  module Interval
@@ -5,12 +5,12 @@ module GrowsurfRuby
5
5
  {
6
6
  id: String,
7
7
  participant_id_or_email: String,
8
+ affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
8
9
  email: String,
9
10
  first_name: String,
10
11
  last_name: String,
11
12
  metadata: ::Hash[Symbol, top],
12
13
  notes: String,
13
- paypal_email: String,
14
14
  referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
15
15
  referred_by: String,
16
16
  unsubscribed: bool,
@@ -26,6 +26,12 @@ module GrowsurfRuby
26
26
 
27
27
  attr_accessor participant_id_or_email: String
28
28
 
29
+ attr_reader affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status?
30
+
31
+ def affiliate_status=: (
32
+ GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status
33
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status
34
+
29
35
  attr_reader email: String?
30
36
 
31
37
  def email=: (String) -> String
@@ -46,10 +52,6 @@ module GrowsurfRuby
46
52
 
47
53
  def notes=: (String) -> String
48
54
 
49
- attr_reader paypal_email: String?
50
-
51
- def paypal_email=: (String) -> String
52
-
53
55
  attr_reader referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status?
54
56
 
55
57
  def referral_status=: (
@@ -71,12 +73,12 @@ module GrowsurfRuby
71
73
  def initialize: (
72
74
  id: String,
73
75
  participant_id_or_email: String,
76
+ ?affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
74
77
  ?email: String,
75
78
  ?first_name: String,
76
79
  ?last_name: String,
77
80
  ?metadata: ::Hash[Symbol, top],
78
81
  ?notes: String,
79
- ?paypal_email: String,
80
82
  ?referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
81
83
  ?referred_by: String,
82
84
  ?unsubscribed: bool,
@@ -87,12 +89,12 @@ module GrowsurfRuby
87
89
  def to_hash: -> {
88
90
  id: String,
89
91
  participant_id_or_email: String,
92
+ affiliate_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status,
90
93
  email: String,
91
94
  first_name: String,
92
95
  last_name: String,
93
96
  metadata: ::Hash[Symbol, top],
94
97
  notes: String,
95
- paypal_email: String,
96
98
  referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
97
99
  referred_by: String,
98
100
  unsubscribed: bool,
@@ -100,6 +102,18 @@ module GrowsurfRuby
100
102
  request_options: GrowsurfRuby::RequestOptions
101
103
  }
102
104
 
105
+ type affiliate_status = :APPROVED | :SUSPENDED | :BANNED
106
+
107
+ module AffiliateStatus
108
+ extend GrowsurfRuby::Internal::Type::Enum
109
+
110
+ APPROVED: :APPROVED
111
+ SUSPENDED: :SUSPENDED
112
+ BANNED: :BANNED
113
+
114
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::affiliate_status]
115
+ end
116
+
103
117
  type referral_status =
104
118
  :CREDIT_PENDING | :CREDIT_AWARDED | :CREDIT_EXPIRED
105
119
 
@@ -1,13 +1,16 @@
1
1
  module GrowsurfRuby
2
2
  module Models
3
3
  module Campaign
4
- type referral_source = :DIRECT | :PARTICIPANT
4
+ type referral_source = :DIRECT | :PARTICIPANT | :DELETED_PARTICIPANT | :IMPORT | :MANUAL
5
5
 
6
6
  module ReferralSource
7
7
  extend GrowsurfRuby::Internal::Type::Enum
8
8
 
9
9
  DIRECT: :DIRECT
10
10
  PARTICIPANT: :PARTICIPANT
11
+ DELETED_PARTICIPANT: :DELETED_PARTICIPANT
12
+ IMPORT: :IMPORT
13
+ MANUAL: :MANUAL
11
14
 
12
15
  def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::referral_source]
13
16
  end