growsurf-ruby 1.2.1 → 1.4.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 (131) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +21 -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 +25 -25
  19. data/lib/growsurf_ruby/models/campaign/participant_reward.rb +1 -0
  20. data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +25 -9
  21. data/lib/growsurf_ruby/models/campaign/referral_source.rb +3 -0
  22. data/lib/growsurf_ruby/models/campaign/reward.rb +41 -3
  23. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +26 -4
  24. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +26 -4
  25. data/lib/growsurf_ruby/models/campaign.rb +24 -3
  26. data/lib/growsurf_ruby/models/campaign_create_affiliate_invite_params.rb +45 -0
  27. data/lib/growsurf_ruby/models/campaign_list_affiliate_applications_params.rb +57 -0
  28. data/lib/growsurf_ruby/models/campaign_list_affiliate_invites_params.rb +58 -0
  29. data/lib/growsurf_ruby/models/campaign_list_payouts_params.rb +1 -0
  30. data/lib/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rb +26 -0
  31. data/lib/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rb +26 -0
  32. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +9 -6
  33. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +59 -11
  34. data/lib/growsurf_ruby/models/campaign_review_affiliate_application_params.rb +94 -0
  35. data/lib/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rb +26 -0
  36. data/lib/growsurf_ruby/models/commission_structure.rb +16 -3
  37. data/lib/growsurf_ruby/models/email_analytics.rb +41 -0
  38. data/lib/growsurf_ruby/models/participant_commission_list.rb +19 -1
  39. data/lib/growsurf_ruby/models/participant_payout_list.rb +8 -1
  40. data/lib/growsurf_ruby/models/reward_tax_valuation.rb +24 -9
  41. data/lib/growsurf_ruby/models.rb +19 -0
  42. data/lib/growsurf_ruby/resources/campaign/design.rb +14 -12
  43. data/lib/growsurf_ruby/resources/campaign/options.rb +7 -7
  44. data/lib/growsurf_ruby/resources/campaign/participant.rb +101 -14
  45. data/lib/growsurf_ruby/resources/campaign/rewards.rb +8 -4
  46. data/lib/growsurf_ruby/resources/campaign.rb +231 -4
  47. data/lib/growsurf_ruby/version.rb +1 -1
  48. data/lib/growsurf_ruby.rb +16 -0
  49. data/rbi/growsurf_ruby/models/affiliate_application.rbi +431 -0
  50. data/rbi/growsurf_ruby/models/affiliate_application_list_response.rbi +70 -0
  51. data/rbi/growsurf_ruby/models/affiliate_invite.rbi +167 -0
  52. data/rbi/growsurf_ruby/models/affiliate_invite_list_response.rbi +70 -0
  53. data/rbi/growsurf_ruby/models/campaign/create.rbi +17 -0
  54. data/rbi/growsurf_ruby/models/campaign/participant.rbi +169 -3
  55. data/rbi/growsurf_ruby/models/campaign/participant_activity_logs_response.rbi +3 -5
  56. data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi +35 -20
  57. data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +3 -1
  58. data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rbi +48 -0
  59. data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbi +243 -0
  60. data/rbi/growsurf_ruby/models/campaign/participant_list_payouts_params.rbi +5 -0
  61. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbi +100 -0
  62. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbi +118 -0
  63. data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi +38 -62
  64. data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi +5 -0
  65. data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +67 -11
  66. data/rbi/growsurf_ruby/models/campaign/referral_source.rbi +9 -0
  67. data/rbi/growsurf_ruby/models/campaign/reward.rbi +78 -2
  68. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +68 -4
  69. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +68 -4
  70. data/rbi/growsurf_ruby/models/campaign.rbi +48 -2
  71. data/rbi/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbi +74 -0
  72. data/rbi/growsurf_ruby/models/campaign_list_affiliate_applications_params.rbi +130 -0
  73. data/rbi/growsurf_ruby/models/campaign_list_affiliate_invites_params.rbi +135 -0
  74. data/rbi/growsurf_ruby/models/campaign_list_payouts_params.rbi +5 -0
  75. data/rbi/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rbi +46 -0
  76. data/rbi/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbi +46 -0
  77. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +15 -10
  78. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +68 -18
  79. data/rbi/growsurf_ruby/models/campaign_review_affiliate_application_params.rbi +167 -0
  80. data/rbi/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbi +46 -0
  81. data/rbi/growsurf_ruby/models/commission_structure.rbi +34 -3
  82. data/rbi/growsurf_ruby/models/email_analytics.rbi +200 -0
  83. data/rbi/growsurf_ruby/models/participant_commission_list.rbi +48 -0
  84. data/rbi/growsurf_ruby/models/participant_payout_list.rbi +17 -3
  85. data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi +66 -9
  86. data/rbi/growsurf_ruby/models.rbi +25 -0
  87. data/rbi/growsurf_ruby/resources/campaign/design.rbi +9 -8
  88. data/rbi/growsurf_ruby/resources/campaign/options.rbi +7 -7
  89. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +99 -18
  90. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +18 -4
  91. data/rbi/growsurf_ruby/resources/campaign.rbi +188 -10
  92. data/sig/growsurf_ruby/models/affiliate_application.rbs +192 -0
  93. data/sig/growsurf_ruby/models/affiliate_application_list_response.rbs +39 -0
  94. data/sig/growsurf_ruby/models/affiliate_invite.rbs +92 -0
  95. data/sig/growsurf_ruby/models/affiliate_invite_list_response.rbs +39 -0
  96. data/sig/growsurf_ruby/models/campaign/create.rbs +7 -0
  97. data/sig/growsurf_ruby/models/campaign/participant.rbs +62 -2
  98. data/sig/growsurf_ruby/models/campaign/participant_activity_logs_response.rbs +2 -11
  99. data/sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs +12 -12
  100. data/sig/growsurf_ruby/models/campaign/participant_get_payout_destination_params.rbs +30 -0
  101. data/sig/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbs +107 -0
  102. data/sig/growsurf_ruby/models/campaign/participant_list_payouts_params.rbs +2 -1
  103. data/sig/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_params.rbs +49 -0
  104. data/sig/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbs +57 -0
  105. data/sig/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbs +5 -13
  106. data/sig/growsurf_ruby/models/campaign/participant_reward.rbs +2 -1
  107. data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +21 -7
  108. data/sig/growsurf_ruby/models/campaign/referral_source.rbs +4 -1
  109. data/sig/growsurf_ruby/models/campaign/reward.rbs +28 -0
  110. data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +20 -0
  111. data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +20 -0
  112. data/sig/growsurf_ruby/models/campaign.rbs +16 -0
  113. data/sig/growsurf_ruby/models/campaign_create_affiliate_invite_params.rbs +40 -0
  114. data/sig/growsurf_ruby/models/campaign_list_affiliate_applications_params.rbs +61 -0
  115. data/sig/growsurf_ruby/models/campaign_list_affiliate_invites_params.rbs +62 -0
  116. data/sig/growsurf_ruby/models/campaign_list_payouts_params.rbs +2 -1
  117. data/sig/growsurf_ruby/models/campaign_resend_affiliate_invite_params.rbs +28 -0
  118. data/sig/growsurf_ruby/models/campaign_retrieve_affiliate_application_params.rbs +28 -0
  119. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +36 -16
  120. data/sig/growsurf_ruby/models/campaign_review_affiliate_application_params.rbs +79 -0
  121. data/sig/growsurf_ruby/models/campaign_revoke_affiliate_invite_params.rbs +28 -0
  122. data/sig/growsurf_ruby/models/commission_structure.rbs +16 -4
  123. data/sig/growsurf_ruby/models/email_analytics.rbs +92 -0
  124. data/sig/growsurf_ruby/models/participant_commission_list.rbs +16 -0
  125. data/sig/growsurf_ruby/models/participant_payout_list.rbs +12 -4
  126. data/sig/growsurf_ruby/models/reward_tax_valuation.rbs +26 -4
  127. data/sig/growsurf_ruby/models.rbs +18 -0
  128. data/sig/growsurf_ruby/resources/campaign/participant.rbs +16 -2
  129. data/sig/growsurf_ruby/resources/campaign/rewards.rbs +2 -0
  130. data/sig/growsurf_ruby/resources/campaign.rbs +53 -0
  131. metadata +54 -3
