growsurf-ruby 1.13.0 → 1.13.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 +9 -0
- data/README.md +1 -1
- data/lib/growsurf_ruby/resources/campaign/design.rb +4 -0
- data/lib/growsurf_ruby/resources/campaign/emails.rb +4 -0
- data/lib/growsurf_ruby/resources/campaign/installation.rb +4 -0
- data/lib/growsurf_ruby/resources/campaign/options.rb +10 -5
- data/lib/growsurf_ruby/resources/campaign/rewards.rb +5 -0
- data/lib/growsurf_ruby/resources/campaign.rb +5 -0
- data/lib/growsurf_ruby/version.rb +1 -1
- data/rbi/growsurf_ruby/resources/campaign/design.rbi +4 -0
- data/rbi/growsurf_ruby/resources/campaign/emails.rbi +4 -0
- data/rbi/growsurf_ruby/resources/campaign/installation.rbi +4 -0
- data/rbi/growsurf_ruby/resources/campaign/options.rbi +10 -5
- data/rbi/growsurf_ruby/resources/campaign/rewards.rbi +5 -0
- data/rbi/growsurf_ruby/resources/campaign.rbi +5 -0
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: f6d2dc9919ceef21fe534f95e3b51189b4801902cb7d5b5e930145c3b38ab6d6
|
|
4
|
+
data.tar.gz: 0e63f2406c0c7767ea0fc0b22244ce13da2de1b93a34b1e19bc484de2fd72d02
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 223dd14d46675ed5fa185c8b75815d50eed2221bde317f2dbb20d11ba35f6d1d33b363af1e6a3b93c17bd0e9f080aa8443029db3dd25b6d9765a3e33545c4c30
|
|
7
|
+
data.tar.gz: d2d3d0de619f63a1786e63283d17ce998355e2834d1c976034ee579e502474a9951b989198cd99484abc988fe077e9ea35994124b75948f80c0be2da70810495
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,14 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.13.1](https://github.com/growsurf/growsurf-ruby/compare/v1.13.0...v1.13.1) (2026-10-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Documentation
|
|
7
|
+
|
|
8
|
+
* note Business plan covers any language change while languages are on ([10cb2ca](https://github.com/growsurf/growsurf-ruby/commit/10cb2ca8522e15e509b7a31774a7da0571859ebc))
|
|
9
|
+
* sync SDK comments with the REST API contract ([28ab4fd](https://github.com/growsurf/growsurf-ruby/commit/28ab4fddd5f58bb2234d018f10afdda047df3c00))
|
|
10
|
+
* sync SDK guidance with the REST API contract ([d2e01f5](https://github.com/growsurf/growsurf-ruby/commit/d2e01f53d729d54220b56c766160f15ff19e14d0))
|
|
11
|
+
|
|
3
12
|
## [1.13.0](https://github.com/growsurf/growsurf-ruby/compare/v1.12.0...v1.13.0) (2026-10-09)
|
|
4
13
|
|
|
5
14
|
|
data/README.md
CHANGED
|
@@ -44,6 +44,10 @@ module GrowsurfRuby
|
|
|
44
44
|
# anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
|
|
45
45
|
# Unknown fields, fields not available for the program type, and invalid values return a
|
|
46
46
|
# `400`. Landing-page custom code and JavaScript are not editable via the API.
|
|
47
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
48
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
49
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
50
|
+
# program before retrying.
|
|
47
51
|
#
|
|
48
52
|
# @overload update(id, body, request_options: {})
|
|
49
53
|
#
|
|
@@ -39,6 +39,10 @@ module GrowsurfRuby
|
|
|
39
39
|
# available for the program type returns a `400`. Some fields are read-only
|
|
40
40
|
# (`settings.sender.fromEmail`, whose custom value requires dashboard domain
|
|
41
41
|
# verification).
|
|
42
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
43
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
44
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
45
|
+
# program before retrying.
|
|
42
46
|
#
|
|
43
47
|
# @overload update(id, body, request_options: {})
|
|
44
48
|
#
|
|
@@ -32,6 +32,10 @@ module GrowsurfRuby
|
|
|
32
32
|
# enabling `mobile.isEnabled` creates one. Changing `shareUrl` re-resolves its
|
|
33
33
|
# redirect destinations, which may take a moment to complete. URLs must include an
|
|
34
34
|
# explicit `http://` or `https://` scheme.
|
|
35
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
36
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
37
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
38
|
+
# program before retrying.
|
|
35
39
|
#
|
|
36
40
|
# @overload update(id, body, request_options: {})
|
|
37
41
|
#
|
|
@@ -5,10 +5,10 @@ module GrowsurfRuby
|
|
|
5
5
|
class Campaign
|
|
6
6
|
class Options
|
|
7
7
|
# Retrieves a program's options — the same surface as the dashboard Program
|
|
8
|
-
# Editor's **Options** tab. Includes reward/fraud approval,
|
|
9
|
-
# toggles, referral cookie/credit windows, reCAPTCHA, affiliate
|
|
10
|
-
# application review, payout threshold + tax settings (affiliate
|
|
11
|
-
# notification-email settings, and the program's languages.
|
|
8
|
+
# Editor's **Options** tab. Includes the attribution model, reward/fraud approval,
|
|
9
|
+
# anti-fraud lists + toggles, referral cookie/credit windows, reCAPTCHA, affiliate
|
|
10
|
+
# enrollment + application review, payout threshold + tax settings (affiliate
|
|
11
|
+
# only), notification-email settings, and the program's languages.
|
|
12
12
|
# `fraud.recaptcha.secretKey` is never returned.
|
|
13
13
|
#
|
|
14
14
|
# @overload retrieve(id, request_options: {})
|
|
@@ -34,7 +34,12 @@ module GrowsurfRuby
|
|
|
34
34
|
# programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
|
|
35
35
|
# is write-only. `referralCreditWindowDays: null` means "never expires".
|
|
36
36
|
# Turning on `languages.additionalLanguages` requires the Business plan or
|
|
37
|
-
# higher
|
|
37
|
+
# higher. While any are on, every `languages` change, including turning them
|
|
38
|
+
# off, requires it too (`403` otherwise).
|
|
39
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
40
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
41
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
42
|
+
# program before retrying.
|
|
38
43
|
#
|
|
39
44
|
# @overload update(id, body, request_options: {})
|
|
40
45
|
#
|
|
@@ -31,6 +31,7 @@ module GrowsurfRuby
|
|
|
31
31
|
# Enabling an active reward of a type automatically enables that reward type on
|
|
32
32
|
# the program. For an affiliate reward, `commissionStructure.event: LEAD`
|
|
33
33
|
# requires a `FIXED` commission with a positive `amount`.
|
|
34
|
+
# A concurrent edit can return `409`; reload the program before retrying.
|
|
34
35
|
#
|
|
35
36
|
# @overload create(id, type:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
36
37
|
#
|
|
@@ -102,6 +103,10 @@ module GrowsurfRuby
|
|
|
102
103
|
# copy; removing a key that campaign copy still references returns a `409` listing
|
|
103
104
|
# the referencing fields. For an affiliate reward, `commissionStructure.event:
|
|
104
105
|
# LEAD` requires a `FIXED` commission with a positive `amount`.
|
|
106
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
107
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
108
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
109
|
+
# program before retrying.
|
|
105
110
|
#
|
|
106
111
|
# @overload update(campaign_reward_id, id:, commission_structure: nil, conversions_required: nil, coupon_code: nil, description: nil, event: nil, image_url: nil, is_unlimited: nil, is_visible: nil, limit: nil, limit_duration: nil, metadata: nil, next_milestone_prefix: nil, next_milestone_suffix: nil, number_of_winners: nil, order: nil, referral_coupon_code: nil, referral_description: nil, referred_reward_upfront: nil, referred_value: nil, title: nil, value: nil, request_options: {})
|
|
107
112
|
#
|
|
@@ -124,6 +124,10 @@ module GrowsurfRuby
|
|
|
124
124
|
# configuration (design, emails, options, installation) is edited via the
|
|
125
125
|
# dedicated config sub-resources, not here. The program cannot be deleted via this
|
|
126
126
|
# endpoint.
|
|
127
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
128
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
129
|
+
# response saves the change. A concurrent edit can return `409`; reload the program
|
|
130
|
+
# before retrying.
|
|
127
131
|
#
|
|
128
132
|
# @overload update(id, company_logo_image_url: nil, company_name: nil, name: nil, status: nil, request_options: {})
|
|
129
133
|
#
|
|
@@ -155,6 +159,7 @@ module GrowsurfRuby
|
|
|
155
159
|
|
|
156
160
|
# Clones an existing program into a new `DRAFT` program. Integrations and
|
|
157
161
|
# credentials are not copied; active rewards are cloned.
|
|
162
|
+
# A concurrent edit to the program can return `409`; retry the clone.
|
|
158
163
|
#
|
|
159
164
|
# @overload clone(id, request_options: {})
|
|
160
165
|
#
|
|
@@ -63,6 +63,10 @@ module GrowsurfRuby
|
|
|
63
63
|
# wholesale). Unknown fields, fields not available for the program type, and invalid
|
|
64
64
|
# values return a `400`. Landing-page custom code and JavaScript are not editable via the
|
|
65
65
|
# API.
|
|
66
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
67
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
68
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
69
|
+
# program before retrying.
|
|
66
70
|
sig do
|
|
67
71
|
params(
|
|
68
72
|
id: String,
|
|
@@ -33,6 +33,10 @@ module GrowsurfRuby
|
|
|
33
33
|
# available for the program type returns a `400`. Some fields are read-only
|
|
34
34
|
# (`settings.sender.fromEmail`, whose custom value requires dashboard domain
|
|
35
35
|
# verification).
|
|
36
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
37
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
38
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
39
|
+
# program before retrying.
|
|
36
40
|
sig do
|
|
37
41
|
params(
|
|
38
42
|
id: String,
|
|
@@ -27,6 +27,10 @@ module GrowsurfRuby
|
|
|
27
27
|
# enabling `mobile.isEnabled` creates one. Changing `shareUrl` re-resolves its
|
|
28
28
|
# redirect destinations, which may take a moment to complete. URLs must include an
|
|
29
29
|
# explicit `http://` or `https://` scheme.
|
|
30
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
31
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
32
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
33
|
+
# program before retrying.
|
|
30
34
|
sig do
|
|
31
35
|
params(
|
|
32
36
|
id: String,
|
|
@@ -5,10 +5,10 @@ module GrowsurfRuby
|
|
|
5
5
|
class Campaign
|
|
6
6
|
class Options
|
|
7
7
|
# Retrieves a program's options — the same surface as the dashboard Program
|
|
8
|
-
# Editor's **Options** tab. Includes reward/fraud approval,
|
|
9
|
-
# toggles, referral cookie/credit windows, reCAPTCHA, affiliate
|
|
10
|
-
# application review, payout threshold + tax settings (affiliate
|
|
11
|
-
# notification-email settings, and the program's languages.
|
|
8
|
+
# Editor's **Options** tab. Includes the attribution model, reward/fraud approval,
|
|
9
|
+
# anti-fraud lists + toggles, referral cookie/credit windows, reCAPTCHA, affiliate
|
|
10
|
+
# enrollment + application review, payout threshold + tax settings (affiliate
|
|
11
|
+
# only), notification-email settings, and the program's languages.
|
|
12
12
|
# `fraud.recaptcha.secretKey` is never returned.
|
|
13
13
|
sig do
|
|
14
14
|
params(
|
|
@@ -30,7 +30,12 @@ module GrowsurfRuby
|
|
|
30
30
|
# programs require `requireParticipantAuth: true`). `fraud.recaptcha.secretKey`
|
|
31
31
|
# is write-only. `referralCreditWindowDays: null` means "never expires".
|
|
32
32
|
# Turning on `languages.additionalLanguages` requires the Business plan or
|
|
33
|
-
# higher
|
|
33
|
+
# higher. While any are on, every `languages` change, including turning them
|
|
34
|
+
# off, requires it too (`403` otherwise).
|
|
35
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
36
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
37
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
38
|
+
# program before retrying.
|
|
34
39
|
sig do
|
|
35
40
|
params(
|
|
36
41
|
id: String,
|
|
@@ -27,6 +27,7 @@ module GrowsurfRuby
|
|
|
27
27
|
# Enabling an active reward of a type automatically enables that reward type on
|
|
28
28
|
# the program. For an affiliate reward, `commissionStructure.event: LEAD`
|
|
29
29
|
# requires a `FIXED` commission with a positive `amount`.
|
|
30
|
+
# A concurrent edit can return `409`; reload the program before retrying.
|
|
30
31
|
sig do
|
|
31
32
|
params(
|
|
32
33
|
id: String,
|
|
@@ -134,6 +135,10 @@ module GrowsurfRuby
|
|
|
134
135
|
# copy; removing a key that campaign copy still references returns a `409` listing
|
|
135
136
|
# the referencing fields. For an affiliate reward, `commissionStructure.event:
|
|
136
137
|
# LEAD` requires a `FIXED` commission with a positive `amount`.
|
|
138
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
139
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
140
|
+
# response saves the change. A concurrent edit can return `409`; reload the
|
|
141
|
+
# program before retrying.
|
|
137
142
|
sig do
|
|
138
143
|
params(
|
|
139
144
|
campaign_reward_id: String,
|
|
@@ -110,6 +110,10 @@ module GrowsurfRuby
|
|
|
110
110
|
# configuration (design, emails, options, installation) is edited via the
|
|
111
111
|
# dedicated config sub-resources, not here. The program cannot be deleted via this
|
|
112
112
|
# endpoint.
|
|
113
|
+
# Changes to participant email content are checked before saving. Rejected content
|
|
114
|
+
# returns `400`; if the check is unavailable, `503` asks you to retry. Neither
|
|
115
|
+
# response saves the change. A concurrent edit can return `409`; reload the program
|
|
116
|
+
# before retrying.
|
|
113
117
|
sig do
|
|
114
118
|
params(
|
|
115
119
|
id: String,
|
|
@@ -138,6 +142,7 @@ module GrowsurfRuby
|
|
|
138
142
|
|
|
139
143
|
# Clones an existing program into a new `DRAFT` program. Integrations and
|
|
140
144
|
# credentials are not copied; active rewards are cloned.
|
|
145
|
+
# A concurrent edit to the program can return `409`; retry the clone.
|
|
141
146
|
sig do
|
|
142
147
|
params(
|
|
143
148
|
id: String,
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: growsurf-ruby
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.13.
|
|
4
|
+
version: 1.13.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Growsurf
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-10-
|
|
11
|
+
date: 2026-10-14 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|