airbyte-agent-slack 0.1.20__tar.gz → 0.1.28__tar.gz

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 (62) hide show
  1. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/AUTH.md +2 -2
  2. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/CHANGELOG.md +40 -0
  3. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/PKG-INFO +7 -7
  4. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/README.md +6 -6
  5. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/REFERENCE.md +224 -2
  6. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/__init__.py +34 -6
  7. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/connector_model_loader.py +138 -8
  8. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/executor/local_executor.py +3 -1
  9. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http_client.py +1 -1
  10. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/introspection.py +222 -10
  11. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/components.py +5 -0
  12. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/security.py +0 -1
  13. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/types.py +1 -0
  14. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/connector.py +265 -32
  15. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/connector_model.py +101 -4
  16. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/models.py +184 -24
  17. airbyte_agent_slack-0.1.28/airbyte_agent_slack/types.py +883 -0
  18. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/pyproject.toml +1 -1
  19. airbyte_agent_slack-0.1.20/airbyte_agent_slack/types.py +0 -98
  20. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/.gitignore +0 -0
  21. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/__init__.py +0 -0
  22. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/__init__.py +0 -0
  23. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/auth_strategies.py +0 -0
  24. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/auth_template.py +0 -0
  25. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/cloud_utils/__init__.py +0 -0
  26. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/cloud_utils/client.py +0 -0
  27. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/constants.py +0 -0
  28. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/exceptions.py +0 -0
  29. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/executor/__init__.py +0 -0
  30. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/executor/hosted_executor.py +0 -0
  31. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/executor/models.py +0 -0
  32. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/extensions.py +0 -0
  33. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/__init__.py +0 -0
  34. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/adapters/__init__.py +0 -0
  35. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/adapters/httpx_adapter.py +0 -0
  36. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/config.py +0 -0
  37. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/exceptions.py +0 -0
  38. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/protocols.py +0 -0
  39. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/http/response.py +0 -0
  40. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/logging/__init__.py +0 -0
  41. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/logging/logger.py +0 -0
  42. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/logging/types.py +0 -0
  43. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/observability/__init__.py +0 -0
  44. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/observability/config.py +0 -0
  45. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/observability/models.py +0 -0
  46. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/observability/redactor.py +0 -0
  47. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/observability/session.py +0 -0
  48. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/performance/__init__.py +0 -0
  49. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/performance/instrumentation.py +0 -0
  50. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/performance/metrics.py +0 -0
  51. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/__init__.py +0 -0
  52. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/base.py +0 -0
  53. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/connector.py +0 -0
  54. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/extensions.py +0 -0
  55. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/schema/operations.py +0 -0
  56. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/secrets.py +0 -0
  57. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/telemetry/__init__.py +0 -0
  58. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/telemetry/config.py +0 -0
  59. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/telemetry/events.py +0 -0
  60. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/telemetry/tracker.py +0 -0
  61. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/utils.py +0 -0
  62. {airbyte_agent_slack-0.1.20 → airbyte_agent_slack-0.1.28}/airbyte_agent_slack/_vendored/connector_sdk/validation.py +0 -0
@@ -97,13 +97,13 @@ After creating the connector, execute operations using either the Python SDK or
97
97
  from airbyte_agent_slack import SlackConnector
98
98
 
99
99
  connector = SlackConnector(
100
- external_user_id="<your-scoped-token>",
100
+ external_user_id="<your_external_user_id>",
101
101
  airbyte_client_id="<your-client-id>",
102
102
  airbyte_client_secret="<your-client-secret>"
103
103
  )
104
104
 
105
105
  @agent.tool_plain # assumes you're using Pydantic AI
106
- @SlackConnector.describe
106
+ @SlackConnector.tool_utils
107
107
  async def slack_execute(entity: str, action: str, params: dict | None = None):
108
108
  return await connector.execute(entity, action, params or {})
