growsurf-ruby 0.6.0 → 0.7.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 (30) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +12 -0
  3. data/README.md +1 -1
  4. data/lib/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rb +28 -0
  5. data/lib/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rb +24 -0
  6. data/lib/growsurf_ruby/models/campaign/participant_refund_transaction_params.rb +130 -0
  7. data/lib/growsurf_ruby/models/campaign/participant_refund_transaction_response.rb +81 -0
  8. data/lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb +19 -1
  9. data/lib/growsurf_ruby/models/participant_commission_list.rb +11 -11
  10. data/lib/growsurf_ruby/models/participant_payout_list.rb +7 -1
  11. data/lib/growsurf_ruby/resources/campaign/participant.rb +98 -3
  12. data/lib/growsurf_ruby/version.rb +1 -1
  13. data/lib/growsurf_ruby.rb +4 -0
  14. data/rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbi +48 -0
  15. data/rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbi +36 -0
  16. data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi +234 -0
  17. data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbi +131 -0
  18. data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi +24 -1
  19. data/rbi/growsurf_ruby/models/participant_commission_list.rbi +10 -10
  20. data/rbi/growsurf_ruby/models/participant_payout_list.rbi +12 -3
  21. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +94 -0
  22. data/sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbs +30 -0
  23. data/sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbs +20 -0
  24. data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbs +151 -0
  25. data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbs +75 -0
  26. data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs +7 -1
  27. data/sig/growsurf_ruby/models/participant_commission_list.rbs +12 -12
  28. data/sig/growsurf_ruby/models/participant_payout_list.rbs +10 -3
  29. data/sig/growsurf_ruby/resources/campaign/participant.rbs +28 -0
  30. metadata +14 -2