@@ -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
@@ -11,7 +11,9 @@ module GrowsurfRuby
11
11
  conversions_required: Integer?,
12
12
  coupon_code: String?,
13
13
  description: String?,
14
+ event: GrowsurfRuby::Models::Campaign::Reward::event?,
14
15
  image_url: String?,
16
+ is_visible: bool,
15
17
  limit: Integer?,
16
18
  limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
17
19
  next_milestone_prefix: String?,
@@ -22,6 +24,7 @@ module GrowsurfRuby
22
24
  referral_description: String?,
23
25
  referred_reward_upfront: bool,
24
26
  referred_value: GrowsurfRuby::RewardTaxValuation?,
27
+ title: String?,
25
28
  value: GrowsurfRuby::RewardTaxValuation?
26
29
  }
27
30
 
@@ -42,8 +45,14 @@ module GrowsurfRuby
42
45
 
43
46
  attr_accessor description: String?
44
47
 
48
+ attr_accessor event: GrowsurfRuby::Models::Campaign::Reward::event?
49
+
45
50
  attr_accessor image_url: String?
46
51
 
52
+ attr_reader is_visible: bool?
53
+
54
+ def is_visible=: (bool) -> bool
55
+
47
56
  attr_accessor limit: Integer?
48
57
 
49
58
  attr_accessor limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?
