knockapi 1.28.0 → 1.29.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.
Files changed (11) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +1 -1
  4. data/lib/knockapi/models/audience_add_members_params.rb +10 -18
  5. data/lib/knockapi/models/audience_remove_members_params.rb +10 -18
  6. data/lib/knockapi/version.rb +1 -1
  7. data/rbi/knockapi/models/audience_add_members_params.rbi +12 -39
  8. data/rbi/knockapi/models/audience_remove_members_params.rbi +12 -39
  9. data/sig/knockapi/models/audience_add_members_params.rbs +4 -19
  10. data/sig/knockapi/models/audience_remove_members_params.rbs +4 -19
  11. metadata +1 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 64a442736b2460b038455a36525edbb82ed5c11e17e026aaa909ec0e6cb0a1f1
4
- data.tar.gz: e007cb42e465cfadcddac8988508d456bc260fe956adcc490a0d665f5b20c129
3
+ metadata.gz: 6aca8197a847207edfa736bd62c6c5747822d3317bfb2df7b702df812614a20b
4
+ data.tar.gz: ed781bd80f436aa34dc6cdbeeded35b4802224b9697aa87812df21aaa8fa3724
5
5
  SHA512:
6
- metadata.gz: 1159248a48a06c4e456157b3a335bd71984979a2c4d5a5956f3eb6505a29653b01c5f35c768d04adb6285882e9b4f4a06d7d6760bb030d1e1174abc78e5b1f01
7
- data.tar.gz: 0ba8d28798f8222322b4fde1a681fa12d8650d3e236fec5f934a80ece6d9c731ff0348ec7a5a2719246e33b64a69b5bc34f075cf9e1312ff781fc1d9d87ddd9b
6
+ metadata.gz: 89fcac1b17dd519c28c40f4934d9d45d4312e0b8a179c2bdb64a288756498c822d9deb2415da6d52056b31be3279cb2b59ade4210b6b8eebb76aa7503020464d
7
+ data.tar.gz: 22cc9546c00292a39bfd0ed2156542b8553fa0ac7e2e68112b23f56680c1cd6d63ccd70fbe2f521bdaa9978c773067170a8861b3a17e3e8bb3801afdb79c5298
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.29.0 (2026-01-23)
4
+
5
+ Full Changelog: [v1.28.0...v1.29.0](https://github.com/knocklabs/knock-ruby/compare/v1.28.0...v1.29.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([bea8ceb](https://github.com/knocklabs/knock-ruby/commit/bea8cebbd2499815f0117dc68193e7b1cac3545e))
10
+
3
11
  ## 1.28.0 (2026-01-23)
4
12
 
5
13
  Full Changelog: [v1.27.0...v1.28.0](https://github.com/knocklabs/knock-ruby/compare/v1.27.0...v1.28.0)
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 "knockapi", "~> 1.28.0"
20
+ gem "knockapi", "~> 1.29.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
data/lib/knockapi/models/audience_add_members_params.rb CHANGED
@@ -20,10 +20,13 @@ module Knockapi
20
20
 
21
21
  class Member < Knockapi::Internal::Type::BaseModel
22
22
  # @!attribute user
23
- # An object containing the user's ID.
23
+ # A set of parameters to inline-identify a user with. Inline identifying the user
24
+ # will ensure that the user is available before the request is executed in Knock.
25
+ # It will perform an upsert for the user you're supplying, replacing any
26
+ # properties specified.
24
27
  #
25
- # @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
26
- required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }
28
+ # @return [Knockapi::Models::InlineIdentifyUserRequest]
29
+ required :user, -> { Knockapi::InlineIdentifyUserRequest }
27
30
 
28
31
  # @!attribute tenant
29
32
  # The unique identifier for the tenant.
@@ -32,25 +35,14 @@ module Knockapi
32
35
  optional :tenant, String, nil?: true
33
36
 
34
37
  # @!method initialize(user:, tenant: nil)
38
+ # Some parameter documentations has been truncated, see
39
+ # {Knockapi::Models::AudienceAddMembersParams::Member} for more details.
40
+ #
35
41
  # An audience member.
36
42
  #
37
- # @param user [Knockapi::Models::AudienceAddMembersParams::Member::User] An object containing the user's ID.
43
+ # @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
38
44
  #
39
45
  # @param tenant [String, nil] The unique identifier for the tenant.
40
-
41
- # @see Knockapi::Models::AudienceAddMembersParams::Member#user
42
- class User < Knockapi::Internal::Type::BaseModel
43
- # @!attribute id
44
- # The unique identifier of the user.
45
- #
46
- # @return [String, nil]
47
- optional :id, String
48
-
49
- # @!method initialize(id: nil)
50
- # An object containing the user's ID.
51
- #
52
- # @param id [String] The unique identifier of the user.
53
- end
54
46
  end
55
47
  end
56
48
  end
data/lib/knockapi/models/audience_remove_members_params.rb CHANGED
@@ -20,10 +20,13 @@ module Knockapi
20
20
 
21
21
  class Member < Knockapi::Internal::Type::BaseModel
22
22
  # @!attribute user
23
- # An object containing the user's ID.
23
+ # A set of parameters to inline-identify a user with. Inline identifying the user
24
+ # will ensure that the user is available before the request is executed in Knock.
25
+ # It will perform an upsert for the user you're supplying, replacing any
26
+ # properties specified.
24
27
  #
25
- # @return [Knockapi::Models::AudienceRemoveMembersParams::Member::User]
26
- required :user, -> { Knockapi::AudienceRemoveMembersParams::Member::User }
28
+ # @return [Knockapi::Models::InlineIdentifyUserRequest]
29
+ required :user, -> { Knockapi::InlineIdentifyUserRequest }
27
30
 
28
31
  # @!attribute tenant
29
32
  # The unique identifier for the tenant.
@@ -32,25 +35,14 @@ module Knockapi
32
35
  optional :tenant, String, nil?: true
33
36
 
34
37
  # @!method initialize(user:, tenant: nil)
38
+ # Some parameter documentations has been truncated, see
39
+ # {Knockapi::Models::AudienceRemoveMembersParams::Member} for more details.
40
+ #
35
41
  # An audience member.
36
42
  #
37
- # @param user [Knockapi::Models::AudienceRemoveMembersParams::Member::User] An object containing the user's ID.
43
+ # @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
38
44
  #
39
45
  # @param tenant [String, nil] The unique identifier for the tenant.
40
-
41
- # @see Knockapi::Models::AudienceRemoveMembersParams::Member#user
42
- class User < Knockapi::Internal::Type::BaseModel
43
- # @!attribute id
44
- # The unique identifier of the user.
45
- #
46
- # @return [String, nil]
47
- optional :id, String
48
-
49
- # @!method initialize(id: nil)
50
- # An object containing the user's ID.
51
- #
52
- # @param id [String] The unique identifier of the user.
53
- end
54
46
  end
55
47
  end
56
48
  end
data/lib/knockapi/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Knockapi
4
- VERSION = "1.28.0"
4
+ VERSION = "1.29.0"
5
5
  end
data/rbi/knockapi/models/audience_add_members_params.rbi CHANGED
@@ -48,15 +48,14 @@ module Knockapi
48
48
  )
