growsurf-ruby 1.7.1 → 1.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (12) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +26 -0
  3. data/README.md +1 -1
  4. data/lib/growsurf_ruby/models/campaign_create_params.rb +25 -10
  5. data/lib/growsurf_ruby/resources/campaign/design.rb +6 -2
  6. data/lib/growsurf_ruby/resources/campaign.rb +1 -1
  7. data/lib/growsurf_ruby/version.rb +1 -1
  8. data/rbi/growsurf_ruby/models/campaign_create_params.rbi +18 -0
  9. data/rbi/growsurf_ruby/resources/campaign/design.rbi +5 -2
  10. data/rbi/growsurf_ruby/resources/campaign.rbi +4 -3
  11. data/sig/growsurf_ruby/models/campaign_create_params.rbs +4 -1
  12. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4c4264a852ff0ca77180179c1831e2d321d98f71c95fa4a8b0ba7ebb8e46e0f9
4
- data.tar.gz: 04a8a7f10fd055630f07be8787ad0508941ec6378d81b05039a6281dee7c4da3
3
+ metadata.gz: 3cc9cb8240076dada54cb5c6791f162c599eb3963e13e2baec3d2f7e2afcf66e
4
+ data.tar.gz: a631c70f08428385f1bb0afaf6c218b88354804e1a6908ad95a081d87745100d
5
5
  SHA512:
