growsurf-ruby 1.4.0 → 1.5.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 +22 -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 +17 -11
  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
@@ -0,0 +1,29 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type program_resource_upload_parameter = String | Integer | Float | bool
5
+
6
+ type program_resource_upload_ticket =
7
+ {
8
+ ticket: String,
9
+ expires_in: Integer,
10
+ upload_url: String,
11
+ upload_parameters: ::Hash[Symbol, program_resource_upload_parameter]
12
+ }
13
+
14
+ class ProgramResourceUploadTicket < GrowsurfRuby::Internal::Type::BaseModel
15
+ attr_accessor ticket: String
16
+ attr_accessor expires_in: Integer
17
+ attr_accessor upload_url: String
18
+ attr_accessor upload_parameters: ::Hash[Symbol, program_resource_upload_parameter]
19
+ def initialize: (
20
+ ticket: String,
21
+ expires_in: Integer,
22
+ upload_url: String,
23
+ upload_parameters: ::Hash[Symbol, program_resource_upload_parameter]
24
+ ) -> void
25
+ def to_hash: -> program_resource_upload_ticket
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,29 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ module Campaign
4
+ type program_resource_upload_ticket_params =
5
+ { file_name: String, mime_type: String, bytes: Integer }
6
+ & GrowsurfRuby::Internal::Type::request_parameters
7
+
8
+ class ProgramResourceUploadTicketParams < GrowsurfRuby::Internal::Type::BaseModel
9
+ extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
10
+ include GrowsurfRuby::Internal::Type::RequestParameters
11
+ attr_accessor file_name: String
12
+ attr_accessor mime_type: String
13
+ attr_accessor bytes: Integer
14
+ def initialize: (
15
+ file_name: String,
16
+ mime_type: String,
17
+ bytes: Integer,
18
+ ?request_options: GrowsurfRuby::request_opts
19
+ ) -> void
20
+ def to_hash: -> {
21
+ file_name: String,
22
+ mime_type: String,
23
+ bytes: Integer,
24
+ request_options: GrowsurfRuby::RequestOptions
25
+ }
26
+ end
27
+ end
28
+ end
29
+ end
@@ -6,25 +6,25 @@ module GrowsurfRuby
6
6
  type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
7
7
  commission_structure: GrowsurfRuby::CommissionStructure,
8
8
  conversions_required: Integer,
9
- coupon_code: String,
9
+ coupon_code: String?,
10
10
  description: String,
11
11
  event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
12
- image_url: String,
12
+ image_url: String?,
13
13
  is_unlimited: bool,
14
14
  is_visible: bool,
15
15
  limit: Integer,
16
16
  limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
17
17
  metadata: ::Hash[Symbol, top],
18
- next_milestone_prefix: String,
19
- next_milestone_suffix: String,
18
+ next_milestone_prefix: String?,
19
+ next_milestone_suffix: String?,
20
20
  number_of_winners: Integer,
21
21
  order: Integer,
22
- referral_coupon_code: String,
23
- referral_description: String,
22
+ referral_coupon_code: String?,
23
+ referral_description: String?,
24
24
  referred_reward_upfront: bool,
25
- referred_value: GrowsurfRuby::RewardTaxValuation,
25
+ referred_value: GrowsurfRuby::RewardTaxValuation?,
26
26
  title: String,
27
- value: GrowsurfRuby::RewardTaxValuation
27
+ value: GrowsurfRuby::RewardTaxValuation?
28
28
  }
29
29
  & GrowsurfRuby::Internal::Type::request_parameters
30
30
 
@@ -46,7 +46,7 @@ module GrowsurfRuby
46
46
 
47
47
  attr_reader coupon_code: String?
48
48
 
49
- def coupon_code=: (String) -> String
49
+ def coupon_code=: (String?) -> String?
50
50
 
51
51
  attr_reader description: String?
52
52
 
@@ -60,7 +60,7 @@ module GrowsurfRuby
60
60
 
61
61
  attr_reader image_url: String?
62
62
 
63
- def image_url=: (String) -> String
63
+ def image_url=: (String?) -> String?
64
64
 
65
65
  attr_reader is_unlimited: bool?
66
66
 
