growsurf-ruby 1.0.0 → 1.1.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 (137) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +1 -1
  4. data/lib/growsurf_ruby/client.rb +4 -0
  5. data/lib/growsurf_ruby/models/account.rb +90 -0
  6. data/lib/growsurf_ruby/models/account_create_params.rb +46 -0
  7. data/lib/growsurf_ruby/models/account_create_response.rb +64 -0
  8. data/lib/growsurf_ruby/models/account_resend_verification_email_response.rb +33 -0
  9. data/lib/growsurf_ruby/models/account_rotate_api_key_response.rb +17 -0
  10. data/lib/growsurf_ruby/models/account_update_params.rb +35 -0
  11. data/lib/growsurf_ruby/models/campaign/campaign_reward_list_response.rb +2 -2
  12. data/lib/growsurf_ruby/models/campaign/create.rb +5 -1
  13. data/lib/growsurf_ruby/models/campaign/participant_activity_logs_response.rb +65 -0
  14. data/lib/growsurf_ruby/models/campaign/participant_analytics_response.rb +421 -0
  15. data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb +35 -0
  16. data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_response.rb +151 -0
  17. data/lib/growsurf_ruby/models/campaign/participant_email_params.rb +76 -0
  18. data/lib/growsurf_ruby/models/campaign/participant_email_response.rb +38 -0
  19. data/lib/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rb +46 -0
  20. data/lib/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rb +98 -0
  21. data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +21 -1
  22. data/lib/growsurf_ruby/models/campaign/reward.rb +17 -6
  23. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +25 -15
  24. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +25 -15
  25. data/lib/growsurf_ruby/models/campaign/webhook.rb +72 -0
  26. data/lib/growsurf_ruby/models/campaign/webhook_create_params.rb +52 -0
  27. data/lib/growsurf_ruby/models/campaign/webhook_delete_params.rb +28 -0
  28. data/lib/growsurf_ruby/models/campaign/webhook_delete_response.rb +24 -0
  29. data/lib/growsurf_ruby/models/campaign/webhook_event.rb +23 -0
  30. data/lib/growsurf_ruby/models/campaign/webhook_list_response.rb +18 -0
  31. data/lib/growsurf_ruby/models/campaign/webhook_test_params.rb +42 -0
  32. data/lib/growsurf_ruby/models/campaign/webhook_test_response.rb +50 -0
  33. data/lib/growsurf_ruby/models/campaign/webhook_update_params.rb +59 -0
  34. data/lib/growsurf_ruby/models/campaign.rb +17 -6
  35. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +36 -1
  36. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +538 -1
  37. data/lib/growsurf_ruby/models/campaign_update_params.rb +0 -3
  38. data/lib/growsurf_ruby/models/commission_structure.rb +8 -2
  39. data/lib/growsurf_ruby/models/referral_flow_screenshots_response.rb +72 -0
  40. data/lib/growsurf_ruby/models.rb +8 -0
  41. data/lib/growsurf_ruby/resources/account.rb +159 -0
  42. data/lib/growsurf_ruby/resources/campaign/design.rb +9 -7
  43. data/lib/growsurf_ruby/resources/campaign/emails.rb +8 -5
  44. data/lib/growsurf_ruby/resources/campaign/installation.rb +8 -6
  45. data/lib/growsurf_ruby/resources/campaign/options.rb +8 -5
  46. data/lib/growsurf_ruby/resources/campaign/participant.rb +170 -2
  47. data/lib/growsurf_ruby/resources/campaign/rewards.rb +17 -21
  48. data/lib/growsurf_ruby/resources/campaign/webhooks.rb +157 -0
  49. data/lib/growsurf_ruby/resources/campaign.rb +30 -2
  50. data/lib/growsurf_ruby/version.rb +1 -1
  51. data/lib/growsurf_ruby.rb +26 -0
  52. data/rbi/growsurf_ruby/client.rbi +3 -0
  53. data/rbi/growsurf_ruby/models/account.rbi +125 -0
  54. data/rbi/growsurf_ruby/models/account_create_params.rbi +73 -0
  55. data/rbi/growsurf_ruby/models/account_create_response.rbi +115 -0
  56. data/rbi/growsurf_ruby/models/account_resend_verification_email_response.rbi +76 -0
  57. data/rbi/growsurf_ruby/models/account_rotate_api_key_response.rbi +30 -0
  58. data/rbi/growsurf_ruby/models/account_update_params.rbi +65 -0
  59. data/rbi/growsurf_ruby/models/campaign/campaign_reward_list_response.rbi +2 -2
  60. data/rbi/growsurf_ruby/models/campaign/create.rbi +8 -0
  61. data/rbi/growsurf_ruby/models/campaign/participant_activity_logs_response.rbi +111 -0
  62. data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi +630 -0
  63. data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbi +56 -0
  64. data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +285 -0
  65. data/rbi/growsurf_ruby/models/campaign/participant_email_params.rbi +118 -0
  66. data/rbi/growsurf_ruby/models/campaign/participant_email_response.rbi +84 -0
  67. data/rbi/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rbi +74 -0
  68. data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi +207 -0
  69. data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +24 -0
  70. data/rbi/growsurf_ruby/models/campaign/reward.rbi +25 -4
  71. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +34 -9
  72. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +34 -9
  73. data/rbi/growsurf_ruby/models/campaign/webhook.rbi +93 -0
  74. data/rbi/growsurf_ruby/models/campaign/webhook_create_params.rbi +91 -0
  75. data/rbi/growsurf_ruby/models/campaign/webhook_delete_params.rbi +48 -0
  76. data/rbi/growsurf_ruby/models/campaign/webhook_delete_response.rbi +33 -0
  77. data/rbi/growsurf_ruby/models/campaign/webhook_event.rbi +60 -0
  78. data/rbi/growsurf_ruby/models/campaign/webhook_list_response.rbi +36 -0
  79. data/rbi/growsurf_ruby/models/campaign/webhook_test_params.rbi +69 -0
  80. data/rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi +102 -0
  81. data/rbi/growsurf_ruby/models/campaign/webhook_update_params.rbi +98 -0
  82. data/rbi/growsurf_ruby/models/campaign.rbi +25 -4
  83. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +91 -0
  84. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +1011 -3
  85. data/rbi/growsurf_ruby/models/campaign_update_params.rbi +0 -15
  86. data/rbi/growsurf_ruby/models/commission_structure.rbi +8 -2
  87. data/rbi/growsurf_ruby/models/referral_flow_screenshots_response.rbi +94 -0
  88. data/rbi/growsurf_ruby/models.rbi +9 -0
  89. data/rbi/growsurf_ruby/resources/account.rbi +112 -0
  90. data/rbi/growsurf_ruby/resources/campaign/design.rbi +7 -5
  91. data/rbi/growsurf_ruby/resources/campaign/emails.rbi +7 -5
  92. data/rbi/growsurf_ruby/resources/campaign/installation.rbi +7 -4
  93. data/rbi/growsurf_ruby/resources/campaign/options.rbi +7 -5
  94. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +160 -0
  95. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +37 -21
  96. data/rbi/growsurf_ruby/resources/campaign/webhooks.rbi +123 -0
  97. data/rbi/growsurf_ruby/resources/campaign.rbi +33 -2
  98. data/sig/growsurf_ruby/client.rbs +2 -0
  99. data/sig/growsurf_ruby/models/account.rbs +67 -0
  100. data/sig/growsurf_ruby/models/account_create_params.rbs +42 -0
  101. data/sig/growsurf_ruby/models/account_create_response.rbs +47 -0
  102. data/sig/growsurf_ruby/models/account_resend_verification_email_response.rbs +35 -0
  103. data/sig/growsurf_ruby/models/account_rotate_api_key_response.rbs +13 -0
  104. data/sig/growsurf_ruby/models/account_update_params.rbs +42 -0
  105. data/sig/growsurf_ruby/models/campaign/participant_activity_logs_response.rbs +59 -0
  106. data/sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs +407 -0
  107. data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbs +30 -0
  108. data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbs +125 -0
  109. data/sig/growsurf_ruby/models/campaign/participant_email_params.rbs +61 -0
  110. data/sig/growsurf_ruby/models/campaign/participant_email_response.rbs +37 -0
  111. data/sig/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rbs +47 -0
  112. data/sig/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbs +90 -0
  113. data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +14 -0
  114. data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +0 -7
  115. data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +0 -7
  116. data/sig/growsurf_ruby/models/campaign/webhook.rbs +52 -0
  117. data/sig/growsurf_ruby/models/campaign/webhook_create_params.rbs +51 -0
  118. data/sig/growsurf_ruby/models/campaign/webhook_delete_params.rbs +30 -0
  119. data/sig/growsurf_ruby/models/campaign/webhook_delete_response.rbs +17 -0
  120. data/sig/growsurf_ruby/models/campaign/webhook_event.rbs +28 -0
  121. data/sig/growsurf_ruby/models/campaign/webhook_list_response.rbs +18 -0
  122. data/sig/growsurf_ruby/models/campaign/webhook_test_params.rbs +42 -0
  123. data/sig/growsurf_ruby/models/campaign/webhook_test_response.rbs +54 -0
  124. data/sig/growsurf_ruby/models/campaign/webhook_update_params.rbs +63 -0
  125. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_params.rbs +35 -1
  126. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +533 -3
  127. data/sig/growsurf_ruby/models/campaign_update_params.rbs +1 -4
  128. data/sig/growsurf_ruby/models/commission_structure.rbs +7 -2
  129. data/sig/growsurf_ruby/models/referral_flow_screenshots_response.rbs +54 -0
  130. data/sig/growsurf_ruby/models/reward_tax_valuation.rbs +4 -1
  131. data/sig/growsurf_ruby/models.rbs +8 -0
  132. data/sig/growsurf_ruby/resources/account.rbs +38 -0
  133. data/sig/growsurf_ruby/resources/campaign/participant.rbs +37 -0
  134. data/sig/growsurf_ruby/resources/campaign/rewards.rbs +0 -2
  135. data/sig/growsurf_ruby/resources/campaign/webhooks.rbs +46 -0
  136. data/sig/growsurf_ruby/resources/campaign.rbs +9 -0
  137. metadata +80 -2
