growsurf-ruby 0.0.2

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 (224) hide show
  1. checksums.yaml +7 -0
  2. data/.ignore +2 -0
  3. data/CHANGELOG.md +11 -0
  4. data/README.md +234 -0
  5. data/SECURITY.md +23 -0
  6. data/lib/growsurf_ruby/client.rb +90 -0
  7. data/lib/growsurf_ruby/errors.rb +228 -0
  8. data/lib/growsurf_ruby/file_part.rb +58 -0
  9. data/lib/growsurf_ruby/internal/transport/base_client.rb +573 -0
  10. data/lib/growsurf_ruby/internal/transport/pooled_net_requester.rb +210 -0
  11. data/lib/growsurf_ruby/internal/type/array_of.rb +168 -0
  12. data/lib/growsurf_ruby/internal/type/base_model.rb +531 -0
  13. data/lib/growsurf_ruby/internal/type/base_page.rb +55 -0
  14. data/lib/growsurf_ruby/internal/type/boolean.rb +77 -0
  15. data/lib/growsurf_ruby/internal/type/converter.rb +327 -0
  16. data/lib/growsurf_ruby/internal/type/enum.rb +156 -0
  17. data/lib/growsurf_ruby/internal/type/file_input.rb +111 -0
  18. data/lib/growsurf_ruby/internal/type/hash_of.rb +188 -0
  19. data/lib/growsurf_ruby/internal/type/request_parameters.rb +42 -0
  20. data/lib/growsurf_ruby/internal/type/union.rb +254 -0
  21. data/lib/growsurf_ruby/internal/type/unknown.rb +81 -0
  22. data/lib/growsurf_ruby/internal/util.rb +966 -0
  23. data/lib/growsurf_ruby/internal.rb +20 -0
  24. data/lib/growsurf_ruby/models/campaign/commission_approve_params.rb +28 -0
  25. data/lib/growsurf_ruby/models/campaign/commission_approve_response.rb +18 -0
  26. data/lib/growsurf_ruby/models/campaign/commission_delete_params.rb +28 -0
  27. data/lib/growsurf_ruby/models/campaign/commission_delete_response.rb +18 -0
  28. data/lib/growsurf_ruby/models/campaign/fraud_risk_level.rb +18 -0
  29. data/lib/growsurf_ruby/models/campaign/participant.rb +495 -0
  30. data/lib/growsurf_ruby/models/campaign/participant_add_params.rb +93 -0
  31. data/lib/growsurf_ruby/models/campaign/participant_delete_params.rb +28 -0
  32. data/lib/growsurf_ruby/models/campaign/participant_delete_response.rb +18 -0
  33. data/lib/growsurf_ruby/models/campaign/participant_list_commissions_params.rb +68 -0
  34. data/lib/growsurf_ruby/models/campaign/participant_list_payouts_params.rb +67 -0
  35. data/lib/growsurf_ruby/models/campaign/participant_list_referrals_params.rb +117 -0
  36. data/lib/growsurf_ruby/models/campaign/participant_list_rewards_params.rb +46 -0
  37. data/lib/growsurf_ruby/models/campaign/participant_list_rewards_response.rb +30 -0
  38. data/lib/growsurf_ruby/models/campaign/participant_record_transaction_params.rb +170 -0
  39. data/lib/growsurf_ruby/models/campaign/participant_record_transaction_response.rb +91 -0
  40. data/lib/growsurf_ruby/models/campaign/participant_retrieve_params.rb +28 -0
  41. data/lib/growsurf_ruby/models/campaign/participant_reward.rb +103 -0
  42. data/lib/growsurf_ruby/models/campaign/participant_send_invites_params.rb +46 -0
  43. data/lib/growsurf_ruby/models/campaign/participant_send_invites_response.rb +30 -0
  44. data/lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb +28 -0
  45. data/lib/growsurf_ruby/models/campaign/participant_trigger_referral_response.rb +24 -0
  46. data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +100 -0
  47. data/lib/growsurf_ruby/models/campaign/referral_source.rb +17 -0
  48. data/lib/growsurf_ruby/models/campaign/referral_status.rb +19 -0
  49. data/lib/growsurf_ruby/models/campaign/reward_approve_params.rb +38 -0
  50. data/lib/growsurf_ruby/models/campaign/reward_approve_response.rb +18 -0
  51. data/lib/growsurf_ruby/models/campaign/reward_delete_params.rb +28 -0
  52. data/lib/growsurf_ruby/models/campaign/reward_delete_response.rb +18 -0
  53. data/lib/growsurf_ruby/models/campaign/reward_fulfill_params.rb +28 -0
  54. data/lib/growsurf_ruby/models/campaign/reward_fulfill_response.rb +18 -0
  55. data/lib/growsurf_ruby/models/campaign.rb +257 -0
  56. data/lib/growsurf_ruby/models/campaign_list_commissions_params.rb +59 -0
  57. data/lib/growsurf_ruby/models/campaign_list_leaderboard_params.rb +71 -0
  58. data/lib/growsurf_ruby/models/campaign_list_params.rb +14 -0
  59. data/lib/growsurf_ruby/models/campaign_list_participants_params.rb +37 -0
  60. data/lib/growsurf_ruby/models/campaign_list_payouts_params.rb +58 -0
  61. data/lib/growsurf_ruby/models/campaign_list_referrals_params.rb +108 -0
  62. data/lib/growsurf_ruby/models/campaign_list_response.rb +16 -0
  63. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +50 -0
  64. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +215 -0
  65. data/lib/growsurf_ruby/models/campaign_retrieve_params.rb +20 -0
  66. data/lib/growsurf_ruby/models/commission_structure.rb +137 -0
  67. data/lib/growsurf_ruby/models/participant_commission_list.rb +170 -0
  68. data/lib/growsurf_ruby/models/participant_list.rb +29 -0
  69. data/lib/growsurf_ruby/models/participant_payout_list.rb +136 -0
  70. data/lib/growsurf_ruby/models/referral_list.rb +96 -0
  71. data/lib/growsurf_ruby/models.rb +71 -0
  72. data/lib/growsurf_ruby/request_options.rb +77 -0
  73. data/lib/growsurf_ruby/resources/campaign/commission.rb +71 -0
  74. data/lib/growsurf_ruby/resources/campaign/participant.rb +446 -0
  75. data/lib/growsurf_ruby/resources/campaign/reward.rb +102 -0
  76. data/lib/growsurf_ruby/resources/campaign.rb +266 -0
  77. data/lib/growsurf_ruby/version.rb +5 -0
  78. data/lib/growsurf_ruby.rb +106 -0
  79. data/manifest.yaml +17 -0
  80. data/rbi/growsurf_ruby/client.rbi +51 -0
  81. data/rbi/growsurf_ruby/errors.rbi +205 -0
  82. data/rbi/growsurf_ruby/file_part.rbi +37 -0
  83. data/rbi/growsurf_ruby/internal/transport/base_client.rbi +305 -0
  84. data/rbi/growsurf_ruby/internal/transport/pooled_net_requester.rbi +84 -0
  85. data/rbi/growsurf_ruby/internal/type/array_of.rbi +104 -0
  86. data/rbi/growsurf_ruby/internal/type/base_model.rbi +314 -0
  87. data/rbi/growsurf_ruby/internal/type/base_page.rbi +43 -0
  88. data/rbi/growsurf_ruby/internal/type/boolean.rbi +58 -0
  89. data/rbi/growsurf_ruby/internal/type/converter.rbi +222 -0
  90. data/rbi/growsurf_ruby/internal/type/enum.rbi +82 -0
  91. data/rbi/growsurf_ruby/internal/type/file_input.rbi +59 -0
  92. data/rbi/growsurf_ruby/internal/type/hash_of.rbi +104 -0
  93. data/rbi/growsurf_ruby/internal/type/request_parameters.rbi +31 -0
  94. data/rbi/growsurf_ruby/internal/type/union.rbi +128 -0
  95. data/rbi/growsurf_ruby/internal/type/unknown.rbi +58 -0
  96. data/rbi/growsurf_ruby/internal/util.rbi +515 -0
  97. data/rbi/growsurf_ruby/internal.rbi +18 -0
  98. data/rbi/growsurf_ruby/models/campaign/commission_approve_params.rbi +48 -0
  99. data/rbi/growsurf_ruby/models/campaign/commission_approve_response.rbi +28 -0
  100. data/rbi/growsurf_ruby/models/campaign/commission_delete_params.rbi +48 -0
  101. data/rbi/growsurf_ruby/models/campaign/commission_delete_response.rbi +28 -0
  102. data/rbi/growsurf_ruby/models/campaign/fraud_risk_level.rbi +29 -0
  103. data/rbi/growsurf_ruby/models/campaign/participant.rbi +667 -0
  104. data/rbi/growsurf_ruby/models/campaign/participant_add_params.rbi +166 -0
  105. data/rbi/growsurf_ruby/models/campaign/participant_delete_params.rbi +48 -0
  106. data/rbi/growsurf_ruby/models/campaign/participant_delete_response.rbi +28 -0
  107. data/rbi/growsurf_ruby/models/campaign/participant_list_commissions_params.rbi +148 -0
  108. data/rbi/growsurf_ruby/models/campaign/participant_list_payouts_params.rbi +143 -0
  109. data/rbi/growsurf_ruby/models/campaign/participant_list_referrals_params.rbi +228 -0
  110. data/rbi/growsurf_ruby/models/campaign/participant_list_rewards_params.rbi +74 -0
  111. data/rbi/growsurf_ruby/models/campaign/participant_list_rewards_response.rbi +48 -0
  112. data/rbi/growsurf_ruby/models/campaign/participant_record_transaction_params.rbi +255 -0
  113. data/rbi/growsurf_ruby/models/campaign/participant_record_transaction_response.rbi +138 -0
  114. data/rbi/growsurf_ruby/models/campaign/participant_retrieve_params.rbi +48 -0
  115. data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi +185 -0
  116. data/rbi/growsurf_ruby/models/campaign/participant_send_invites_params.rbi +70 -0
  117. data/rbi/growsurf_ruby/models/campaign/participant_send_invites_response.rbi +44 -0
  118. data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi +48 -0
  119. data/rbi/growsurf_ruby/models/campaign/participant_trigger_referral_response.rbi +36 -0
  120. data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +178 -0
  121. data/rbi/growsurf_ruby/models/campaign/referral_source.rbi +31 -0
  122. data/rbi/growsurf_ruby/models/campaign/referral_status.rbi +44 -0
  123. data/rbi/growsurf_ruby/models/campaign/reward_approve_params.rbi +63 -0
  124. data/rbi/growsurf_ruby/models/campaign/reward_approve_response.rbi +28 -0
  125. data/rbi/growsurf_ruby/models/campaign/reward_delete_params.rbi +48 -0
  126. data/rbi/growsurf_ruby/models/campaign/reward_delete_response.rbi +28 -0
  127. data/rbi/growsurf_ruby/models/campaign/reward_fulfill_params.rbi +48 -0
  128. data/rbi/growsurf_ruby/models/campaign/reward_fulfill_response.rbi +28 -0
  129. data/rbi/growsurf_ruby/models/campaign.rbi +376 -0
  130. data/rbi/growsurf_ruby/models/campaign_list_commissions_params.rbi +135 -0
  131. data/rbi/growsurf_ruby/models/campaign_list_leaderboard_params.rbi +171 -0
  132. data/rbi/growsurf_ruby/models/campaign_list_params.rbi +32 -0
  133. data/rbi/growsurf_ruby/models/campaign_list_participants_params.rbi +66 -0
  134. data/rbi/growsurf_ruby/models/campaign_list_payouts_params.rbi +127 -0
  135. data/rbi/growsurf_ruby/models/campaign_list_referrals_params.rbi +213 -0
  136. data/rbi/growsurf_ruby/models/campaign_list_response.rbi +32 -0
  137. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +81 -0
  138. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +320 -0
  139. data/rbi/growsurf_ruby/models/campaign_retrieve_params.rbi +38 -0
  140. data/rbi/growsurf_ruby/models/commission_structure.rbi +174 -0
  141. data/rbi/growsurf_ruby/models/participant_commission_list.rbi +269 -0
  142. data/rbi/growsurf_ruby/models/participant_list.rbi +44 -0
  143. data/rbi/growsurf_ruby/models/participant_payout_list.rbi +219 -0
  144. data/rbi/growsurf_ruby/models/referral_list.rbi +129 -0
  145. data/rbi/growsurf_ruby/models.rbi +38 -0
  146. data/rbi/growsurf_ruby/request_options.rbi +59 -0
  147. data/rbi/growsurf_ruby/resources/campaign/commission.rbi +49 -0
  148. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +385 -0
  149. data/rbi/growsurf_ruby/resources/campaign/reward.rbi +70 -0
  150. data/rbi/growsurf_ruby/resources/campaign.rbi +205 -0
  151. data/rbi/growsurf_ruby/version.rbi +5 -0
  152. data/sig/growsurf_ruby/client.rbs +26 -0
  153. data/sig/growsurf_ruby/errors.rbs +117 -0
  154. data/sig/growsurf_ruby/file_part.rbs +21 -0
  155. data/sig/growsurf_ruby/internal/transport/base_client.rbs +133 -0
  156. data/sig/growsurf_ruby/internal/transport/pooled_net_requester.rbs +48 -0
  157. data/sig/growsurf_ruby/internal/type/array_of.rbs +48 -0
  158. data/sig/growsurf_ruby/internal/type/base_model.rbs +104 -0
  159. data/sig/growsurf_ruby/internal/type/base_page.rbs +24 -0
  160. data/sig/growsurf_ruby/internal/type/boolean.rbs +26 -0
  161. data/sig/growsurf_ruby/internal/type/converter.rbs +79 -0
  162. data/sig/growsurf_ruby/internal/type/enum.rbs +32 -0
  163. data/sig/growsurf_ruby/internal/type/file_input.rbs +25 -0
  164. data/sig/growsurf_ruby/internal/type/hash_of.rbs +48 -0
  165. data/sig/growsurf_ruby/internal/type/request_parameters.rbs +19 -0
  166. data/sig/growsurf_ruby/internal/type/union.rbs +52 -0
  167. data/sig/growsurf_ruby/internal/type/unknown.rbs +26 -0
  168. data/sig/growsurf_ruby/internal/util.rbs +199 -0
  169. data/sig/growsurf_ruby/internal.rbs +9 -0
  170. data/sig/growsurf_ruby/models/campaign/commission_approve_params.rbs +30 -0
  171. data/sig/growsurf_ruby/models/campaign/commission_approve_response.rbs +15 -0
  172. data/sig/growsurf_ruby/models/campaign/commission_delete_params.rbs +30 -0
  173. data/sig/growsurf_ruby/models/campaign/commission_delete_response.rbs +15 -0
  174. data/sig/growsurf_ruby/models/campaign/fraud_risk_level.rbs +17 -0
  175. data/sig/growsurf_ruby/models/campaign/participant.rbs +455 -0
  176. data/sig/growsurf_ruby/models/campaign/participant_add_params.rbs +95 -0
  177. data/sig/growsurf_ruby/models/campaign/participant_delete_params.rbs +30 -0
  178. data/sig/growsurf_ruby/models/campaign/participant_delete_response.rbs +15 -0
  179. data/sig/growsurf_ruby/models/campaign/participant_list_commissions_params.rbs +70 -0
  180. data/sig/growsurf_ruby/models/campaign/participant_list_payouts_params.rbs +69 -0
  181. data/sig/growsurf_ruby/models/campaign/participant_list_referrals_params.rbs +123 -0
  182. data/sig/growsurf_ruby/models/campaign/participant_list_rewards_params.rbs +47 -0
  183. data/sig/growsurf_ruby/models/campaign/participant_list_rewards_response.rbs +32 -0
  184. data/sig/growsurf_ruby/models/campaign/participant_record_transaction_params.rbs +194 -0
  185. data/sig/growsurf_ruby/models/campaign/participant_record_transaction_response.rbs +84 -0
  186. data/sig/growsurf_ruby/models/campaign/participant_retrieve_params.rbs +30 -0
  187. data/sig/growsurf_ruby/models/campaign/participant_reward.rbs +111 -0
  188. data/sig/growsurf_ruby/models/campaign/participant_send_invites_params.rbs +48 -0
  189. data/sig/growsurf_ruby/models/campaign/participant_send_invites_response.rbs +28 -0
  190. data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs +30 -0
  191. data/sig/growsurf_ruby/models/campaign/participant_trigger_referral_response.rbs +20 -0
  192. data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +104 -0
  193. data/sig/growsurf_ruby/models/campaign/referral_source.rbs +16 -0
  194. data/sig/growsurf_ruby/models/campaign/referral_status.rbs +19 -0
  195. data/sig/growsurf_ruby/models/campaign/reward_approve_params.rbs +36 -0
  196. data/sig/growsurf_ruby/models/campaign/reward_approve_response.rbs +15 -0
  197. data/sig/growsurf_ruby/models/campaign/reward_delete_params.rbs +30 -0
  198. data/sig/growsurf_ruby/models/campaign/reward_delete_response.rbs +15 -0
  199. data/sig/growsurf_ruby/models/campaign/reward_fulfill_params.rbs +30 -0
  200. data/sig/growsurf_ruby/models/campaign/reward_fulfill_response.rbs +15 -0
  201. data/sig/growsurf_ruby/models/campaign.rbs +221 -0
  202. data/sig/growsurf_ruby/models/campaign_list_commissions_params.rbs +63 -0
  203. data/sig/growsurf_ruby/models/campaign_list_leaderboard_params.rbs +83 -0
  204. data/sig/growsurf_ruby/models/campaign_list_params.rbs +15 -0
  205. data/sig/growsurf_ruby/models/campaign_list_participants_params.rbs +36 -0
  206. data/sig/growsurf_ruby/models/campaign_list_payouts_params.rbs +62 -0
  207. data/sig/growsurf_ruby/models/campaign_list_referrals_params.rbs +116 -0
  208. data/sig/growsurf_ruby/models/campaign_list_response.rbs +14 -0
  209. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_params.rbs +42 -0
  210. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +217 -0
  211. data/sig/growsurf_ruby/models/campaign_retrieve_params.rbs +23 -0
  212. data/sig/growsurf_ruby/models/commission_structure.rbs +121 -0
  213. data/sig/growsurf_ruby/models/participant_commission_list.rbs +166 -0
  214. data/sig/growsurf_ruby/models/participant_list.rbs +30 -0
  215. data/sig/growsurf_ruby/models/participant_payout_list.rbs +136 -0
  216. data/sig/growsurf_ruby/models/referral_list.rbs +92 -0
  217. data/sig/growsurf_ruby/models.rbs +31 -0
  218. data/sig/growsurf_ruby/request_options.rbs +36 -0
  219. data/sig/growsurf_ruby/resources/campaign/commission.rbs +21 -0
  220. data/sig/growsurf_ruby/resources/campaign/participant.rbs +133 -0
  221. data/sig/growsurf_ruby/resources/campaign/reward.rbs +28 -0
  222. data/sig/growsurf_ruby/resources/campaign.rbs +76 -0
  223. data/sig/growsurf_ruby/version.rbs +3 -0
  224. metadata +295 -0
