growsurf-ruby 1.5.1 → 1.7.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 +29 -0
- data/README.md +1 -1
- data/lib/growsurf_ruby/models/campaign/participant_bulk_delete_response.rb +21 -5
- data/lib/growsurf_ruby/models/campaign/participant_delete_response.rb +11 -1
- data/lib/growsurf_ruby/models/campaign/pending_analytics_erasure.rb +26 -0
- data/lib/growsurf_ruby/models/campaign_list_participants_params.rb +11 -1
- data/lib/growsurf_ruby/resources/campaign.rb +3 -1
- data/lib/growsurf_ruby/version.rb +1 -1
- data/lib/growsurf_ruby.rb +1 -0
- data/rbi/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbi +30 -2
- data/rbi/growsurf_ruby/models/campaign/participant_delete_response.rbi +43 -3
- data/rbi/growsurf_ruby/models/campaign/pending_analytics_erasure.rbi +40 -0
- data/rbi/growsurf_ruby/models/campaign_list_participants_params.rbi +15 -0
- data/rbi/growsurf_ruby/resources/campaign.rbi +5 -0
- data/sig/growsurf_ruby/models/campaign/participant_bulk_delete_response.rbs +8 -3
- data/sig/growsurf_ruby/models/campaign/participant_delete_response.rbs +5 -3
- data/sig/growsurf_ruby/models/campaign/pending_analytics_erasure.rbs +17 -0
- data/sig/growsurf_ruby/models/campaign_list_participants_params.rbs +12 -1
- data/sig/growsurf_ruby/resources/campaign.rbs +1 -0
- metadata +5 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b0442db1ea6db89b62aba3916b7a4fcba080deb4c385f0545406d25996d3993a
|
|
4
|
+
data.tar.gz: a756736f5ebd86a9380daad1c90285aaff296f9e1678bafeebd4b2c7455c6581
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 17b67359f79eaae8e474fb00e585125c441f17f766b0839d9947e6dfc9dd5012d5db9ea41eba5ab27edf0dafbaebd5b5584fc40758e1d248b1d45bd85cadaf05
|
|
7
|
+
data.tar.gz: d2dd71fe46cdb2472fae60037c7a9d60e3087123bfe607a745c60f46c739856c50ca71d6d063b4b53114d9f8f6a40addadc43bd5125e601579e7a5cb6a90b140
|
data/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,34 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.7.0](https://github.com/growsurf/growsurf-ruby/compare/v1.6.0...v1.7.0) (2026-09-17)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* **api:** add metadata filter to campaign.listParticipants ([8ac3946](https://github.com/growsurf/growsurf-ruby/commit/8ac3946c277c4c7f7fa67883fd37c683a200c0a1))
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
### Chores
|
|
12
|
+
|
|
13
|
+
* refresh Gemfile.lock for 1.6.0 and keep it current on release PRs ([b767b23](https://github.com/growsurf/growsurf-ruby/commit/b767b238c2c52bc3fc9d55efa85a6d95a52164dd))
|
|
14
|
+
|
|
15
|
+
## [1.6.0](https://github.com/growsurf/growsurf-ruby/compare/v1.5.1...v1.6.0) (2026-09-14)
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
### Features
|
|
19
|
+
|
|
20
|
+
* **api:** add pending analyticsErasure to participant delete responses ([43ea40d](https://github.com/growsurf/growsurf-ruby/commit/43ea40d0b1aef235b6bd11e3bbda0c6ac092a60c))
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Bug Fixes
|
|
24
|
+
|
|
25
|
+
* **types:** correct analyticsErasure param ordering and RBI style ([44b0dc1](https://github.com/growsurf/growsurf-ruby/commit/44b0dc1852633775a99227951aaf9b7b51d13d46))
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
### Chores
|
|
29
|
+
|
|
30
|
+
* merge dev into main ([9855d24](https://github.com/growsurf/growsurf-ruby/commit/9855d240457ad9ae95d4946d0574787390177e2d))
|
|
31
|
+
|
|
3
32
|
## [1.5.1](https://github.com/growsurf/growsurf-ruby/compare/v1.5.0...v1.5.1) (2026-09-10)
|
|
4
33
|
|
|
5
34
|
|
data/README.md
CHANGED
|
@@ -5,26 +5,39 @@ module GrowsurfRuby
|
|
|
5
5
|
module Campaign
|
|
6
6
|
# @see GrowsurfRuby::Resources::Campaign::Participant#bulk_delete
|
|
7
7
|
class ParticipantBulkDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute analytics_erasure
|
|
9
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
10
|
+
#
|
|
11
|
+
# @return [GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure, nil]
|
|
12
|
+
optional :analytics_erasure,
|
|
13
|
+
-> { GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure },
|
|
14
|
+
api_name: :analyticsErasure
|
|
15
|
+
|
|
8
16
|
# @!attribute results
|
|
9
17
|
# One entry per submitted identifier, in the same order as the request.
|
|
10
18
|
#
|
|
11
19
|
# @return [Array<GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result>]
|
|
12
20
|
required :results,
|
|
13
|
-
->
|
|
21
|
+
-> do
|
|
14
22
|
GrowsurfRuby::Internal::Type::ArrayOf[
|
|
15
23
|
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result
|
|
16
24
|
]
|
|
17
|
-
|
|
25
|
+
end
|
|
18
26
|
|
|
19
27
|
# @!attribute summary
|
|
20
28
|
#
|
|
21
29
|
# @return [GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary]
|
|
22
|
-
required :summary,
|
|
30
|
+
required :summary,
|
|
31
|
+
-> do
|
|
32
|
+
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary
|
|
33
|
+
end
|
|
23
34
|
|
|
24
|
-
# @!method initialize(results:, summary:)
|
|
35
|
+
# @!method initialize(results:, summary:, analytics_erasure: nil)
|
|
25
36
|
# @param results [Array<GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result>] One entry per submitted identifier, in the same order as the request.
|
|
26
37
|
#
|
|
27
38
|
# @param summary [GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary]
|
|
39
|
+
#
|
|
40
|
+
# @param analytics_erasure [GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure, nil] Analytics erasure is pending. Do not repeat successful deletions.
|
|
28
41
|
|
|
29
42
|
class Result < GrowsurfRuby::Internal::Type::BaseModel
|
|
30
43
|
# @!attribute identifier
|
|
@@ -46,7 +59,10 @@ module GrowsurfRuby
|
|
|
46
59
|
# `ERROR` — the lookup or deletion failed for this row.
|
|
47
60
|
#
|
|
48
61
|
# @return [Symbol, GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result::Status]
|
|
49
|
-
required :status,
|
|
62
|
+
required :status,
|
|
63
|
+
enum: -> do
|
|
64
|
+
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result::Status
|
|
65
|
+
end
|
|
50
66
|
|
|
51
67
|
# @!attribute email
|
|
52
68
|
# The resolved participant's email address. Present on `DELETED` rows.
|
|
@@ -5,13 +5,23 @@ module GrowsurfRuby
|
|
|
5
5
|
module Campaign
|
|
6
6
|
# @see GrowsurfRuby::Resources::Campaign::Participant#delete
|
|
7
7
|
class ParticipantDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
8
|
+
# @!attribute analytics_erasure
|
|
9
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
10
|
+
#
|
|
11
|
+
# @return [GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure, nil]
|
|
12
|
+
optional :analytics_erasure,
|
|
13
|
+
-> { GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure },
|
|
14
|
+
api_name: :analyticsErasure
|
|
15
|
+
|
|
8
16
|
# @!attribute success
|
|
9
17
|
#
|
|
10
18
|
# @return [Boolean]
|
|
11
19
|
required :success, GrowsurfRuby::Internal::Type::Boolean
|
|
12
20
|
|
|
13
|
-
# @!method initialize(success:)
|
|
21
|
+
# @!method initialize(success:, analytics_erasure: nil)
|
|
14
22
|
# @param success [Boolean]
|
|
23
|
+
#
|
|
24
|
+
# @param analytics_erasure [GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure, nil] Analytics erasure is pending. Do not repeat successful deletions.
|
|
15
25
|
end
|
|
16
26
|
end
|
|
17
27
|
end
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module GrowsurfRuby
|
|
4
|
+
module Models
|
|
5
|
+
module Campaign
|
|
6
|
+
class PendingAnalyticsErasure < GrowsurfRuby::Internal::Type::BaseModel
|
|
7
|
+
# @!attribute status
|
|
8
|
+
# Analytics erasure has been accepted but is not confirmed complete.
|
|
9
|
+
#
|
|
10
|
+
# @return [String]
|
|
11
|
+
required :status, String
|
|
12
|
+
|
|
13
|
+
# @!attribute operation_id
|
|
14
|
+
# Opaque reference for support inquiries about this analytics erasure.
|
|
15
|
+
#
|
|
16
|
+
# @return [String]
|
|
17
|
+
required :operation_id, String, api_name: :operationId
|
|
18
|
+
|
|
19
|
+
# @!method initialize(status:, operation_id:)
|
|
20
|
+
# @param status [String] Analytics erasure has been accepted but is not confirmed complete.
|
|
21
|
+
#
|
|
22
|
+
# @param operation_id [String] Opaque reference for support inquiries about this analytics erasure.
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
26
|
+
end
|
|
@@ -18,17 +18,27 @@ module GrowsurfRuby
|
|
|
18
18
|
# @return [Integer, nil]
|
|
19
19
|
optional :limit, Integer
|
|
20
20
|
|
|
21
|
+
# @!attribute metadata
|
|
22
|
+
# Return only participants whose metadata matches every given key and value
|
|
23
|
+
# exactly. Send each pair as `metadata[key]=value`. Up to 3 keys per request.
|
|
24
|
+
# Values compare as strings, which is how metadata is stored.
|
|
25
|
+
#
|
|
26
|
+
# @return [Hash{Symbol=>String}, nil]
|
|
27
|
+
optional :metadata, GrowsurfRuby::Internal::Type::HashOf[String]
|
|
28
|
+
|
|
21
29
|
# @!attribute next_id
|
|
22
30
|
# ID to start the next paged result set with.
|
|
23
31
|
#
|
|
24
32
|
# @return [String, nil]
|
|
25
33
|
optional :next_id, String
|
|
26
34
|
|
|
27
|
-
# @!method initialize(id:, limit: nil, next_id: nil, request_options: {})
|
|
35
|
+
# @!method initialize(id:, limit: nil, metadata: nil, next_id: nil, request_options: {})
|
|
28
36
|
# @param id [String]
|
|
29
37
|
#
|
|
30
38
|
# @param limit [Integer] Number of results to return. Maximum 100.
|
|
31
39
|
#
|
|
40
|
+
# @param metadata [Hash{Symbol=>String}] Return only participants whose metadata matches every given key and value exac
|
|
41
|
+
#
|
|
32
42
|
# @param next_id [String] ID to start the next paged result set with.
|
|
33
43
|
#
|
|
34
44
|
# @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}]
|
|
@@ -377,12 +377,14 @@ module GrowsurfRuby
|
|
|
377
377
|
|
|
378
378
|
# Retrieves a paged list of participants in a program.
|
|
379
379
|
#
|
|
380
|
-
# @overload list_participants(id, limit: nil, next_id: nil, request_options: {})
|
|
380
|
+
# @overload list_participants(id, limit: nil, metadata: nil, next_id: nil, request_options: {})
|
|
381
381
|
#
|
|
382
382
|
# @param id [String] GrowSurf program ID.
|
|
383
383
|
#
|
|
384
384
|
# @param limit [Integer] Number of results to return. Maximum 100.
|
|
385
385
|
#
|
|
386
|
+
# @param metadata [Hash{Symbol=>String}] Return only participants whose metadata matches every given key and value exac
|
|
387
|
+
#
|
|
386
388
|
# @param next_id [String] ID to start the next paged result set with.
|
|
387
389
|
#
|
|
388
390
|
# @param request_options [GrowsurfRuby::RequestOptions, Hash{Symbol=>Object}, nil]
|
data/lib/growsurf_ruby.rb
CHANGED
|
@@ -75,6 +75,7 @@ require_relative "growsurf_ruby/models/campaign/participant_bulk_delete_response
|
|
|
75
75
|
require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_params"
|
|
76
76
|
require_relative "growsurf_ruby/models/campaign/participant_cancel_delayed_referral_response"
|
|
77
77
|
require_relative "growsurf_ruby/models/campaign/participant_delete_params"
|
|
78
|
+
require_relative "growsurf_ruby/models/campaign/pending_analytics_erasure"
|
|
78
79
|
require_relative "growsurf_ruby/models/campaign/participant_delete_response"
|
|
79
80
|
require_relative "growsurf_ruby/models/campaign/participant_email_params"
|
|
80
81
|
require_relative "growsurf_ruby/models/campaign/participant_email_response"
|
|
@@ -12,6 +12,24 @@ module GrowsurfRuby
|
|
|
12
12
|
)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
16
|
+
sig do
|
|
17
|
+
returns(
|
|
18
|
+
T.nilable(GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure)
|
|
19
|
+
)
|
|
20
|
+
end
|
|
21
|
+
attr_reader :analytics_erasure
|
|
22
|
+
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
analytics_erasure:
|
|
26
|
+
T.nilable(
|
|
27
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure::OrHash
|
|
28
|
+
)
|
|
29
|
+
).void
|
|
30
|
+
end
|
|
31
|
+
attr_writer :analytics_erasure
|
|
32
|
+
|
|
15
33
|
# One entry per submitted identifier, in the same order as the request.
|
|
16
34
|
sig do
|
|
17
35
|
returns(
|
|
@@ -44,19 +62,29 @@ module GrowsurfRuby
|
|
|
44
62
|
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result::OrHash
|
|
45
63
|
],
|
|
46
64
|
summary:
|
|
47
|
-
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary::OrHash
|
|
65
|
+
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Summary::OrHash,
|
|
66
|
+
analytics_erasure:
|
|
67
|
+
T.nilable(
|
|
68
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure::OrHash
|
|
69
|
+
)
|
|
48
70
|
).returns(T.attached_class)
|
|
49
71
|
end
|
|
50
72
|
def self.new(
|
|
51
73
|
# One entry per submitted identifier, in the same order as the request.
|
|
52
74
|
results:,
|
|
53
|
-
summary
|
|
75
|
+
summary:,
|
|
76
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
77
|
+
analytics_erasure: nil
|
|
54
78
|
)
|
|
55
79
|
end
|
|
56
80
|
|
|
57
81
|
sig do
|
|
58
82
|
override.returns(
|
|
59
83
|
{
|
|
84
|
+
analytics_erasure:
|
|
85
|
+
T.nilable(
|
|
86
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure
|
|
87
|
+
),
|
|
60
88
|
results:
|
|
61
89
|
T::Array[
|
|
62
90
|
GrowsurfRuby::Campaign::ParticipantBulkDeleteResponse::Result
|
|
@@ -12,14 +12,54 @@ module GrowsurfRuby
|
|
|
12
12
|
)
|
|
13
13
|
end
|
|
14
14
|
|
|
15
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
16
|
+
sig do
|
|
17
|
+
returns(
|
|
18
|
+
T.nilable(GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure)
|
|
19
|
+
)
|
|
20
|
+
end
|
|
21
|
+
attr_reader :analytics_erasure
|
|
22
|
+
|
|
23
|
+
sig do
|
|
24
|
+
params(
|
|
25
|
+
analytics_erasure:
|
|
26
|
+
T.nilable(
|
|
27
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure::OrHash
|
|
28
|
+
)
|
|
29
|
+
).void
|
|
30
|
+
end
|
|
31
|
+
attr_writer :analytics_erasure
|
|
32
|
+
|
|
15
33
|
sig { returns(T::Boolean) }
|
|
16
34
|
attr_accessor :success
|
|
17
35
|
|
|
18
|
-
sig
|
|
19
|
-
|
|
36
|
+
sig do
|
|
37
|
+
params(
|
|
38
|
+
success: T::Boolean,
|
|
39
|
+
analytics_erasure:
|
|
40
|
+
T.nilable(
|
|
41
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure::OrHash
|
|
42
|
+
)
|
|
43
|
+
).returns(T.attached_class)
|
|
44
|
+
end
|
|
45
|
+
def self.new(
|
|
46
|
+
success:,
|
|
47
|
+
# Analytics erasure is pending. Do not repeat successful deletions.
|
|
48
|
+
analytics_erasure: nil
|
|
49
|
+
)
|
|
20
50
|
end
|
|
21
51
|
|
|
22
|
-
sig
|
|
52
|
+
sig do
|
|
53
|
+
override.returns(
|
|
54
|
+
{
|
|
55
|
+
success: T::Boolean,
|
|
56
|
+
analytics_erasure:
|
|
57
|
+
T.nilable(
|
|
58
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure
|
|
59
|
+
)
|
|
60
|
+
}
|
|
61
|
+
)
|
|
62
|
+
end
|
|
23
63
|
def to_hash
|
|
24
64
|
end
|
|
25
65
|
end
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module GrowsurfRuby
|
|
4
|
+
module Models
|
|
5
|
+
module Campaign
|
|
6
|
+
class PendingAnalyticsErasure < GrowsurfRuby::Internal::Type::BaseModel
|
|
7
|
+
OrHash =
|
|
8
|
+
T.type_alias do
|
|
9
|
+
T.any(
|
|
10
|
+
GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure,
|
|
11
|
+
GrowsurfRuby::Internal::AnyHash
|
|
12
|
+
)
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
# Analytics erasure has been accepted but is not confirmed complete.
|
|
16
|
+
sig { returns(String) }
|
|
17
|
+
attr_accessor :status
|
|
18
|
+
|
|
19
|
+
# Opaque reference for support inquiries about this analytics erasure.
|
|
20
|
+
sig { returns(String) }
|
|
21
|
+
attr_accessor :operation_id
|
|
22
|
+
|
|
23
|
+
sig do
|
|
24
|
+
params(status: String, operation_id: String).returns(T.attached_class)
|
|
25
|
+
end
|
|
26
|
+
def self.new(
|
|
27
|
+
# Analytics erasure has been accepted but is not confirmed complete.
|
|
28
|
+
status:,
|
|
29
|
+
# Opaque reference for support inquiries about this analytics erasure.
|
|
30
|
+
operation_id:
|
|
31
|
+
)
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
sig { override.returns({ status: String, operation_id: String }) }
|
|
35
|
+
def to_hash
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
40
|
+
end
|
|
@@ -24,6 +24,15 @@ module GrowsurfRuby
|
|
|
24
24
|
sig { params(limit: Integer).void }
|
|
25
25
|
attr_writer :limit
|
|
26
26
|
|
|
27
|
+
# Return only participants whose metadata matches every given key and value
|
|
28
|
+
# exactly. Send each pair as `metadata[key]=value`. Up to 3 keys per request.
|
|
29
|
+
# Values compare as strings, which is how metadata is stored.
|
|
30
|
+
sig { returns(T.nilable(T::Hash[Symbol, String])) }
|
|
31
|
+
attr_reader :metadata
|
|
32
|
+
|
|
33
|
+
sig { params(metadata: T::Hash[Symbol, String]).void }
|
|
34
|
+
attr_writer :metadata
|
|
35
|
+
|
|
27
36
|
# ID to start the next paged result set with.
|
|
28
37
|
sig { returns(T.nilable(String)) }
|
|
29
38
|
attr_reader :next_id
|
|
@@ -35,6 +44,7 @@ module GrowsurfRuby
|
|
|
35
44
|
params(
|
|
36
45
|
id: String,
|
|
37
46
|
limit: Integer,
|
|
47
|
+
metadata: T::Hash[Symbol, String],
|
|
38
48
|
next_id: String,
|
|
39
49
|
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
40
50
|
).returns(T.attached_class)
|
|
@@ -43,6 +53,10 @@ module GrowsurfRuby
|
|
|
43
53
|
id:,
|
|
44
54
|
# Number of results to return. Maximum 100.
|
|
45
55
|
limit: nil,
|
|
56
|
+
# Return only participants whose metadata matches every given key and value
|
|
57
|
+
# exactly. Send each pair as `metadata[key]=value`. Up to 3 keys per request.
|
|
58
|
+
# Values compare as strings, which is how metadata is stored.
|
|
59
|
+
metadata: nil,
|
|
46
60
|
# ID to start the next paged result set with.
|
|
47
61
|
next_id: nil,
|
|
48
62
|
request_options: {}
|
|
@@ -54,6 +68,7 @@ module GrowsurfRuby
|
|
|
54
68
|
{
|
|
55
69
|
id: String,
|
|
56
70
|
limit: Integer,
|
|
71
|
+
metadata: T::Hash[Symbol, String],
|
|
57
72
|
next_id: String,
|
|
58
73
|
request_options: GrowsurfRuby::RequestOptions
|
|
59
74
|
}
|
|
@@ -325,6 +325,7 @@ module GrowsurfRuby
|
|
|
325
325
|
params(
|
|
326
326
|
id: String,
|
|
327
327
|
limit: Integer,
|
|
328
|
+
metadata: T::Hash[Symbol, String],
|
|
328
329
|
next_id: String,
|
|
329
330
|
request_options: GrowsurfRuby::RequestOptions::OrHash
|
|
330
331
|
).returns(GrowsurfRuby::ParticipantList)
|
|
@@ -334,6 +335,10 @@ module GrowsurfRuby
|
|
|
334
335
|
id,
|
|
335
336
|
# Number of results to return. Maximum 100.
|
|
336
337
|
limit: nil,
|
|
338
|
+
# Return only participants whose metadata matches every given key and value
|
|
339
|
+
# exactly. Send each pair as `metadata[key]=value`. Up to 3 keys per request.
|
|
340
|
+
# Values compare as strings, which is how metadata is stored.
|
|
341
|
+
metadata: nil,
|
|
337
342
|
# ID to start the next paged result set with.
|
|
338
343
|
next_id: nil,
|
|
339
344
|
request_options: {}
|
|
@@ -4,22 +4,27 @@ module GrowsurfRuby
|
|
|
4
4
|
type participant_bulk_delete_response =
|
|
5
5
|
{
|
|
6
6
|
results: ::Array[GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result],
|
|
7
|
-
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary
|
|
7
|
+
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary,
|
|
8
|
+
?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?
|
|
8
9
|
}
|
|
9
10
|
|
|
10
11
|
class ParticipantBulkDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
12
|
+
attr_accessor analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?
|
|
13
|
+
|
|
11
14
|
attr_accessor results: ::Array[GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result]
|
|
12
15
|
|
|
13
16
|
attr_accessor summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary
|
|
14
17
|
|
|
15
18
|
def initialize: (
|
|
16
19
|
results: ::Array[GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result],
|
|
17
|
-
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary
|
|
20
|
+
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary,
|
|
21
|
+
?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?
|
|
18
22
|
) -> void
|
|
19
23
|
|
|
20
24
|
def to_hash: -> {
|
|
21
25
|
results: ::Array[GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Result],
|
|
22
|
-
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary
|
|
26
|
+
summary: GrowsurfRuby::Models::Campaign::ParticipantBulkDeleteResponse::Summary,
|
|
27
|
+
?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?
|
|
23
28
|
}
|
|
24
29
|
|
|
25
30
|
type result =
|
|
@@ -1,14 +1,16 @@
|
|
|
1
1
|
module GrowsurfRuby
|
|
2
2
|
module Models
|
|
3
3
|
module Campaign
|
|
4
|
-
type participant_delete_response = { success: bool }
|
|
4
|
+
type participant_delete_response = { success: bool, ?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure? }
|
|
5
5
|
|
|
6
6
|
class ParticipantDeleteResponse < GrowsurfRuby::Internal::Type::BaseModel
|
|
7
|
+
attr_accessor analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?
|
|
8
|
+
|
|
7
9
|
attr_accessor success: bool
|
|
8
10
|
|
|
9
|
-
def initialize: (success: bool) -> void
|
|
11
|
+
def initialize: (success: bool, ?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure?) -> void
|
|
10
12
|
|
|
11
|
-
def to_hash: -> { success: bool }
|
|
13
|
+
def to_hash: -> { success: bool, ?analytics_erasure: GrowsurfRuby::Models::Campaign::PendingAnalyticsErasure? }
|
|
12
14
|
end
|
|
13
15
|
end
|
|
14
16
|
end
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
module GrowsurfRuby
|
|
2
|
+
module Models
|
|
3
|
+
module Campaign
|
|
4
|
+
type pending_analytics_erasure = { status: String, operation_id: String }
|
|
5
|
+
|
|
6
|
+
class PendingAnalyticsErasure < GrowsurfRuby::Internal::Type::BaseModel
|
|
7
|
+
attr_accessor status: String
|
|
8
|
+
|
|
9
|
+
attr_accessor operation_id: String
|
|
10
|
+
|
|
11
|
+
def initialize: (status: String, operation_id: String) -> void
|
|
12
|
+
|
|
13
|
+
def to_hash: -> { status: String, operation_id: String }
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
module GrowsurfRuby
|
|
2
2
|
module Models
|
|
3
3
|
type campaign_list_participants_params =
|
|
4
|
-
{
|
|
4
|
+
{
|
|
5
|
+
id: String,
|
|
6
|
+
limit: Integer,
|
|
7
|
+
metadata: ::Hash[Symbol, String],
|
|
8
|
+
next_id: String
|
|
9
|
+
}
|
|
5
10
|
& GrowsurfRuby::Internal::Type::request_parameters
|
|
6
11
|
|
|
7
12
|
class CampaignListParticipantsParams < GrowsurfRuby::Internal::Type::BaseModel
|
|
@@ -14,6 +19,10 @@ module GrowsurfRuby
|
|
|
14
19
|
|
|
15
20
|
def limit=: (Integer) -> Integer
|
|
16
21
|
|
|
22
|
+
attr_reader metadata: ::Hash[Symbol, String]?
|
|
23
|
+
|
|
24
|
+
def metadata=: (::Hash[Symbol, String]) -> ::Hash[Symbol, String]
|
|
25
|
+
|
|
17
26
|
attr_reader next_id: String?
|
|
18
27
|
|
|
19
28
|
def next_id=: (String) -> String
|
|
@@ -21,6 +30,7 @@ module GrowsurfRuby
|
|
|
21
30
|
def initialize: (
|
|
22
31
|
id: String,
|
|
23
32
|
?limit: Integer,
|
|
33
|
+
?metadata: ::Hash[Symbol, String],
|
|
24
34
|
?next_id: String,
|
|
25
35
|
?request_options: GrowsurfRuby::request_opts
|
|
26
36
|
) -> void
|
|
@@ -28,6 +38,7 @@ module GrowsurfRuby
|
|
|
28
38
|
def to_hash: -> {
|
|
29
39
|
id: String,
|
|
30
40
|
limit: Integer,
|
|
41
|
+
metadata: ::Hash[Symbol, String],
|
|
31
42
|
next_id: String,
|
|
32
43
|
request_options: GrowsurfRuby::RequestOptions
|
|
33
44
|
}
|
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.
|
|
4
|
+
version: 1.7.0
|
|
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-
|
|
11
|
+
date: 2026-09-17 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: cgi
|
|
@@ -126,6 +126,7 @@ files:
|
|
|
126
126
|
- lib/growsurf_ruby/models/campaign/participant_trigger_referral_params.rb
|
|
127
127
|
- lib/growsurf_ruby/models/campaign/participant_trigger_referral_response.rb
|
|
128
128
|
- lib/growsurf_ruby/models/campaign/participant_update_params.rb
|
|
129
|
+
- lib/growsurf_ruby/models/campaign/pending_analytics_erasure.rb
|
|
129
130
|
- lib/growsurf_ruby/models/campaign/program_resource.rb
|
|
130
131
|
- lib/growsurf_ruby/models/campaign/program_resource_create_params.rb
|
|
131
132
|
- lib/growsurf_ruby/models/campaign/program_resource_delete_params.rb
|
|
@@ -280,6 +281,7 @@ files:
|
|
|
280
281
|
- rbi/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbi
|
|
281
282
|
- rbi/growsurf_ruby/models/campaign/participant_trigger_referral_response.rbi
|
|
282
283
|
- rbi/growsurf_ruby/models/campaign/participant_update_params.rbi
|
|
284
|
+
- rbi/growsurf_ruby/models/campaign/pending_analytics_erasure.rbi
|
|
283
285
|
- rbi/growsurf_ruby/models/campaign/program_resource.rbi
|
|
284
286
|
- rbi/growsurf_ruby/models/campaign/program_resource_create_params.rbi
|
|
285
287
|
- rbi/growsurf_ruby/models/campaign/program_resource_delete_params.rbi
|
|
@@ -433,6 +435,7 @@ files:
|
|
|
433
435
|
- sig/growsurf_ruby/models/campaign/participant_trigger_referral_params.rbs
|
|
434
436
|
- sig/growsurf_ruby/models/campaign/participant_trigger_referral_response.rbs
|
|
435
437
|
- sig/growsurf_ruby/models/campaign/participant_update_params.rbs
|
|
438
|
+
- sig/growsurf_ruby/models/campaign/pending_analytics_erasure.rbs
|
|
436
439
|
- sig/growsurf_ruby/models/campaign/program_resource.rbs
|
|
437
440
|
- sig/growsurf_ruby/models/campaign/program_resource_create_params.rbs
|
|
438
441
|
- sig/growsurf_ruby/models/campaign/program_resource_delete_params.rbs
|