growsurf-ruby 1.4.0 → 1.5.1

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 +34 -0
  3. data/README.md +10 -7
  4. data/lib/growsurf_ruby/internal/transport/base_client.rb +6 -1
  5. data/lib/growsurf_ruby/internal/type/base_model.rb +26 -0
  6. data/lib/growsurf_ruby/internal/type/base_page.rb +6 -0
  7. data/lib/growsurf_ruby/models/account_create_response.rb +3 -3
  8. data/lib/growsurf_ruby/models/analytics_availability.rb +16 -0
  9. data/lib/growsurf_ruby/models/analytics_unavailable_reason.rb +20 -0
  10. data/lib/growsurf_ruby/models/campaign/delete_program_resource_response.rb +12 -0
  11. data/lib/growsurf_ruby/models/campaign/integration.rb +69 -0
  12. data/lib/growsurf_ruby/models/campaign/integration_list_response.rb +24 -0
  13. data/lib/growsurf_ruby/models/campaign/participant_activation_analytics.rb +75 -0
  14. data/lib/growsurf_ruby/models/campaign/participant_analytics_response.rb +11 -0
  15. data/lib/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rb +17 -17
  16. data/lib/growsurf_ruby/models/campaign/participant_record_transaction_params.rb +9 -1
  17. data/lib/growsurf_ruby/models/campaign/participant_refund_transaction_params.rb +17 -1
  18. data/lib/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rb +8 -8
  19. data/lib/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rb +4 -3
  20. data/lib/growsurf_ruby/models/campaign/participant_reward.rb +15 -3
  21. data/lib/growsurf_ruby/models/campaign/program_resource.rb +51 -0
  22. data/lib/growsurf_ruby/models/campaign/program_resource_create_params.rb +32 -0
  23. data/lib/growsurf_ruby/models/campaign/program_resource_delete_params.rb +14 -0
  24. data/lib/growsurf_ruby/models/campaign/program_resource_list_response.rb +12 -0
  25. data/lib/growsurf_ruby/models/campaign/program_resource_update_params.rb +35 -0
  26. data/lib/growsurf_ruby/models/campaign/program_resource_upload_result.rb +33 -0
  27. data/lib/growsurf_ruby/models/campaign/program_resource_upload_ticket.rb +26 -0
  28. data/lib/growsurf_ruby/models/campaign/program_resource_upload_ticket_params.rb +17 -0
  29. data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +9 -8
  30. data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +9 -8
  31. data/lib/growsurf_ruby/models/campaign.rb +3 -1
  32. data/lib/growsurf_ruby/models/campaign_activation_analytics_response.rb +186 -0
  33. data/lib/growsurf_ruby/models/campaign_create_params.rb +37 -1
  34. data/lib/growsurf_ruby/models/campaign_engagement_analytics.rb +174 -0
  35. data/lib/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rb +35 -0
  36. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +37 -4
  37. data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +3 -0
  38. data/lib/growsurf_ruby/models/commission_structure.rb +4 -1
  39. data/lib/growsurf_ruby/models/participant_commission_list.rb +5 -5
  40. data/lib/growsurf_ruby/models/participant_payout_list.rb +5 -5
  41. data/lib/growsurf_ruby/models.rb +7 -0
  42. data/lib/growsurf_ruby/resources/account.rb +24 -14
  43. data/lib/growsurf_ruby/resources/campaign/design.rb +11 -5
  44. data/lib/growsurf_ruby/resources/campaign/emails.rb +2 -1
  45. data/lib/growsurf_ruby/resources/campaign/integrations.rb +41 -0
  46. data/lib/growsurf_ruby/resources/campaign/participant.rb +25 -24
  47. data/lib/growsurf_ruby/resources/campaign/program_resources.rb +112 -0
  48. data/lib/growsurf_ruby/resources/campaign/rewards.rb +6 -4
  49. data/lib/growsurf_ruby/resources/campaign.rb +53 -7
  50. data/lib/growsurf_ruby/resources/team.rb +7 -5
  51. data/lib/growsurf_ruby/version.rb +1 -1
  52. data/lib/growsurf_ruby.rb +19 -0
  53. data/rbi/growsurf_ruby/internal/type/base_model.rbi +10 -0
  54. data/rbi/growsurf_ruby/internal/type/base_page.rbi +3 -0
  55. data/rbi/growsurf_ruby/models/analytics_availability.rbi +19 -0
  56. data/rbi/growsurf_ruby/models/analytics_unavailable_reason.rbi +23 -0
  57. data/rbi/growsurf_ruby/models/campaign/delete_program_resource_response.rbi +33 -0
  58. data/rbi/growsurf_ruby/models/campaign/integration.rbi +93 -0
  59. data/rbi/growsurf_ruby/models/campaign/integration_list_response.rbi +46 -0
  60. data/rbi/growsurf_ruby/models/campaign/participant_activation_analytics.rbi +133 -0
  61. data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi +35 -0
  62. data/rbi/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbi +17 -23
  63. data/rbi/growsurf_ruby/models/campaign/participant_record_transaction_params.rbi +18 -0
  64. data/rbi/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbi +18 -0
  65. data/rbi/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbi +7 -9
  66. data/rbi/growsurf_ruby/models/campaign/participant_reward.rbi +24 -6
  67. data/rbi/growsurf_ruby/models/campaign/program_resource.rbi +186 -0
  68. data/rbi/growsurf_ruby/models/campaign/program_resource_create_params.rbi +95 -0
  69. data/rbi/growsurf_ruby/models/campaign/program_resource_delete_params.rbi +37 -0
  70. data/rbi/growsurf_ruby/models/campaign/program_resource_list_response.rbi +29 -0
  71. data/rbi/growsurf_ruby/models/campaign/program_resource_update_params.rbi +105 -0
  72. data/rbi/growsurf_ruby/models/campaign/program_resource_upload_result.rbi +94 -0
  73. data/rbi/growsurf_ruby/models/campaign/program_resource_upload_ticket.rbi +57 -0
  74. data/rbi/growsurf_ruby/models/campaign/program_resource_upload_ticket_params.rbi +53 -0
  75. data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +33 -24
  76. data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +33 -24
  77. data/rbi/growsurf_ruby/models/campaign.rbi +6 -3
  78. data/rbi/growsurf_ruby/models/campaign_activation_analytics_response.rbi +325 -0
  79. data/rbi/growsurf_ruby/models/campaign_create_params.rbi +91 -0
  80. data/rbi/growsurf_ruby/models/campaign_engagement_analytics.rbi +369 -0
  81. data/rbi/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rbi +59 -0
  82. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +56 -3
  83. data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +27 -7
  84. data/rbi/growsurf_ruby/models/commission_structure.rbi +3 -1
  85. data/rbi/growsurf_ruby/models/participant_commission_list.rbi +15 -15
  86. data/rbi/growsurf_ruby/models/participant_payout_list.rbi +15 -15
  87. data/rbi/growsurf_ruby/models.rbi +7 -0
  88. data/rbi/growsurf_ruby/resources/account.rbi +9 -6
  89. data/rbi/growsurf_ruby/resources/campaign/design.rbi +32 -4
  90. data/rbi/growsurf_ruby/resources/campaign/emails.rbi +2 -1
  91. data/rbi/growsurf_ruby/resources/campaign/integrations.rbi +35 -0
  92. data/rbi/growsurf_ruby/resources/campaign/participant.rbi +27 -18
  93. data/rbi/growsurf_ruby/resources/campaign/program_resources.rbi +116 -0
  94. data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +21 -16
  95. data/rbi/growsurf_ruby/resources/campaign.rbi +53 -5
  96. data/rbi/growsurf_ruby/resources/team.rbi +7 -5
  97. data/sig/growsurf_ruby/internal/type/base_model.rbs +6 -0
  98. data/sig/growsurf_ruby/internal/type/base_page.rbs +2 -0
  99. data/sig/growsurf_ruby/models/analytics_availability.rbs +15 -0
  100. data/sig/growsurf_ruby/models/analytics_unavailable_reason.rbs +26 -0
  101. data/sig/growsurf_ruby/models/campaign/delete_program_resource_response.rbs +14 -0
  102. data/sig/growsurf_ruby/models/campaign/integration.rbs +47 -0
  103. data/sig/growsurf_ruby/models/campaign/integration_list_response.rbs +20 -0
  104. data/sig/growsurf_ruby/models/campaign/participant_activation_analytics.rbs +96 -0
  105. data/sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs +22 -1
  106. data/sig/growsurf_ruby/models/campaign/participant_get_payout_destination_response.rbs +17 -22
  107. data/sig/growsurf_ruby/models/campaign/participant_record_transaction_params.rbs +15 -1
  108. data/sig/growsurf_ruby/models/campaign/participant_refund_transaction_params.rbs +15 -1
  109. data/sig/growsurf_ruby/models/campaign/participant_request_payout_destination_confirmation_response.rbs +8 -10
  110. data/sig/growsurf_ruby/models/campaign/participant_reward.rbs +22 -8
  111. data/sig/growsurf_ruby/models/campaign/program_resource.rbs +94 -0
  112. data/sig/growsurf_ruby/models/campaign/program_resource_create_params.rbs +45 -0
  113. data/sig/growsurf_ruby/models/campaign/program_resource_delete_params.rbs +22 -0
  114. data/sig/growsurf_ruby/models/campaign/program_resource_list_response.rbs +14 -0
  115. data/sig/growsurf_ruby/models/campaign/program_resource_update_params.rbs +48 -0
  116. data/sig/growsurf_ruby/models/campaign/program_resource_upload_result.rbs +58 -0
  117. data/sig/growsurf_ruby/models/campaign/program_resource_upload_ticket.rbs +29 -0
  118. data/sig/growsurf_ruby/models/campaign/program_resource_upload_ticket_params.rbs +29 -0
  119. data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +34 -34
  120. data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +34 -34
  121. data/sig/growsurf_ruby/models/campaign.rbs +7 -5
  122. data/sig/growsurf_ruby/models/campaign_activation_analytics_response.rbs +202 -0
  123. data/sig/growsurf_ruby/models/campaign_create_params.rbs +29 -0
  124. data/sig/growsurf_ruby/models/campaign_engagement_analytics.rbs +186 -0
  125. data/sig/growsurf_ruby/models/campaign_retrieve_activation_analytics_params.rbs +45 -0
  126. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_params.rbs +30 -1
  127. data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +21 -3
  128. data/sig/growsurf_ruby/models/participant_commission_list.rbs +20 -20
  129. data/sig/growsurf_ruby/models/participant_payout_list.rbs +20 -20
  130. data/sig/growsurf_ruby/models.rbs +6 -0
  131. data/sig/growsurf_ruby/resources/campaign/design.rbs +19 -0
  132. data/sig/growsurf_ruby/resources/campaign/integrations.rbs +14 -0
  133. data/sig/growsurf_ruby/resources/campaign/participant.rbs +4 -0
  134. data/sig/growsurf_ruby/resources/campaign/program_resources.rbs +58 -0
  135. data/sig/growsurf_ruby/resources/campaign/rewards.rbs +12 -12
  136. data/sig/growsurf_ruby/resources/campaign.rbs +17 -0
  137. metadata +59 -2