6
- metadata.gz: 6d821a1c07c9ba393abb5c9ff3c0c08c39670f614f04f994043128bd9273f622e2f5fbe875631c7eda38bc4ba7ae77614c67b95aa43b882a663986e4cb3308ea
7
- data.tar.gz: c6ab8613be7ab066109361b167e586c8e3dd40918dbc5b22079dfa657fa51fbd0caa638efa00dabba21df32c9466bf0ba666906bc2d11af795d96e6cca26f8f2
6
+ metadata.gz: 1d5b8aa05bdd8fdf3fbf6822a696c5d76a041e29af11d7e5b7b469067d80c25074bb6324e4fc6f2e756f479917fac70f4dcd6b032a92891734bfaca5f0ba951b
7
+ data.tar.gz: ce692094a359a416f1441881afbd73880fa1a73abf7f74c722e6832f02c210c211d3658a4c5d6bec94ad60df3d98a7c295060229277069c15900b7086c8bc87f
data/CHANGELOG.md CHANGED
@@ -1,5 +1,31 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.8.1](https://github.com/growsurf/growsurf-ruby/compare/v1.8.0...v1.8.1) (2026-09-19)
4
+
5
+
6
+ ### Chores
7
+
8
+ * merge dev into main ([f954268](https://github.com/growsurf/growsurf-ruby/commit/f954268c05141b1eaf2b0b12c505b4fb212e4a61))
9
+ * merge dev into main ([36ac45a](https://github.com/growsurf/growsurf-ruby/commit/36ac45a41e8df7d0484fc3adf3f9b40f37e34eda))
10
+
11
+
12
+ ### Documentation
13
+
14
+ * **api:** document the starter rewards each campaign goal seeds ([f33a807](https://github.com/growsurf/growsurf-ruby/commit/f33a807119d979c67fd0e9e10744aae96c74ee9d))
15
+ * **api:** document the starter rewards each campaign goal seeds ([41c4330](https://github.com/growsurf/growsurf-ruby/commit/41c4330aad6022de40dbb96a237a8fef644b0be0))
16
+
17
+ ## [1.8.0](https://github.com/growsurf/growsurf-ruby/compare/v1.7.1...v1.8.0) (2026-09-19)
18
+
19
+
20
+ ### Features
21
+
22
+ * **api:** add campaign design widget section and healthcare goals ([5432ec3](https://github.com/growsurf/growsurf-ruby/commit/5432ec3df0834b8f877378cfd8de2447c22a6d79))
23
+
24
+
25
+ ### Chores
26
+
27
+ * merge dev into main ([fba5897](https://github.com/growsurf/growsurf-ruby/commit/fba589788c1a6d99aef06377fd940776c8a03676))
28
+
3
29
  ## [1.7.1](https://github.com/growsurf/growsurf-ruby/compare/v1.7.0...v1.7.1) (2026-09-18)
4
30
 
5
31
 
data/README.md CHANGED
@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
17
17
  <!-- x-release-please-start-version -->
18
18
 
19
19
  ```ruby
20
- gem "growsurf-ruby", "~> 1.7.1"
20
+ gem "growsurf-ruby", "~> 1.8.1"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
data/lib/growsurf_ruby/models/campaign_create_params.rb CHANGED
@@ -28,14 +28,26 @@ module GrowsurfRuby
28
28
  optional :currency_iso, String, api_name: :currencyISO
29
29
 
30
30
  # @!attribute goal
31
- # What the program is for, which seeds share settings that suit that audience.
32
- # Programs selling to businesses (`CUSTOMERS`, `USERS`, `B2B_SAAS_SELF_SERVICE`,
33
- # `B2B_SAAS_ENTERPRISE`) start with the LinkedIn share button visible; consumer,
34
- # financial, education, insurance, newsletter, and waitlist programs
35
- # (`B2C_SUBSCRIPTIONS`, `FINANCIAL_SERVICES`, `ONLINE_EDUCATION`,
36
- # `ONLINE_INSURANCE`, `SUBSCRIBERS`, `WAITLIST`) start with it hidden. Omit it and
37
- # every share button keeps its standard default. Set only when the program is
38
- # created; it is not accepted on update.
31
+ # What the program is for, which seeds the share buttons and the starter rewards
32
+ # that suit that audience. Programs whose participants refer other businesses
33
+ # (`CUSTOMERS`, `USERS`, `B2B_SAAS_SELF_SERVICE`, `B2B_SAAS_ENTERPRISE`,
34
+ # `HEALTHCARE_PROVIDERS`) start with the LinkedIn share button visible;
35
+ # consumer, financial, education, insurance, telehealth, newsletter, and
36
+ # waitlist programs (`B2C_SUBSCRIPTIONS`, `FINANCIAL_SERVICES`,
37
+ # `ONLINE_EDUCATION`, `INSURANCE`, `ONLINE_INSURANCE`, `TELEHEALTH`,
38
+ # `SUBSCRIBERS`, `WAITLIST`) start with it hidden, and on a referral program
39
+ # each goal also sets the rest of its share buttons to suit that audience. When
40
+ # you create a referral program without `rewards`, the goal also decides the
41
+ # starter rewards: most goals get one double-sided reward,
42
+ # `HEALTHCARE_PROVIDERS` gets a single-sided reward, `SUBSCRIBERS` gets a
43
+ # four-step milestone ladder, and `WAITLIST` gets a leaderboard. Every one
44
+ # arrives switched off with a placeholder name, so the program awards nothing
45
+ # until you set the amount and turn one on. `TELEHEALTH` is for consumer
46
+ # telehealth and wellness subscriptions; `HEALTHCARE_PROVIDERS` is for provider
47
+ # networks and clinician-facing products. `INSURANCE` replaces
48
+ # `ONLINE_INSURANCE`, which is still accepted. Omit it and every share button
49
+ # keeps its standard default. Set only when the program is created; it is not
50
+ # accepted on update.
39
51
  #
40
52
  # @return [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal, nil]
41
53
  optional :goal, enum: -> { GrowsurfRuby::CampaignCreateParams::Goal }
@@ -60,7 +72,7 @@ module GrowsurfRuby
60
72
  #
61
73
  # @param currency_iso [String]
62
74
  #
63
- # @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds share settings that suit that audience.
75
+ # @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds the share buttons and the starter rewards that suit that audience.
64
76
  #
65
77
  # @param name [String]
66
78
  #
@@ -79,7 +91,7 @@ module GrowsurfRuby
79
91
  # @return [Array<Symbol>]
80
92
  end
81
93
 
82
- # What the program is for, which seeds share settings that suit that audience.
94
+ # What the program is for, which seeds the share buttons and the starter rewards that suit that audience.
83
95
  #
84
96
  # @see GrowsurfRuby::Models::CampaignCreateParams#goal
85
97
  module Goal
@@ -94,7 +106,10 @@ module GrowsurfRuby
94
106
  B2C_SUBSCRIPTIONS = :B2C_SUBSCRIPTIONS
95
107
  FINANCIAL_SERVICES = :FINANCIAL_SERVICES
96
108
  ONLINE_EDUCATION = :ONLINE_EDUCATION
109
+ INSURANCE = :INSURANCE
97
110
  ONLINE_INSURANCE = :ONLINE_INSURANCE
111
+ TELEHEALTH = :TELEHEALTH
112
+ HEALTHCARE_PROVIDERS = :HEALTHCARE_PROVIDERS
98
113
 
99
114
  # @!method self.values
100
115
  # @return [Array<Symbol>]
data/lib/growsurf_ruby/resources/campaign/design.rb CHANGED
@@ -9,7 +9,10 @@ module GrowsurfRuby
9
9
  # cards. This includes the GrowSurf window layout, header, share channels and invites,
10
10
  # signup form, Resources presentation, portal and landing pages, theme styling, and referral
11
11
  # or affiliate summary and status sections. `referredExperience` includes the Claim Offer Popup for both program
12
- # types, with its colors under `theme.referredExperienceOfferPopup`.
12
+ # types, with its colors under `theme.referredExperienceOfferPopup`. `widget` is the website
13
+ # widget shown in a corner of your own site, with its colors under `theme.widget`;
14
+ # both of its audience switches start off, so a program shows nothing until you turn one
15
+ # on.
13
16
  # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
14
17
  # unknown values mean `INITIALS`.
15
18
  # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
@@ -32,7 +35,8 @@ module GrowsurfRuby
32
35
  end
33
36
 
34
37
  # Updates a program's design configuration, including the payout-destination confirmation
35
- # page copy and the Claim Offer Popup under `referredExperience`. Only the fields you send
38
+ # page copy, the Claim Offer Popup under `referredExperience`, and the website widget under
39
+ # `widget`. Only the fields you send
36
40
  # are changed;
37
41
  # anything you leave out is untouched (arrays such as `signup.fields` replace wholesale).
38
42
  # Unknown fields, fields not available for the program type, and invalid values return a
data/lib/growsurf_ruby/resources/campaign.rb CHANGED
@@ -97,7 +97,7 @@ module GrowsurfRuby
97
97
  #
98
98
  # @param currency_iso [String] ISO 4217 currency code. Defaults to USD. Chosen when the program is created and immutable afterward — it cannot be changed on update.
99
99
  #
100
- # @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds share settings that suit that audience. Programs selling to businesses start with the LinkedIn share button visible; consumer, financial, education, insurance, newsletter, and waitlist programs start with it hidden. Set only when the program is created.
100
+ # @param goal [Symbol, GrowsurfRuby::Models::CampaignCreateParams::Goal] What the program is for, which seeds the share buttons and the starter rewards that suit that audience. Programs whose participants refer other businesses start with the LinkedIn share button visible; consumer, financial, education, insurance, telehealth, newsletter, and waitlist programs start with it hidden. Starter rewards arrive switched off with a placeholder name, so the program awards nothing until you set the amount and turn one on. Set only when the program is created.
101
101
  #
102
102
  # @param name [String] The program name. Defaults to a generated friendly label plus the creation date.
103
103
  #
data/lib/growsurf_ruby/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module GrowsurfRuby
4
- VERSION = "1.7.1"
4
+ VERSION = "1.8.1"
5
5
  end
data/rbi/growsurf_ruby/models/campaign_create_params.rbi CHANGED
@@ -197,12 +197,30 @@ module GrowsurfRuby
197
197
  GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol
198
198
  )
199
199
 
200
+ INSURANCE =
201
+ T.let(
202
+ :INSURANCE,
203
+ GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol
204
+ )
205
+
200
206
  ONLINE_INSURANCE =
201
207
  T.let(
202
208
  :ONLINE_INSURANCE,
203
209
  GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol
204
210
  )
205
211
 
212
+ TELEHEALTH =
213
+ T.let(
214
+ :TELEHEALTH,
215
+ GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol
216
+ )
217
+
218
+ HEALTHCARE_PROVIDERS =
219
+ T.let(
220
+ :HEALTHCARE_PROVIDERS,
221
+ GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol
222
+ )
223
+
206
224
  sig do
207
225
  override.returns(
208
226
  T::Array[GrowsurfRuby::CampaignCreateParams::Goal::TaggedSymbol]
data/rbi/growsurf_ruby/resources/campaign/design.rbi CHANGED
@@ -32,7 +32,9 @@ module GrowsurfRuby
32
32
  # channels + invite, signup form, Resources presentation, portal/landing pages, theme styling, and the
33
33
  # referral/affiliate summary + status sections. `referredExperience` includes the Claim
34
34
  # Offer Popup for both program types, with its colors under
35
- # `theme.referredExperienceOfferPopup`.
35
+ # `theme.referredExperienceOfferPopup`. `widget` is the website widget shown in a
36
+ # corner of your own site, with its colors under `theme.widget`; both of its audience
37
+ # switches start off, so a program shows nothing until you turn one on.
36
38
  # `participantAvatarStyle` is `CHARACTERS`, `INITIALS`, `ANIMALS`, or `GRADIENT`; missing or
37
39
  # unknown values mean `INITIALS`.
38
40
  # `payoutDestinationConfirmation` is omitted when no confirmation fields are stored. Stored
@@ -51,7 +53,8 @@ module GrowsurfRuby
51
53
  end
52
54
 
53
55
  # Updates a program's design configuration, including the payout-destination confirmation
54
- # page copy and the Claim Offer Popup under `referredExperience`. Only the fields you send are
56
+ # page copy, the Claim Offer Popup under `referredExperience`, and the website widget under
57
+ # `widget`. Only the fields you send are
55
58
  # changed; anything you leave out is untouched (arrays such as `signup.fields` replace
56
59
  # wholesale). Unknown fields, fields not available for the program type, and invalid
57
60
  # values return a `400`. Landing-page custom code and JavaScript are not editable via the
data/rbi/growsurf_ruby/resources/campaign.rbi CHANGED
@@ -92,9 +92,10 @@ module GrowsurfRuby
92
92
  # immutable afterward — it cannot be changed on update.
93
93
  currency_iso: nil,
94
94
  # What the program is for, which seeds share settings that suit that audience.
95
- # Programs selling to businesses start with the LinkedIn share button visible;
96
- # consumer, financial, education, insurance, newsletter, and waitlist programs
97
- # start with it hidden. Set only when the program is created.
95
+ # Programs whose participants refer other businesses start with the LinkedIn share
96
+ # button visible; consumer, financial, education, insurance, telehealth,
97
+ # newsletter, and waitlist programs start with it hidden. Set only when the
98
+ # program is created.
98
99
  goal: nil,
99
100
  # The program name. Defaults to a generated friendly label plus the creation date.
100
101
  name: nil,
data/sig/growsurf_ruby/models/campaign_create_params.rbs CHANGED
@@ -80,7 +80,7 @@ module GrowsurfRuby
80
80
  end
81
81
 
82
82
  type goal =
83
- :CUSTOMERS | :USERS | :SUBSCRIBERS | :WAITLIST | :B2B_SAAS_SELF_SERVICE | :B2B_SAAS_ENTERPRISE | :B2C_SUBSCRIPTIONS | :FINANCIAL_SERVICES | :ONLINE_EDUCATION | :ONLINE_INSURANCE
83
+ :CUSTOMERS | :USERS | :SUBSCRIBERS | :WAITLIST | :B2B_SAAS_SELF_SERVICE | :B2B_SAAS_ENTERPRISE | :B2C_SUBSCRIPTIONS | :FINANCIAL_SERVICES | :ONLINE_EDUCATION | :INSURANCE | :ONLINE_INSURANCE | :TELEHEALTH | :HEALTHCARE_PROVIDERS
84
84
 
85
85
  module Goal
86
86
  extend GrowsurfRuby::Internal::Type::Enum
@@ -94,7 +94,10 @@ module GrowsurfRuby
94
94
  B2C_SUBSCRIPTIONS: :B2C_SUBSCRIPTIONS
95
95
  FINANCIAL_SERVICES: :FINANCIAL_SERVICES
96
96
  ONLINE_EDUCATION: :ONLINE_EDUCATION
97
+ INSURANCE: :INSURANCE
97
98
  ONLINE_INSURANCE: :ONLINE_INSURANCE
99
+ TELEHEALTH: :TELEHEALTH
100
+ HEALTHCARE_PROVIDERS: :HEALTHCARE_PROVIDERS
98
101
 
99
102
  def self?.values: -> ::Array[GrowsurfRuby::Models::CampaignCreateParams::goal]
100
103
  end
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.7.1
4
+ version: 1.8.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-09-18 00:00:00.000000000 Z
11
+ date: 2026-09-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: cgi