@@ -0,0 +1,151 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_refund_transaction_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
9
+ amount: Integer,
10
+ amount_refunded: Integer,
11
+ charge_id: String,
12
+ currency: String,
13
+ description: String,
14
+ external_id: String,
15
+ invoice_id: String,
16
+ order_id: String,
17
+ payment_id: String,
18
+ payment_intent_id: String,
19
+ refund_amount: Integer,
20
+ refund_id: String,
21
+ refund_status: String,
22
+ transaction_id: String
23
+ }
24
+ & GrowsurfRuby::Internal::Type::request_parameters
25
+
26
+ class ParticipantRefundTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
27
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
28
+ include GrowsurfRuby::Internal::Type::RequestParameters
29
+
30
+ attr_accessor id: String
31
+
32
+ attr_accessor participant_id_or_email: String
33
+
34
+ attr_reader amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type?
35
+
36
+ def amendment_type=: (
37
+ GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type
38
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type
39
+
40
+ attr_reader amount: Integer?
41
+
42
+ def amount=: (Integer) -> Integer
43
+
44
+ attr_reader amount_refunded: Integer?
45
+
46
+ def amount_refunded=: (Integer) -> Integer
47
+
48
+ attr_reader charge_id: String?
49
+
50
+ def charge_id=: (String) -> String
51
+
52
+ attr_reader currency: String?
53
+
54
+ def currency=: (String) -> String
55
+
56
+ attr_reader description: String?
57
+
58
+ def description=: (String) -> String
59
+
60
+ attr_reader external_id: String?
61
+
62
+ def external_id=: (String) -> String
63
+
64
+ attr_reader invoice_id: String?
65
+
66
+ def invoice_id=: (String) -> String
67
+
68
+ attr_reader order_id: String?
69
+
70
+ def order_id=: (String) -> String
71
+
72
+ attr_reader payment_id: String?
73
+
74
+ def payment_id=: (String) -> String
75
+
76
+ attr_reader payment_intent_id: String?
77
+
78
+ def payment_intent_id=: (String) -> String
79
+
80
+ attr_reader refund_amount: Integer?
81
+
82
+ def refund_amount=: (Integer) -> Integer
83
+
84
+ attr_reader refund_id: String?
85
+
86
+ def refund_id=: (String) -> String
87
+
88
+ attr_reader refund_status: String?
89
+
90
+ def refund_status=: (String) -> String
91
+
92
+ attr_reader transaction_id: String?
93
+
94
+ def transaction_id=: (String) -> String
95
+
96
+ def initialize: (
97
+ id: String,
98
+ participant_id_or_email: String,
99
+ ?amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
100
+ ?amount: Integer,
101
+ ?amount_refunded: Integer,
102
+ ?charge_id: String,
103
+ ?currency: String,
104
+ ?description: String,
105
+ ?external_id: String,
106
+ ?invoice_id: String,
107
+ ?order_id: String,
108
+ ?payment_id: String,
109
+ ?payment_intent_id: String,
110
+ ?refund_amount: Integer,
111
+ ?refund_id: String,
112
+ ?refund_status: String,
113
+ ?transaction_id: String,
114
+ ?request_options: GrowsurfRuby::request_opts
115
+ ) -> void
116
+
117
+ def to_hash: -> {
118
+ id: String,
119
+ participant_id_or_email: String,
120
+ amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
121
+ amount: Integer,
122
+ amount_refunded: Integer,
123
+ charge_id: String,
124
+ currency: String,
125
+ description: String,
126
+ external_id: String,
127
+ invoice_id: String,
128
+ order_id: String,
129
+ payment_id: String,
130
+ payment_intent_id: String,
131
+ refund_amount: Integer,
132
+ refund_id: String,
133
+ refund_status: String,
134
+ transaction_id: String,
135
+ request_options: GrowsurfRuby::RequestOptions
136
+ }
137
+
138
+ type amendment_type = :REFUND | :CHARGEBACK
139
+
140
+ module AmendmentType
141
+ extend GrowsurfRuby::Internal::Type::Enum
142
+
143
+ REFUND: :REFUND
144
+ CHARGEBACK: :CHARGEBACK
145
+
146
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type]
147
+ end
148
+ end
149
+ end
150
+ end
151
+ end
@@ -0,0 +1,75 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_refund_transaction_response =
5
+ {
6
+ adjusted: Integer,
7
+ amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
8
+ deleted: Integer,
9
+ matched: Integer,
10
+ matching_commission_ids: ::Array[String],
11
+ message: String,
12
+ reversed: Integer,
13
+ success: bool,
14
+ not_found: bool
15
+ }
16
+
17
+ class ParticipantRefundTransactionResponse < GrowsurfRuby::Internal::Type::BaseModel
18
+ attr_accessor adjusted: Integer
19
+
20
+ attr_accessor amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type
21
+
22
+ attr_accessor deleted: Integer
23
+
24
+ attr_accessor matched: Integer
25
+
26
+ attr_accessor matching_commission_ids: ::Array[String]
27
+
28
+ attr_accessor message: String
29
+
30
+ attr_accessor reversed: Integer
31
+
32
+ attr_accessor success: bool
33
+
34
+ attr_reader not_found: bool?
35
+
36
+ def not_found=: (bool) -> bool
37
+
38
+ def initialize: (
39
+ adjusted: Integer,
40
+ amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
41
+ deleted: Integer,
42
+ matched: Integer,
43
+ matching_commission_ids: ::Array[String],
44
+ message: String,
45
+ reversed: Integer,
46
+ success: bool,
47
+ ?not_found: bool
48
+ ) -> void
49
+
50
+ def to_hash: -> {
51
+ adjusted: Integer,
52
+ amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type,
53
+ deleted: Integer,
54
+ matched: Integer,
55
+ matching_commission_ids: ::Array[String],
56
+ message: String,
57
+ reversed: Integer,
58
+ success: bool,
59
+ not_found: bool
60
+ }
61
+
62
+ type amendment_type = :REFUND | :CHARGEBACK
63
+
64
+ module AmendmentType
65
+ extend GrowsurfRuby::Internal::Type::Enum
66
+
67
+ REFUND: :REFUND
68
+ CHARGEBACK: :CHARGEBACK
69
+
70
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse::amendment_type]
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -2,7 +2,7 @@ module GrowsurfRuby
2
2
  module Models
3
3
  module Campaign
4
4
  type participant_trigger_referral_params =