@@ -66,6 +75,8 @@ module GrowsurfRuby
66
75
 
67
76
  attr_accessor referred_value: GrowsurfRuby::RewardTaxValuation?
68
77
 
78
+ attr_accessor title: String?
79
+
69
80
  attr_accessor value: GrowsurfRuby::RewardTaxValuation?
70
81
 
71
82
  def initialize: (
@@ -77,7 +88,9 @@ module GrowsurfRuby
77
88
  ?conversions_required: Integer?,
78
89
  ?coupon_code: String?,
79
90
  ?description: String?,
91
+ ?event: GrowsurfRuby::Models::Campaign::Reward::event?,
80
92
  ?image_url: String?,
93
+ ?is_visible: bool,
81
94
  ?limit: Integer?,
82
95
  ?limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
83
96
  ?next_milestone_prefix: String?,
@@ -88,6 +101,7 @@ module GrowsurfRuby
88
101
  ?referral_description: String?,
89
102
  ?referred_reward_upfront: bool,
90
103
  ?referred_value: GrowsurfRuby::RewardTaxValuation?,
104
+ ?title: String?,
91
105
  ?value: GrowsurfRuby::RewardTaxValuation?
92
106
  ) -> void
93
107
 
@@ -100,7 +114,9 @@ module GrowsurfRuby
100
114
  conversions_required: Integer?,
101
115
  coupon_code: String?,
102
116
  description: String?,
117
+ event: GrowsurfRuby::Models::Campaign::Reward::event?,
103
118
  image_url: String?,
119
+ is_visible: bool,
104
120
  limit: Integer?,
105
121
  limit_duration: GrowsurfRuby::Models::Campaign::Reward::limit_duration?,
106
122
  next_milestone_prefix: String?,
@@ -111,6 +127,7 @@ module GrowsurfRuby
111
127
  referral_description: String?,
112
128
  referred_reward_upfront: bool,
113
129
  referred_value: GrowsurfRuby::RewardTaxValuation?,
130
+ title: String?,
114
131
  value: GrowsurfRuby::RewardTaxValuation?
115
132
  }
116
133
 
@@ -129,6 +146,17 @@ module GrowsurfRuby
129
146
  def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::Reward::type_]