@@ -86,11 +86,11 @@ module GrowsurfRuby
86
86
 
87
87
  attr_reader next_milestone_prefix: String?
88
88
 
89
- def next_milestone_prefix=: (String) -> String
89
+ def next_milestone_prefix=: (String?) -> String?
90
90
 
91
91
  attr_reader next_milestone_suffix: String?
92
92
 
93
- def next_milestone_suffix=: (String) -> String
93
+ def next_milestone_suffix=: (String?) -> String?
94
94
 
95
95
  attr_reader number_of_winners: Integer?
96
96
 
@@ -102,11 +102,11 @@ module GrowsurfRuby
102
102
 
103
103
  attr_reader referral_coupon_code: String?
104
104
 
105
- def referral_coupon_code=: (String) -> String
105
+ def referral_coupon_code=: (String?) -> String?
106
106
 
107
107
  attr_reader referral_description: String?
108
108
 
109
- def referral_description=: (String) -> String
109
+ def referral_description=: (String?) -> String?
110
110
 
111
111
  attr_reader referred_reward_upfront: bool?
112
112
 
@@ -115,8 +115,8 @@ module GrowsurfRuby
115
115
  attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
116
116
 
117
117
  def referred_value=: (
118
- GrowsurfRuby::RewardTaxValuation
119
- ) -> GrowsurfRuby::RewardTaxValuation
118
+ GrowsurfRuby::RewardTaxValuation?
119
+ ) -> GrowsurfRuby::RewardTaxValuation?
120
120
 
121
121
  attr_reader title: String?
122
122
 
@@ -125,32 +125,32 @@ module GrowsurfRuby
125
125
  attr_reader value: GrowsurfRuby::RewardTaxValuation?
126
126
 
127
127
  def value=: (
128
- GrowsurfRuby::RewardTaxValuation
129
- ) -> GrowsurfRuby::RewardTaxValuation
128
+ GrowsurfRuby::RewardTaxValuation?
129
+ ) -> GrowsurfRuby::RewardTaxValuation?
130
130
 
131
131
  def initialize: (
132
132
  type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
133
133
  ?commission_structure: GrowsurfRuby::CommissionStructure,
134
134
  ?conversions_required: Integer,
135
- ?coupon_code: String,
135
+ ?coupon_code: String?,
136
136
  ?description: String,
137
137
  ?event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
138
- ?image_url: String,
138
+ ?image_url: String?,
139
139
  ?is_unlimited: bool,
140
140
  ?is_visible: bool,
141
141
  ?limit: Integer,
142
142
  ?limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
143
143
  ?metadata: ::Hash[Symbol, top],
144
- ?next_milestone_prefix: String,
145
- ?next_milestone_suffix: String,
144
+ ?next_milestone_prefix: String?,
145
+ ?next_milestone_suffix: String?,
146
146
  ?number_of_winners: Integer,
147
147
  ?order: Integer,
148
- ?referral_coupon_code: String,
149
- ?referral_description: String,
148
+ ?referral_coupon_code: String?,
149
+ ?referral_description: String?,
150
150
  ?referred_reward_upfront: bool,
151
- ?referred_value: GrowsurfRuby::RewardTaxValuation,
151
+ ?referred_value: GrowsurfRuby::RewardTaxValuation?,
152
152
  ?title: String,
153
- ?value: GrowsurfRuby::RewardTaxValuation,
153
+ ?value: GrowsurfRuby::RewardTaxValuation?,
154
154
  ?request_options: GrowsurfRuby::request_opts
155
155
  ) -> void
156
156
 
@@ -158,25 +158,25 @@ module GrowsurfRuby
158
158
  type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
159
159
  commission_structure: GrowsurfRuby::CommissionStructure,
160
160
  conversions_required: Integer,
161
- coupon_code: String,
161
+ coupon_code: String?,
162
162
  description: String,
163
163
  event: GrowsurfRuby::Models::Campaign::RewardCreateParams::event,
164
- image_url: String,
164
+ image_url: String?,
165
165
  is_unlimited: bool,
166
166
  is_visible: bool,
167
167
  limit: Integer,
168
168
  limit_duration: GrowsurfRuby::Models::Campaign::RewardCreateParams::limit_duration,