@@ -6,6 +6,7 @@ module GrowsurfRuby
6
6
  company_logo_image_url: String,
7
7
  company_name: String,
8
8
  currency_iso: String,
9
+ goal: GrowsurfRuby::Models::CampaignCreateParams::goal,
9
10
  name: String,
10
11
  rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams]
11
12
  }
@@ -29,6 +30,12 @@ module GrowsurfRuby
29
30
 
30
31
  def currency_iso=: (String) -> String
31
32
 
33
+ attr_reader goal: GrowsurfRuby::Models::CampaignCreateParams::goal?
34
+
35
+ def goal=: (
36
+ GrowsurfRuby::Models::CampaignCreateParams::goal
37
+ ) -> GrowsurfRuby::Models::CampaignCreateParams::goal
38
+
32
39
  attr_reader name: String?
33
40
 
34
41
  def name=: (String) -> String
@@ -44,6 +51,7 @@ module GrowsurfRuby
44
51
  ?company_logo_image_url: String,
45
52
  ?company_name: String,
46
53
  ?currency_iso: String,
54
+ ?goal: GrowsurfRuby::Models::CampaignCreateParams::goal,
47
55
  ?name: String,
48
56
  ?rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
49
57
  ?request_options: GrowsurfRuby::request_opts
@@ -54,6 +62,7 @@ module GrowsurfRuby
54
62
  company_logo_image_url: String,