130
147
  end
131
148
 
149
+ type event = :LEAD | :CONVERSION
150
+
151
+ module Event
152
+ extend GrowsurfRuby::Internal::Type::Enum
153
+
154
+ LEAD: :LEAD
155
+ CONVERSION: :CONVERSION
156
+
157
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::Reward::event]
158
+ end
159
+
132
160
  type limit_duration = :IN_TOTAL | :PER_MONTH | :PER_YEAR
133
161
 
134
162
  module LimitDuration
@@ -8,6 +8,7 @@ module GrowsurfRuby
8
8
  conversions_required: Integer,
9
9
  coupon_code: String,
10
10
  description: String,
11
+ event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
11
12
  image_url: String,
12
13
  is_unlimited: bool,
13
14
  is_visible: bool,
@@ -51,6 +52,12 @@ module GrowsurfRuby
51
52
 
52
53
  def description=: (String) -> String
53
54
 
55
+ attr_reader event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event?
56
+
57
+ def event=: (
58
+ GrowsurfRuby::Models::Campaign::RewardCreateParams::event
59
+ ) -> GrowsurfRuby::Models::Campaign::RewardCreateParams::event
60
+
54
61
  attr_reader image_url: String?
55
62
 
56
63
  def image_url=: (String) -> String
@@ -127,6 +134,7 @@ module GrowsurfRuby
127
134
  ?conversions_required: Integer,
128
135
  ?coupon_code: String,
129
136
  ?description: String,
137
+ ?event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
130
138
  ?image_url: String,
131
139
  ?is_unlimited: bool,
132
140
  ?is_visible: bool,
@@ -152,6 +160,7 @@ module GrowsurfRuby
152
160
  conversions_required: Integer,
153
161
  coupon_code: String,
154
162
  description: String,
163
+ event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
155
164
  image_url: String,
156
165
  is_unlimited: bool,
157
166
  is_visible: bool,
@@ -186,6 +195,17 @@ module GrowsurfRuby
186
195
  def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::RewardCreateParams::type_]
187
196
  end
188
197
 
198
+ type event = :LEAD | :CONVERSION
199
+
200
+ module Event
201
+ extend GrowsurfRuby::Internal::Type::Enum
202
+
203
+ LEAD: :LEAD
204
+ CONVERSION: :CONVERSION
205
+
206
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::RewardCreateParams::event]
207
+ end
208
+
189
209
  type limit_duration = :IN_TOTAL | :PER_MONTH | :PER_YEAR
190
210
 
191
211
  module LimitDuration
@@ -9,6 +9,7 @@ module GrowsurfRuby
9
9
  conversions_required: Integer,
10
10
  coupon_code: String,
11
11
  description: String,
12
+ event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
12
13
  image_url: String,
13
14
  is_unlimited: bool,
14
15
  is_visible: bool,
@@ -54,6 +55,12 @@ module GrowsurfRuby
54
55
 
55
56
  def description=: (String) -> String
56
57
 
58
+ attr_reader event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event?
59
+
60
+ def event=: (
61
+ GrowsurfRuby::Models::Campaign::RewardUpdateParams::event
62
+ ) -> GrowsurfRuby::Models::Campaign::RewardUpdateParams::event
63
+
57
64
  attr_reader image_url: String?
58
65
 
59
66
  def image_url=: (String) -> String
@@ -131,6 +138,7 @@ module GrowsurfRuby
131
138
  ?conversions_required: Integer,
132
139
  ?coupon_code: String,
133
140
  ?description: String,
141
+ ?event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
134
142
  ?image_url: String,
135
143
  ?is_unlimited: bool,
136
144
  ?is_visible: bool,
@@ -157,6 +165,7 @@ module GrowsurfRuby
157
165
  conversions_required: Integer,
158
166
  coupon_code: String,
159
167
  description: String,
168
+ event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
160
169
  image_url: String,
161
170
  is_unlimited: bool,
162
171
  is_visible: bool,