169
169
  metadata: ::Hash[Symbol, top],
170
- next_milestone_prefix: String,
171
- next_milestone_suffix: String,
170
+ next_milestone_prefix: String?,
171
+ next_milestone_suffix: String?,
172
172
  number_of_winners: Integer,
173
173
  order: Integer,
174
- referral_coupon_code: String,
175
- referral_description: String,
174
+ referral_coupon_code: String?,
175
+ referral_description: String?,
176
176
  referred_reward_upfront: bool,
177
- referred_value: GrowsurfRuby::RewardTaxValuation,
177
+ referred_value: GrowsurfRuby::RewardTaxValuation?,
178
178
  title: String,
179
- value: GrowsurfRuby::RewardTaxValuation,
179
+ value: GrowsurfRuby::RewardTaxValuation?,
180
180
  request_options: GrowsurfRuby::RequestOptions
181
181
  }
182
182
 
@@ -7,25 +7,25 @@ module GrowsurfRuby
7
7
  campaign_reward_id: String,
8
8
  commission_structure: GrowsurfRuby::CommissionStructure,
9
9
  conversions_required: Integer,
10
- coupon_code: String,
10
+ coupon_code: String?,
11
11
  description: String,
12
12
  event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
13
- image_url: String,
13
+ image_url: String?,
14
14
  is_unlimited: bool,
15
15
  is_visible: bool,
16
16
  limit: Integer,
17
17
  limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
18
18
  metadata: ::Hash[Symbol, top],
19
- next_milestone_prefix: String,
20
- next_milestone_suffix: String,
19
+ next_milestone_prefix: String?,
20
+ next_milestone_suffix: String?,
21
21
  number_of_winners: Integer,
22
22
  order: Integer,
23
- referral_coupon_code: String,
24
- referral_description: String,
23
+ referral_coupon_code: String?,
24
+ referral_description: String?,
25
25
  referred_reward_upfront: bool,
26
- referred_value: GrowsurfRuby::RewardTaxValuation,
26
+ referred_value: GrowsurfRuby::RewardTaxValuation?,
27
27
  title: String,
28
- value: GrowsurfRuby::RewardTaxValuation
28
+ value: GrowsurfRuby::RewardTaxValuation?
29
29
  }
30
30
  & GrowsurfRuby::Internal::Type::request_parameters
31
31
 
@@ -49,7 +49,7 @@ module GrowsurfRuby
49
49
 
50
50
  attr_reader coupon_code: String?
51
51
 
52
- def coupon_code=: (String) -> String
52
+ def coupon_code=: (String?) -> String?
53
53
 
54
54
  attr_reader description: String?
55
55
 
@@ -63,7 +63,7 @@ module GrowsurfRuby
63
63
 
64
64
  attr_reader image_url: String?
65
65
 
66
- def image_url=: (String) -> String
66
+ def image_url=: (String?) -> String?
67
67
 
68
68
  attr_reader is_unlimited: bool?
69
69
 
@@ -89,11 +89,11 @@ module GrowsurfRuby
89
89
 
90
90
  attr_reader next_milestone_prefix: String?
91
91
 
92
- def next_milestone_prefix=: (String) -> String
92
+ def next_milestone_prefix=: (String?) -> String?
93
93
 
94
94
  attr_reader next_milestone_suffix: String?
95
95
 
96
- def next_milestone_suffix=: (String) -> String
96
+ def next_milestone_suffix=: (String?) -> String?
97
97
 
98
98
  attr_reader number_of_winners: Integer?
99
99
 
@@ -105,11 +105,11 @@ module GrowsurfRuby
105
105
 
106
106
  attr_reader referral_coupon_code: String?
107
107
 
108
- def referral_coupon_code=: (String) -> String
108
+ def referral_coupon_code=: (String?) -> String?
109
109
 
110
110
  attr_reader referral_description: String?
111
111
 
112
- def referral_description=: (String) -> String
112
+ def referral_description=: (String?) -> String?
113
113
 
114
114
  attr_reader referred_reward_upfront: bool?
115
115
 
@@ -118,8 +118,8 @@ module GrowsurfRuby
118
118
  attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
119
119
 