55
63
  company_name: String,
56
64
  currency_iso: String,
65
+ goal: GrowsurfRuby::Models::CampaignCreateParams::goal,
57
66
  name: String,
58
67
  rewards: ::Array[GrowsurfRuby::Campaign::RewardCreateParams],
59
68
  request_options: GrowsurfRuby::RequestOptions
@@ -69,6 +78,26 @@ module GrowsurfRuby
69
78
 
70
79
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignCreateParams::type_]
71
80
  end
81
+
82
+ type goal =
83
+ :CUSTOMERS | :USERS | :SUBSCRIBERS | :WAITLIST | :B2B_SAAS_SELF_SERVICE | :B2B_SAAS_ENTERPRISE | :B2C_SUBSCRIPTIONS | :FINANCIAL_SERVICES | :ONLINE_EDUCATION | :ONLINE_INSURANCE
84
+
85
+ module Goal
86
+ extend GrowsurfRuby::Internal::Type::Enum
87
+
88
+ CUSTOMERS: :CUSTOMERS
89
+ USERS: :USERS
90
+ SUBSCRIBERS: :SUBSCRIBERS
91
+ WAITLIST: :WAITLIST
92
+ B2B_SAAS_SELF_SERVICE: :B2B_SAAS_SELF_SERVICE
93
+ B2B_SAAS_ENTERPRISE: :B2B_SAAS_ENTERPRISE
94
+ B2C_SUBSCRIPTIONS: :B2C_SUBSCRIPTIONS
95
+ FINANCIAL_SERVICES: :FINANCIAL_SERVICES
96
+ ONLINE_EDUCATION: :ONLINE_EDUCATION
97
+ ONLINE_INSURANCE: :ONLINE_INSURANCE
98
+
99
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignCreateParams::goal]
100
+ end
72
101
  end
73
102
  end
74
103
  end