@@ -176,6 +185,17 @@ module GrowsurfRuby
176
185
  request_options: GrowsurfRuby::RequestOptions
177
186
  }
178
187
 
188
+ type event = :LEAD | :CONVERSION
189
+
190
+ module Event
191
+ extend GrowsurfRuby::Internal::Type::Enum
192
+
193
+ LEAD: :LEAD
194
+ CONVERSION: :CONVERSION
195
+
196
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::RewardUpdateParams::event]
197
+ end
198
+
179
199
  type limit_duration = :IN_TOTAL | :PER_MONTH | :PER_YEAR
180
200
 
181
201
  module LimitDuration
@@ -78,6 +78,7 @@ module GrowsurfRuby
78
78
  conversions_required: Integer?,
79
79
  coupon_code: String?,
80
80
  description: String?,
81
+ event: GrowsurfRuby::Models::CampaignAPI::Reward::event?,
81
82
  image_url: String?,
82
83
  limit: Integer?,
83
84
  limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
@@ -109,6 +110,8 @@ module GrowsurfRuby
109
110
 
110
111
  attr_accessor description: String?
111
112
 
113
+ attr_accessor event: GrowsurfRuby::Models::CampaignAPI::Reward::event?
114
+
112
115
  attr_accessor image_url: String?
113
116
 
114
117
  attr_accessor limit: Integer?
@@ -144,6 +147,7 @@ module GrowsurfRuby
144
147
  ?conversions_required: Integer?,
145
148
  ?coupon_code: String?,
146
149
  ?description: String?,
150
+ ?event: GrowsurfRuby::Models::CampaignAPI::Reward::event?,
147
151
  ?image_url: String?,
148
152
  ?limit: Integer?,
149
153
  ?limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
@@ -167,6 +171,7 @@ module GrowsurfRuby
167
171
  conversions_required: Integer?,
168
172
  coupon_code: String?,
169
173
  description: String?,
174
+ event: GrowsurfRuby::Models::CampaignAPI::Reward::event?,
170
175
  image_url: String?,
171
176
  limit: Integer?,
172
177
  limit_duration: GrowsurfRuby::Models::CampaignAPI::Reward::limit_duration?,
@@ -196,6 +201,17 @@ module GrowsurfRuby
196
201
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::Reward::type_]
197
202
  end
198
203
 
204
+ type event = :LEAD | :CONVERSION
205
+
206
+ module Event
207
+ extend GrowsurfRuby::Internal::Type::Enum
208
+
209
+ LEAD: :LEAD
210
+ CONVERSION: :CONVERSION
211
+
212
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::Reward::event]
213
+ end
214
+
199
215
  type limit_duration = :IN_TOTAL | :PER_MONTH
200
216
 
201
217
  module LimitDuration