49
49
  end
50
50
 
51
- # An object containing the user's ID.
52
- sig { returns(Knockapi::AudienceAddMembersParams::Member::User) }
51
+ # A set of parameters to inline-identify a user with. Inline identifying the user
52
+ # will ensure that the user is available before the request is executed in Knock.
53
+ # It will perform an upsert for the user you're supplying, replacing any
54
+ # properties specified.
55
+ sig { returns(Knockapi::InlineIdentifyUserRequest) }
53
56
  attr_reader :user
54
57
 
55
- sig do
56
- params(
57
- user: Knockapi::AudienceAddMembersParams::Member::User::OrHash
58
- ).void
59
- end
58
+ sig { params(user: Knockapi::InlineIdentifyUserRequest::OrHash).void }
60
59
  attr_writer :user
61
60
 
62
61
  # The unique identifier for the tenant.
@@ -66,12 +65,15 @@ module Knockapi
66
65
  # An audience member.
67
66
  sig do
68
67
  params(
69
- user: Knockapi::AudienceAddMembersParams::Member::User::OrHash,
68
+ user: Knockapi::InlineIdentifyUserRequest::OrHash,
70
69
  tenant: T.nilable(String)
71
70
  ).returns(T.attached_class)
72
71
  end
73
72
  def self.new(
74
- # An object containing the user's ID.
73
+ # A set of parameters to inline-identify a user with. Inline identifying the user
74
+ # will ensure that the user is available before the request is executed in Knock.
75
+ # It will perform an upsert for the user you're supplying, replacing any
76
+ # properties specified.
75
77
  user:,
76
78
  # The unique identifier for the tenant.
77
79
  tenant: nil
@@ -81,42 +83,13 @@ module Knockapi
81
83
  sig do
82
84
  override.returns(
83
85
  {
84
- user: Knockapi::AudienceAddMembersParams::Member::User,
86
+ user: Knockapi::InlineIdentifyUserRequest,
85
87
  tenant: T.nilable(String)
86
88
  }
87
89
  )
88
90
  end
89
91
  def to_hash
90
92
  end
91
-
92
- class User < Knockapi::Internal::Type::BaseModel
93
- OrHash =
94
- T.type_alias do
95
- T.any(
96
- Knockapi::AudienceAddMembersParams::Member::User,
97
- Knockapi::Internal::AnyHash
98
- )
99
- end
100
-
101
- # The unique identifier of the user.
102
- sig { returns(T.nilable(String)) }
103
- attr_reader :id
104
-
105
- sig { params(id: String).void }
106
- attr_writer :id
107
-
108
- # An object containing the user's ID.
109
- sig { params(id: String).returns(T.attached_class) }
110
- def self.new(
111
- # The unique identifier of the user.
112
- id: nil
113
- )
114
- end
115
-
116
- sig { override.returns({ id: String }) }
117
- def to_hash
118
- end
119
- end
120
93
  end
121
94
  end
122
95
  end
data/rbi/knockapi/models/audience_remove_members_params.rbi CHANGED
@@ -52,15 +52,14 @@ module Knockapi
52
52
  )