@@ -0,0 +1,69 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_list_payouts_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ limit: Integer,
9
+ next_id: String,
10
+ status: GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status
11
+ }
12
+ & GrowsurfRuby::Internal::Type::request_parameters
13
+
14
+ class ParticipantListPayoutsParams < GrowsurfRuby::Internal::Type::BaseModel
15
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
16
+ include GrowsurfRuby::Internal::Type::RequestParameters
17
+
18
+ attr_accessor id: String
19
+
20
+ attr_accessor participant_id_or_email: String
21
+
22
+ attr_reader limit: Integer?
23
+
24
+ def limit=: (Integer) -> Integer
25
+
26
+ attr_reader next_id: String?
27
+
28
+ def next_id=: (String) -> String
29
+
30
+ attr_reader status: GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status?
31
+
32
+ def status=: (
33
+ GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status
34
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status
35
+
36
+ def initialize: (
37
+ id: String,
38
+ participant_id_or_email: String,
39
+ ?limit: Integer,
40
+ ?next_id: String,
41
+ ?status: GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status,
42
+ ?request_options: GrowsurfRuby::request_opts
43
+ ) -> void
44
+
45
+ def to_hash: -> {
46
+ id: String,
47
+ participant_id_or_email: String,
48
+ limit: Integer,
49
+ next_id: String,
50
+ status: GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status,
51
+ request_options: GrowsurfRuby::RequestOptions
52
+ }
53
+
54
+ type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED
55
+
56
+ module Status
57
+ extend GrowsurfRuby::Internal::Type::Enum
58
+
59
+ UPCOMING: :UPCOMING
60
+ QUEUED: :QUEUED
61
+ ISSUED: :ISSUED
62
+ FAILED: :FAILED
63
+
64
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantListPayoutsParams::status]
65
+ end
66
+ end
67
+ end
68
+ end
69
+ end
@@ -0,0 +1,123 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_list_referrals_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ desc: bool,
9
+ email: String,
10
+ first_name: String,
11
+ last_name: String,
12
+ limit: Integer,
13
+ next_id: String,
14
+ offset: Integer,
15
+ referral_status: GrowsurfRuby::Models::Campaign::referral_status,
16
+ sort_by: GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by
17
+ }
18
+ & GrowsurfRuby::Internal::Type::request_parameters
19
+
20
+ class ParticipantListReferralsParams < GrowsurfRuby::Internal::Type::BaseModel
21
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
22
+ include GrowsurfRuby::Internal::Type::RequestParameters
23
+
24
+ attr_accessor id: String
25
+
26
+ attr_accessor participant_id_or_email: String
27
+
28
+ attr_reader desc: bool?
29
+
30
+ def desc=: (bool) -> bool
31
+
32
+ attr_reader email: String?
33
+
34
+ def email=: (String) -> String
35
+
36
+ attr_reader first_name: String?
37
+
38
+ def first_name=: (String) -> String
39
+
40
+ attr_reader last_name: String?
41
+
42
+ def last_name=: (String) -> String
43
+
44
+ attr_reader limit: Integer?
45
+
46
+ def limit=: (Integer) -> Integer
47
+
48
+ attr_reader next_id: String?
49
+
50
+ def next_id=: (String) -> String
51
+
52
+ attr_reader offset: Integer?
53
+
54
+ def offset=: (Integer) -> Integer
55
+
56
+ attr_reader referral_status: GrowsurfRuby::Models::Campaign::referral_status?
57
+
58
+ def referral_status=: (
59
+ GrowsurfRuby::Models::Campaign::referral_status
60
+ ) -> GrowsurfRuby::Models::Campaign::referral_status
61
+
62
+ attr_reader sort_by: GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by?
63
+
64
+ def sort_by=: (
65
+ GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by
66
+ ) -> GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by
67
+
68
+ def initialize: (
69
+ id: String,
70
+ participant_id_or_email: String,
71
+ ?desc: bool,
72
+ ?email: String,
73
+ ?first_name: String,
74
+ ?last_name: String,
75
+ ?limit: Integer,
76
+ ?next_id: String,
77
+ ?offset: Integer,
78
+ ?referral_status: GrowsurfRuby::Models::Campaign::referral_status,
79
+ ?sort_by: GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by,
80
+ ?request_options: GrowsurfRuby::request_opts
81
+ ) -> void
82
+
83
+ def to_hash: -> {
84
+ id: String,
85
+ participant_id_or_email: String,
86
+ desc: bool,
87
+ email: String,
88
+ first_name: String,
89
+ last_name: String,
90
+ limit: Integer,
91
+ next_id: String,
92
+ offset: Integer,
93
+ referral_status: GrowsurfRuby::Models::Campaign::referral_status,
94
+ sort_by: GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by,
95
+ request_options: GrowsurfRuby::RequestOptions
96
+ }
97
+
98
+ type sort_by =
99
+ :updatedAt
100
+ | :createdAt
101
+ | :email
102
+ | :firstName
103
+ | :lastName
104
+ | :referralStatus
105
+ | :referralTriggeredAt
106
+
107
+ module SortBy
108
+ extend GrowsurfRuby::Internal::Type::Enum
109
+
110
+ UPDATED_AT: :updatedAt
111
+ CREATED_AT: :createdAt
112
+ EMAIL: :email
113
+ FIRST_NAME: :firstName
114
+ LAST_NAME: :lastName
115
+ REFERRAL_STATUS: :referralStatus
116
+ REFERRAL_TRIGGERED_AT: :referralTriggeredAt
117
+
118
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantListReferralsParams::sort_by]
119
+ end
120
+ end
121
+ end
122
+ end
123
+ end
@@ -0,0 +1,47 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_list_rewards_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ limit: Integer,
9
+ next_id: String
10
+ }
11
+ & GrowsurfRuby::Internal::Type::request_parameters
12
+
13
+ class ParticipantListRewardsParams < GrowsurfRuby::Internal::Type::BaseModel
14
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
15
+ include GrowsurfRuby::Internal::Type::RequestParameters
16
+
17
+ attr_accessor id: String
18
+
19
+ attr_accessor participant_id_or_email: String
20
+
21
+ attr_reader limit: Integer?
22
+
23
+ def limit=: (Integer) -> Integer
24
+
25
+ attr_reader next_id: String?
26
+
27
+ def next_id=: (String) -> String
28
+
29
+ def initialize: (
30
+ id: String,
31
+ participant_id_or_email: String,
32
+ ?limit: Integer,
33
+ ?next_id: String,
34
+ ?request_options: GrowsurfRuby::request_opts
35
+ ) -> void
36
+
37
+ def to_hash: -> {
38
+ id: String,
39
+ participant_id_or_email: String,
40
+ limit: Integer,
41
+ next_id: String,
42
+ request_options: GrowsurfRuby::RequestOptions
43
+ }
44
+ end
45
+ end
46
+ end
47
+ end
@@ -0,0 +1,32 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_list_rewards_response =
5
+ {
6
+ limit: Integer,
7
+ next_id: String?,
8
+ rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
9
+ }
10
+
11
+ class ParticipantListRewardsResponse < GrowsurfRuby::Internal::Type::BaseModel
12
+ attr_accessor limit: Integer
13
+
14
+ attr_accessor next_id: String?
15
+
16
+ attr_accessor rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
17
+
18
+ def initialize: (
19
+ limit: Integer,
20
+ next_id: String?,
21
+ rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
22
+ ) -> void
23
+
24
+ def to_hash: -> {
25
+ limit: Integer,
26
+ next_id: String?,
27
+ rewards: ::Array[GrowsurfRuby::Campaign::ParticipantReward]
28
+ }
29
+ end
30
+ end
31
+ end
32
+ end
@@ -0,0 +1,194 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_record_transaction_params =
5
+ {
6
+ id: String,
7
+ participant_id_or_email: String,
8
+ currency: String,
9
+ gross_amount: Integer,
10
+ amount_cash_net: Integer,
11
+ amount_paid: Integer,
12
+ charge_id: String,
13
+ customer_id: String,
14
+ description: String,
15
+ external_id: String,
16
+ invoice_id: String,
17
+ invoice_subtotal_excluding_tax: Integer,
18
+ invoice_total: Integer,
19
+ invoice_total_excluding_tax: Integer,
20
+ net_amount: Integer,
21
+ order_id: String,
22
+ paid_at: Integer,
23
+ payment_id: String,
24
+ payment_intent_id: String,
25
+ subscription_id: String,
26
+ tax_amount: Integer,
27
+ total_tax_amount: Integer,
28
+ total_tax_amounts: ::Array[::Hash[Symbol, top]],
29
+ total_taxes: ::Array[::Hash[Symbol, top]],
30
+ transaction_id: String
31
+ }
32
+ & GrowsurfRuby::Internal::Type::request_parameters
33
+
34
+ class ParticipantRecordTransactionParams < GrowsurfRuby::Internal::Type::BaseModel
35
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
36
+ include GrowsurfRuby::Internal::Type::RequestParameters
37
+
38
+ attr_accessor id: String
39
+
40
+ attr_accessor participant_id_or_email: String
41
+
42
+ attr_accessor currency: String
43
+
44
+ attr_accessor gross_amount: Integer
45
+
46
+ attr_reader amount_cash_net: Integer?
47
+
48
+ def amount_cash_net=: (Integer) -> Integer
49
+
50
+ attr_reader amount_paid: Integer?
51
+
52
+ def amount_paid=: (Integer) -> Integer
53
+
54
+ attr_reader charge_id: String?
55
+
56
+ def charge_id=: (String) -> String
57
+
58
+ attr_reader customer_id: String?
59
+
60
+ def customer_id=: (String) -> String
61
+
62
+ attr_reader description: String?
63
+
64
+ def description=: (String) -> String
65
+
66
+ attr_reader external_id: String?
67
+
68
+ def external_id=: (String) -> String
69
+
70
+ attr_reader invoice_id: String?
71
+
72
+ def invoice_id=: (String) -> String
73
+
74
+ attr_reader invoice_subtotal_excluding_tax: Integer?
75
+
76
+ def invoice_subtotal_excluding_tax=: (Integer) -> Integer
77
+
78
+ attr_reader invoice_total: Integer?
79
+
80
+ def invoice_total=: (Integer) -> Integer
81
+
82
+ attr_reader invoice_total_excluding_tax: Integer?
83
+
84
+ def invoice_total_excluding_tax=: (Integer) -> Integer
85
+
86
+ attr_reader net_amount: Integer?
87
+
88
+ def net_amount=: (Integer) -> Integer
89
+
90
+ attr_reader order_id: String?
91
+
92
+ def order_id=: (String) -> String
93
+
94
+ attr_reader paid_at: Integer?
95
+
96
+ def paid_at=: (Integer) -> Integer
97
+
98
+ attr_reader payment_id: String?
99
+
100
+ def payment_id=: (String) -> String
101
+
102
+ attr_reader payment_intent_id: String?
103
+
104
+ def payment_intent_id=: (String) -> String
105
+
106
+ attr_reader subscription_id: String?
107
+
108
+ def subscription_id=: (String) -> String
109
+
110
+ attr_reader tax_amount: Integer?
111
+
112
+ def tax_amount=: (Integer) -> Integer
113
+
114
+ attr_reader total_tax_amount: Integer?
115
+
116
+ def total_tax_amount=: (Integer) -> Integer
117
+
118
+ attr_reader total_tax_amounts: ::Array[::Hash[Symbol, top]]?
119
+
120
+ def total_tax_amounts=: (
121
+ ::Array[::Hash[Symbol, top]]
122
+ ) -> ::Array[::Hash[Symbol, top]]
123
+
124
+ attr_reader total_taxes: ::Array[::Hash[Symbol, top]]?
125
+
126
+ def total_taxes=: (
127
+ ::Array[::Hash[Symbol, top]]
128
+ ) -> ::Array[::Hash[Symbol, top]]
129
+
130
+ attr_reader transaction_id: String?
131
+
132
+ def transaction_id=: (String) -> String
133
+
134
+ def initialize: (
135
+ id: String,
136
+ participant_id_or_email: String,
137
+ currency: String,
138
+ gross_amount: Integer,
139
+ ?amount_cash_net: Integer,
140
+ ?amount_paid: Integer,
141
+ ?charge_id: String,
142
+ ?customer_id: String,
143
+ ?description: String,
144
+ ?external_id: String,
145
+ ?invoice_id: String,
146
+ ?invoice_subtotal_excluding_tax: Integer,
147
+ ?invoice_total: Integer,
148
+ ?invoice_total_excluding_tax: Integer,
149
+ ?net_amount: Integer,
150
+ ?order_id: String,
151
+ ?paid_at: Integer,
152
+ ?payment_id: String,
153
+ ?payment_intent_id: String,
154
+ ?subscription_id: String,
155
+ ?tax_amount: Integer,
156
+ ?total_tax_amount: Integer,
157
+ ?total_tax_amounts: ::Array[::Hash[Symbol, top]],
158
+ ?total_taxes: ::Array[::Hash[Symbol, top]],
159
+ ?transaction_id: String,
160
+ ?request_options: GrowsurfRuby::request_opts
161
+ ) -> void
162
+
163
+ def to_hash: -> {
164
+ id: String,
165
+ participant_id_or_email: String,
166
+ currency: String,
167
+ gross_amount: Integer,
168
+ amount_cash_net: Integer,
169
+ amount_paid: Integer,
170
+ charge_id: String,
171
+ customer_id: String,
172
+ description: String,
173
+ external_id: String,
174
+ invoice_id: String,
175
+ invoice_subtotal_excluding_tax: Integer,
176
+ invoice_total: Integer,
177
+ invoice_total_excluding_tax: Integer,
178
+ net_amount: Integer,
179
+ order_id: String,
180
+ paid_at: Integer,
181
+ payment_id: String,
182
+ payment_intent_id: String,
183
+ subscription_id: String,
184
+ tax_amount: Integer,
185
+ total_tax_amount: Integer,
186
+ total_tax_amounts: ::Array[::Hash[Symbol, top]],
187
+ total_taxes: ::Array[::Hash[Symbol, top]],
188
+ transaction_id: String,
189
+ request_options: GrowsurfRuby::RequestOptions
190
+ }
191
+ end
192
+ end
193
+ end
194
+ end
@@ -0,0 +1,84 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_record_transaction_response =
5
+ GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember0
6
+ | GrowsurfRuby::Models::Campaign::ParticipantRecordTransactionResponse::UnionMember1
7
+
8
+ module ParticipantRecordTransactionResponse
9
+ extend GrowsurfRuby::Internal::Type::Union
10
+
11
+ type union_member0 =
12
+ { duplicate: false, first_sale: bool, message: String, success: true }
13
+
14
+ class UnionMember0 < GrowsurfRuby::Internal::Type::BaseModel
15
+ attr_accessor duplicate: false
16
+
17
+ attr_accessor first_sale: bool
18
+
19
+ attr_accessor message: String
20
+
21
+ attr_accessor success: true
22
+
23
+ def initialize: (
24
+ first_sale: bool,
25
+ message: String,
26
+ ?duplicate: false,
27
+ ?success: true
28
+ ) -> void
29
+
30
+ def to_hash: -> {
31
+ duplicate: false,
32
+ first_sale: bool,
33
+ message: String,
34
+ success: true
35
+ }
36
+ end
37
+
38
+ type union_member1 =
39
+ {
40
+ commissions_created: Integer,
41
+ duplicate: true,
42
+ duplicate_fields: ::Array[String],
43
+ matching_commission_ids: ::Array[String],
44
+ message: String,
45
+ success: false
46
+ }
47
+
48
+ class UnionMember1 < GrowsurfRuby::Internal::Type::BaseModel
49
+ attr_accessor commissions_created: Integer
50
+
51
+ attr_accessor duplicate: true
52
+
53
+ attr_accessor duplicate_fields: ::Array[String]
54
+
55
+ attr_accessor matching_commission_ids: ::Array[String]
56
+
57
+ attr_accessor message: String
58
+
59
+ attr_accessor success: false
60
+
61
+ def initialize: (
62
+ commissions_created: Integer,
63
+ duplicate_fields: ::Array[String],
64
+ matching_commission_ids: ::Array[String],
65
+ message: String,
66
+ ?duplicate: true,
67
+ ?success: false
68
+ ) -> void
69
+
70
+ def to_hash: -> {
71
+ commissions_created: Integer,
72
+ duplicate: true,
73
+ duplicate_fields: ::Array[String],
74
+ matching_commission_ids: ::Array[String],
75
+ message: String,
76
+ success: false
77
+ }
78
+ end
79
+
80
+ def self?.variants: -> ::Array[GrowsurfRuby::Models::Campaign::participant_record_transaction_response]
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,30 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_retrieve_params =
5
+ { id: String, participant_id_or_email: String }
6
+ & GrowsurfRuby::Internal::Type::request_parameters
7
+
8
+ class ParticipantRetrieveParams < 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,111 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type participant_reward =
5
+ {
6
+ id: String,
7
+ reward_id: String,
8
+ status: GrowsurfRuby::Models::Campaign::ParticipantReward::status,
9
+ approved: bool,
10
+ approved_at: Integer,
11
+ commission_structure: GrowsurfRuby::CommissionStructure?,
12
+ fulfilled_at: Integer,
13
+ is_available: bool,
14
+ is_fulfilled: bool,
15
+ is_referrer: bool,
16
+ referred_id: String,
17
+ referrer_id: String,
18
+ unread: bool
19
+ }
20
+
21
+ class ParticipantReward < GrowsurfRuby::Internal::Type::BaseModel
22
+ attr_accessor id: String
23
+
24
+ attr_accessor reward_id: String
25
+
26
+ attr_accessor status: GrowsurfRuby::Models::Campaign::ParticipantReward::status
27
+
28
+ attr_reader approved: bool?
29
+
30
+ def approved=: (bool) -> bool
31
+
32
+ attr_reader approved_at: Integer?
33
+
34
+ def approved_at=: (Integer) -> Integer
35
+
36
+ attr_accessor commission_structure: GrowsurfRuby::CommissionStructure?
37
+
38
+ attr_reader fulfilled_at: Integer?
39
+
40
+ def fulfilled_at=: (Integer) -> Integer
41
+
42
+ attr_reader is_available: bool?
43
+
44
+ def is_available=: (bool) -> bool
45
+
46
+ attr_reader is_fulfilled: bool?
47
+
48
+ def is_fulfilled=: (bool) -> bool
49
+
50
+ attr_reader is_referrer: bool?
51
+
52
+ def is_referrer=: (bool) -> bool
53
+
54
+ attr_reader referred_id: String?
55
+
56
+ def referred_id=: (String) -> String
57
+
58
+ attr_reader referrer_id: String?
59
+
60
+ def referrer_id=: (String) -> String
61
+
62
+ attr_reader unread: bool?
63
+
64
+ def unread=: (bool) -> bool
65
+
66
+ def initialize: (
67
+ id: String,
68
+ reward_id: String,
69
+ status: GrowsurfRuby::Models::Campaign::ParticipantReward::status,
70
+ ?approved: bool,
71
+ ?approved_at: Integer,
72
+ ?commission_structure: GrowsurfRuby::CommissionStructure?,
73
+ ?fulfilled_at: Integer,
74
+ ?is_available: bool,
75
+ ?is_fulfilled: bool,
76
+ ?is_referrer: bool,
77
+ ?referred_id: String,
78
+ ?referrer_id: String,
79
+ ?unread: bool
80
+ ) -> void
81
+
82
+ def to_hash: -> {
83
+ id: String,
84
+ reward_id: String,
85
+ status: GrowsurfRuby::Models::Campaign::ParticipantReward::status,
86
+ approved: bool,
87
+ approved_at: Integer,
88
+ commission_structure: GrowsurfRuby::CommissionStructure?,
89
+ fulfilled_at: Integer,
90
+ is_available: bool,
91
+ is_fulfilled: bool,
92
+ is_referrer: bool,
93
+ referred_id: String,
94
+ referrer_id: String,
95
+ unread: bool
96
+ }
97
+
98
+ type status = :PENDING | :FULFILLED
99
+
100
+ module Status
101
+ extend GrowsurfRuby::Internal::Type::Enum
102
+
103
+ PENDING: :PENDING
104
+ FULFILLED: :FULFILLED
105
+
106
+ def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantReward::status]
107
+ end
108
+ end
109
+ end
110
+ end
111
+ end