120
120
  def referred_value=: (
121
- GrowsurfRuby::RewardTaxValuation
122
- ) -> GrowsurfRuby::RewardTaxValuation
121
+ GrowsurfRuby::RewardTaxValuation?
122
+ ) -> GrowsurfRuby::RewardTaxValuation?
123
123
 
124
124
  attr_reader title: String?
125
125
 
@@ -128,33 +128,33 @@ module GrowsurfRuby
128
128
  attr_reader value: GrowsurfRuby::RewardTaxValuation?
129
129
 
130
130
  def value=: (
131
- GrowsurfRuby::RewardTaxValuation
132
- ) -> GrowsurfRuby::RewardTaxValuation
131
+ GrowsurfRuby::RewardTaxValuation?
132
+ ) -> GrowsurfRuby::RewardTaxValuation?
133
133
 
134
134
  def initialize: (
135
135
  id: String,
136
136
  campaign_reward_id: String,
137
137
  ?commission_structure: GrowsurfRuby::CommissionStructure,
138
138
  ?conversions_required: Integer,
139
- ?coupon_code: String,
139
+ ?coupon_code: String?,
140
140
  ?description: String,
141
141
  ?event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
142
- ?image_url: String,
142
+ ?image_url: String?,
143
143
  ?is_unlimited: bool,
144
144
  ?is_visible: bool,
145
145
  ?limit: Integer,
146
146
  ?limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
147
147
  ?metadata: ::Hash[Symbol, top],
148
- ?next_milestone_prefix: String,
149
- ?next_milestone_suffix: String,
148
+ ?next_milestone_prefix: String?,
149
+ ?next_milestone_suffix: String?,
150
150
  ?number_of_winners: Integer,
151
151
  ?order: Integer,
152
- ?referral_coupon_code: String,
153
- ?referral_description: String,
152
+ ?referral_coupon_code: String?,
153
+ ?referral_description: String?,
154
154
  ?referred_reward_upfront: bool,
155
- ?referred_value: GrowsurfRuby::RewardTaxValuation,
155
+ ?referred_value: GrowsurfRuby::RewardTaxValuation?,
156
156
  ?title: String,
157
- ?value: GrowsurfRuby::RewardTaxValuation,
157
+ ?value: GrowsurfRuby::RewardTaxValuation?,
158
158
  ?request_options: GrowsurfRuby::request_opts
159
159
  ) -> void
160
160
 
@@ -163,25 +163,25 @@ module GrowsurfRuby
163
163
  campaign_reward_id: String,
164
164
  commission_structure: GrowsurfRuby::CommissionStructure,
165
165
  conversions_required: Integer,
166
- coupon_code: String,
166
+ coupon_code: String?,
167
167
  description: String,
168
168
  event: GrowsurfRuby::Models::Campaign::RewardUpdateParams::event,
169
- image_url: String,
169
+ image_url: String?,
170
170
  is_unlimited: bool,
171
171
  is_visible: bool,
172
172
  limit: Integer,
173
173
  limit_duration: GrowsurfRuby::Models::Campaign::RewardUpdateParams::limit_duration,
174
174
  metadata: ::Hash[Symbol, top],
175
- next_milestone_prefix: String,
176
- next_milestone_suffix: String,
175
+ next_milestone_prefix: String?,
176
+ next_milestone_suffix: String?,
177
177
  number_of_winners: Integer,
178
178
  order: Integer,
179
- referral_coupon_code: String,
180
- referral_description: String,
179
+ referral_coupon_code: String?,
180
+ referral_description: String?,
181
181
  referred_reward_upfront: bool,
182
- referred_value: GrowsurfRuby::RewardTaxValuation,
182
+ referred_value: GrowsurfRuby::RewardTaxValuation?,
183
183
  title: String,
184
- value: GrowsurfRuby::RewardTaxValuation,
184
+ value: GrowsurfRuby::RewardTaxValuation?,
185
185
  request_options: GrowsurfRuby::RequestOptions
186
186
  }
187
187
 
@@ -12,7 +12,7 @@ module GrowsurfRuby
12
12
  status: GrowsurfRuby::Models::CampaignAPI::status,
13
13
  type: GrowsurfRuby::Models::CampaignAPI::type_,
14
14
  winner_count: Integer,