@@ -0,0 +1,40 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_create_affiliate_invite_params =
4
+ { id: String, email: String, first_name: String, last_name: String }
5
+ & GrowsurfRuby::Internal::Type::request_parameters
6
+
7
+ class CampaignCreateAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
8
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
9
+ include GrowsurfRuby::Internal::Type::RequestParameters
10
+
11
+ attr_accessor id: String
12
+
13
+ attr_accessor email: String
14
+
15
+ attr_reader first_name: String?
16
+
17
+ def first_name=: (String) -> String
18
+
19
+ attr_reader last_name: String?
20
+
21
+ def last_name=: (String) -> String
22
+
23
+ def initialize: (
24
+ id: String,
25
+ email: String,
26
+ ?first_name: String,
27
+ ?last_name: String,
28
+ ?request_options: GrowsurfRuby::request_opts
29
+ ) -> void
30
+
31
+ def to_hash: -> {
32
+ id: String,
33
+ email: String,
34
+ first_name: String,
35
+ last_name: String,
36
+ request_options: GrowsurfRuby::RequestOptions
37
+ }
38
+ end
39
+ end
40
+ end
@@ -0,0 +1,61 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_list_affiliate_applications_params =
4
+ {
5
+ id: String,
6
+ limit: Integer,
7
+ offset: Integer,
8
+ status: GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status
9
+ }
10
+ & GrowsurfRuby::Internal::Type::request_parameters
11
+
12
+ class CampaignListAffiliateApplicationsParams < 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_reader limit: Integer?
19
+
20
+ def limit=: (Integer) -> Integer
21
+
22
+ attr_reader offset: Integer?
23
+
24
+ def offset=: (Integer) -> Integer
25
+
26
+ attr_reader status: GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status?
27
+
28
+ def status=: (
29
+ GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status
30
+ ) -> GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status
31
+
32
+ def initialize: (
33
+ id: String,
34
+ ?limit: Integer,
35
+ ?offset: Integer,
36
+ ?status: GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status,
37
+ ?request_options: GrowsurfRuby::request_opts
38
+ ) -> void
39
+
40
+ def to_hash: -> {
41
+ id: String,
42
+ limit: Integer,
43
+ offset: Integer,
44
+ status: GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status,
45
+ request_options: GrowsurfRuby::RequestOptions
46
+ }
47
+
48
+ type status = :PENDING | :APPROVED | :DENIED
49
+
50
+ module Status
51
+ extend GrowsurfRuby::Internal::Type::Enum
52
+
53
+ PENDING: :PENDING
54
+ APPROVED: :APPROVED
55
+ DENIED: :DENIED
56
+
57
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignListAffiliateApplicationsParams::status]
58
+ end
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,62 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_list_affiliate_invites_params =
4
+ {
5
+ id: String,
6
+ limit: Integer,
7
+ offset: Integer,
8
+ status: GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status
9
+ }
10
+ & GrowsurfRuby::Internal::Type::request_parameters
11
+
12
+ class CampaignListAffiliateInvitesParams < 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_reader limit: Integer?
19
+
20
+ def limit=: (Integer) -> Integer
21
+
22
+ attr_reader offset: Integer?
23
+
24
+ def offset=: (Integer) -> Integer
25
+
26
+ attr_reader status: GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status?
27
+
28
+ def status=: (
29
+ GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status
30
+ ) -> GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status
31
+
32
+ def initialize: (
33
+ id: String,
34
+ ?limit: Integer,
35
+ ?offset: Integer,
36
+ ?status: GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status,
37
+ ?request_options: GrowsurfRuby::request_opts
38
+ ) -> void
39
+
40
+ def to_hash: -> {
41
+ id: String,
42
+ limit: Integer,
43
+ offset: Integer,
44
+ status: GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status,
45
+ request_options: GrowsurfRuby::RequestOptions
46
+ }
47
+
48
+ type status = :PENDING | :ACCEPTED | :EXPIRED | :REVOKED
49
+
50
+ module Status
51
+ extend GrowsurfRuby::Internal::Type::Enum
52
+
53
+ PENDING: :PENDING
54
+ ACCEPTED: :ACCEPTED
55
+ EXPIRED: :EXPIRED
56
+ REVOKED: :REVOKED
57
+
58
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignListAffiliateInvitesParams::status]
59
+ end
60
+ end
61
+ end
62
+ end
@@ -45,7 +45,7 @@ module GrowsurfRuby
45
45
  request_options: GrowsurfRuby::RequestOptions
46
46
  }
47
47
 
48
- type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
48
+ type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED | :REVERSED
49
49
 
50
50
  module Status
51
51
  extend GrowsurfRuby::Internal::Type::Enum
@@ -54,6 +54,7 @@ module GrowsurfRuby
54
54
  QUEUED: :QUEUED
55
55
  ISSUED: :ISSUED
56
56
  FAILED: :FAILED
57
+ REVERSED: :REVERSED
57
58
 
58
59
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignListPayoutsParams::status]
59
60
  end