@@ -4,7 +4,11 @@ module GrowsurfRuby
4
4
  {
5
5
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
6
6
  end_date: Integer,
7
- start_date: Integer
7
+ start_date: Integer,
8
+ previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
9
+ rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
10
+ series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
11
+ status_counts: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts
8
12
  }
9
13
 
10
14
  class CampaignRetrieveAnalyticsResponse < GrowsurfRuby::Internal::Type::BaseModel
@@ -14,16 +18,48 @@ module GrowsurfRuby
14
18
 
15
19
  attr_accessor start_date: Integer
16
20
 
21
+ attr_reader previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod?
22
+
23
+ def previous_period=: (
24
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod
25
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod
26
+
27
+ attr_reader rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates?
28
+
29
+ def rates=: (
30
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates
31
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates
32
+
33
+ attr_reader series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series]?
34
+
35
+ def series=: (
36
+ ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series]
37
+ ) -> ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series]
38
+
39
+ attr_reader status_counts: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts?
40
+
41
+ def status_counts=: (
42
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts
43
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts
44
+
17
45
  def initialize: (
18
46
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
19
47
  end_date: Integer,
20
- start_date: Integer
48
+ start_date: Integer,
49
+ ?previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
50
+ ?rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
51
+ ?series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
52
+ ?status_counts: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts
21
53
  ) -> void
22
54
 
23
55
  def to_hash: -> {
24
56
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
25
57
  end_date: Integer,
26
- start_date: Integer
58
+ start_date: Integer,
59
+ previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
60
+ rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
61
+ series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
62
+ status_counts: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts
27
63
  }
28
64
 
29
65
  type analytics =
@@ -233,6 +269,500 @@ module GrowsurfRuby
233
269
  whats_app_shares: Integer
234
270
  }