109
109
  ```
@@ -1,5 +1,45 @@
1
1
  # Slack changelog
2
2
 
3
+ ## [0.1.28] - 2026-01-27
4
+ - Updated connector definition (YAML version 0.1.9)
5
+ - Source commit: 0f5e1914
6
+ - SDK version: 0.1.0
7
+
8
+ ## [0.1.27] - 2026-01-27
9
+ - Updated connector definition (YAML version 0.1.9)
10
+ - Source commit: a01f6b16
11
+ - SDK version: 0.1.0
12
+
13
+ ## [0.1.26] - 2026-01-27
14
+ - Updated connector definition (YAML version 0.1.9)
15
+ - Source commit: c9b05509
16
+ - SDK version: 0.1.0
17
+
18
+ ## [0.1.25] - 2026-01-27
19
+ - Updated connector definition (YAML version 0.1.8)
20
+ - Source commit: 4bded58d
21
+ - SDK version: 0.1.0
22
+
23
+ ## [0.1.24] - 2026-01-26
24
+ - Updated connector definition (YAML version 0.1.8)
25
+ - Source commit: 74809153
26
+ - SDK version: 0.1.0
27
+
28
+ ## [0.1.23] - 2026-01-26
29
+ - Updated connector definition (YAML version 0.1.8)
30
+ - Source commit: b73c71e0
31
+ - SDK version: 0.1.0
32
+
33
+ ## [0.1.22] - 2026-01-24
34
+ - Updated connector definition (YAML version 0.1.8)
35
+ - Source commit: 609c1d86
36
+ - SDK version: 0.1.0
37
+
38
+ ## [0.1.21] - 2026-01-23
39
+ - Updated connector definition (YAML version 0.1.8)
40
+ - Source commit: 32c5ef46
41
+ - SDK version: 0.1.0
42
+
3
43
  ## [0.1.20] - 2026-01-23
4
44
  - Updated connector definition (YAML version 0.1.7)
5
45
  - Source commit: 049f6ad5
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-slack
3
- Version: 0.1.20
3
+ Version: 0.1.28
4
4
  Summary: Airbyte Slack Connector for AI platforms
5
5
  Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
6
6
  Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -104,7 +104,7 @@ connector = SlackConnector(
104
104
  )
105
105
 
106
106
  @agent.tool_plain # assumes you're using Pydantic AI
107
- @SlackConnector.describe
107
+ @SlackConnector.tool_utils
108
108
  async def slack_execute(entity: str, action: str, params: dict | None = None):
109
109
  return await connector.execute(entity, action, params or {})
110
110
  ```
@@ -119,13 +119,13 @@ This example assumes you've already authenticated your connector with Airbyte. S
119
119
  from airbyte_agent_slack import SlackConnector
120
120
 
121
121
  connector = SlackConnector(
122
- external_user_id="<your-scoped-token>",
122
+ external_user_id="<your_external_user_id>",
123
123
  airbyte_client_id="<your-client-id>",
124
124
  airbyte_client_secret="<your-client-secret>"
125
125
  )
126
126
 
127
127
  @agent.tool_plain # assumes you're using Pydantic AI
128
- @SlackConnector.describe
128
+ @SlackConnector.tool_utils
129
129
  async def slack_execute(entity: str, action: str, params: dict | None = None):
130
130
  return await connector.execute(entity, action, params or {})
131
131
  ```
@@ -158,6 +158,6 @@ For the service's official API docs, see the [Slack API reference](https://api.s
158
158
 
159
159
  ## Version information
160
160
 
161
- - **Package version:** 0.1.20
162
- - **Connector version:** 0.1.7
163
- - **Generated with Connector SDK commit SHA:** 049f6ad546186bde8303b77e0e1001a831a58654
161
+ - **Package version:** 0.1.28
162
+ - **Connector version:** 0.1.9
163
+ - **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
@@ -71,7 +71,7 @@ connector = SlackConnector(
71
71
  )
72
72
 
73
73
  @agent.tool_plain # assumes you're using Pydantic AI
74
- @SlackConnector.describe
74
+ @SlackConnector.tool_utils
75
75
  async def slack_execute(entity: str, action: str, params: dict | None = None):
76
76
  return await connector.execute(entity, action, params or {})
77
77
  ```