5
- { id: String, participant_id_or_email: String }
5
+ { id: String, participant_id_or_email: String, delay_in_days: Integer }
6
6
  & GrowsurfRuby::Internal::Type::request_parameters
7
7
 
8
8
  class ParticipantTriggerReferralParams < GrowsurfRuby::Internal::Type::BaseModel
@@ -13,15 +13,21 @@ module GrowsurfRuby
13
13
 
14
14
  attr_accessor participant_id_or_email: String
15
15
 
16
+ attr_reader delay_in_days: Integer?
17
+
18
+ def delay_in_days=: (Integer) -> Integer
19
+
16
20
  def initialize: (
17
21
  id: String,
18
22
  participant_id_or_email: String,
23
+ ?delay_in_days: Integer,
19
24
  ?request_options: GrowsurfRuby::request_opts
20
25
  ) -> void
21
26
 
22
27
  def to_hash: -> {
23
28
  id: String,
24
29
  participant_id_or_email: String,
30
+ delay_in_days: Integer,
25
31
  request_options: GrowsurfRuby::RequestOptions
26
32
  }
27
33
  end
@@ -29,12 +29,12 @@ module GrowsurfRuby
29
29
  type commission =
30
30
  {
31
31
  id: String,
32
- amount: Integer,
32
+ amount: Integer?,
33
33
  created_at: Integer,
34
34
  currency_iso: String,
35
35
  referred_id: String,
36
36
  referrer_id: String,
37
- sale_amount: Integer,
37
+ sale_amount: Integer?,
38
38
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
39
39
  amount_in_campaign_currency: Integer?,
40
40
  approved_at: Integer,
@@ -47,13 +47,13 @@ module GrowsurfRuby
47
47
  payout_queued_at: Integer,
48
48
  provider: String?,
49
49
  reversed_at: Integer,
50
- sale_amount_amount_in_campaign_currency: Integer?
50
+ sale_amount_in_campaign_currency: Integer?
51
51
  }
52
52
 
53
53
  class Commission < GrowsurfRuby::Internal::Type::BaseModel
54
54
  attr_accessor id: String
55
55
 
56
- attr_accessor amount: Integer
56
+ attr_accessor amount: Integer?
57
57
 
58
58
  attr_accessor created_at: Integer
59
59
 
@@ -63,7 +63,7 @@ module GrowsurfRuby
63
63
 
64
64
  attr_accessor referrer_id: String
65
65
 
66
- attr_accessor sale_amount: Integer
66
+ attr_accessor sale_amount: Integer?
67
67
 
68
68
  attr_accessor status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status
69
69
 
@@ -99,16 +99,16 @@ module GrowsurfRuby
99
99
 
100
100
  def reversed_at=: (Integer) -> Integer
101
101
 
102
- attr_accessor sale_amount_amount_in_campaign_currency: Integer?
102
+ attr_accessor sale_amount_in_campaign_currency: Integer?
103
103
 
104
104
  def initialize: (
105
105
  id: String,
106
- amount: Integer,
106
+ amount: Integer?,
107
107
  created_at: Integer,
108
108
  currency_iso: String,
109
109
  referred_id: String,
110
110
  referrer_id: String,
111
- sale_amount: Integer,
111
+ sale_amount: Integer?,
112
112
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
113
113
  ?amount_in_campaign_currency: Integer?,
114
114
  ?approved_at: Integer,
@@ -121,17 +121,17 @@ module GrowsurfRuby
121
121
  ?payout_queued_at: Integer,
122
122
  ?provider: String?,
123
123
  ?reversed_at: Integer,
124
- ?sale_amount_amount_in_campaign_currency: Integer?
124
+ ?sale_amount_in_campaign_currency: Integer?
125
125
  ) -> void
126
126
 
