knockapi 1.7.0 → 1.8.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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a8fe0e1d10c71e9d8525e72100489e37c46340b10b56774afdb51c91e42edd82
4
- data.tar.gz: '033928a1fd5f48acc9a83424c4c9f57a63fedd47510d3f6be6be822c6b0784e1'
3
+ metadata.gz: ecdf2142ece1cb5a06bdc492b95c4e0e55c24c596f3aac58d0ab7439e9ee6792
4
+ data.tar.gz: b1d8b66b23b82987cbbf69c98eb28cb5b6aafee251438246e2ac661603f0b8fa
5
5
  SHA512:
6
- metadata.gz: 1d390284ec7a8d3d6229b24536c000a93c86864fcd8280ce8c9d9c5b68ee3ca6d18cb9ec2a8cf0c69609e839941cef90e34b5e2355a0b77caf152c3db1a983b2
7
- data.tar.gz: aa2d1c5854f1f2f747862ef533f4fa6867dc0379cfff4d7fb03b6d5197bc29ea4d634c595e26ab9c454c9da589217d4c84e037b26e019b9071df5a53ae73278e
6
+ metadata.gz: e77b7bd9f3d1ff38178cb81f69b2344763e07b49f977d37c175b030081ab68fe0f2589ad38d44a9c6a4ebdae1d4621c51f489073a2cd4dd7aa4b750358a3236a
7
+ data.tar.gz: 178e6ba036c1f049a16cdf502ae3dd78d22d8bab9f203a9200a7ab904ec938c77f0fa2f85dd4fda50ef0403a8fa0dbbc7f03d4aec364942421ee6aeb5bfc3f0b
data/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # Changelog
2
2
 
3
+ ## 1.8.0 (2025-06-13)
4
+
5
+ Full Changelog: [v1.7.0...v1.8.0](https://github.com/knocklabs/knock-ruby/compare/v1.7.0...v1.8.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([c69a4d1](https://github.com/knocklabs/knock-ruby/commit/c69a4d1cb01e0e8e7fb930b862ebeb06ae217bfc))
10
+
3
11
  ## 1.7.0 (2025-06-12)
4
12
 
5
13
  Full Changelog: [v1.6.0...v1.7.0](https://github.com/knocklabs/knock-ruby/compare/v1.6.0...v1.7.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.7.0"
20
+ gem "knockapi", "~> 1.8.0"
21
21
  ```
22
22
 
23
23
  <!-- x-release-please-end -->
@@ -36,13 +36,14 @@ module Knockapi
36
36
  optional :cursor, String
37
37
 
38
38
  # @!attribute exclude_archived
39
- # Set to true to exclude archived channels from the list.
39
+ # Set to true to exclude archived channels from the list. Defaults to `true` when
40
+ # not explicitly provided.
40
41
  #
41
42
  # @return [Boolean, nil]
42
43
  optional :exclude_archived, Knockapi::Internal::Type::Boolean
43
44
 
44
45
  # @!attribute limit
45
- # The maximum number of channels to return.
46
+ # The maximum number of channels to return. Defaults to 200.
46
47
  #
47
48
  # @return [Integer, nil]
48
49
  optional :limit, Integer
@@ -55,7 +56,8 @@ module Knockapi
55
56
 
56
57
  # @!attribute types
57
58
  # Mix and match channel types by providing a comma-separated list of any
58
- # combination of public_channel, private_channel, mpim, im.
59
+ # combination of public_channel, private_channel, mpim, im. Defaults to
60
+ # `"public_channel,private_channel"`.
59
61
  #
60
62
  # @return [String, nil]
61
63
  optional :types, String
@@ -67,9 +69,9 @@ module Knockapi
67
69
  #
68
70
  # @param cursor [String] Paginate through collections of data by setting the cursor parameter to a next_c
69
71
  #
70
- # @param exclude_archived [Boolean] Set to true to exclude archived channels from the list.
72
+ # @param exclude_archived [Boolean] Set to true to exclude archived channels from the list. Defaults to `true` when
71
73
  #
72
- # @param limit [Integer] The maximum number of channels to return.
74
+ # @param limit [Integer] The maximum number of channels to return. Defaults to 200.
73
75
  #
74
76
  # @param team_id [String] Encoded team ID (T1234) to list channels in, required if org token is used.
75
77
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Knockapi
4
- VERSION = "1.7.0"
4
+ VERSION = "1.8.0"
5
5
  end
@@ -83,14 +83,15 @@ module Knockapi
83
83
  sig { params(cursor: String).void }
84
84
  attr_writer :cursor
85
85
 
86
- # Set to true to exclude archived channels from the list.
86
+ # Set to true to exclude archived channels from the list. Defaults to `true` when
87
+ # not explicitly provided.
87
88
  sig { returns(T.nilable(T::Boolean)) }
88
89
  attr_reader :exclude_archived
89
90
 
90
91
  sig { params(exclude_archived: T::Boolean).void }
91
92
  attr_writer :exclude_archived
92
93
 
93
- # The maximum number of channels to return.
94
+ # The maximum number of channels to return. Defaults to 200.
94
95
  sig { returns(T.nilable(Integer)) }
95
96
  attr_reader :limit
96
97
 
@@ -105,7 +106,8 @@ module Knockapi
105
106
  attr_writer :team_id
106
107
 
107
108
  # Mix and match channel types by providing a comma-separated list of any
108
- # combination of public_channel, private_channel, mpim, im.
109
+ # combination of public_channel, private_channel, mpim, im. Defaults to
110
+ # `"public_channel,private_channel"`.
109
111
  sig { returns(T.nilable(String)) }
110
112
  attr_reader :types
111
113
 
@@ -126,14 +128,16 @@ module Knockapi
126
128
  # next_cursor attribute returned by a previous request's response_metadata.
127
129
  # Default value fetches the first "page" of the collection.
128
130
  cursor: nil,
129
- # Set to true to exclude archived channels from the list.
131
+ # Set to true to exclude archived channels from the list. Defaults to `true` when
132
+ # not explicitly provided.
130
133
  exclude_archived: nil,
131
- # The maximum number of channels to return.
134
+ # The maximum number of channels to return. Defaults to 200.
132
135
  limit: nil,
133
136
  # Encoded team ID (T1234) to list channels in, required if org token is used.
134
137
  team_id: nil,
135
138
  # Mix and match channel types by providing a comma-separated list of any
136
- # combination of public_channel, private_channel, mpim, im.
139
+ # combination of public_channel, private_channel, mpim, im. Defaults to
140
+ # `"public_channel,private_channel"`.
137
141
  types: nil
138
142
  )
139
143
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: knockapi
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.7.0
4
+ version: 1.8.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Knock
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-06-12 00:00:00.000000000 Z
11
+ date: 2025-06-13 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: connection_pool