@@ -86,13 +86,13 @@ This example assumes you've already authenticated your connector with Airbyte. S
86
86
  from airbyte_agent_slack import SlackConnector
87
87
 
88
88
  connector = SlackConnector(
89
- external_user_id="<your-scoped-token>",
89
+ external_user_id="<your_external_user_id>",
90
90
  airbyte_client_id="<your-client-id>",
91
91
  airbyte_client_secret="<your-client-secret>"
92
92
  )
93
93
 
94
94
  @agent.tool_plain # assumes you're using Pydantic AI
95
- @SlackConnector.describe
95
+ @SlackConnector.tool_utils
96
96
  async def slack_execute(entity: str, action: str, params: dict | None = None):
97
97
  return await connector.execute(entity, action, params or {})
98
98
  ```
@@ -125,6 +125,6 @@ For the service's official API docs, see the [Slack API reference](https://api.s
125
125
 
126
126
  ## Version information
127
127
 
128
- - **Package version:** 0.1.20
129
- - **Connector version:** 0.1.7
130
- - **Generated with Connector SDK commit SHA:** 049f6ad546186bde8303b77e0e1001a831a58654
128
+ - **Package version:** 0.1.28
129
+ - **Connector version:** 0.1.9
130
+ - **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
@@ -8,8 +8,8 @@ The Slack connector supports the following entities and actions.
8
8
 
9
9
  | Entity | Actions |
10
10
  |--------|---------|
11
- | Users | [List](#users-list), [Get](#users-get) |
12
- | Channels | [List](#channels-list), [Get](#channels-get), [Create](#channels-create), [Update](#channels-update) |
11
+ | Users | [List](#users-list), [Get](#users-get), [Search](#users-search) |
12
+ | Channels | [List](#channels-list), [Get](#channels-get), [Create](#channels-create), [Update](#channels-update), [Search](#channels-search) |
13
13
  | Channel Messages | [List](#channel-messages-list) |
14
14
  | Threads | [List](#threads-list) |
15
15
  | Messages | [Create](#messages-create), [Update](#messages-update) |
@@ -151,6 +151,109 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
151
151
  | `who_can_share_contact_card` | `string \| null` | |
152
152
 
153
153
 
154
+ </details>
155
+
156
+ ### Users Search
157
+
158
+ Search and filter users records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
159
+
160
+ #### Python SDK
161
+
162
+ ```python
163
+ await slack.users.search(
164
+ query={"filter": {"eq": {"color": "<str>"}}}
165
+ )
166
+ ```
167
+
168
+ #### API
169
+
170
+ ```bash
171
+ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
172
+ --header 'Content-Type: application/json' \
173
+ --header 'Authorization: Bearer {your_auth_token}' \
174
+ --data '{
175
+ "entity": "users",
176
+ "action": "search",
177
+ "params": {
178
+ "query": {"filter": {"eq": {"color": "<str>"}}}
179
+ }
180
+ }'
181
+ ```
182
+
183
+ #### Parameters
184
+
185
+ | Parameter Name | Type | Required | Description |
186
+ |----------------|------|----------|-------------|
187
+ | `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
188
+ | `query.filter` | `object` | No | Filter conditions |
189
+ | `query.sort` | `array` | No | Sort conditions |
190
+ | `limit` | `integer` | No | Maximum results to return (default 1000) |
191
+ | `cursor` | `string` | No | Pagination cursor from previous response's next_cursor |
192
+ | `fields` | `array` | No | Field paths to include in results |
193
+
194
+ #### Searchable Fields
195
+
196
+ | Field Name | Type | Description |
197
+ |------------|------|-------------|
198
+ | `color` | `string` | The color assigned to the user for visual purposes. |
199
+ | `deleted` | `boolean` | Indicates if the user is deleted or not. |
200
+ | `has_2fa` | `boolean` | Flag indicating if the user has two-factor authentication enabled. |
201
+ | `id` | `string` | Unique identifier for the user. |
202
+ | `is_admin` | `boolean` | Flag specifying if the user is an admin or not. |
203
+ | `is_app_user` | `boolean` | Specifies if the user is an app user. |
204
+ | `is_bot` | `boolean` | Indicates if the user is a bot account. |
205
+ | `is_email_confirmed` | `boolean` | Flag indicating if the user's email is confirmed. |
206
+ | `is_forgotten` | `boolean` | Specifies if the user is marked as forgotten. |
207
+ | `is_invited_user` | `boolean` | Indicates if the user is invited or not. |
208
+ | `is_owner` | `boolean` | Flag indicating if the user is an owner. |
209
+ | `is_primary_owner` | `boolean` | Specifies if the user is the primary owner. |
210
+ | `is_restricted` | `boolean` | Flag specifying if the user is restricted. |
211
+ | `is_ultra_restricted` | `boolean` | Indicates if the user has ultra-restricted access. |
212
+ | `name` | `string` | The username of the user. |
213
+ | `profile` | `object` | User's profile information containing detailed details. |
214
+ | `real_name` | `string` | The real name of the user. |
215
+ | `team_id` | `string` | Unique identifier for the team the user belongs to. |
216
+ | `tz` | `string` | Timezone of the user. |
217
+ | `tz_label` | `string` | Label representing the timezone of the user. |
218
+ | `tz_offset` | `integer` | Offset of the user's timezone. |
219
+ | `updated` | `integer` | Timestamp of when the user's information was last updated. |
220
+ | `who_can_share_contact_card` | `string` | Specifies who can share the user's contact card. |
221
+
222
+ <details>
223
+ <summary><b>Response Schema</b></summary>
224
+
225
+ | Field Name | Type | Description |
226
+ |------------|------|-------------|
227
+ | `hits` | `array` | List of matching records |
228
+ | `hits[].id` | `string` | Record identifier |
229
+ | `hits[].score` | `number` | Relevance score |
230
+ | `hits[].data` | `object` | Record data containing the searchable fields listed above |
231
+ | `hits[].data.color` | `string` | The color assigned to the user for visual purposes. |
232
+ | `hits[].data.deleted` | `boolean` | Indicates if the user is deleted or not. |
233
+ | `hits[].data.has_2fa` | `boolean` | Flag indicating if the user has two-factor authentication enabled. |
234
+ | `hits[].data.id` | `string` | Unique identifier for the user. |
235
+ | `hits[].data.is_admin` | `boolean` | Flag specifying if the user is an admin or not. |
236
+ | `hits[].data.is_app_user` | `boolean` | Specifies if the user is an app user. |
237
+ | `hits[].data.is_bot` | `boolean` | Indicates if the user is a bot account. |
238
+ | `hits[].data.is_email_confirmed` | `boolean` | Flag indicating if the user's email is confirmed. |
239
+ | `hits[].data.is_forgotten` | `boolean` | Specifies if the user is marked as forgotten. |
240
+ | `hits[].data.is_invited_user` | `boolean` | Indicates if the user is invited or not. |
241
+ | `hits[].data.is_owner` | `boolean` | Flag indicating if the user is an owner. |
242
+ | `hits[].data.is_primary_owner` | `boolean` | Specifies if the user is the primary owner. |
243
+ | `hits[].data.is_restricted` | `boolean` | Flag specifying if the user is restricted. |
244
+ | `hits[].data.is_ultra_restricted` | `boolean` | Indicates if the user has ultra-restricted access. |
245
+ | `hits[].data.name` | `string` | The username of the user. |
246
+ | `hits[].data.profile` | `object` | User's profile information containing detailed details. |
247
+ | `hits[].data.real_name` | `string` | The real name of the user. |
248
+ | `hits[].data.team_id` | `string` | Unique identifier for the team the user belongs to. |
249
+ | `hits[].data.tz` | `string` | Timezone of the user. |
250
+ | `hits[].data.tz_label` | `string` | Label representing the timezone of the user. |
251
+ | `hits[].data.tz_offset` | `integer` | Offset of the user's timezone. |
252
+ | `hits[].data.updated` | `integer` | Timestamp of when the user's information was last updated. |
253
+ | `hits[].data.who_can_share_contact_card` | `string` | Specifies who can share the user's contact card. |
254
+ | `next_cursor` | `string \| null` | Cursor for next page of results |
255
+ | `took_ms` | `number` | Query execution time in milliseconds |
256
+
154
257
  </details>