127
127
  def to_hash: -> {
128
128
  id: String,
129
- amount: Integer,
129
+ amount: Integer?,
130
130
  created_at: Integer,
131
131
  currency_iso: String,
132
132
  referred_id: String,
133
133
  referrer_id: String,
134
- sale_amount: Integer,
134
+ sale_amount: Integer?,
135
135
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
136
136
  amount_in_campaign_currency: Integer?,
137
137
  approved_at: Integer,
@@ -144,7 +144,7 @@ module GrowsurfRuby
144
144
  payout_queued_at: Integer,
145
145
  provider: String?,
146
146
  reversed_at: Integer,
147
- sale_amount_amount_in_campaign_currency: Integer?
147
+ sale_amount_in_campaign_currency: Integer?
148
148
  }
149
149
 
150
150
  type status = :PENDING | :APPROVED | :PAID | :REVERSED | :DELETED
@@ -42,7 +42,8 @@ module GrowsurfRuby
42
42
  failed_at: Integer,
43
43
  fx_error: String?,
44
44
  issued_at: Integer,
45
- provider: String?
45
+ provider: String?,
46
+ queued_at: Integer
46
47
  }
47
48
 
48
49
  class Payout < GrowsurfRuby::Internal::Type::BaseModel
@@ -82,6 +83,10 @@ module GrowsurfRuby
82
83
 
83
84
  attr_accessor provider: String?
84
85
 
86
+ attr_reader queued_at: Integer?
87
+
88
+ def queued_at=: (Integer) -> Integer
89
+
85
90
  def initialize: (
86
91
  id: String,
87
92
  amount: Integer,
@@ -97,7 +102,8 @@ module GrowsurfRuby
97
102
  ?failed_at: Integer,
98
103
  ?fx_error: String?,
99
104
  ?issued_at: Integer,
100
- ?provider: String?
105
+ ?provider: String?,
106
+ ?queued_at: Integer
101
107
  ) -> void
102
108
 
103
109
  def to_hash: -> {
@@ -115,7 +121,8 @@ module GrowsurfRuby
115
121
  failed_at: Integer,
116
122
  fx_error: String?,
117
123
  issued_at: Integer,
118
- provider: String?
124
+ provider: String?,
125
+ queued_at: Integer
119
126
  }
120
127
 
121
128
  type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
@@ -112,6 +112,27 @@ module GrowsurfRuby
112
112
  ?request_options: GrowsurfRuby::request_opts
113
113
  ) -> GrowsurfRuby::Models::Campaign::participant_record_transaction_response
114
114
 