@@ -0,0 +1,186 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ class CampaignEngagementAnalytics < GrowsurfRuby::Internal::Type::BaseModel
4
+ type program_type = :REFERRAL | :AFFILIATE
5
+ type interval = :day | :week | :month
6
+ type platform_value = :ALL | :WEB | :IOS | :ANDROID
7
+ type breakdown_platform = :WEB | :IOS | :ANDROID
8
+ type portal_source =
9
+ :DEFAULT_LAUNCHER
10
+ | :SDK_OPEN
11
+ | :CSS_CLASS
12
+ | :EMBEDDABLE_ELEMENT
13
+ | :HOSTED_PORTAL
14
+ | :NATIVE_WINDOW
15
+ | :UNKNOWN
16
+
17
+ attr_accessor coverage_start_at: Integer?
18
+ attr_accessor metric_contract_version: Integer
19
+ attr_accessor program_type: GrowsurfRuby::Models::CampaignEngagementAnalytics::program_type
20
+ attr_accessor timezone: String
21
+ attr_accessor interval: GrowsurfRuby::Models::CampaignEngagementAnalytics::interval
22
+ attr_accessor platform: GrowsurfRuby::Models::CampaignEngagementAnalytics::PlatformFilter
23
+ attr_accessor period: GrowsurfRuby::Models::CampaignEngagementAnalytics::Period
24
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
25
+ attr_accessor reason: GrowsurfRuby::Models::analytics_unavailable_reason?
26
+ attr_accessor totals: GrowsurfRuby::Models::CampaignEngagementAnalytics::Totals
27
+ attr_accessor previous_period: GrowsurfRuby::Models::CampaignEngagementAnalytics::PreviousPeriod
28
+ attr_accessor comparison: GrowsurfRuby::Models::CampaignEngagementAnalytics::Comparison
29
+ attr_accessor series: ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::SeriesPoint]
30
+ attr_accessor breakdowns: GrowsurfRuby::Models::CampaignEngagementAnalytics::Breakdowns
31
+
32
+ def initialize: (**untyped) -> void
33
+
34
+ module ProgramType
35
+ extend GrowsurfRuby::Internal::Type::Enum
36
+ REFERRAL: :REFERRAL
37
+ AFFILIATE: :AFFILIATE
38
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::program_type]
39
+ end
40
+
41
+ module Interval
42
+ extend GrowsurfRuby::Internal::Type::Enum
43
+ DAY: :day
44
+ WEEK: :week
45
+ MONTH: :month
46
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::interval]
47
+ end
48
+
49
+ module Platform
50
+ extend GrowsurfRuby::Internal::Type::Enum
51
+ ALL: :ALL
52
+ WEB: :WEB
53
+ IOS: :IOS
54
+ ANDROID: :ANDROID
55
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::platform_value]
56
+ end
57
+
58
+ module BreakdownPlatform
59
+ extend GrowsurfRuby::Internal::Type::Enum
60
+ WEB: :WEB
61
+ IOS: :IOS
62
+ ANDROID: :ANDROID
63
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::breakdown_platform]
64
+ end
65
+
66
+ module PortalSource
67
+ extend GrowsurfRuby::Internal::Type::Enum
68
+ DEFAULT_LAUNCHER: :DEFAULT_LAUNCHER
69
+ SDK_OPEN: :SDK_OPEN
70
+ CSS_CLASS: :CSS_CLASS
71
+ EMBEDDABLE_ELEMENT: :EMBEDDABLE_ELEMENT
72
+ HOSTED_PORTAL: :HOSTED_PORTAL
73
+ NATIVE_WINDOW: :NATIVE_WINDOW
74
+ UNKNOWN: :UNKNOWN
75
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::portal_source]
76
+ end
77
+
78
+ class Metric < GrowsurfRuby::Internal::Type::BaseModel
79
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
80
+ attr_accessor value: Float?
81
+ attr_accessor reason: GrowsurfRuby::Models::analytics_unavailable_reason?
82
+ attr_accessor delta: Float?
83
+ def initialize: (**untyped) -> void
84
+ end
85
+
86
+ class Totals < GrowsurfRuby::Internal::Type::BaseModel
87
+ attr_accessor active_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
88
+ attr_accessor sharing_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
89
+ attr_accessor sharing_rate: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
90
+ attr_accessor repeat_active_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
91
+ attr_accessor repeat_sharing_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
92
+ attr_accessor retained_active_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
93
+ attr_accessor portal_views: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
94
+ attr_accessor share_actions: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric
95
+ def initialize: (**untyped) -> void
96
+ end
97
+
98
+ class Period < GrowsurfRuby::Internal::Type::BaseModel
99
+ attr_accessor from: Integer
100
+ attr_accessor to: Integer
101
+ attr_accessor effective_from: Integer?
102
+ attr_accessor previous_from: Integer
103
+ attr_accessor previous_to: Integer
104
+ def initialize: (**untyped) -> void
105
+ end
106
+
107
+ class PlatformFilter < GrowsurfRuby::Internal::Type::BaseModel
108
+ attr_accessor requested: GrowsurfRuby::Models::CampaignEngagementAnalytics::platform_value
109
+ attr_accessor applied: GrowsurfRuby::Models::CampaignEngagementAnalytics::platform_value
110
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
111
+ def initialize: (**untyped) -> void
112
+ end
113
+
114
+ class PreviousPeriod < GrowsurfRuby::Internal::Type::BaseModel
115
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
116
+ attr_accessor reason: GrowsurfRuby::Models::analytics_unavailable_reason?
117
+ attr_accessor totals: GrowsurfRuby::Models::CampaignEngagementAnalytics::Totals?
118
+ def initialize: (**untyped) -> void
119
+ end
120
+
121
+ class ComparisonMetrics < GrowsurfRuby::Internal::Type::BaseModel
122
+ attr_accessor active_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
123
+ attr_accessor sharing_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
124
+ attr_accessor repeat_active_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
125
+ attr_accessor repeat_sharing_participants: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
126
+ attr_accessor portal_views: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
127
+ attr_accessor share_actions: GrowsurfRuby::Models::CampaignEngagementAnalytics::Metric?
128
+ def initialize: (**untyped) -> void
129
+ end
130
+
131
+ class Comparison < GrowsurfRuby::Internal::Type::BaseModel
132
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
133
+ attr_accessor reason: GrowsurfRuby::Models::analytics_unavailable_reason?
134
+ attr_accessor metrics: GrowsurfRuby::Models::CampaignEngagementAnalytics::ComparisonMetrics?
135
+ def initialize: (**untyped) -> void
136
+ end
137
+
138
+ class SeriesPoint < GrowsurfRuby::Internal::Type::BaseModel
139
+ attr_accessor from: Integer
140
+ attr_accessor to: Integer
141
+ attr_accessor active_participants: Integer
142
+ attr_accessor sharing_participants: Integer
143
+ attr_accessor portal_views: Integer
144
+ attr_accessor share_actions: Integer
145
+ def initialize: (**untyped) -> void
146
+ end
147
+
148
+ class PlatformBreakdown < GrowsurfRuby::Internal::Type::BaseModel
149
+ attr_accessor key: GrowsurfRuby::Models::CampaignEngagementAnalytics::breakdown_platform
150
+ attr_accessor active_participants: Integer
151
+ attr_accessor sharing_participants: Integer
152
+ attr_accessor portal_views: Integer
153
+ attr_accessor share_actions: Integer
154
+ def initialize: (**untyped) -> void
155
+ end
156
+
157
+ class PortalSourceBreakdown < GrowsurfRuby::Internal::Type::BaseModel
158
+ attr_accessor key: GrowsurfRuby::Models::CampaignEngagementAnalytics::portal_source
159
+ attr_accessor active_participants: Integer
160
+ attr_accessor portal_views: Integer
161
+ def initialize: (**untyped) -> void
162
+ end
163
+
164
+ class ShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
165
+ attr_accessor key: String
166
+ attr_accessor sharing_participants: Integer
167
+ attr_accessor share_actions: Integer
168
+ def initialize: (**untyped) -> void
169
+ end
170
+
171
+ class FirstShareChannelBreakdown < GrowsurfRuby::Internal::Type::BaseModel
172
+ attr_accessor key: String
173
+ attr_accessor sharing_participants: Integer
174
+ def initialize: (**untyped) -> void
175
+ end
176
+
177
+ class Breakdowns < GrowsurfRuby::Internal::Type::BaseModel
178
+ attr_accessor platforms: ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::PlatformBreakdown]
179
+ attr_accessor portal_view_sources: ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::PortalSourceBreakdown]
180
+ attr_accessor share_channels: ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::ShareChannelBreakdown]
181
+ attr_accessor first_share_channels: ::Array[GrowsurfRuby::Models::CampaignEngagementAnalytics::FirstShareChannelBreakdown]
182
+ def initialize: (**untyped) -> void
183
+ end
184
+ end
185
+ end
186
+ end
@@ -0,0 +1,45 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ type campaign_retrieve_activation_analytics_params =
4
+ {
5
+ id: String,
6
+ cohort_from: Integer,
7
+ cohort_to: Integer,
8
+ cohort_interval: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::cohort_interval,
9
+ observation_window_days: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::observation_window_days,
10
+ timezone: String
11
+ }
12
+ & GrowsurfRuby::Internal::Type::request_parameters
13
+
14
+ class CampaignRetrieveActivationAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
15
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
16
+ include GrowsurfRuby::Internal::Type::RequestParameters
17
+
18
+ type cohort_interval = :day | :week | :month
19
+ type observation_window_days = 7 | 30
20
+
21
+ attr_accessor id: String
22
+ attr_accessor cohort_from: Integer?
23
+ attr_accessor cohort_to: Integer?
24
+ attr_accessor cohort_interval: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::cohort_interval?
25
+ attr_accessor observation_window_days: GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::observation_window_days?
26
+ attr_accessor timezone: String?
27
+ def initialize: (**untyped) -> void
28
+
29
+ module CohortInterval
30
+ extend GrowsurfRuby::Internal::Type::Enum
31
+ DAY: :day
32
+ WEEK: :week
33
+ MONTH: :month
34
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::cohort_interval]
35
+ end
36
+
37
+ module ObservationWindowDays
38
+ extend GrowsurfRuby::Internal::Type::Enum
39
+ SEVEN: 7
40
+ THIRTY: 30
41
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams::observation_window_days]
42
+ end
43
+ end
44
+ end
45
+ end
@@ -7,7 +7,9 @@ module GrowsurfRuby
7
7
  end_date: Integer,