53
53
  end
54
54
 
55
- # An object containing the user's ID.
56
- sig { returns(Knockapi::AudienceRemoveMembersParams::Member::User) }
55
+ # A set of parameters to inline-identify a user with. Inline identifying the user
56
+ # will ensure that the user is available before the request is executed in Knock.
57
+ # It will perform an upsert for the user you're supplying, replacing any
58
+ # properties specified.
59
+ sig { returns(Knockapi::InlineIdentifyUserRequest) }
57
60
  attr_reader :user
58
61
 
59
- sig do
60
- params(
61
- user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash
62
- ).void
63
- end
62
+ sig { params(user: Knockapi::InlineIdentifyUserRequest::OrHash).void }
64
63
  attr_writer :user
65
64
 
66
65
  # The unique identifier for the tenant.
@@ -70,12 +69,15 @@ module Knockapi
70
69
  # An audience member.
71
70
  sig do
72
71
  params(
73
- user: Knockapi::AudienceRemoveMembersParams::Member::User::OrHash,
72
+ user: Knockapi::InlineIdentifyUserRequest::OrHash,
74
73
  tenant: T.nilable(String)
75
74
  ).returns(T.attached_class)
76
75
  end
77
76
  def self.new(
78
- # An object containing the user's ID.
77
+ # A set of parameters to inline-identify a user with. Inline identifying the user
78
+ # will ensure that the user is available before the request is executed in Knock.
79
+ # It will perform an upsert for the user you're supplying, replacing any
80
+ # properties specified.
79
81
  user:,
80
82
  # The unique identifier for the tenant.
81
83
  tenant: nil
@@ -85,42 +87,13 @@ module Knockapi
85
87
  sig do
86
88
  override.returns(
87
89
  {
88
- user: Knockapi::AudienceRemoveMembersParams::Member::User,
90
+ user: Knockapi::InlineIdentifyUserRequest,
89
91
  tenant: T.nilable(String)
90
92
  }
91
93
  )
92
94
  end
93
95
  def to_hash
94
96
  end
95
-
96
- class User < Knockapi::Internal::Type::BaseModel
97
- OrHash =
98
- T.type_alias do
99
- T.any(
100
- Knockapi::AudienceRemoveMembersParams::Member::User,
101
- Knockapi::Internal::AnyHash
102
- )
103
- end
104
-
105
- # The unique identifier of the user.
106
- sig { returns(T.nilable(String)) }
107
- attr_reader :id
108
-
109
- sig { params(id: String).void }
110
- attr_writer :id
111
-
112
- # An object containing the user's ID.
113
- sig { params(id: String).returns(T.attached_class) }
114
- def self.new(
115
- # The unique identifier of the user.
116
- id: nil
117
- )
118
- end
119
-
120
- sig { override.returns({ id: String }) }
121
- def to_hash
122
- end
123
- end
124
97
  end
125
98
  end
126
99
  end
data/sig/knockapi/models/audience_add_members_params.rbs CHANGED
@@ -21,37 +21,22 @@ module Knockapi
21
21
  }