115
+ def refund_transaction: (
116
+ String participant_id_or_email,
117
+ id: String,
118
+ ?amendment_type: GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionParams::amendment_type,
119
+ ?amount: Integer,
120
+ ?amount_refunded: Integer,
121
+ ?charge_id: String,
122
+ ?currency: String,
123
+ ?description: String,
124
+ ?external_id: String,
125
+ ?invoice_id: String,
126
+ ?order_id: String,
127
+ ?payment_id: String,
128
+ ?payment_intent_id: String,
129
+ ?refund_amount: Integer,
130
+ ?refund_id: String,
131
+ ?refund_status: String,
132
+ ?transaction_id: String,
133
+ ?request_options: GrowsurfRuby::request_opts
134
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantRefundTransactionResponse
135
+
115
136
  def send_invites: (
116
137
  String participant_id_or_email,
117
138
  id: String,
@@ -124,9 +145,16 @@ module GrowsurfRuby
124
145
  def trigger_referral: (
125
146
  String participant_id_or_email,
126
147
  id: String,
148
+ ?delay_in_days: Integer,
127
149
  ?request_options: GrowsurfRuby::request_opts
128
150
  ) -> GrowsurfRuby::Models::Campaign::ParticipantTriggerReferralResponse
129
151
 
152
+ def cancel_delayed_referral: (
153
+ String participant_id_or_email,
154
+ id: String,
155
+ ?request_options: GrowsurfRuby::request_opts
156
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantCancelDelayedReferralResponse
157
+
130
158
  def initialize: (client: GrowsurfRuby::Client) -> void
131
159
  end
132
160
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: growsurf-ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.0
4
+ version: 0.7.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Growsurf
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2026-06-23 00:00:00.000000000 Z
11
+ date: 2026-06-29 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi
@@ -78,6 +78,8 @@ files:
78
78
  - lib/growsurf_ruby/models/campaign/fraud_risk_level.rb
79
79
  - lib/growsurf_ruby/models/campaign/participant.rb
80
80
  - lib/growsurf_ruby/models/campaign/participant_add_params.rb
81
+ - lib/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rb
82
+ - lib/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rb
81
83
  - lib/growsurf_ruby/models/campaign/participant_delete_params.rb
82
84
  - lib/growsurf_ruby/models/campaign/participant_delete_response.rb
83
85
  - lib/growsurf_ruby/models/campaign/participant_list_commissions_params.rb
@@ -87,6 +89,8 @@ files:
87
89
  - lib/growsurf_ruby/models/campaign/participant_list_rewards_response.rb
88
90
  - lib/growsurf_ruby/models/campaign/participant_record_transaction_params.rb
89
91
  - lib/growsurf_ruby/models/campaign/participant_record_transaction_response.rb
92
+ - lib/growsurf_ruby/models/campaign/participant_refund_transaction_params.rb
93
+ - lib/growsurf_ruby/models/campaign/participant_refund_transaction_response.rb
90
94
  - lib/growsurf_ruby/models/campaign/participant_retrieve_params.rb
91
95
  - lib/growsurf_ruby/models/campaign/participant_reward.rb
92
96
  - lib/growsurf_ruby/models/campaign/participant_send_invites_params.rb
@@ -154,6 +158,8 @@ files:
154
158
  - rbi/growsurf_ruby/models/campaign/fraud_risk_level.rbi
155
159
  - rbi/growsurf_ruby/models/campaign/participant.rbi
156
160
  - rbi/growsurf_ruby/models/campaign/participant_add_params.rbi
161
+ - rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbi
162
+ - rbi/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbi
157
163
  - rbi/growsurf_ruby/models/campaign/participant_delete_params.rbi
158
164
  - rbi/growsurf_ruby/models/campaign/participant_delete_response.rbi
159
165
  - rbi/growsurf_ruby/models/campaign/participant_list_commissions_params.rbi
@@ -163,6 +169,8 @@ files:
163
169
  - rbi/growsurf_ruby/models/campaign/participant_list_rewards_response.rbi
164
170
  - rbi/growsurf_ruby/models/campaign/participant_record_transaction_params.rbi
165
171
  - rbi/growsurf_ruby/models/campaign/participant_record_transaction_response.rbi
172
+ - rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi
173
+ - rbi/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbi
166
174
  - rbi/growsurf_ruby/models/campaign/participant_retrieve_params.rbi
167
175
  - rbi/growsurf_ruby/models/campaign/participant_reward.rbi
168
176
  - rbi/growsurf_ruby/models/campaign/participant_send_invites_params.rbi
@@ -229,6 +237,8 @@ files:
229
237
  - sig/growsurf_ruby/models/campaign/fraud_risk_level.rbs
230
238
  - sig/growsurf_ruby/models/campaign/participant.rbs
231
239
  - sig/growsurf_ruby/models/campaign/participant_add_params.rbs
240
+ - sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params.rbs
241
+ - sig/growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response.rbs
232
242
  - sig/growsurf_ruby/models/campaign/participant_delete_params.rbs
233
243
  - sig/growsurf_ruby/models/campaign/participant_delete_response.rbs
234
244
  - sig/growsurf_ruby/models/campaign/participant_list_commissions_params.rbs
@@ -238,6 +248,8 @@ files:
238
248
  - sig/growsurf_ruby/models/campaign/participant_list_rewards_response.rbs
239
249
  - sig/growsurf_ruby/models/campaign/participant_record_transaction_params.rbs
240
250
  - sig/growsurf_ruby/models/campaign/participant_record_transaction_response.rbs
251
+ - sig/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbs
252
+ - sig/growsurf_ruby/models/campaign/participant_refund_transaction_response.rbs
241
253
  - sig/growsurf_ruby/models/campaign/participant_retrieve_params.rbs
242
254
  - sig/growsurf_ruby/models/campaign/participant_reward.rbs
243
255
  - sig/growsurf_ruby/models/campaign/participant_send_invites_params.rbs