@@ -0,0 +1,28 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_resend_affiliate_invite_params =
4
+ { id: String, invite_id: String }
5
+ & GrowsurfRuby::Internal::Type::request_parameters
6
+
7
+ class CampaignResendAffiliateInviteParams < GrowsurfRuby::Internal::Type::BaseModel
8
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
9
+ include GrowsurfRuby::Internal::Type::RequestParameters
10
+
11
+ attr_accessor id: String
12
+
13
+ attr_accessor invite_id: String
14
+
15
+ def initialize: (
16
+ id: String,
17
+ invite_id: String,
18
+ ?request_options: GrowsurfRuby::request_opts
19
+ ) -> void
20
+
21
+ def to_hash: -> {
22
+ id: String,
23
+ invite_id: String,
24
+ request_options: GrowsurfRuby::RequestOptions
25
+ }
26
+ end
27
+ end
28
+ end
@@ -0,0 +1,28 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_retrieve_affiliate_application_params =
4
+ { id: String, application_id: String }
5
+ & GrowsurfRuby::Internal::Type::request_parameters
6
+
7
+ class CampaignRetrieveAffiliateApplicationParams < GrowsurfRuby::Internal::Type::BaseModel
8
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
9
+ include GrowsurfRuby::Internal::Type::RequestParameters
10
+
11
+ attr_accessor id: String
12
+
13
+ attr_accessor application_id: String
14
+
15
+ def initialize: (
16
+ id: String,
17
+ application_id: String,
18
+ ?request_options: GrowsurfRuby::request_opts
19
+ ) -> void
20
+
21
+ def to_hash: -> {
22
+ id: String,
23
+ application_id: String,
24
+ request_options: GrowsurfRuby::RequestOptions
25
+ }
26
+ end
27
+ end
28
+ end
@@ -89,6 +89,7 @@ module GrowsurfRuby
89
89
  total_revenue: Integer,
90
90
  tumblr_shares: Integer,
91
91
  twitter_shares: Integer,
92
+ unique_commission_referrals: Integer,
92
93
  unique_impressions: Integer,
93
94
  wechat_shares: Integer,
94
95
  whats_app_shares: Integer
@@ -195,6 +196,10 @@ module GrowsurfRuby
195
196
 
196
197
  def twitter_shares=: (Integer) -> Integer
197
198
 
199
+ attr_reader unique_commission_referrals: Integer?
200
+
201
+ def unique_commission_referrals=: (Integer) -> Integer
202
+
198
203
  attr_reader unique_impressions: Integer?
199
204
 
200
205
  def unique_impressions=: (Integer) -> Integer
@@ -233,6 +238,7 @@ module GrowsurfRuby
233
238
  ?total_revenue: Integer,
234
239
  ?tumblr_shares: Integer,
235
240
  ?twitter_shares: Integer,
241
+ ?unique_commission_referrals: Integer,
236
242
  ?unique_impressions: Integer,
237
243
  ?wechat_shares: Integer,
238
244
  ?whats_app_shares: Integer
@@ -264,6 +270,7 @@ module GrowsurfRuby
264
270
  total_revenue: Integer,
265
271
  tumblr_shares: Integer,
266
272
  twitter_shares: Integer,
273
+ unique_commission_referrals: Integer,
267
274
  unique_impressions: Integer,
268
275
  wechat_shares: Integer,
269
276
  whats_app_shares: Integer
@@ -358,6 +365,7 @@ module GrowsurfRuby
358
365
  total_revenue: Integer,
359
366
  tumblr_shares: Integer,
360
367
  twitter_shares: Integer,
368
+ unique_commission_referrals: Integer,
361
369
  unique_impressions: Integer,
362
370
  wechat_shares: Integer,
363
371
  whats_app_shares: Integer
@@ -468,6 +476,10 @@ module GrowsurfRuby
468
476
 
469
477
  def twitter_shares=: (Integer) -> Integer
470
478
 
479
+ attr_reader unique_commission_referrals: Integer?
480
+
481
+ def unique_commission_referrals=: (Integer) -> Integer
482
+
471
483
  attr_reader unique_impressions: Integer?
472
484
 
473
485
  def unique_impressions=: (Integer) -> Integer
