growsurf-ruby 0.8.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +18 -0
- data/README.md +1 -1
- data/lib/growsurf_ruby/client.rb +4 -0
- data/lib/growsurf_ruby/models/account.rb +90 -0
- data/lib/growsurf_ruby/models/account_create_params.rb +46 -0
- data/lib/growsurf_ruby/models/account_create_response.rb +64 -0
- data/lib/growsurf_ruby/models/account_resend_verification_email_response.rb +33 -0
- data/lib/growsurf_ruby/models/account_rotate_api_key_response.rb +17 -0
- data/lib/growsurf_ruby/models/account_update_params.rb +35 -0
- data/lib/growsurf_ruby/models/campaign/campaign_reward_list_response.rb +2 -2
- data/lib/growsurf_ruby/models/campaign/create.rb +5 -1
- data/lib/growsurf_ruby/models/campaign/participant_activity_logs_response.rb +65 -0
- data/lib/growsurf_ruby/models/campaign/participant_analytics_response.rb +421 -0
- data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_params.rb +35 -0
- data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_response.rb +151 -0
- data/lib/growsurf_ruby/models/campaign/participant_email_params.rb +76 -0
- data/lib/growsurf_ruby/models/campaign/participant_email_response.rb +38 -0
- data/lib/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rb +46 -0
- data/lib/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rb +98 -0
- data/lib/growsurf_ruby/models/campaign/participant_update_params.rb +21 -1
- data/lib/growsurf_ruby/models/campaign/reward.rb +43 -5
- data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +48 -15
- data/lib/growsurf_ruby/models/campaign/reward_delete_params.rb +4 -4
- data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +51 -18
- data/lib/growsurf_ruby/models/campaign/webhook.rb +72 -0
- data/lib/growsurf_ruby/models/campaign/webhook_create_params.rb +52 -0
- data/lib/growsurf_ruby/models/campaign/webhook_delete_params.rb +28 -0
- data/lib/growsurf_ruby/models/campaign/webhook_delete_response.rb +24 -0
- data/lib/growsurf_ruby/models/campaign/webhook_event.rb +23 -0
- data/lib/growsurf_ruby/models/campaign/webhook_list_response.rb +18 -0
- data/lib/growsurf_ruby/models/campaign/webhook_test_params.rb +42 -0
- data/lib/growsurf_ruby/models/campaign/webhook_test_response.rb +50 -0
- data/lib/growsurf_ruby/models/campaign/webhook_update_params.rb +59 -0
- data/lib/growsurf_ruby/models/campaign.rb +43 -5
- data/lib/growsurf_ruby/models/campaign_create_params.rb +1 -15
- data/lib/growsurf_ruby/models/campaign_retrieve_analytics_params.rb +36 -1
- data/lib/growsurf_ruby/models/campaign_retrieve_analytics_response.rb +538 -1
- data/lib/growsurf_ruby/models/campaign_update_params.rb +1 -53
- data/lib/growsurf_ruby/models/commission_structure.rb +8 -2
- data/lib/growsurf_ruby/models/referral_flow_screenshots_response.rb +72 -0
- data/lib/growsurf_ruby/models/reward_tax_valuation.rb +35 -0
- data/lib/growsurf_ruby/models.rb +10 -0
- data/lib/growsurf_ruby/resources/account.rb +159 -0
- data/lib/growsurf_ruby/resources/campaign/design.rb +68 -0
- data/lib/growsurf_ruby/resources/campaign/emails.rb +66 -0
- data/lib/growsurf_ruby/resources/campaign/installation.rb +67 -0
- data/lib/growsurf_ruby/resources/campaign/options.rb +66 -0
- data/lib/growsurf_ruby/resources/campaign/participant.rb +170 -2
- data/lib/growsurf_ruby/resources/campaign/rewards.rb +36 -32
- data/lib/growsurf_ruby/resources/campaign/webhooks.rb +157 -0
- data/lib/growsurf_ruby/resources/campaign.rb +62 -27
- data/lib/growsurf_ruby/version.rb +1 -1
- data/lib/growsurf_ruby.rb +31 -0
- data/rbi/growsurf_ruby/client.rbi +3 -0
- data/rbi/growsurf_ruby/models/account.rbi +125 -0
- data/rbi/growsurf_ruby/models/account_create_params.rbi +73 -0
- data/rbi/growsurf_ruby/models/account_create_response.rbi +115 -0
- data/rbi/growsurf_ruby/models/account_resend_verification_email_response.rbi +76 -0
- data/rbi/growsurf_ruby/models/account_rotate_api_key_response.rbi +30 -0
- data/rbi/growsurf_ruby/models/account_update_params.rbi +65 -0
- data/rbi/growsurf_ruby/models/campaign/campaign_reward_list_response.rbi +2 -2
- data/rbi/growsurf_ruby/models/campaign/create.rbi +8 -0
- data/rbi/growsurf_ruby/models/campaign/participant_activity_logs_response.rbi +111 -0
- data/rbi/growsurf_ruby/models/campaign/participant_analytics_response.rbi +630 -0
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbi +56 -0
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +285 -0
- data/rbi/growsurf_ruby/models/campaign/participant_email_params.rbi +118 -0
- data/rbi/growsurf_ruby/models/campaign/participant_email_response.rbi +84 -0
- data/rbi/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rbi +74 -0
- data/rbi/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbi +207 -0
- data/rbi/growsurf_ruby/models/campaign/participant_update_params.rbi +24 -0
- data/rbi/growsurf_ruby/models/campaign/reward.rbi +63 -3
- data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +62 -9
- data/rbi/growsurf_ruby/models/campaign/reward_delete_params.rbi +4 -4
- data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +66 -13
- data/rbi/growsurf_ruby/models/campaign/webhook.rbi +93 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_create_params.rbi +91 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_delete_params.rbi +48 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_delete_response.rbi +33 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_event.rbi +60 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_list_response.rbi +36 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_test_params.rbi +69 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_test_response.rbi +102 -0
- data/rbi/growsurf_ruby/models/campaign/webhook_update_params.rbi +98 -0
- data/rbi/growsurf_ruby/models/campaign.rbi +63 -3
- data/rbi/growsurf_ruby/models/campaign_create_params.rbi +0 -18
- data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_params.rbi +91 -0
- data/rbi/growsurf_ruby/models/campaign_retrieve_analytics_response.rbi +1011 -3
- data/rbi/growsurf_ruby/models/campaign_update_params.rbi +0 -78
- data/rbi/growsurf_ruby/models/commission_structure.rbi +8 -2
- data/rbi/growsurf_ruby/models/referral_flow_screenshots_response.rbi +94 -0
- data/rbi/growsurf_ruby/models/reward_tax_valuation.rbi +56 -0
- data/rbi/growsurf_ruby/models.rbi +11 -0
- data/rbi/growsurf_ruby/resources/account.rbi +112 -0
- data/rbi/growsurf_ruby/resources/campaign/design.rbi +52 -0
- data/rbi/growsurf_ruby/resources/campaign/emails.rbi +51 -0
- data/rbi/growsurf_ruby/resources/campaign/installation.rbi +53 -0
- data/rbi/growsurf_ruby/resources/campaign/options.rbi +51 -0
- data/rbi/growsurf_ruby/resources/campaign/participant.rbi +160 -0
- data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +61 -29
- data/rbi/growsurf_ruby/resources/campaign/webhooks.rbi +123 -0
- data/rbi/growsurf_ruby/resources/campaign.rbi +58 -32
- data/sig/growsurf_ruby/client.rbs +2 -0
- data/sig/growsurf_ruby/models/account.rbs +67 -0
- data/sig/growsurf_ruby/models/account_create_params.rbs +42 -0
- data/sig/growsurf_ruby/models/account_create_response.rbs +47 -0
- data/sig/growsurf_ruby/models/account_resend_verification_email_response.rbs +35 -0
- data/sig/growsurf_ruby/models/account_rotate_api_key_response.rbs +13 -0
- data/sig/growsurf_ruby/models/account_update_params.rbs +42 -0
- data/sig/growsurf_ruby/models/campaign/participant_activity_logs_response.rbs +59 -0
- data/sig/growsurf_ruby/models/campaign/participant_analytics_response.rbs +407 -0
- data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_params.rbs +30 -0
- data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbs +125 -0
- data/sig/growsurf_ruby/models/campaign/participant_email_params.rbs +61 -0
- data/sig/growsurf_ruby/models/campaign/participant_email_response.rbs +37 -0
- data/sig/growsurf_ruby/models/campaign/participant_list_activity_logs_params.rbs +47 -0
- data/sig/growsurf_ruby/models/campaign/participant_retrieve_analytics_params.rbs +90 -0
- data/sig/growsurf_ruby/models/campaign/participant_update_params.rbs +14 -0
- data/sig/growsurf_ruby/models/campaign/reward.rbs +18 -3
- data/sig/growsurf_ruby/models/campaign/reward_create_params.rbs +19 -8
- data/sig/growsurf_ruby/models/campaign/reward_delete_params.rbs +4 -4
- data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +23 -12
- data/sig/growsurf_ruby/models/campaign/webhook.rbs +52 -0
- data/sig/growsurf_ruby/models/campaign/webhook_create_params.rbs +51 -0
- data/sig/growsurf_ruby/models/campaign/webhook_delete_params.rbs +30 -0
- data/sig/growsurf_ruby/models/campaign/webhook_delete_response.rbs +17 -0
- data/sig/growsurf_ruby/models/campaign/webhook_event.rbs +28 -0
- data/sig/growsurf_ruby/models/campaign/webhook_list_response.rbs +18 -0
- data/sig/growsurf_ruby/models/campaign/webhook_test_params.rbs +42 -0
- data/sig/growsurf_ruby/models/campaign/webhook_test_response.rbs +54 -0
- data/sig/growsurf_ruby/models/campaign/webhook_update_params.rbs +63 -0
- data/sig/growsurf_ruby/models/campaign.rbs +18 -3
- data/sig/growsurf_ruby/models/campaign_create_params.rbs +0 -14
- data/sig/growsurf_ruby/models/campaign_retrieve_analytics_params.rbs +35 -1
- data/sig/growsurf_ruby/models/campaign_retrieve_analytics_response.rbs +533 -3
- data/sig/growsurf_ruby/models/campaign_update_params.rbs +1 -53
- data/sig/growsurf_ruby/models/commission_structure.rbs +7 -2
- data/sig/growsurf_ruby/models/referral_flow_screenshots_response.rbs +54 -0
- data/sig/growsurf_ruby/models/reward_tax_valuation.rbs +22 -0
- data/sig/growsurf_ruby/models.rbs +10 -0
- data/sig/growsurf_ruby/resources/account.rbs +38 -0
- data/sig/growsurf_ruby/resources/campaign/design.rbs +20 -0
- data/sig/growsurf_ruby/resources/campaign/emails.rbs +20 -0
- data/sig/growsurf_ruby/resources/campaign/installation.rbs +20 -0
- data/sig/growsurf_ruby/resources/campaign/options.rbs +20 -0
- data/sig/growsurf_ruby/resources/campaign/participant.rbs +37 -0
- data/sig/growsurf_ruby/resources/campaign/rewards.rbs +6 -4
- data/sig/growsurf_ruby/resources/campaign/webhooks.rbs +46 -0
- data/sig/growsurf_ruby/resources/campaign.rbs +17 -9
- metadata +95 -2
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type participant_retrieve_analytics_params =
|
|
5
|
+
{
|
|
6
|
+
id: String,
|
|
7
|
+
participant_id_or_email: String,
|
|
8
|
+
days: Integer,
|
|
9
|
+
end_date: Integer,
|
|
10
|
+
include: :series,
|
|
11
|
+
interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
|
|
12
|
+
start_date: Integer
|
|
13
|
+
}
|
|
14
|
+
& GrowsurfRuby::Internal::Type::request_parameters
|
|
15
|
+
|
|
16
|
+
class ParticipantRetrieveAnalyticsParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
17
|
+
extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
|
|
18
|
+
include GrowsurfRuby::Internal::Type::RequestParameters
|
|
19
|
+
|
|
20
|
+
attr_accessor id: String
|
|
21
|
+
|
|
22
|
+
attr_accessor participant_id_or_email: String
|
|
23
|
+
|
|
24
|
+
attr_reader days: Integer?
|
|
25
|
+
|
|
26
|
+
def days=: (Integer) -> Integer
|
|
27
|
+
|
|
28
|
+
attr_reader end_date: Integer?
|
|
29
|
+
|
|
30
|
+
def end_date=: (Integer) -> Integer
|
|
31
|
+
|
|
32
|
+
attr_reader include: :series?
|
|
33
|
+
|
|
34
|
+
def include=: (:series) -> :series
|
|
35
|
+
|
|
36
|
+
attr_reader interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval?
|
|
37
|
+
|
|
38
|
+
def interval=: (
|
|
39
|
+
GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval
|
|
40
|
+
) -> GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval
|
|
41
|
+
|
|
42
|
+
attr_reader start_date: Integer?
|
|
43
|
+
|
|
44
|
+
def start_date=: (Integer) -> Integer
|
|
45
|
+
|
|
46
|
+
def initialize: (
|
|
47
|
+
id: String,
|
|
48
|
+
participant_id_or_email: String,
|
|
49
|
+
?days: Integer,
|
|
50
|
+
?end_date: Integer,
|
|
51
|
+
?include: :series,
|
|
52
|
+
?interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
|
|
53
|
+
?start_date: Integer,
|
|
54
|
+
?request_options: GrowsurfRuby::request_opts
|
|
55
|
+
) -> void
|
|
56
|
+
|
|
57
|
+
def to_hash: -> {
|
|
58
|
+
id: String,
|
|
59
|
+
participant_id_or_email: String,
|
|
60
|
+
days: Integer,
|
|
61
|
+
end_date: Integer,
|
|
62
|
+
include: :series,
|
|
63
|
+
interval: GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval,
|
|
64
|
+
start_date: Integer,
|
|
65
|
+
request_options: GrowsurfRuby::RequestOptions
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
module Include
|
|
69
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
70
|
+
|
|
71
|
+
SERIES: :series
|
|
72
|
+
|
|
73
|
+
def self?.values: -> ::Array[:series]
|
|
74
|
+
end
|
|
75
|
+
|
|
76
|
+
type interval = :day | :week | :month
|
|
77
|
+
|
|
78
|
+
module Interval
|
|
79
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
80
|
+
|
|
81
|
+
DAY: :day
|
|
82
|
+
WEEK: :week
|
|
83
|
+
MONTH: :month
|
|
84
|
+
|
|
85
|
+
def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::ParticipantRetrieveAnalyticsParams::interval]
|
|
86
|
+
end
|
|
87
|
+
end
|
|
88
|
+
end
|
|
89
|
+
end
|
|
90
|
+
end
|
|
@@ -9,6 +9,8 @@ module GrowsurfRuby
|
|
|
9
9
|
first_name: String,
|
|
10
10
|
last_name: String,
|
|
11
11
|
metadata: ::Hash[Symbol, top],
|
|
12
|
+
notes: String,
|
|
13
|
+
paypal_email: String,
|
|
12
14
|
referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
|
|
13
15
|
referred_by: String,
|
|
14
16
|
unsubscribed: bool,
|
|
@@ -40,6 +42,14 @@ module GrowsurfRuby
|
|
|
40
42
|
|
|
41
43
|
def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
|
|
42
44
|
|
|
45
|
+
attr_reader notes: String?
|
|
46
|
+
|
|
47
|
+
def notes=: (String) -> String
|
|
48
|
+
|
|
49
|
+
attr_reader paypal_email: String?
|
|
50
|
+
|
|
51
|
+
def paypal_email=: (String) -> String
|
|
52
|
+
|
|
43
53
|
attr_reader referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status?
|
|
44
54
|
|
|
45
55
|
def referral_status=: (
|
|
@@ -65,6 +75,8 @@ module GrowsurfRuby
|
|
|
65
75
|
?first_name: String,
|
|
66
76
|
?last_name: String,
|
|
67
77
|
?metadata: ::Hash[Symbol, top],
|
|
78
|
+
?notes: String,
|
|
79
|
+
?paypal_email: String,
|
|
68
80
|
?referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
|
|
69
81
|
?referred_by: String,
|
|
70
82
|
?unsubscribed: bool,
|
|
@@ -79,6 +91,8 @@ module GrowsurfRuby
|
|
|
79
91
|
first_name: String,
|
|
80
92
|
last_name: String,
|
|
81
93
|
metadata: ::Hash[Symbol, top],
|
|
94
|
+
notes: String,
|
|
95
|
+
paypal_email: String,
|
|
82
96
|
referral_status: GrowsurfRuby::Models::Campaign::ParticipantUpdateParams::referral_status,
|
|
83
97
|
referred_by: String,
|
|
84
98
|
unsubscribed: bool,
|
|
@@ -18,8 +18,11 @@ module GrowsurfRuby
|
|
|
18
18
|
next_milestone_suffix: String?,
|
|
19
19
|
number_of_winners: Integer?,
|
|
20
20
|
order: Integer?,
|
|
21
|
+
referral_coupon_code: String?,
|
|
21
22
|
referral_description: String?,
|
|
22
|
-
referred_reward_upfront: bool
|
|
23
|
+
referred_reward_upfront: bool,
|
|
24
|
+
referred_value: GrowsurfRuby::RewardTaxValuation?,
|
|
25
|
+
value: GrowsurfRuby::RewardTaxValuation?
|
|
23
26
|
}
|
|
24
27
|
|
|
25
28
|
class Reward < GrowsurfRuby::Internal::Type::BaseModel
|
|
@@ -53,12 +56,18 @@ module GrowsurfRuby
|
|
|
53
56
|
|
|
54
57
|
attr_accessor order: Integer?
|
|
55
58
|
|
|
59
|
+
attr_accessor referral_coupon_code: String?
|
|
60
|
+
|
|
56
61
|
attr_accessor referral_description: String?
|
|
57
62
|
|
|
58
63
|
attr_reader referred_reward_upfront: bool?
|
|
59
64
|
|
|
60
65
|
def referred_reward_upfront=: (bool) -> bool
|
|
61
66
|
|
|
67
|
+
attr_accessor referred_value: GrowsurfRuby::RewardTaxValuation?
|
|
68
|
+
|
|
69
|
+
attr_accessor value: GrowsurfRuby::RewardTaxValuation?
|
|
70
|
+
|
|
62
71
|
def initialize: (
|
|
63
72
|
id: String,
|
|
64
73
|
is_unlimited: bool,
|
|
@@ -75,8 +84,11 @@ module GrowsurfRuby
|
|
|
75
84
|
?next_milestone_suffix: String?,
|
|
76
85
|
?number_of_winners: Integer?,
|
|
77
86
|
?order: Integer?,
|
|
87
|
+
?referral_coupon_code: String?,
|
|
78
88
|
?referral_description: String?,
|
|
79
|
-
?referred_reward_upfront: bool
|
|
89
|
+
?referred_reward_upfront: bool,
|
|
90
|
+
?referred_value: GrowsurfRuby::RewardTaxValuation?,
|
|
91
|
+
?value: GrowsurfRuby::RewardTaxValuation?
|
|
80
92
|
) -> void
|
|
81
93
|
|
|
82
94
|
def to_hash: -> {
|
|
@@ -95,8 +107,11 @@ module GrowsurfRuby
|
|
|
95
107
|
next_milestone_suffix: String?,
|
|
96
108
|
number_of_winners: Integer?,
|
|
97
109
|
order: Integer?,
|
|
110
|
+
referral_coupon_code: String?,
|
|
98
111
|
referral_description: String?,
|
|
99
|
-
referred_reward_upfront: bool
|
|
112
|
+
referred_reward_upfront: bool,
|
|
113
|
+
referred_value: GrowsurfRuby::RewardTaxValuation?,
|
|
114
|
+
value: GrowsurfRuby::RewardTaxValuation?
|
|
100
115
|
}
|
|
101
116
|
|
|
102
117
|
type type_ =
|
|
@@ -9,7 +9,6 @@ module GrowsurfRuby
|
|
|
9
9
|
coupon_code: String,
|
|
10
10
|
description: String,
|
|
11
11
|
image_url: String,
|
|
12
|
-
is_active: bool,
|
|
13
12
|
is_unlimited: bool,
|
|
14
13
|
is_visible: bool,
|
|
15
14
|
limit: Integer,
|
|
@@ -22,7 +21,9 @@ module GrowsurfRuby
|
|
|
22
21
|
referral_coupon_code: String,
|
|
23
22
|
referral_description: String,
|
|
24
23
|
referred_reward_upfront: bool,
|
|
25
|
-
|
|
24
|
+
referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
25
|
+
title: String,
|
|
26
|
+
value: GrowsurfRuby::RewardTaxValuation
|
|
26
27
|
}
|
|
27
28
|
& GrowsurfRuby::Internal::Type::request_parameters
|
|
28
29
|
|
|
@@ -54,10 +55,6 @@ module GrowsurfRuby
|
|
|
54
55
|
|
|
55
56
|
def image_url=: (String) -> String
|
|
56
57
|
|
|
57
|
-
attr_reader is_active: bool?
|
|
58
|
-
|
|
59
|
-
def is_active=: (bool) -> bool
|
|
60
|
-
|
|
61
58
|
attr_reader is_unlimited: bool?
|
|
62
59
|
|
|
63
60
|
def is_unlimited=: (bool) -> bool
|
|
@@ -108,10 +105,22 @@ module GrowsurfRuby
|
|
|
108
105
|
|
|
109
106
|
def referred_reward_upfront=: (bool) -> bool
|
|
110
107
|
|
|
108
|
+
attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
|
|
109
|
+
|
|
110
|
+
def referred_value=: (
|
|
111
|
+
GrowsurfRuby::RewardTaxValuation
|
|
112
|
+
) -> GrowsurfRuby::RewardTaxValuation
|
|
113
|
+
|
|
111
114
|
attr_reader title: String?
|
|
112
115
|
|
|
113
116
|
def title=: (String) -> String
|
|
114
117
|
|
|
118
|
+
attr_reader value: GrowsurfRuby::RewardTaxValuation?
|
|
119
|
+
|
|
120
|
+
def value=: (
|
|
121
|
+
GrowsurfRuby::RewardTaxValuation
|
|
122
|
+
) -> GrowsurfRuby::RewardTaxValuation
|
|
123
|
+
|
|
115
124
|
def initialize: (
|
|
116
125
|
type: GrowsurfRuby::Models::Campaign::RewardCreateParams::type_,
|
|
117
126
|
?commission_structure: GrowsurfRuby::CommissionStructure,
|
|
@@ -119,7 +128,6 @@ module GrowsurfRuby
|
|
|
119
128
|
?coupon_code: String,
|
|
120
129
|
?description: String,
|
|
121
130
|
?image_url: String,
|
|
122
|
-
?is_active: bool,
|
|
123
131
|
?is_unlimited: bool,
|
|
124
132
|
?is_visible: bool,
|
|
125
133
|
?limit: Integer,
|
|
@@ -132,7 +140,9 @@ module GrowsurfRuby
|
|
|
132
140
|
?referral_coupon_code: String,
|
|
133
141
|
?referral_description: String,
|
|
134
142
|
?referred_reward_upfront: bool,
|
|
143
|
+
?referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
135
144
|
?title: String,
|
|
145
|
+
?value: GrowsurfRuby::RewardTaxValuation,
|
|
136
146
|
?request_options: GrowsurfRuby::request_opts
|
|
137
147
|
) -> void
|
|
138
148
|
|
|
@@ -143,7 +153,6 @@ module GrowsurfRuby
|
|
|
143
153
|
coupon_code: String,
|
|
144
154
|
description: String,
|
|
145
155
|
image_url: String,
|
|
146
|
-
is_active: bool,
|
|
147
156
|
is_unlimited: bool,
|
|
148
157
|
is_visible: bool,
|
|
149
158
|
limit: Integer,
|
|
@@ -156,7 +165,9 @@ module GrowsurfRuby
|
|
|
156
165
|
referral_coupon_code: String,
|
|
157
166
|
referral_description: String,
|
|
158
167
|
referred_reward_upfront: bool,
|
|
168
|
+
referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
159
169
|
title: String,
|
|
170
|
+
value: GrowsurfRuby::RewardTaxValuation,
|
|
160
171
|
request_options: GrowsurfRuby::RequestOptions
|
|
161
172
|
}
|
|
162
173
|
|
|
@@ -2,7 +2,7 @@ module GrowsurfRuby
|
|
|
2
2
|
module Models
|
|
3
3
|
module Campaign
|
|
4
4
|
type reward_delete_params =
|
|
5
|
-
{ id: String,
|
|
5
|
+
{ id: String, campaign_reward_id: String }
|
|
6
6
|
& GrowsurfRuby::Internal::Type::request_parameters
|
|
7
7
|
|
|
8
8
|
class RewardDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
@@ -11,17 +11,17 @@ module GrowsurfRuby
|
|
|
11
11
|
|
|
12
12
|
attr_accessor id: String
|
|
13
13
|
|
|
14
|
-
attr_accessor
|
|
14
|
+
attr_accessor campaign_reward_id: String
|
|
15
15
|
|
|
16
16
|
def initialize: (
|
|
17
17
|
id: String,
|
|
18
|
-
|
|
18
|
+
campaign_reward_id: String,
|
|
19
19
|
?request_options: GrowsurfRuby::request_opts
|
|
20
20
|
) -> void
|
|
21
21
|
|
|
22
22
|
def to_hash: -> {
|
|
23
23
|
id: String,
|
|
24
|
-
|
|
24
|
+
campaign_reward_id: String,
|
|
25
25
|
request_options: GrowsurfRuby::RequestOptions
|
|
26
26
|
}
|
|
27
27
|
end
|
|
@@ -4,13 +4,12 @@ module GrowsurfRuby
|
|
|
4
4
|
type reward_update_params =
|
|
5
5
|
{
|
|
6
6
|
id: String,
|
|
7
|
-
|
|
7
|
+
campaign_reward_id: String,
|
|
8
8
|
commission_structure: GrowsurfRuby::CommissionStructure,
|
|
9
9
|
conversions_required: Integer,
|
|
10
10
|
coupon_code: String,
|
|
11
11
|
description: String,
|
|
12
12
|
image_url: String,
|
|
13
|
-
is_active: bool,
|
|
14
13
|
is_unlimited: bool,
|
|
15
14
|
is_visible: bool,
|
|
16
15
|
limit: Integer,
|
|
@@ -23,7 +22,9 @@ module GrowsurfRuby
|
|
|
23
22
|
referral_coupon_code: String,
|
|
24
23
|
referral_description: String,
|
|
25
24
|
referred_reward_upfront: bool,
|
|
26
|
-
|
|
25
|
+
referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
26
|
+
title: String,
|
|
27
|
+
value: GrowsurfRuby::RewardTaxValuation
|
|
27
28
|
}
|
|
28
29
|
& GrowsurfRuby::Internal::Type::request_parameters
|
|
29
30
|
|
|
@@ -33,7 +34,7 @@ module GrowsurfRuby
|
|
|
33
34
|
|
|
34
35
|
attr_accessor id: String
|
|
35
36
|
|
|
36
|
-
attr_accessor
|
|
37
|
+
attr_accessor campaign_reward_id: String
|
|
37
38
|
|
|
38
39
|
attr_reader commission_structure: GrowsurfRuby::CommissionStructure?
|
|
39
40
|
|
|
@@ -57,10 +58,6 @@ module GrowsurfRuby
|
|
|
57
58
|
|
|
58
59
|
def image_url=: (String) -> String
|
|
59
60
|
|
|
60
|
-
attr_reader is_active: bool?
|
|
61
|
-
|
|
62
|
-
def is_active=: (bool) -> bool
|
|
63
|
-
|
|
64
61
|
attr_reader is_unlimited: bool?
|
|
65
62
|
|
|
66
63
|
def is_unlimited=: (bool) -> bool
|
|
@@ -111,19 +108,30 @@ module GrowsurfRuby
|
|
|
111
108
|
|
|
112
109
|
def referred_reward_upfront=: (bool) -> bool
|
|
113
110
|
|
|
111
|
+
attr_reader referred_value: GrowsurfRuby::RewardTaxValuation?
|
|
112
|
+
|
|
113
|
+
def referred_value=: (
|
|
114
|
+
GrowsurfRuby::RewardTaxValuation
|
|
115
|
+
) -> GrowsurfRuby::RewardTaxValuation
|
|
116
|
+
|
|
114
117
|
attr_reader title: String?
|
|
115
118
|
|
|
116
119
|
def title=: (String) -> String
|
|
117
120
|
|
|
121
|
+
attr_reader value: GrowsurfRuby::RewardTaxValuation?
|
|
122
|
+
|
|
123
|
+
def value=: (
|
|
124
|
+
GrowsurfRuby::RewardTaxValuation
|
|
125
|
+
) -> GrowsurfRuby::RewardTaxValuation
|
|
126
|
+
|
|
118
127
|
def initialize: (
|
|
119
128
|
id: String,
|
|
120
|
-
|
|
129
|
+
campaign_reward_id: String,
|
|
121
130
|
?commission_structure: GrowsurfRuby::CommissionStructure,
|
|
122
131
|
?conversions_required: Integer,
|
|
123
132
|
?coupon_code: String,
|
|
124
133
|
?description: String,
|
|
125
134
|
?image_url: String,
|
|
126
|
-
?is_active: bool,
|
|
127
135
|
?is_unlimited: bool,
|
|
128
136
|
?is_visible: bool,
|
|
129
137
|
?limit: Integer,
|
|
@@ -136,19 +144,20 @@ module GrowsurfRuby
|
|
|
136
144
|
?referral_coupon_code: String,
|
|
137
145
|
?referral_description: String,
|
|
138
146
|
?referred_reward_upfront: bool,
|
|
147
|
+
?referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
139
148
|
?title: String,
|
|
149
|
+
?value: GrowsurfRuby::RewardTaxValuation,
|
|
140
150
|
?request_options: GrowsurfRuby::request_opts
|
|
141
151
|
) -> void
|
|
142
152
|
|
|
143
153
|
def to_hash: -> {
|
|
144
154
|
id: String,
|
|
145
|
-
|
|
155
|
+
campaign_reward_id: String,
|
|
146
156
|
commission_structure: GrowsurfRuby::CommissionStructure,
|
|
147
157
|
conversions_required: Integer,
|
|
148
158
|
coupon_code: String,
|
|
149
159
|
description: String,
|
|
150
160
|
image_url: String,
|
|
151
|
-
is_active: bool,
|
|
152
161
|
is_unlimited: bool,
|
|
153
162
|
is_visible: bool,
|
|
154
163
|
limit: Integer,
|
|
@@ -161,7 +170,9 @@ module GrowsurfRuby
|
|
|
161
170
|
referral_coupon_code: String,
|
|
162
171
|
referral_description: String,
|
|
163
172
|
referred_reward_upfront: bool,
|
|
173
|
+
referred_value: GrowsurfRuby::RewardTaxValuation,
|
|
164
174
|
title: String,
|
|
175
|
+
value: GrowsurfRuby::RewardTaxValuation,
|
|
165
176
|
request_options: GrowsurfRuby::RequestOptions
|
|
166
177
|
}
|
|
167
178
|
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook =
|
|
5
|
+
{
|
|
6
|
+
auto_disabled_due_to_failures: bool,
|
|
7
|
+
events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
8
|
+
failure_count: Integer,
|
|
9
|
+
id: String,
|
|
10
|
+
is_enabled: bool,
|
|
11
|
+
last_failure_at: Integer?,
|
|
12
|
+
payload_url: String?
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
class Webhook < GrowsurfRuby::Internal::Type::BaseModel
|
|
16
|
+
attr_accessor auto_disabled_due_to_failures: bool
|
|
17
|
+
|
|
18
|
+
attr_accessor events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event]
|
|
19
|
+
|
|
20
|
+
attr_accessor failure_count: Integer
|
|
21
|
+
|
|
22
|
+
attr_accessor id: String
|
|
23
|
+
|
|
24
|
+
attr_accessor is_enabled: bool
|
|
25
|
+
|
|
26
|
+
attr_accessor last_failure_at: Integer?
|
|
27
|
+
|
|
28
|
+
attr_accessor payload_url: String?
|
|
29
|
+
|
|
30
|
+
def initialize: (
|
|
31
|
+
auto_disabled_due_to_failures: bool,
|
|
32
|
+
events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
33
|
+
failure_count: Integer,
|
|
34
|
+
id: String,
|
|
35
|
+
is_enabled: bool,
|
|
36
|
+
?last_failure_at: Integer?,
|
|
37
|
+
?payload_url: String?
|
|
38
|
+
) -> void
|
|
39
|
+
|
|
40
|
+
def to_hash: -> {
|
|
41
|
+
auto_disabled_due_to_failures: bool,
|
|
42
|
+
events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
43
|
+
failure_count: Integer,
|
|
44
|
+
id: String,
|
|
45
|
+
is_enabled: bool,
|
|
46
|
+
last_failure_at: Integer?,
|
|
47
|
+
payload_url: String?
|
|
48
|
+
}
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
52
|
+
end
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_create_params =
|
|
5
|
+
{
|
|
6
|
+
payload_url: String,
|
|
7
|
+
events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
8
|
+
is_enabled: bool,
|
|
9
|
+
secret: String
|
|
10
|
+
}
|
|
11
|
+
& GrowsurfRuby::Internal::Type::request_parameters
|
|
12
|
+
|
|
13
|
+
class WebhookCreateParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
14
|
+
extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
|
|
15
|
+
include GrowsurfRuby::Internal::Type::RequestParameters
|
|
16
|
+
|
|
17
|
+
attr_accessor payload_url: String
|
|
18
|
+
|
|
19
|
+
attr_reader events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event]?
|
|
20
|
+
|
|
21
|
+
def events=: (
|
|
22
|
+
::Array[GrowsurfRuby::Models::Campaign::webhook_event]
|
|
23
|
+
) -> ::Array[GrowsurfRuby::Models::Campaign::webhook_event]
|
|
24
|
+
|
|
25
|
+
attr_reader is_enabled: bool?
|
|
26
|
+
|
|
27
|
+
def is_enabled=: (bool) -> bool
|
|
28
|
+
|
|
29
|
+
attr_reader secret: String?
|
|
30
|
+
|
|
31
|
+
def secret=: (String) -> String
|
|
32
|
+
|
|
33
|
+
def initialize: (
|
|
34
|
+
payload_url: String,
|
|
35
|
+
?events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
36
|
+
?is_enabled: bool,
|
|
37
|
+
?secret: String,
|
|
38
|
+
?request_options: GrowsurfRuby::request_opts
|
|
39
|
+
) -> void
|
|
40
|
+
|
|
41
|
+
def to_hash: -> {
|
|
42
|
+
payload_url: String,
|
|
43
|
+
events: ::Array[GrowsurfRuby::Models::Campaign::webhook_event],
|
|
44
|
+
is_enabled: bool,
|
|
45
|
+
secret: String,
|
|
46
|
+
request_options: GrowsurfRuby::RequestOptions
|
|
47
|
+
}
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_delete_params =
|
|
5
|
+
{ id: String, webhook_id: String }
|
|
6
|
+
& GrowsurfRuby::Internal::Type::request_parameters
|
|
7
|
+
|
|
8
|
+
class WebhookDeleteParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
9
|
+
extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
|
|
10
|
+
include GrowsurfRuby::Internal::Type::RequestParameters
|
|
11
|
+
|
|
12
|
+
attr_accessor id: String
|
|
13
|
+
|
|
14
|
+
attr_accessor webhook_id: String
|
|
15
|
+
|
|
16
|
+
def initialize: (
|
|
17
|
+
id: String,
|
|
18
|
+
webhook_id: String,
|
|
19
|
+
?request_options: GrowsurfRuby::request_opts
|
|
20
|
+
) -> void
|
|
21
|
+
|
|
22
|
+
def to_hash: -> {
|
|
23
|
+
id: String,
|
|
24
|
+
webhook_id: String,
|
|
25
|
+
request_options: GrowsurfRuby::RequestOptions
|
|
26
|
+
}
|
|
27
|
+
end
|
|
28
|
+
end
|
|
29
|
+
end
|
|
30
|
+
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_delete_response = { id: String, success: bool }
|
|
5
|
+
|
|
6
|
+
class WebhookDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
7
|
+
attr_accessor id: String
|
|
8
|
+
|
|
9
|
+
attr_accessor success: bool
|
|
10
|
+
|
|
11
|
+
def initialize: (id: String, success: bool) -> void
|
|
12
|
+
|
|
13
|
+
def to_hash: -> { id: String, success: bool }
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_event =
|
|
5
|
+
:PARTICIPANT_REACHED_A_GOAL
|
|
6
|
+
| :NEW_PARTICIPANT_ADDED
|
|
7
|
+
| :CAMPAIGN_ENDED
|
|
8
|
+
| :PARTICIPANT_FRAUD_STATUS_UPDATED
|
|
9
|
+
| :NEW_COMMISSION_ADDED
|
|
10
|
+
| :COMMISSION_ADJUSTED
|
|
11
|
+
| :NEW_PAYOUT_ISSUED
|
|
12
|
+
|
|
13
|
+
module WebhookEvent
|
|
14
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
15
|
+
|
|
16
|
+
PARTICIPANT_REACHED_A_GOAL: :PARTICIPANT_REACHED_A_GOAL
|
|
17
|
+
NEW_PARTICIPANT_ADDED: :NEW_PARTICIPANT_ADDED
|
|
18
|
+
CAMPAIGN_ENDED: :CAMPAIGN_ENDED
|
|
19
|
+
PARTICIPANT_FRAUD_STATUS_UPDATED: :PARTICIPANT_FRAUD_STATUS_UPDATED
|
|
20
|
+
NEW_COMMISSION_ADDED: :NEW_COMMISSION_ADDED
|
|
21
|
+
COMMISSION_ADJUSTED: :COMMISSION_ADJUSTED
|
|
22
|
+
NEW_PAYOUT_ISSUED: :NEW_PAYOUT_ISSUED
|
|
23
|
+
|
|
24
|
+
def self?.values: -> ::Array[GrowsurfRuby::Models::Campaign::webhook_event]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_list_response =
|
|
5
|
+
{ webhooks: ::Array[GrowsurfRuby::Campaign::Webhook] }
|
|
6
|
+
|
|
7
|
+
class WebhookListResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
8
|
+
attr_accessor webhooks: ::Array[GrowsurfRuby::Campaign::Webhook]
|
|
9
|
+
|
|
10
|
+
def initialize: (
|
|
11
|
+
webhooks: ::Array[GrowsurfRuby::Campaign::Webhook]
|
|
12
|
+
) -> void
|
|
13
|
+
|
|
14
|
+
def to_hash: -> { webhooks: ::Array[GrowsurfRuby::Campaign::Webhook] }
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type webhook_test_params =
|
|
5
|
+
{
|
|
6
|
+
id: String,
|
|
7
|
+
webhook_id: String,
|
|
8
|
+
event: GrowsurfRuby::Models::Campaign::webhook_event
|
|
9
|
+
}
|
|
10
|
+
& GrowsurfRuby::Internal::Type::request_parameters
|
|
11
|
+
|
|
12
|
+
class WebhookTestParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
13
|
+
extend GrowsurfRuby::Internal::Type::RequestParameters::Converter
|
|
14
|
+
include GrowsurfRuby::Internal::Type::RequestParameters
|
|
15
|
+
|
|
16
|
+
attr_accessor id: String
|
|
17
|
+
|
|
18
|
+
attr_accessor webhook_id: String
|
|
19
|
+
|
|
20
|
+
attr_reader event: GrowsurfRuby::Models::Campaign::webhook_event?
|
|
21
|
+
|
|
22
|
+
def event=: (
|
|
23
|
+
GrowsurfRuby::Models::Campaign::webhook_event
|
|
24
|
+
) -> GrowsurfRuby::Models::Campaign::webhook_event
|
|
25
|
+
|
|
26
|
+
def initialize: (
|
|
27
|
+
id: String,
|
|
28
|
+
webhook_id: String,
|
|
29
|
+
?event: GrowsurfRuby::Models::Campaign::webhook_event,
|
|
30
|
+
?request_options: GrowsurfRuby::request_opts
|
|
31
|
+
) -> void
|
|
32
|
+
|
|
33
|
+
def to_hash: -> {
|
|
34
|
+
id: String,
|
|
35
|
+
webhook_id: String,
|
|
36
|
+
event: GrowsurfRuby::Models::Campaign::webhook_event,
|
|
37
|
+
request_options: GrowsurfRuby::RequestOptions
|
|
38
|
+
}
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|