155
258
 
156
259
  ## Channels
@@ -471,6 +574,125 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
471
574
  | `is_read_only` | `boolean \| null` | |
472
575
 
473
576
 
577
+ </details>
578
+
579
+ ### Channels Search
580
+
581
+ Search and filter channels records powered by Airbyte's data sync. This often provides additional fields and operators beyond what the API natively supports, making it easier to narrow down results before performing further operations. Only available in hosted mode.
582
+
583
+ #### Python SDK
584
+
585
+ ```python
586
+ await slack.channels.search(
587
+ query={"filter": {"eq": {"context_team_id": "<str>"}}}
588
+ )
589
+ ```
590
+
591
+ #### API
592
+
593
+ ```bash
594
+ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_id}/execute' \
595
+ --header 'Content-Type: application/json' \
596
+ --header 'Authorization: Bearer {your_auth_token}' \
597
+ --data '{
598
+ "entity": "channels",
599
+ "action": "search",
600
+ "params": {
601
+ "query": {"filter": {"eq": {"context_team_id": "<str>"}}}
602
+ }
603
+ }'
604
+ ```
605
+
606
+ #### Parameters
607
+
608
+ | Parameter Name | Type | Required | Description |
609
+ |----------------|------|----------|-------------|
610
+ | `query` | `object` | Yes | Filter and sort conditions. Supports operators: eq, neq, gt, gte, lt, lte, in, like, fuzzy, keyword, not, and, or |
611
+ | `query.filter` | `object` | No | Filter conditions |
612
+ | `query.sort` | `array` | No | Sort conditions |
613
+ | `limit` | `integer` | No | Maximum results to return (default 1000) |
614
+ | `cursor` | `string` | No | Pagination cursor from previous response's next_cursor |
615
+ | `fields` | `array` | No | Field paths to include in results |
616
+
617
+ #### Searchable Fields
618
+
619
+ | Field Name | Type | Description |
620
+ |------------|------|-------------|
621
+ | `context_team_id` | `string` | The unique identifier of the team context in which the channel exists. |
622
+ | `created` | `integer` | The timestamp when the channel was created. |
623
+ | `creator` | `string` | The ID of the user who created the channel. |
624
+ | `id` | `string` | The unique identifier of the channel. |
625
+ | `is_archived` | `boolean` | Indicates if the channel is archived. |
626
+ | `is_channel` | `boolean` | Indicates if the entity is a channel. |
627
+ | `is_ext_shared` | `boolean` | Indicates if the channel is externally shared. |
628
+ | `is_general` | `boolean` | Indicates if the channel is a general channel in the workspace. |
629
+ | `is_group` | `boolean` | Indicates if the channel is a group (private channel) rather than a regular channel. |
630
+ | `is_im` | `boolean` | Indicates if the entity is a direct message (IM) channel. |
631
+ | `is_member` | `boolean` | Indicates if the calling user is a member of the channel. |
632
+ | `is_mpim` | `boolean` | Indicates if the entity is a multiple person direct message (MPIM) channel. |
633
+ | `is_org_shared` | `boolean` | Indicates if the channel is organization-wide shared. |
634
+ | `is_pending_ext_shared` | `boolean` | Indicates if the channel is pending external shared. |
635
+ | `is_private` | `boolean` | Indicates if the channel is a private channel. |
636
+ | `is_read_only` | `boolean` | Indicates if the channel is read-only. |
637
+ | `is_shared` | `boolean` | Indicates if the channel is shared. |
638
+ | `last_read` | `string` | The timestamp of the user's last read message in the channel. |
639
+ | `locale` | `string` | The locale of the channel. |
640
+ | `name` | `string` | The name of the channel. |
641
+ | `name_normalized` | `string` | The normalized name of the channel. |
642
+ | `num_members` | `integer` | The number of members in the channel. |
643
+ | `parent_conversation` | `string` | The parent conversation of the channel. |
644
+ | `pending_connected_team_ids` | `array` | The IDs of teams that are pending to be connected to the channel. |
645
+ | `pending_shared` | `array` | The list of pending shared items of the channel. |
646
+ | `previous_names` | `array` | The previous names of the channel. |
647
+ | `purpose` | `object` | The purpose of the channel. |
648
+ | `shared_team_ids` | `array` | The IDs of teams with which the channel is shared. |
649
+ | `topic` | `object` | The topic of the channel. |
650
+ | `unlinked` | `integer` | Indicates if the channel is unlinked. |
651
+ | `updated` | `integer` | The timestamp when the channel was last updated. |
652
+
653
+ <details>
654
+ <summary><b>Response Schema</b></summary>
655
+
656
+ | Field Name | Type | Description |
657
+ |------------|------|-------------|
658
+ | `hits` | `array` | List of matching records |
659
+ | `hits[].id` | `string` | Record identifier |
660
+ | `hits[].score` | `number` | Relevance score |
661
+ | `hits[].data` | `object` | Record data containing the searchable fields listed above |
662
+ | `hits[].data.context_team_id` | `string` | The unique identifier of the team context in which the channel exists. |
663
+ | `hits[].data.created` | `integer` | The timestamp when the channel was created. |
664
+ | `hits[].data.creator` | `string` | The ID of the user who created the channel. |
665
+ | `hits[].data.id` | `string` | The unique identifier of the channel. |
666
+ | `hits[].data.is_archived` | `boolean` | Indicates if the channel is archived. |
667
+ | `hits[].data.is_channel` | `boolean` | Indicates if the entity is a channel. |
668
+ | `hits[].data.is_ext_shared` | `boolean` | Indicates if the channel is externally shared. |
669
+ | `hits[].data.is_general` | `boolean` | Indicates if the channel is a general channel in the workspace. |
670
+ | `hits[].data.is_group` | `boolean` | Indicates if the channel is a group (private channel) rather than a regular channel. |
671
+ | `hits[].data.is_im` | `boolean` | Indicates if the entity is a direct message (IM) channel. |
672
+ | `hits[].data.is_member` | `boolean` | Indicates if the calling user is a member of the channel. |
673
+ | `hits[].data.is_mpim` | `boolean` | Indicates if the entity is a multiple person direct message (MPIM) channel. |
674
+ | `hits[].data.is_org_shared` | `boolean` | Indicates if the channel is organization-wide shared. |
675
+ | `hits[].data.is_pending_ext_shared` | `boolean` | Indicates if the channel is pending external shared. |
676
+ | `hits[].data.is_private` | `boolean` | Indicates if the channel is a private channel. |
677
+ | `hits[].data.is_read_only` | `boolean` | Indicates if the channel is read-only. |
678
+ | `hits[].data.is_shared` | `boolean` | Indicates if the channel is shared. |
679
+ | `hits[].data.last_read` | `string` | The timestamp of the user's last read message in the channel. |
680
+ | `hits[].data.locale` | `string` | The locale of the channel. |
681
+ | `hits[].data.name` | `string` | The name of the channel. |
682
+ | `hits[].data.name_normalized` | `string` | The normalized name of the channel. |
683
+ | `hits[].data.num_members` | `integer` | The number of members in the channel. |
684
+ | `hits[].data.parent_conversation` | `string` | The parent conversation of the channel. |
685
+ | `hits[].data.pending_connected_team_ids` | `array` | The IDs of teams that are pending to be connected to the channel. |
686
+ | `hits[].data.pending_shared` | `array` | The list of pending shared items of the channel. |
687
+ | `hits[].data.previous_names` | `array` | The previous names of the channel. |
688
+ | `hits[].data.purpose` | `object` | The purpose of the channel. |
689
+ | `hits[].data.shared_team_ids` | `array` | The IDs of teams with which the channel is shared. |
690
+ | `hits[].data.topic` | `object` | The topic of the channel. |
691
+ | `hits[].data.unlinked` | `integer` | Indicates if the channel is unlinked. |
692
+ | `hits[].data.updated` | `integer` | The timestamp when the channel was last updated. |
693
+ | `next_cursor` | `string \| null` | Cursor for next page of results |
694
+ | `took_ms` | `number` | Query execution time in milliseconds |
695
+
474
696
  </details>