235
271
  end
272
+
273
+ type previous_period =
274
+ {
275
+ analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
276
+ end_date: Integer,
277
+ start_date: Integer
278
+ }
279
+
280
+ class PreviousPeriod < GrowsurfRuby::Internal::Type::BaseModel
281
+ attr_accessor analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics
282
+
283
+ attr_accessor end_date: Integer
284
+
285
+ attr_accessor start_date: Integer
286
+
287
+ def initialize: (
288
+ analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
289
+ end_date: Integer,
290
+ start_date: Integer
291
+ ) -> void
292
+
293
+ def to_hash: -> {
294
+ analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
295
+ end_date: Integer,
296
+ start_date: Integer
297
+ }
298
+ end
299
+
300
+ type rates =
301
+ {
302
+ participation_rate: Float,
303
+ referral_conversion_rate: Float,
304
+ shares_per_participant: Float
305
+ }
306
+
307
+ class Rates < GrowsurfRuby::Internal::Type::BaseModel
308
+ attr_reader participation_rate: Float?
309
+
310
+ def participation_rate=: (Float) -> Float
311
+
312
+ attr_reader referral_conversion_rate: Float?
313
+
314
+ def referral_conversion_rate=: (Float) -> Float
315
+
316
+ attr_reader shares_per_participant: Float?
317
+
318
+ def shares_per_participant=: (Float) -> Float
319
+
320
+ def initialize: (
321
+ ?participation_rate: Float,
322
+ ?referral_conversion_rate: Float,
323
+ ?shares_per_participant: Float
324
+ ) -> void
325
+
326
+ def to_hash: -> {
327
+ participation_rate: Float,
328
+ referral_conversion_rate: Float,
329
+ shares_per_participant: Float
330
+ }
331
+ end
332
+
333
+ type series =
334
+ {
335
+ android_native_shares: Integer,
336
+ bluesky_shares: Integer,
337
+ copy_ref_link_shares: Integer,
338
+ email_shares: Integer,
339
+ facebook_shares: Integer,
340
+ impressions: Integer,
341
+ invites: Integer,
342
+ ios_native_shares: Integer,
343
+ linked_in_shares: Integer,
344
+ messenger_shares: Integer,
345
+ participants: Integer,
346
+ period_start: Integer,
347
+ pinterest_shares: Integer,
348
+ qrcode_shares: Integer,
349
+ reddit_shares: Integer,
350
+ referral_credit_expireds: Integer,
351
+ referral_credit_pendings: Integer,
352
+ referrals: Integer,
353
+ sms_shares: Integer,
354
+ telegram_shares: Integer,
355
+ threads_shares: Integer,
356
+ total_commission_count: Integer,
357
+ total_commissions: Integer,
358
+ total_revenue: Integer,
359
+ tumblr_shares: Integer,
360
+ twitter_shares: Integer,
361
+ unique_impressions: Integer,
362
+ wechat_shares: Integer,
363
+ whats_app_shares: Integer
364
+ }
365
+
366
+ class Series < GrowsurfRuby::Internal::Type::BaseModel
367
+ attr_reader android_native_shares: Integer?
368
+
369
+ def android_native_shares=: (Integer) -> Integer
370
+
371
+ attr_reader bluesky_shares: Integer?
372
+
373
+ def bluesky_shares=: (Integer) -> Integer
374
+
375
+ attr_reader copy_ref_link_shares: Integer?
376
+
377
+ def copy_ref_link_shares=: (Integer) -> Integer
378
+
379
+ attr_reader email_shares: Integer?
380
+
381
+ def email_shares=: (Integer) -> Integer
382
+
383
+ attr_reader facebook_shares: Integer?
384
+
385
+ def facebook_shares=: (Integer) -> Integer
386
+
387
+ attr_reader impressions: Integer?
388
+
389
+ def impressions=: (Integer) -> Integer
390
+
391
+ attr_reader invites: Integer?
392
+
393
+ def invites=: (Integer) -> Integer
394
+
395
+ attr_reader ios_native_shares: Integer?
396
+
397
+ def ios_native_shares=: (Integer) -> Integer
398
+
399
+ attr_reader linked_in_shares: Integer?
400
+
401
+ def linked_in_shares=: (Integer) -> Integer
402
+
403
+ attr_reader messenger_shares: Integer?
404
+
405
+ def messenger_shares=: (Integer) -> Integer
406
+
407
+ attr_reader participants: Integer?
408
+
409
+ def participants=: (Integer) -> Integer
410
+
411
+ attr_reader period_start: Integer?
412
+
413
+ def period_start=: (Integer) -> Integer
414
+
415
+ attr_reader pinterest_shares: Integer?
416
+
417
+ def pinterest_shares=: (Integer) -> Integer
418
+
419
+ attr_reader qrcode_shares: Integer?
420
+
421
+ def qrcode_shares=: (Integer) -> Integer
422
+
423
+ attr_reader reddit_shares: Integer?
424
+
425
+ def reddit_shares=: (Integer) -> Integer
426
+
427
+ attr_reader referral_credit_expireds: Integer?
428
+
429
+ def referral_credit_expireds=: (Integer) -> Integer
430
+
431
+ attr_reader referral_credit_pendings: Integer?
432
+
433
+ def referral_credit_pendings=: (Integer) -> Integer
434
+
435
+ attr_reader referrals: Integer?
436
+
437
+ def referrals=: (Integer) -> Integer
438
+
439
+ attr_reader sms_shares: Integer?
440
+
441
+ def sms_shares=: (Integer) -> Integer
442
+
443
+ attr_reader telegram_shares: Integer?
444
+
445
+ def telegram_shares=: (Integer) -> Integer
446
+
447
+ attr_reader threads_shares: Integer?
448
+
449
+ def threads_shares=: (Integer) -> Integer
450
+
451
+ attr_reader total_commission_count: Integer?
452
+
453
+ def total_commission_count=: (Integer) -> Integer
454
+
455
+ attr_reader total_commissions: Integer?
456
+
457
+ def total_commissions=: (Integer) -> Integer
458
+
459
+ attr_reader total_revenue: Integer?
460
+
461
+ def total_revenue=: (Integer) -> Integer
462
+
463
+ attr_reader tumblr_shares: Integer?
464
+
465
+ def tumblr_shares=: (Integer) -> Integer
466
+
467
+ attr_reader twitter_shares: Integer?
468
+
469
+ def twitter_shares=: (Integer) -> Integer
470
+
471
+ attr_reader unique_impressions: Integer?
472
+
473
+ def unique_impressions=: (Integer) -> Integer
474
+
475
+ attr_reader wechat_shares: Integer?
476
+
477
+ def wechat_shares=: (Integer) -> Integer
478
+
479
+ attr_reader whats_app_shares: Integer?
480
+
481
+ def whats_app_shares=: (Integer) -> Integer
482
+
483
+ def initialize: (
484
+ ?android_native_shares: Integer,
485
+ ?bluesky_shares: Integer,
486
+ ?copy_ref_link_shares: Integer,
487
+ ?email_shares: Integer,
488
+ ?facebook_shares: Integer,
489
+ ?impressions: Integer,
490
+ ?invites: Integer,
491
+ ?ios_native_shares: Integer,
492
+ ?linked_in_shares: Integer,
493
+ ?messenger_shares: Integer,
494
+ ?participants: Integer,
495
+ ?period_start: Integer,
496
+ ?pinterest_shares: Integer,
497
+ ?qrcode_shares: Integer,
498
+ ?reddit_shares: Integer,
499
+ ?referral_credit_expireds: Integer,
500
+ ?referral_credit_pendings: Integer,
501
+ ?referrals: Integer,
502
+ ?sms_shares: Integer,
503
+ ?telegram_shares: Integer,
504
+ ?threads_shares: Integer,
505
+ ?total_commission_count: Integer,
506
+ ?total_commissions: Integer,
507
+ ?total_revenue: Integer,
508
+ ?tumblr_shares: Integer,
509
+ ?twitter_shares: Integer,
510
+ ?unique_impressions: Integer,
511
+ ?wechat_shares: Integer,
512
+ ?whats_app_shares: Integer
513
+ ) -> void
514
+
515
+ def to_hash: -> {
516
+ android_native_shares: Integer,
517
+ bluesky_shares: Integer,
518
+ copy_ref_link_shares: Integer,
519
+ email_shares: Integer,
520
+ facebook_shares: Integer,
521
+ impressions: Integer,
522
+ invites: Integer,
523
+ ios_native_shares: Integer,
524
+ linked_in_shares: Integer,
525
+ messenger_shares: Integer,
526
+ participants: Integer,
527
+ period_start: Integer,
528
+ pinterest_shares: Integer,
529
+ qrcode_shares: Integer,
530
+ reddit_shares: Integer,
531
+ referral_credit_expireds: Integer,
532
+ referral_credit_pendings: Integer,
533
+ referrals: Integer,
534
+ sms_shares: Integer,
535
+ telegram_shares: Integer,
536
+ threads_shares: Integer,
537
+ total_commission_count: Integer,
538
+ total_commissions: Integer,
539
+ total_revenue: Integer,
540
+ tumblr_shares: Integer,
541
+ twitter_shares: Integer,
542
+ unique_impressions: Integer,
543
+ wechat_shares: Integer,
544
+ whats_app_shares: Integer
545
+ }
546
+ end
547
+
548
+ type status_counts =
549
+ {
550
+ affiliate_status: ::Hash[Symbol, Integer],
551
+ commission_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus,
552
+ currency_iso: String,
553
+ payout_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus,
554
+ reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
555
+ }
556
+
557
+ class StatusCounts < GrowsurfRuby::Internal::Type::BaseModel
558
+ attr_reader affiliate_status: ::Hash[Symbol, Integer]?
559
+
560
+ def affiliate_status=: (
561
+ ::Hash[Symbol, Integer]
562
+ ) -> ::Hash[Symbol, Integer]
563
+
564
+ attr_reader commission_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus?
565
+
566
+ def commission_status=: (
567
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus
568
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus
569
+
570
+ attr_reader currency_iso: String?
571
+
572
+ def currency_iso=: (String) -> String
573
+
574
+ attr_reader payout_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus?
575
+
576
+ def payout_status=: (
577
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus
578
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus
579
+
580
+ attr_reader reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus?
581
+
582
+ def reward_status=: (
583
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
584
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
585
+
586
+ def initialize: (
587
+ ?affiliate_status: ::Hash[Symbol, Integer],
588
+ ?commission_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus,
589
+ ?currency_iso: String,
590
+ ?payout_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus,
591
+ ?reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
592
+ ) -> void
593
+
594
+ def to_hash: -> {
595
+ affiliate_status: ::Hash[Symbol, Integer],
596
+ commission_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus,
597
+ currency_iso: String,
598
+ payout_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus,
599
+ reward_status: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::RewardStatus
600
+ }
601
+
602
+ type commission_status =
603
+ {
604
+ approved: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
605
+ paid: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
606
+ pending: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
607
+ reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
608
+ }
609
+
610
+ class CommissionStatus < GrowsurfRuby::Internal::Type::BaseModel
611
+ attr_reader approved: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric?
612
+
613
+ def approved=: (
614
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
615
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
616
+
617
+ attr_reader paid: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric?
618
+
619
+ def paid=: (
620
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
621
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
622
+
623
+ attr_reader pending: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric?
624
+
625
+ def pending=: (
626
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
627
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
628
+
629
+ attr_reader reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric?
630
+
631
+ def reversed=: (
632
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
633
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
634
+
635
+ def initialize: (
636
+ ?approved: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
637
+ ?paid: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
638
+ ?pending: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
639
+ ?reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
640
+ ) -> void
641
+
642
+ def to_hash: -> {
643
+ approved: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
644
+ paid: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
645
+ pending: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric,
646
+ reversed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::CommissionStatus::CommissionStatusMetric
647
+ }
648
+
649
+ type commission_status_metric =
650
+ {
651
+ count: Integer,
652
+ total_amount: Integer,
653
+ total_revenue: Integer
654
+ }
655
+
656
+ class CommissionStatusMetric < GrowsurfRuby::Internal::Type::BaseModel
657
+ attr_reader count: Integer?
658
+
659
+ def count=: (Integer) -> Integer
660
+
661
+ attr_reader total_amount: Integer?
662
+
663
+ def total_amount=: (Integer) -> Integer
664
+
665
+ attr_reader total_revenue: Integer?
666
+
667
+ def total_revenue=: (Integer) -> Integer
668
+
669
+ def initialize: (
670
+ ?count: Integer,
671
+ ?total_amount: Integer,
672
+ ?total_revenue: Integer
673
+ ) -> void
674
+
675
+ def to_hash: -> {
676
+ count: Integer,
677
+ total_amount: Integer,
678
+ total_revenue: Integer
679
+ }
680
+ end
681
+ end
682
+
683
+ type payout_status =
684
+ {
685
+ failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
686
+ issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
687
+ queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
688
+ upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
689
+ }
690
+
691
+ class PayoutStatus < GrowsurfRuby::Internal::Type::BaseModel
692
+ attr_reader failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
693
+
694
+ def failed=: (
695
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
696
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
697
+
698
+ attr_reader issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
699
+
700
+ def issued=: (
701
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
702
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
703
+
704
+ attr_reader queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
705
+
706
+ def queued=: (
707
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
708
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
709
+
710
+ attr_reader upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric?
711
+
712
+ def upcoming=: (
713
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
714
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
715
+
716
+ def initialize: (
717
+ ?failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
718
+ ?issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
719
+ ?queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
720
+ ?upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
721
+ ) -> void
722
+
723
+ def to_hash: -> {
724
+ failed: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
725
+ issued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
726
+ queued: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric,
727
+ upcoming: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::StatusCounts::PayoutStatus::PayoutStatusMetric
728
+ }
729
+
730
+ type payout_status_metric = { count: Integer, total_amount: Integer }
731
+
732
+ class PayoutStatusMetric < GrowsurfRuby::Internal::Type::BaseModel
733
+ attr_reader count: Integer?
734
+
735
+ def count=: (Integer) -> Integer
736
+
737
+ attr_reader total_amount: Integer?
738
+
739
+ def total_amount=: (Integer) -> Integer
740
+
741
+ def initialize: (
742
+ ?count: Integer,
743
+ ?total_amount: Integer
744
+ ) -> void
745
+
746
+ def to_hash: -> { count: Integer, total_amount: Integer }
747
+ end
748
+ end
749
+
750
+ type reward_status = { approved: Integer, pending: Integer }
751
+
752
+ class RewardStatus < GrowsurfRuby::Internal::Type::BaseModel
753
+ attr_reader approved: Integer?
754
+
755
+ def approved=: (Integer) -> Integer
756
+
757
+ attr_reader pending: Integer?
758
+
759
+ def pending=: (Integer) -> Integer
760
+
761
+ def initialize: (?approved: Integer, ?pending: Integer) -> void
762
+
763
+ def to_hash: -> { approved: Integer, pending: Integer }
764
+ end
765
+ end
236
766
  end
237
767
  end
238
768
  end
@@ -52,16 +52,13 @@ module GrowsurfRuby
52
52
  request_options: GrowsurfRuby::RequestOptions
53
53
  }
54
54
 
55
- type status = :DRAFT | :PENDING | :IN_PROGRESS | :COMPLETE | :CANCELLED
55
+ type status = :IN_PROGRESS | :COMPLETE
56
56
 
57
57
  module Status
58
58
  extend GrowsurfRuby::Internal::Type::Enum
59
59
 
60
- DRAFT: :DRAFT
61
- PENDING: :PENDING
62
60
  IN_PROGRESS: :IN_PROGRESS
63
61
  COMPLETE: :COMPLETE
64
- CANCELLED: :CANCELLED
65
62
 
66
63
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignUpdateParams::status]
67
64
  end
@@ -3,6 +3,7 @@ module GrowsurfRuby
3
3
  type commission_structure =
4
4
  {
5
5
  amount: Integer?,
6
+ amount_iso: String?,
6
7
  approval_required: bool?,
7
8
  duration: String?,
8
9
  duration_in_months: Integer?,
@@ -26,6 +27,8 @@ module GrowsurfRuby
26
27
  class CommissionStructure < GrowsurfRuby::Internal::Type::BaseModel
27
28
  attr_accessor amount: Integer?
28
29
 
30
+ attr_accessor amount_iso: String?
31
+
29
32
  attr_accessor approval_required: bool?
30
33
 
31
34
  attr_accessor duration: String?
@@ -64,6 +67,7 @@ module GrowsurfRuby
64
67
 
65
68
  def initialize: (
66
69
  ?amount: Integer?,
70
+ ?amount_iso: String?,
67
71
  ?approval_required: bool?,
68
72
  ?duration: String?,
69
73
  ?duration_in_months: Integer?,
@@ -86,6 +90,7 @@ module GrowsurfRuby
86
90
 
87
91
  def to_hash: -> {
88
92
  amount: Integer?,
93
+ amount_iso: String?,
89
94
  approval_required: bool?,
90
95
  duration: String?,
91
96
  duration_in_months: Integer?,
@@ -106,13 +111,13 @@ module GrowsurfRuby
106
111
  type: GrowsurfRuby::Models::CommissionStructure::type_?
107
112
  }
108
113
 
109
- type type_ = :PERCENT | :AMOUNT
114
+ type type_ = :PERCENT | :FIXED
110
115
 
111
116
  module Type
112
117
  extend GrowsurfRuby::Internal::Type::Enum
113
118
 
114
119
  PERCENT: :PERCENT
115
- AMOUNT: :AMOUNT
120
+ FIXED: :FIXED
116
121
 
117
122
  def self?.values: -> ::Array[GrowsurfRuby::Models::CommissionStructure::type_]
118
123
  end
@@ -0,0 +1,54 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type referral_flow_screenshots_response =
4
+ {
5
+ referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
6
+ referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
7
+ generated_at: Integer
8
+ }
9
+
10
+ class ReferralFlowScreenshotsResponse < GrowsurfRuby::Internal::Type::BaseModel
11
+ attr_accessor referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
12
+
13
+ attr_accessor referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot
14
+
15
+ attr_accessor generated_at: Integer
16
+
17
+ def initialize: (
18
+ referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
19
+ referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
20
+ generated_at: Integer
21
+ ) -> void
22
+
23
+ def to_hash: -> {
24
+ referrer: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
25
+ referred_friend: GrowsurfRuby::Models::ReferralFlowScreenshotsResponse::ReferralFlowScreenshot,
26
+ generated_at: Integer
27
+ }
28
+
29
+ class ReferralFlowScreenshot < GrowsurfRuby::Internal::Type::BaseModel
30
+ attr_accessor view: String
31
+
32
+ attr_accessor url: String
33
+
34
+ attr_accessor width: Integer
35
+
36
+ attr_accessor height: Integer
37
+
38
+ def initialize: (
39
+ view: String,
40
+ url: String,
41
+ width: Integer,
42
+ height: Integer
43
+ ) -> void
44
+
45
+ def to_hash: -> {
46
+ view: String,
47
+ url: String,
48
+ width: Integer,
49
+ height: Integer
50
+ }
51
+ end
52
+ end
53
+ end
54
+ end
@@ -13,7 +13,10 @@ module GrowsurfRuby
13
13
  ?is_tax_reportable: bool?
14
14
  ) -> void
15
15
 
16
- def to_hash: -> { fair_market_value_usd: Float?, is_tax_reportable: bool? }
16
+ def to_hash: -> {
17
+ fair_market_value_usd: Float?,
18
+ is_tax_reportable: bool?
19
+ }
17
20
  end
18
21
  end
19
22
  end