15
- currency_iso: String
15
+ currency_iso: String?
16
16
  }
17
17
 
18
18
  class CampaignAPI < GrowsurfRuby::Internal::Type::BaseModel
@@ -38,7 +38,7 @@ module GrowsurfRuby
38
38
 
39
39
  attr_reader currency_iso: String?
40
40
 
41
- def currency_iso=: (String) -> String
41
+ def currency_iso=: (String?) -> String?
42
42
 
43
43
  def initialize: (
44
44
  id: String,
@@ -51,7 +51,7 @@ module GrowsurfRuby
51
51
  status: GrowsurfRuby::Models::CampaignAPI::status,
52
52
  type: GrowsurfRuby::Models::CampaignAPI::type_,
53
53
  winner_count: Integer,
54
- ?currency_iso: String
54
+ ?currency_iso: String?
55
55
  ) -> void
56
56
 
57
57
  def to_hash: -> {
@@ -65,7 +65,7 @@ module GrowsurfRuby
65
65
  status: GrowsurfRuby::Models::CampaignAPI::status,
66
66
  type: GrowsurfRuby::Models::CampaignAPI::type_,
67
67
  winner_count: Integer,
68
- currency_iso: String
68
+ currency_iso: String?
69
69
  }
70
70
 
71
71
  type reward =
@@ -224,14 +224,16 @@ module GrowsurfRuby
224
224
  end
225
225
  end
226
226
 
227
- type status = :DRAFT | :IN_PROGRESS | :COMPLETE | :DELETED
227
+ type status = :DRAFT | :PENDING | :IN_PROGRESS | :COMPLETE | :CANCELLED | :DELETED
228
228
 
229
229
  module Status
230
230
  extend GrowsurfRuby::Internal::Type::Enum
231
231
 
232
232
  DRAFT: :DRAFT
233
+ PENDING: :PENDING
233
234
  IN_PROGRESS: :IN_PROGRESS
234
235
  COMPLETE: :COMPLETE
236
+ CANCELLED: :CANCELLED
235
237
  DELETED: :DELETED
236
238
 