475
697
 
476
698
  ## Channel Messages
@@ -17,9 +17,9 @@ from .models import (
17
17
  ChannelPurpose,
18
18
  ChannelsListResponse,
19
19
  ChannelResponse,
20
- Reaction,
21
- Attachment,
22
20
  File,
21
+ Attachment,
22
+ Reaction,
23
23
  Message,
24
24
  Thread,
25
25
  EditedInfo,
@@ -50,7 +50,13 @@ from .models import (
50
50
  UsersListResult,
51
51
  ChannelsListResult,
52
52
  ChannelMessagesListResult,
53
- ThreadsListResult
53
+ ThreadsListResult,
54
+ AirbyteSearchHit,
55
+ AirbyteSearchResult,
56
+ ChannelsSearchData,
57
+ ChannelsSearchResult,
58
+ UsersSearchData,
59
+ UsersSearchResult
54
60
  )
55
61
  from .types import (
56
62
  UsersListParams,
@@ -65,7 +71,15 @@ from .types import (
65
71
  ChannelsUpdateParams,
66
72
  ChannelTopicsCreateParams,
67
73
  ChannelPurposesCreateParams,
68
- ReactionsCreateParams
74
+ ReactionsCreateParams,
75
+ AirbyteSearchParams,
76
+ AirbyteSortOrder,
77
+ ChannelsSearchFilter,
78
+ ChannelsSearchQuery,
79
+ ChannelsCondition,
80
+ UsersSearchFilter,
81
+ UsersSearchQuery,
82
+ UsersCondition
69
83
  )
70
84
 
71
85
  __all__ = [
@@ -81,9 +95,9 @@ __all__ = [
81
95
  "ChannelPurpose",
82
96
  "ChannelsListResponse",
83
97
  "ChannelResponse",
84
- "Reaction",
85
- "Attachment",
86
98
  "File",
99
+ "Attachment",
100
+ "Reaction",
87
101
  "Message",
88
102
  "Thread",
89
103
  "EditedInfo",
@@ -115,6 +129,12 @@ __all__ = [
115
129
  "ChannelsListResult",
116
130
  "ChannelMessagesListResult",
117
131
  "ThreadsListResult",
132
+ "AirbyteSearchHit",
133
+ "AirbyteSearchResult",
134
+ "ChannelsSearchData",
135
+ "ChannelsSearchResult",
136
+ "UsersSearchData",
137
+ "UsersSearchResult",
118
138
  "UsersListParams",
119
139
  "UsersGetParams",
120
140
  "ChannelsListParams",
@@ -128,4 +148,12 @@ __all__ = [
128
148
  "ChannelTopicsCreateParams",
129
149
  "ChannelPurposesCreateParams",
130
150
  "ReactionsCreateParams",
151
+ "AirbyteSearchParams",
152
+ "AirbyteSortOrder",
153
+ "ChannelsSearchFilter",
154
+ "ChannelsSearchQuery",
155
+ "ChannelsCondition",
156
+ "UsersSearchFilter",
157
+ "UsersSearchQuery",
158
+ "UsersCondition",
131
159
  ]