growsurf-ruby 1.0.0 → 1.1.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -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 +17 -6
- data/lib/growsurf_ruby/models/campaign/reward_create_params.rb +25 -15
- data/lib/growsurf_ruby/models/campaign/reward_update_params.rb +25 -15
- 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 +17 -6
- 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 +0 -3
- data/lib/growsurf_ruby/models/commission_structure.rb +8 -2
- data/lib/growsurf_ruby/models.rb +6 -0
- data/lib/growsurf_ruby/resources/account.rb +159 -0
- data/lib/growsurf_ruby/resources/campaign/design.rb +9 -7
- data/lib/growsurf_ruby/resources/campaign/emails.rb +8 -5
- data/lib/growsurf_ruby/resources/campaign/installation.rb +8 -6
- data/lib/growsurf_ruby/resources/campaign/options.rb +8 -5
- data/lib/growsurf_ruby/resources/campaign/participant.rb +170 -2
- data/lib/growsurf_ruby/resources/campaign/rewards.rb +17 -21
- data/lib/growsurf_ruby/resources/campaign/webhooks.rb +157 -0
- data/lib/growsurf_ruby/resources/campaign.rb +11 -2
- data/lib/growsurf_ruby/version.rb +1 -1
- data/lib/growsurf_ruby.rb +25 -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 +25 -4
- data/rbi/growsurf_ruby/models/campaign/reward_create_params.rbi +34 -9
- data/rbi/growsurf_ruby/models/campaign/reward_update_params.rbi +34 -9
- 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 +25 -4
- 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 -15
- data/rbi/growsurf_ruby/models/commission_structure.rbi +8 -2
- data/rbi/growsurf_ruby/models.rbi +6 -0
- data/rbi/growsurf_ruby/resources/account.rbi +112 -0
- data/rbi/growsurf_ruby/resources/campaign/design.rbi +7 -5
- data/rbi/growsurf_ruby/resources/campaign/emails.rbi +7 -5
- data/rbi/growsurf_ruby/resources/campaign/installation.rbi +7 -4
- data/rbi/growsurf_ruby/resources/campaign/options.rbi +7 -5
- data/rbi/growsurf_ruby/resources/campaign/participant.rbi +160 -0
- data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +37 -21
- data/rbi/growsurf_ruby/resources/campaign/webhooks.rbi +123 -0
- data/rbi/growsurf_ruby/resources/campaign.rbi +18 -2
- 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_create_params.rbs +0 -7
- data/sig/growsurf_ruby/models/campaign/reward_update_params.rbs +0 -7
- 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_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 -4
- data/sig/growsurf_ruby/models/commission_structure.rbs +7 -2
- data/sig/growsurf_ruby/models/reward_tax_valuation.rbs +4 -1
- data/sig/growsurf_ruby/models.rbs +6 -0
- data/sig/growsurf_ruby/resources/account.rbs +38 -0
- data/sig/growsurf_ruby/resources/campaign/participant.rbs +37 -0
- data/sig/growsurf_ruby/resources/campaign/rewards.rbs +0 -2
- data/sig/growsurf_ruby/resources/campaign/webhooks.rbs +46 -0
- data/sig/growsurf_ruby/resources/campaign.rbs +4 -0
- metadata +77 -2
|
@@ -32,6 +32,36 @@ module GrowsurfRuby
|
|
|
32
32
|
sig { params(end_date: Integer).void }
|
|
33
33
|
attr_writer :end_date
|
|
34
34
|
|
|
35
|
+
# Comma-separated list of optional enrichments (opt-in to keep the default response
|
|
36
|
+
# lean): `previousPeriod` adds totals for the equal-length window immediately before
|
|
37
|
+
# the requested one; `statusCounts` adds reward (and, for affiliate programs,
|
|
38
|
+
# affiliate/commission/payout) status breakdowns; `rates` adds derived referral
|
|
39
|
+
# rates.
|
|
40
|
+
sig { returns(T.nilable(String)) }
|
|
41
|
+
attr_reader :include
|
|
42
|
+
|
|
43
|
+
sig { params(include: String).void }
|
|
44
|
+
attr_writer :include
|
|
45
|
+
|
|
46
|
+
# When set to `day`, `week`, or `month`, the response also includes a `series` array
|
|
47
|
+
# with per-period totals. Defaults to `total` (no series).
|
|
48
|
+
sig do
|
|
49
|
+
returns(
|
|
50
|
+
T.nilable(
|
|
51
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol
|
|
52
|
+
)
|
|
53
|
+
)
|
|
54
|
+
end
|
|
55
|
+
attr_reader :interval
|
|
56
|
+
|
|
57
|
+
sig do
|
|
58
|
+
params(
|
|
59
|
+
interval:
|
|
60
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol
|
|
61
|
+
).void
|
|
62
|
+
end
|
|
63
|
+
attr_writer :interval
|
|
64
|
+
|
|
35
65
|
# Start date of the analytics timeframe as a Unix timestamp in milliseconds.
|
|
36
66
|
# Required if `days` is not set.
|
|
37
67
|
sig { returns(T.nilable(Integer)) }
|
|
@@ -45,6 +75,9 @@ module GrowsurfRuby
|
|
|
45
75
|
id: String,
|
|
46
76
|
days: Integer,
|
|
47
77
|
end_date: Integer,
|
|
78
|
+
include: String,
|
|
79
|
+
interval:
|
|
80
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
|
|
48
81
|
start_date: Integer,
|
|
49
82
|
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
50
83
|
).returns(T.attached_class)
|
|
@@ -56,6 +89,15 @@ module GrowsurfRuby
|
|
|
56
89
|
# End date of the analytics timeframe as a Unix timestamp in milliseconds.
|
|
57
90
|
# Required if `days` is not set.
|
|
58
91
|
end_date: nil,
|
|
92
|
+
# Comma-separated list of optional enrichments (opt-in to keep the default response
|
|
93
|
+
# lean): `previousPeriod` adds totals for the equal-length window immediately before
|
|
94
|
+
# the requested one; `statusCounts` adds reward (and, for affiliate programs,
|
|
95
|
+
# affiliate/commission/payout) status breakdowns; `rates` adds derived referral
|
|
96
|
+
# rates.
|
|
97
|
+
include: nil,
|
|
98
|
+
# When set to `day`, `week`, or `month`, the response also includes a `series` array
|
|
99
|
+
# with per-period totals. Defaults to `total` (no series).
|
|
100
|
+
interval: nil,
|
|
59
101
|
# Start date of the analytics timeframe as a Unix timestamp in milliseconds.
|
|
60
102
|
# Required if `days` is not set.
|
|
61
103
|
start_date: nil,
|
|
@@ -69,6 +111,9 @@ module GrowsurfRuby
|
|
|
69
111
|
id: String,
|
|
70
112
|
days: Integer,
|
|
71
113
|
end_date: Integer,
|
|
114
|
+
include: String,
|
|
115
|
+
interval:
|
|
116
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::OrSymbol,
|
|
72
117
|
start_date: Integer,
|
|
73
118
|
request_options: GrowsurfRuby::RequestOptions
|
|
74
119
|
}
|
|
@@ -76,6 +121,52 @@ module GrowsurfRuby
|
|
|
76
121
|
end
|
|
77
122
|
def to_hash
|
|
78
123
|
end
|
|
124
|
+
|
|
125
|
+
# When set to `day`, `week`, or `month`, the response also includes a `series` array
|
|
126
|
+
# with per-period totals. Defaults to `total` (no series).
|
|
127
|
+
module Interval
|
|
128
|
+
extend GrowsurfRuby::Internal::Type::Enum
|
|
129
|
+
|
|
130
|
+
TaggedSymbol =
|
|
131
|
+
T.type_alias do
|
|
132
|
+
T.all(
|
|
133
|
+
Symbol,
|
|
134
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval
|
|
135
|
+
)
|
|
136
|
+
end
|
|
137
|
+
OrSymbol = T.type_alias { T.any(Symbol, String) }
|
|
138
|
+
|
|
139
|
+
DAY =
|
|
140
|
+
T.let(
|
|
141
|
+
:day,
|
|
142
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
|
|
143
|
+
)
|
|
144
|
+
WEEK =
|
|
145
|
+
T.let(
|
|
146
|
+
:week,
|
|
147
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
|
|
148
|
+
)
|
|
149
|
+
MONTH =
|
|
150
|
+
T.let(
|
|
151
|
+
:month,
|
|
152
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
|
|
153
|
+
)
|
|
154
|
+
TOTAL =
|
|
155
|
+
T.let(
|
|
156
|
+
:total,
|
|
157
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
|
|
158
|
+
)
|
|
159
|
+
|
|
160
|
+
sig do
|
|
161
|
+
override.returns(
|
|
162
|
+
T::Array[
|
|
163
|
+
GrowsurfRuby::CampaignRetrieveAnalyticsParams::Interval::TaggedSymbol
|
|
164
|
+
]
|
|
165
|
+
)
|
|
166
|
+
end
|
|
167
|
+
def self.values
|
|
168
|
+
end
|
|
169
|
+
end
|
|
79
170
|
end
|
|
80
171
|
end
|
|
81
172
|
end
|