237
239
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignAPI::status]
@@ -0,0 +1,202 @@
1
+ module GrowsurfRuby
2
+ module Models
3
+ class CampaignActivationAnalyticsResponse < GrowsurfRuby::Internal::Type::BaseModel
4
+ type program_type = :REFERRAL | :AFFILIATE
5
+ type cohort_interval = :day | :week | :month
6
+ type portal_viewed_label =
7
+ :"Referral portal viewed" | :"Affiliate portal viewed"
8
+ type stage_key =
9
+ :ELIGIBLE
10
+ | :PORTAL_VIEWED
11
+ | :SHARE_ACTION
12
+ | :UNIQUE_REFERRAL_VISIT
13
+ | :LEAD
14
+ | :CREDITED_REFERRAL
15
+ type stalled_segment_key =
16
+ :ELIGIBLE_NO_PORTAL_VIEW
17
+ | :PORTAL_VIEWED_NO_SHARE_ACTION
18
+ | :SHARED_NO_UNIQUE_REFERRAL_VISIT
19
+ | :UNIQUE_VISIT_NO_LEAD
20
+ | :LEAD_NO_CREDITED_REFERRAL
21
+ type stalled_segment_from_stage =
22
+ :ELIGIBLE | :PORTAL_VIEWED | :SHARE_ACTION | :UNIQUE_REFERRAL_VISIT | :LEAD
23
+ type stalled_segment_to_stage =
24
+ :PORTAL_VIEWED | :SHARE_ACTION | :UNIQUE_REFERRAL_VISIT | :LEAD | :CREDITED_REFERRAL
25
+ type improvement_area_key =
26
+ :PORTAL_ACCESS
27
+ | :SHARING_EXPERIENCE
28
+ | :SHARE_EFFECTIVENESS
29
+ | :VISITOR_SIGNUP
30
+ | :ATTRIBUTION_AND_QUALIFICATION
31
+ type anchor_field = :enrolledAsAdvocateAt | :approvedAsAffiliateAt
32
+
33
+ attr_accessor coverage_start_at: Integer?
34
+ attr_accessor metric_contract_version: Integer
35
+ attr_accessor program_type: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::program_type
36
+ attr_accessor timezone: String
37
+ attr_accessor cohort_interval: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::cohort_interval
38
+ attr_accessor observation_window_days: Integer
39
+ attr_accessor portal_viewed_label: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::portal_viewed_label
40
+ attr_accessor portal_viewed_helper_text: String
41
+ attr_accessor aggregate: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortResult
42
+ attr_accessor cohorts: ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortResult]
43
+ def initialize: (**untyped) -> void
44
+
45
+ module ProgramType
46
+ extend GrowsurfRuby::Internal::Type::Enum
47
+ REFERRAL: :REFERRAL
48
+ AFFILIATE: :AFFILIATE
49
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::program_type]
50
+ end
51
+
52
+ module CohortInterval
53
+ extend GrowsurfRuby::Internal::Type::Enum
54
+ DAY: :day
55
+ WEEK: :week
56
+ MONTH: :month
57
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::cohort_interval]
58
+ end
59
+
60
+ module PortalViewedLabel
61
+ extend GrowsurfRuby::Internal::Type::Enum
62
+ REFERRAL: :"Referral portal viewed"
63
+ AFFILIATE: :"Affiliate portal viewed"
64
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::portal_viewed_label]
65
+ end
66
+
67
+ module StageKey
68
+ extend GrowsurfRuby::Internal::Type::Enum
69
+ ELIGIBLE: :ELIGIBLE
70
+ PORTAL_VIEWED: :PORTAL_VIEWED
71
+ SHARE_ACTION: :SHARE_ACTION
72
+ UNIQUE_REFERRAL_VISIT: :UNIQUE_REFERRAL_VISIT
73
+ LEAD: :LEAD
74
+ CREDITED_REFERRAL: :CREDITED_REFERRAL
75
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stage_key]
76
+ end
77
+
78
+ module StalledSegmentKey
79
+ extend GrowsurfRuby::Internal::Type::Enum
80
+ ELIGIBLE_NO_PORTAL_VIEW: :ELIGIBLE_NO_PORTAL_VIEW
81
+ PORTAL_VIEWED_NO_SHARE_ACTION: :PORTAL_VIEWED_NO_SHARE_ACTION
82
+ SHARED_NO_UNIQUE_REFERRAL_VISIT: :SHARED_NO_UNIQUE_REFERRAL_VISIT
83
+ UNIQUE_VISIT_NO_LEAD: :UNIQUE_VISIT_NO_LEAD
84
+ LEAD_NO_CREDITED_REFERRAL: :LEAD_NO_CREDITED_REFERRAL
85
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_key]
86
+ end
87
+
88
+
89
+ module StalledSegmentFromStage
90
+ extend GrowsurfRuby::Internal::Type::Enum
91
+ ELIGIBLE: :ELIGIBLE
92
+ PORTAL_VIEWED: :PORTAL_VIEWED
93
+ SHARE_ACTION: :SHARE_ACTION
94
+ UNIQUE_REFERRAL_VISIT: :UNIQUE_REFERRAL_VISIT
95
+ LEAD: :LEAD
96
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_from_stage]
97
+ end
98
+
99
+ module StalledSegmentToStage
100
+ extend GrowsurfRuby::Internal::Type::Enum
101
+ PORTAL_VIEWED: :PORTAL_VIEWED
102
+ SHARE_ACTION: :SHARE_ACTION
103
+ UNIQUE_REFERRAL_VISIT: :UNIQUE_REFERRAL_VISIT
104
+ LEAD: :LEAD
105
+ CREDITED_REFERRAL: :CREDITED_REFERRAL
106
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_to_stage]
107
+ end
108
+
109
+ module ImprovementAreaKey
110
+ extend GrowsurfRuby::Internal::Type::Enum
111
+ PORTAL_ACCESS: :PORTAL_ACCESS
112
+ SHARING_EXPERIENCE: :SHARING_EXPERIENCE
113
+ SHARE_EFFECTIVENESS: :SHARE_EFFECTIVENESS
114
+ VISITOR_SIGNUP: :VISITOR_SIGNUP
115
+ ATTRIBUTION_AND_QUALIFICATION: :ATTRIBUTION_AND_QUALIFICATION
116
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::improvement_area_key]
117
+ end
118
+
119
+ module AnchorField
120
+ extend GrowsurfRuby::Internal::Type::Enum
121
+ ENROLLED_AS_ADVOCATE_AT: :enrolledAsAdvocateAt
122
+ APPROVED_AS_AFFILIATE_AT: :approvedAsAffiliateAt
123
+ def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::anchor_field]
124
+ end
125
+
126
+ class Stage < GrowsurfRuby::Internal::Type::BaseModel
127
+ attr_accessor key: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stage_key
128
+ attr_accessor count: Integer
129
+ attr_accessor conversion_rate_from_prior: Float?
130
+ attr_accessor conversion_rate_from_eligible: Float?
131
+ attr_accessor drop_off_count: Integer?
132
+ attr_accessor drop_off_rate: Float?
133
+ attr_accessor median_time_to_stage_ms: Float?
134
+ attr_accessor stalled_segment_key: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_key?
135
+ def initialize: (**untyped) -> void
136
+ end
137
+
138
+ class StageCounts < GrowsurfRuby::Internal::Type::BaseModel
139
+ attr_accessor eligible: Integer
140
+ attr_accessor portal_viewed: Integer
141
+ attr_accessor share_action: Integer
142
+ attr_accessor unique_referral_visit: Integer
143
+ attr_accessor lead: Integer
144
+ attr_accessor credited_referral: Integer
145
+ def initialize: (**untyped) -> void
146
+ end
147
+
148
+ class StalledSegment < GrowsurfRuby::Internal::Type::BaseModel
149
+ attr_accessor key: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_key
150
+ attr_accessor from_stage: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_from_stage
151
+ attr_accessor to_stage: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::stalled_segment_to_stage
152
+ attr_accessor count: Integer
153
+ def initialize: (**untyped) -> void
154
+ end
155
+
156
+ class OutcomeCount < GrowsurfRuby::Internal::Type::BaseModel
157
+ attr_accessor count: Integer
158
+ def initialize: (**untyped) -> void
159
+ end
160
+
161
+ class Outcomes < GrowsurfRuby::Internal::Type::BaseModel
162
+ attr_accessor first_reward: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::OutcomeCount?
163
+ attr_accessor first_commission: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::OutcomeCount?
164
+ attr_accessor payout_setup_completed: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::OutcomeCount?
165
+ def initialize: (**untyped) -> void
166
+ end
167
+
168
+ class LargestDrop < GrowsurfRuby::Internal::Type::BaseModel
169
+ attr_accessor from_stage: String
170
+ attr_accessor to_stage: String
171
+ attr_accessor count: Integer
172
+ attr_accessor rate: Float
173
+ attr_accessor stalled_segment_key: String
174
+ attr_accessor improvement_area_key: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::improvement_area_key
175
+ attr_accessor improvement_area: String
176
+ def initialize: (**untyped) -> void
177
+ end
178
+
179
+ class CohortBounds < GrowsurfRuby::Internal::Type::BaseModel
180
+ attr_accessor from: Integer
181
+ attr_accessor to: Integer
182
+ attr_accessor effective_from: Integer?
183
+ attr_accessor matured_at: Integer
184
+ attr_accessor as_of: Integer
185
+ attr_accessor anchor_field: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::anchor_field
186
+ def initialize: (**untyped) -> void
187
+ end
188
+
189
+ class CohortResult < GrowsurfRuby::Internal::Type::BaseModel
190
+ attr_accessor state: GrowsurfRuby::Models::analytics_availability
191
+ attr_accessor reason: GrowsurfRuby::Models::analytics_unavailable_reason?
192
+ attr_accessor cohort: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::CohortBounds
193
+ attr_accessor strict_stages: ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::Stage]?
194
+ attr_accessor raw_stage_counts: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::StageCounts?
195
+ attr_accessor stalled_segments: ::Array[GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::StalledSegment]?
196
+ attr_accessor outcomes: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::Outcomes?
197
+ attr_accessor largest_drop: GrowsurfRuby::Models::CampaignActivationAnalyticsResponse::LargestDrop?
198
+ def initialize: (**untyped) -> void
199
+ end
200
+ end
201
+ end
202
+ end