8
8
  include: String,
9
9
  interval: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval,
10
- start_date: Integer
10
+ platform: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform,
11
+ start_date: Integer,
12
+ timezone: String
11
13
  }
12
14
  & GrowsurfRuby::Internal::Type::request_parameters
13
15
 
@@ -35,17 +37,29 @@ module GrowsurfRuby
35
37
  GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval
36
38
  ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval
37
39
 
40
+ attr_reader platform: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform?
41
+
42
+ def platform=: (
43
+ GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform
44
+ ) -> GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform
45
+
38
46
  attr_reader start_date: Integer?
39
47
 
40
48
  def start_date=: (Integer) -> Integer
41
49
 
50
+ attr_reader timezone: String?
51
+
52
+ def timezone=: (String) -> String
53
+
42
54
  def initialize: (
43
55
  id: String,
44
56
  ?days: Integer,
45
57
  ?end_date: Integer,
46
58
  ?include: String,
47
59
  ?interval: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval,
60
+ ?platform: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform,
48
61
  ?start_date: Integer,
62
+ ?timezone: String,
49
63
  ?request_options: GrowsurfRuby::request_opts
50
64
  ) -> void
51
65
 
@@ -55,12 +69,16 @@ module GrowsurfRuby
55
69
  end_date: Integer,