22
22
 
23
23
  type member =
24
- {
25
- user: Knockapi::AudienceAddMembersParams::Member::User,
26
- tenant: String?
27
- }
24
+ { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
28
25
 
29
26
  class Member < Knockapi::Internal::Type::BaseModel
30
- attr_accessor user: Knockapi::AudienceAddMembersParams::Member::User
27
+ attr_accessor user: Knockapi::InlineIdentifyUserRequest
31
28
 
32
29
  attr_accessor tenant: String?
33
30
 
34
31
  def initialize: (
35
- user: Knockapi::AudienceAddMembersParams::Member::User,
32
+ user: Knockapi::InlineIdentifyUserRequest,
36
33
  ?tenant: String?
37
34
  ) -> void
38
35
 
39
36
  def to_hash: -> {
40
- user: Knockapi::AudienceAddMembersParams::Member::User,
37
+ user: Knockapi::InlineIdentifyUserRequest,
41
38
  tenant: String?
42
39
  }
43
-
44
- type user = { id: String }
45
-
46
- class User < Knockapi::Internal::Type::BaseModel
47
- attr_reader id: String?
48
-
49
- def id=: (String) -> String
50
-
51
- def initialize: (?id: String) -> void
52
-
53
- def to_hash: -> { id: String }
54
- end
55
40
  end
56
41
  end
57
42
  end
data/sig/knockapi/models/audience_remove_members_params.rbs CHANGED
@@ -21,37 +21,22 @@ module Knockapi
21
21
  }
22
22
 
23
23
  type member =
24
- {
25
- user: Knockapi::AudienceRemoveMembersParams::Member::User,
26
- tenant: String?
27
- }
24
+ { user: Knockapi::InlineIdentifyUserRequest, tenant: String? }
28
25
 
29
26
  class Member < Knockapi::Internal::Type::BaseModel
30
- attr_accessor user: Knockapi::AudienceRemoveMembersParams::Member::User
27
+ attr_accessor user: Knockapi::InlineIdentifyUserRequest
31
28
 
32
29
  attr_accessor tenant: String?
33
30
 
34
31
  def initialize: (
35
- user: Knockapi::AudienceRemoveMembersParams::Member::User,
32
+ user: Knockapi::InlineIdentifyUserRequest,
36
33
  ?tenant: String?
37
34
  ) -> void
38
35
 
39
36
  def to_hash: -> {
40
- user: Knockapi::AudienceRemoveMembersParams::Member::User,
37
+ user: Knockapi::InlineIdentifyUserRequest,
41
38
  tenant: String?
42
39
  }
43
-
44
- type user = { id: String }
45
-
46
- class User < Knockapi::Internal::Type::BaseModel
47
- attr_reader id: String?
48
-
49
- def id=: (String) -> String
50
-
51
- def initialize: (?id: String) -> void
52
-
53
- def to_hash: -> { id: String }
54
- end
55
40
  end
56
41
  end
57
42
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: knockapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.28.0
4
+ version: 1.29.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Knock