@@ -507,6 +519,7 @@ module GrowsurfRuby
507
519
  ?total_revenue: Integer,
508
520
  ?tumblr_shares: Integer,
509
521
  ?twitter_shares: Integer,
522
+ ?unique_commission_referrals: Integer,
510
523
  ?unique_impressions: Integer,
511
524
  ?wechat_shares: Integer,
512
525
  ?whats_app_shares: Integer
@@ -539,6 +552,7 @@ module GrowsurfRuby
539
552
  total_revenue: Integer,
540
553
  tumblr_shares: Integer,
541
554
  twitter_shares: Integer,
555
+ unique_commission_referrals: Integer,
542
556
  unique_impressions: Integer,
543
557
  wechat_shares: Integer,
544
558
  whats_app_shares: Integer
@@ -647,11 +661,7 @@ module GrowsurfRuby
647
661
  }
648
662
 
649
663
  type commission_status_metric =
650
- {
651
- count: Integer,
652
- total_amount: Integer,
653
- total_revenue: Integer
654
- }
664
+ { count: Integer, total_amount: Integer, total_revenue: Integer }
655
665
 
656
666
  class CommissionStatusMetric < GrowsurfRuby::Internal::Type::BaseModel
657
667
  attr_reader count: Integer?
@@ -685,6 +695,7 @@ module GrowsurfRuby
685
695
  failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
686
696
  issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
687
697
  queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
698
+ reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
688
699
  upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
689
700
  }
690
701
 
@@ -707,6 +718,12 @@ module GrowsurfRuby
707
718
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
708
719
  ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
709
720
 
721
+ attr_reader reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
722
+
723
+ def reversed=: (
724
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
725
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
726
+
710
727
  attr_reader upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
711
728
 
712
729
  def upcoming=: (
@@ -717,6 +734,7 @@ module GrowsurfRuby
717
734
  ?failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
718
735
  ?issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
719
736
  ?queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
737
+ ?reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
720
738
  ?upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
721
739
  ) -> void
722
740
 
@@ -724,6 +742,7 @@ module GrowsurfRuby
724
742
  failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
725
743
  issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
726
744
  queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
745
+ reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
727
746
  upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
728
747
  }
729
748
 
@@ -738,29 +757,30 @@ module GrowsurfRuby
738
757
 
739
758
  def total_amount=: (Integer) -> Integer
740
759
 
741
- def initialize: (
742
- ?count: Integer,
743
- ?total_amount: Integer
744
- ) -> void
760
+ def initialize: (?count: Integer, ?total_amount: Integer) -> void
745
761
 
746
762
  def to_hash: -> { count: Integer, total_amount: Integer }
747
763
  end
748
764
  end
749
765
 
750
- type reward_status = { approved: Integer, pending: Integer }
766
+ type reward_status = { completed: Integer, unapproved: Integer, unfulfilled: Integer }
751
767
 
752
768
  class RewardStatus < GrowsurfRuby::Internal::Type::BaseModel
753
- attr_reader approved: Integer?
769
+ attr_reader completed: Integer?
770
+
771
+ def completed=: (Integer) -> Integer
772
+
773
+ attr_reader unapproved: Integer?
754
774
 
755
- def approved=: (Integer) -> Integer
775
+ def unapproved=: (Integer) -> Integer
756
776
 
757
- attr_reader pending: Integer?
777
+ attr_reader unfulfilled: Integer?
758
778
 
759
- def pending=: (Integer) -> Integer
779
+ def unfulfilled=: (Integer) -> Integer
760
780
 
761
- def initialize: (?approved: Integer, ?pending: Integer) -> void
781
+ def initialize: (?completed: Integer, ?unapproved: Integer, ?unfulfilled: Integer) -> void
762
782
 
763
- def to_hash: -> { approved: Integer, pending: Integer }
783
+ def to_hash: -> { completed: Integer, unapproved: Integer, unfulfilled: Integer }
764
784
  end
765
785
  end
766
786
  end