56
70
  include: String,
57
71
  interval: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval,
72
+ platform: GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform,
58
73
  start_date: Integer,
74
+ timezone: String,
59
75
  request_options: GrowsurfRuby::RequestOptions
60
76
  }
61
77
 
62
78
  type interval = :day | :week | :month | :total
63
79
 
80
+ type platform = :ALL | :WEB | :IOS | :ANDROID
81
+
64
82
  module Interval
65
83
  extend GrowsurfRuby::Internal::Type::Enum
66
84
 
@@ -71,6 +89,17 @@ module GrowsurfRuby
71
89
 
72
90
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::interval]
73
91
  end
92
+
93
+ module Platform
94
+ extend GrowsurfRuby::Internal::Type::Enum
95
+
96
+ ALL: :ALL
97
+ WEB: :WEB
98
+ IOS: :IOS
99
+ ANDROID: :ANDROID
100
+
101
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams::platform]
102
+ end
74
103
  end
75
104
  end
76
105
  end
@@ -5,6 +5,7 @@ module GrowsurfRuby
5
5
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
6
6
  end_date: Integer,
7
7
  start_date: Integer,
8
+ engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics,
8
9
  previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
9
10
  rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
10
11
  series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
@@ -18,6 +19,12 @@ module GrowsurfRuby
18
19
 
19
20
  attr_accessor start_date: Integer
20
21
 
22
+ attr_reader engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics?
23
+
24
+ def engagement=: (
25
+ GrowsurfRuby::Models::CampaignEngagementAnalytics
26
+ ) -> GrowsurfRuby::Models::CampaignEngagementAnalytics
27
+
21
28
  attr_reader previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod?
22
29
 
23
30
  def previous_period=: (
@@ -46,6 +53,7 @@ module GrowsurfRuby
46
53
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
47
54
  end_date: Integer,
48
55
  start_date: Integer,
56
+ ?engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics,
49
57
  ?previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
50
58
  ?rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
51
59
  ?series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
@@ -56,6 +64,7 @@ module GrowsurfRuby
56
64
  analytics: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Analytics,
57
65
  end_date: Integer,
58
66
  start_date: Integer,
67
+ engagement: GrowsurfRuby::Models::CampaignEngagementAnalytics,
59
68
  previous_period: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::PreviousPeriod,
60
69
  rates: GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Rates,
61
70
  series: ::Array[GrowsurfRuby::Models::CampaignRetrieveAnalyticsResponse::Series],
@@ -763,7 +772,8 @@ module GrowsurfRuby
763
772
  end
764
773
  end
765
774
 
766
- type reward_status = { completed: Integer, unapproved: Integer, unfulfilled: Integer }
775
+ type reward_status =
776
+ { completed: Integer, unapproved: Integer, unfulfilled: Integer }
767
777
 
768
778
  class RewardStatus < GrowsurfRuby::Internal::Type::BaseModel
769
779
  attr_reader completed: Integer?
@@ -778,9 +788,17 @@ module GrowsurfRuby
778
788
 
779
789
  def unfulfilled=: (Integer) -> Integer
780
790
 
781
- def initialize: (?completed: Integer, ?unapproved: Integer, ?unfulfilled: Integer) -> void
791
+ def initialize: (
792
+ ?completed: Integer,
793
+ ?unapproved: Integer,
794
+ ?unfulfilled: Integer
795
+ ) -> void
782
796
 
783
- def to_hash: -> { completed: Integer, unapproved: Integer, unfulfilled: Integer }
797
+ def to_hash: -> {
798
+ completed: Integer,
799
+ unapproved: Integer,
800
+ unfulfilled: Integer
801
+ }
784
802
  end
785
803
  end
786
804
  end
@@ -38,16 +38,16 @@ module GrowsurfRuby
38
38
  sale_amount: Integer?,
39
39
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
40
40
  amount_in_campaign_currency: Integer?,
41
- approved_at: Integer,
41
+ approved_at: Integer?,
42
42
  campaign_currency_iso: String?,
43
43
  exchange_rate: Float?,
44
- exchange_rate_at: Integer,
44
+ exchange_rate_at: Integer?,
45
45
  fx_error: String?,
46
46
  hold_duration: Integer?,
47
- paid_at: Integer,
48
- payout_queued_at: Integer,
47
+ paid_at: Integer?,
48
+ payout_queued_at: Integer?,
49
49
  provider: String?,
50
- reversed_at: Integer,
50
+ reversed_at: Integer?,
51
51
  sale_amount_in_campaign_currency: Integer?
52
52
  }
53
53
 
@@ -74,7 +74,7 @@ module GrowsurfRuby
74
74
 
75
75
  attr_reader approved_at: Integer?
76
76
 
77
- def approved_at=: (Integer) -> Integer
77
+ def approved_at=: (Integer?) -> Integer?
78
78
 
79
79
  attr_accessor campaign_currency_iso: String?
80
80
 
@@ -82,7 +82,7 @@ module GrowsurfRuby
82
82
 
83
83
  attr_reader exchange_rate_at: Integer?
84
84
 
85
- def exchange_rate_at=: (Integer) -> Integer
85
+ def exchange_rate_at=: (Integer?) -> Integer?
86
86
 
87
87
  attr_accessor fx_error: String?
88
88
 
@@ -90,17 +90,17 @@ module GrowsurfRuby
90
90
 
91
91
  attr_reader paid_at: Integer?
92
92
 
93
- def paid_at=: (Integer) -> Integer
93
+ def paid_at=: (Integer?) -> Integer?
94
94
 
95
95
  attr_reader payout_queued_at: Integer?
96
96
 
97
- def payout_queued_at=: (Integer) -> Integer
97
+ def payout_queued_at=: (Integer?) -> Integer?
98
98
 
99
99
  attr_accessor provider: String?
100
100
 
101
101
  attr_reader reversed_at: Integer?
102
102
 
103
- def reversed_at=: (Integer) -> Integer
103
+ def reversed_at=: (Integer?) -> Integer?
104
104
 
105
105
  attr_accessor sale_amount_in_campaign_currency: Integer?
106
106
 
@@ -115,16 +115,16 @@ module GrowsurfRuby
115
115
  sale_amount: Integer?,
116
116
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
117
117
  ?amount_in_campaign_currency: Integer?,
118
- ?approved_at: Integer,
118
+ ?approved_at: Integer?,
119
119
  ?campaign_currency_iso: String?,
120
120
  ?exchange_rate: Float?,
121
- ?exchange_rate_at: Integer,
121
+ ?exchange_rate_at: Integer?,
122
122
  ?fx_error: String?,
123
123
  ?hold_duration: Integer?,
124
- ?paid_at: Integer,
125
- ?payout_queued_at: Integer,
124
+ ?paid_at: Integer?,
125
+ ?payout_queued_at: Integer?,
126
126
  ?provider: String?,
127
- ?reversed_at: Integer,
127
+ ?reversed_at: Integer?,
128
128
  ?sale_amount_in_campaign_currency: Integer?
129
129
  ) -> void
130
130
 
@@ -139,16 +139,16 @@ module GrowsurfRuby
139
139
  sale_amount: Integer?,
140
140
  status: GrowsurfRuby::Models::ParticipantCommissionList::Commission::status,
141
141
  amount_in_campaign_currency: Integer?,
142
- approved_at: Integer,
142
+ approved_at: Integer?,
143
143
  campaign_currency_iso: String?,
144
144
  exchange_rate: Float?,
145
- exchange_rate_at: Integer,
145
+ exchange_rate_at: Integer?,
146
146
  fx_error: String?,
147
147
  hold_duration: Integer?,
148
- paid_at: Integer,
149
- payout_queued_at: Integer,
148
+ paid_at: Integer?,
149
+ payout_queued_at: Integer?,
150
150
  provider: String?,
151
- reversed_at: Integer,
151
+ reversed_at: Integer?,
152
152
  sale_amount_in_campaign_currency: Integer?
153
153
  }
154
154
 
@@ -38,13 +38,13 @@ module GrowsurfRuby
38
38
  amount_in_campaign_currency: Integer?,
39
39
  campaign_currency_iso: String?,
40
40
  exchange_rate: Float?,
41
- exchange_rate_at: Integer,
42
- failed_at: Integer,
41
+ exchange_rate_at: Integer?,
42
+ failed_at: Integer?,
43
43
  fx_error: String?,
44
- issued_at: Integer,
44
+ issued_at: Integer?,
45
45
  provider: String?,
46
- queued_at: Integer,
47
- reversed_at: Integer
46
+ queued_at: Integer?,
47
+ reversed_at: Integer?
48
48
  }
49
49
 
50
50
  class Payout < GrowsurfRuby::Internal::Type::BaseModel
@@ -70,27 +70,27 @@ module GrowsurfRuby
70
70
 
71
71
  attr_reader exchange_rate_at: Integer?
72
72
 
73
- def exchange_rate_at=: (Integer) -> Integer
73
+ def exchange_rate_at=: (Integer?) -> Integer?
74
74
 
75
75
  attr_reader failed_at: Integer?
76
76
 
77
- def failed_at=: (Integer) -> Integer
77
+ def failed_at=: (Integer?) -> Integer?
78
78
 
79
79
  attr_accessor fx_error: String?
80
80
 
81
81
  attr_reader issued_at: Integer?
82
82
 
83
- def issued_at=: (Integer) -> Integer
83
+ def issued_at=: (Integer?) -> Integer?
84
84
 
85
85
  attr_accessor provider: String?
86
86
 
87
87
  attr_reader queued_at: Integer?
88
88
 
89
- def queued_at=: (Integer) -> Integer
89
+ def queued_at=: (Integer?) -> Integer?
90
90
 
91
91
  attr_reader reversed_at: Integer?
92
92
 
93
- def reversed_at=: (Integer) -> Integer
93
+ def reversed_at=: (Integer?) -> Integer?
94
94
 
95
95
  def initialize: (
96
96
  id: String,
@@ -103,13 +103,13 @@ module GrowsurfRuby
103
103
  ?amount_in_campaign_currency: Integer?,
104
104
  ?campaign_currency_iso: String?,
105
105
  ?exchange_rate: Float?,
106
- ?exchange_rate_at: Integer,
107
- ?failed_at: Integer,
106
+ ?exchange_rate_at: Integer?,
107
+ ?failed_at: Integer?,
108
108
  ?fx_error: String?,
109
- ?issued_at: Integer,
109
+ ?issued_at: Integer?,
110
110
  ?provider: String?,
111
- ?queued_at: Integer,
112
- ?reversed_at: Integer
111
+ ?queued_at: Integer?,
112
+ ?reversed_at: Integer?
113
113
  ) -> void
114
114
 
115
115
  def to_hash: -> {
@@ -123,13 +123,13 @@ module GrowsurfRuby
123
123
  amount_in_campaign_currency: Integer?,
124
124
  campaign_currency_iso: String?,
125
125
  exchange_rate: Float?,
126
- exchange_rate_at: Integer,
127
- failed_at: Integer,
126
+ exchange_rate_at: Integer?,
127
+ failed_at: Integer?,
128
128
  fx_error: String?,
129
- issued_at: Integer,
129
+ issued_at: Integer?,
130
130
  provider: String?,
131
- queued_at: Integer,
132
- reversed_at: Integer
131
+ queued_at: Integer?,
132
+ reversed_at: Integer?
133
133
  }
134
134
 
135
135
  type status = :UPCOMING | :QUEUED | :ISSUED | :FAILED | :REVERSED
@@ -1,6 +1,10 @@
1
1
  module GrowsurfRuby
2
2
  class AccountCreateParams = GrowsurfRuby::Models::AccountCreateParams
3
3
 
4
+ module AnalyticsAvailability = GrowsurfRuby::Models::AnalyticsAvailability
5
+
6
+ module AnalyticsUnavailableReason = GrowsurfRuby::Models::AnalyticsUnavailableReason
7
+
4
8
  class AffiliateApplication = GrowsurfRuby::Models::AffiliateApplication
5
9
 
6
10
  class AffiliateInvite = GrowsurfRuby::Models::AffiliateInvite
@@ -39,6 +43,8 @@ module GrowsurfRuby
39
43
 
40
44
  class CampaignRetrieveAffiliateApplicationParams = GrowsurfRuby::Models::CampaignRetrieveAffiliateApplicationParams
41
45
 
46
+ class CampaignRetrieveActivationAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveActivationAnalyticsParams
47
+
42
48
  class CampaignRetrieveAnalyticsParams = GrowsurfRuby::Models::CampaignRetrieveAnalyticsParams
43
49
 
44
50
  class CampaignRetrieveParams = GrowsurfRuby::Models::CampaignRetrieveParams
@@ -2,6 +2,25 @@ module GrowsurfRuby
2
2
  module Resources
3
3
  class Campaign
4
4
  class Design
5
+ # Icon configuration for the participant Resources destination.
6
+ type resources_icon = {
7
+ type?: "DEFAULT" | "IMAGE" | "NONE",
8
+ imageUrl?: String
9
+ }
10
+
11
+ # Participant presentation settings for Resources. Each label is limited to 100
12
+ # characters; imageUrl is limited to 500. Resource items use Program Resources operations.
13
+ type resources = {
14
+ isPublicDisplayed?: bool,
15
+ title?: String,
16
+ viewResourcesLinkText?: String,
17
+ backLinkText?: String,
18
+ copyButtonText?: String,
19
+ copiedText?: String,
20
+ emptyState?: String,
21
+ icon?: resources_icon
22
+ }
23
+
5
24
  def retrieve: (
6
25
  String id,
7
26
  ?request_options: GrowsurfRuby::request_opts