airbyte-agent-zendesk-support 0.18.67__tar.gz → 0.18.73__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 (61) hide show
  1. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/AUTH.md +37 -8
  2. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/CHANGELOG.md +30 -0
  3. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/PKG-INFO +12 -8
  4. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/README.md +11 -7
  5. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/REFERENCE.md +0 -1
  6. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/__init__.py +2 -0
  7. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/connector_model_loader.py +4 -0
  8. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/hosted_executor.py +5 -0
  9. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/local_executor.py +81 -0
  10. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/models.py +12 -0
  11. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/introspection.py +12 -5
  12. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/operations.py +10 -0
  13. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/tracker.py +4 -4
  14. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/types.py +16 -1
  15. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/validation.py +20 -0
  16. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/connector.py +41 -1
  17. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/connector_model.py +1 -0
  18. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/models.py +19 -0
  19. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/pyproject.toml +1 -1
  20. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/.gitignore +0 -0
  21. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/__init__.py +0 -0
  22. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/__init__.py +0 -0
  23. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/auth_strategies.py +0 -0
  24. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/auth_template.py +0 -0
  25. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/cloud_utils/__init__.py +0 -0
  26. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/cloud_utils/client.py +0 -0
  27. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/constants.py +0 -0
  28. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/exceptions.py +0 -0
  29. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/executor/__init__.py +0 -0
  30. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/extensions.py +0 -0
  31. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/__init__.py +0 -0
  32. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/adapters/__init__.py +0 -0
  33. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/adapters/httpx_adapter.py +0 -0
  34. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/config.py +0 -0
  35. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/exceptions.py +0 -0
  36. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/protocols.py +0 -0
  37. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http/response.py +0 -0
  38. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/http_client.py +0 -0
  39. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/logging/__init__.py +0 -0
  40. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/logging/logger.py +0 -0
  41. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/logging/types.py +0 -0
  42. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/observability/__init__.py +0 -0
  43. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/observability/config.py +0 -0
  44. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/observability/models.py +0 -0
  45. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/observability/redactor.py +0 -0
  46. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/observability/session.py +0 -0
  47. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/performance/__init__.py +0 -0
  48. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/performance/instrumentation.py +0 -0
  49. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/performance/metrics.py +0 -0
  50. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/__init__.py +0 -0
  51. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/base.py +0 -0
  52. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/components.py +0 -0
  53. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/connector.py +0 -0
  54. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/extensions.py +0 -0
  55. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/schema/security.py +0 -0
  56. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/secrets.py +0 -0
  57. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/__init__.py +0 -0
  58. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/config.py +0 -0
  59. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/telemetry/events.py +0 -0
  60. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/_vendored/connector_sdk/utils.py +0 -0
  61. {airbyte_agent_zendesk_support-0.18.67 → airbyte_agent_zendesk_support-0.18.73}/airbyte_agent_zendesk_support/types.py +0 -0
@@ -10,11 +10,16 @@ In open source mode, you provide API credentials directly to the connector.
10
10
 
11
11
  #### OAuth
12
12
 
13
+ `credentials` fields you need:
14
+
15
+
13
16
  | Field Name | Type | Required | Description |
14
17
  |------------|------|----------|-------------|
15
18
  | `access_token` | `str` | Yes | OAuth 2.0 access token |
16
19
  | `refresh_token` | `str` | No | OAuth 2.0 refresh token (optional) |
17
20
 
21
+ Example request:
22
+
18
23
  ```python
19
24
  from airbyte_agent_zendesk-support import ZendeskSupportConnector
20
25
  from airbyte_agent_zendesk-support.models import ZendeskSupportOauth20AuthConfig
@@ -29,11 +34,15 @@ connector = ZendeskSupportConnector(
29
34
 
30
35
  #### Token
31
36
 
37
+ `credentials` fields you need:
38
+
32
39
  | Field Name | Type | Required | Description |
33
40
  |------------|------|----------|-------------|
34
41
  | `email` | `str` | Yes | Your Zendesk account email address |
35
42
  | `api_token` | `str` | Yes | Your Zendesk API token from Admin Center |
36
43
 
44
+ Example request:
45
+
37
46
  ```python
38
47
  from airbyte_agent_zendesk-support import ZendeskSupportConnector
39
48
  from airbyte_agent_zendesk-support.models import ZendeskSupportApiTokenAuthConfig
@@ -51,13 +60,22 @@ connector = ZendeskSupportConnector(
51
60
  In hosted mode, you first create a connector via the Airbyte API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
52
61
 
53
62
  #### OAuth
63
+ Create a connector with OAuth credentials.
64
+
65
+ `credentials` fields you need:
54
66
 
55
- Create a connector with OAuth credentials:
67
+
68
+ | Field Name | Type | Required | Description |
69
+ |------------|------|----------|-------------|
70
+ | `access_token` | `str` | Yes | OAuth 2.0 access token |
71
+ | `refresh_token` | `str` | No | OAuth 2.0 refresh token (optional) |
72
+
73
+ Example request:
56
74
 
57
75
  ```bash
58
- curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
59
- -H 'Authorization: Bearer <SCOPED_TOKEN>' \
60
- -H 'Content-Type: application/json' \
76
+ curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
77
+ -H "Authorization: Bearer <SCOPED_TOKEN>" \
78
+ -H "Content-Type: application/json" \
61
79
  -d '{
62
80
  "external_user_id": "<EXTERNAL_USER_ID>",
63
81
  "connector_type": "Zendesk-Support",
@@ -70,16 +88,27 @@ curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
70
88
  ```
71
89
 
72
90
  #### Token
91
+ Create a connector with Token credentials.
92
+
93
+
94
+ `credentials` fields you need:
95
+
96
+ | Field Name | Type | Required | Description |
97
+ |------------|------|----------|-------------|
98
+ | `email` | `str` | Yes | Your Zendesk account email address |
99
+ | `api_token` | `str` | Yes | Your Zendesk API token from Admin Center |
100
+
101
+ Example request:
73
102
 
74
- Create a connector with Token credentials:
75
103
 
76
104
  ```bash
77
- curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
78
- -H 'Authorization: Bearer <SCOPED_TOKEN>' \
79
- -H 'Content-Type: application/json' \
105
+ curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
106
+ -H "Authorization: Bearer <SCOPED_TOKEN>" \
107
+ -H "Content-Type: application/json" \
80
108
  -d '{
81
109
  "external_user_id": "<EXTERNAL_USER_ID>",
82
110
  "connector_type": "Zendesk-Support",
111
+ "name": "My Zendesk-Support Connector",
83
112
  "credentials": {
84
113
  "email": "<Your Zendesk account email address>",
85
114
  "api_token": "<Your Zendesk API token from Admin Center>"
@@ -1,5 +1,35 @@
1
1
  # Zendesk Support changelog
2
2
 
3
+ ## [0.18.73] - 2026-01-30
4
+ - Updated connector definition (YAML version 0.1.9)
5
+ - Source commit: a3729d85
6
+ - SDK version: 0.1.0
7
+
8
+ ## [0.18.72] - 2026-01-29
9
+ - Updated connector definition (YAML version 0.1.9)
10
+ - Source commit: 43200eed
11
+ - SDK version: 0.1.0
12
+
13
+ ## [0.18.71] - 2026-01-29
14
+ - Updated connector definition (YAML version 0.1.9)
15
+ - Source commit: c718c683
16
+ - SDK version: 0.1.0
17
+
18
+ ## [0.18.70] - 2026-01-28
19
+ - Updated connector definition (YAML version 0.1.9)
20
+ - Source commit: 97007bbd
21
+ - SDK version: 0.1.0
22
+
23
+ ## [0.18.69] - 2026-01-28
24
+ - Updated connector definition (YAML version 0.1.9)
25
+ - Source commit: f6c6fca2
26
+ - SDK version: 0.1.0
27
+
28
+ ## [0.18.68] - 2026-01-28
29
+ - Updated connector definition (YAML version 0.1.9)
30
+ - Source commit: 71f48c10
31
+ - SDK version: 0.1.0
32
+
3
33
  ## [0.18.67] - 2026-01-27
4
34
  - Updated connector definition (YAML version 0.1.9)
5
35
  - Source commit: 0f5e1914
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-zendesk-support
3
- Version: 0.18.67
3
+ Version: 0.18.73
4
4
  Summary: Airbyte Zendesk-Support 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/
@@ -115,10 +115,11 @@ async def zendesk-support_execute(entity: str, action: str, params: dict | None
115
115
  return await connector.execute(entity, action, params or {})
116
116
  ```
117
117
 
118
-
119
118
  ## Full documentation
120
119
 
121
- This connector supports the following entities and actions.
120
+ ### Entities and actions
121
+
122
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
122
123
 
123
124
  | Entity | Actions |
124
125
  |--------|---------|
@@ -146,14 +147,17 @@ This connector supports the following entities and actions.
146
147
  | Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
147
148
 
148
149
 
149
- For all authentication options, see the connector's [authentication documentation](AUTH.md).
150
+ ### Authentication and configuration
151
+
152
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
150
153
 
151
- For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
154
+ ### Zendesk-Support API docs
152
155
 
153
- For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
156
+ See the official [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
154
157
 
155
158
  ## Version information
156
159
 
157
- - **Package version:** 0.18.67
160
+ - **Package version:** 0.18.73
158
161
  - **Connector version:** 0.1.9
159
- - **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
162
+ - **Generated with Connector SDK commit SHA:** e4eb233f8dd57ad9bc825064625222a988db2cc6
163
+ - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/zendesk-support/CHANGELOG.md)
@@ -82,10 +82,11 @@ async def zendesk-support_execute(entity: str, action: str, params: dict | None
82
82
  return await connector.execute(entity, action, params or {})
83
83
  ```
84
84
 
85
-
86
85
  ## Full documentation
87
86
 
88
- This connector supports the following entities and actions.
87
+ ### Entities and actions
88
+
89
+ This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
89
90
 
90
91
  | Entity | Actions |
91
92
  |--------|---------|
@@ -113,14 +114,17 @@ This connector supports the following entities and actions.
113
114
  | Article Attachments | [List](./REFERENCE.md#article-attachments-list), [Get](./REFERENCE.md#article-attachments-get), [Download](./REFERENCE.md#article-attachments-download) |
114
115
 
115
116
 
116
- For all authentication options, see the connector's [authentication documentation](AUTH.md).
117
+ ### Authentication and configuration
118
+
119
+ For all authentication and configuration options, see the connector's [authentication documentation](AUTH.md).
117
120
 
118
- For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
121
+ ### Zendesk-Support API docs
119
122
 
120
- For the service's official API docs, see the [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
123
+ See the official [Zendesk-Support API reference](https://developer.zendesk.com/api-reference/ticketing/introduction/).
121
124
 
122
125
  ## Version information
123
126
 
124
- - **Package version:** 0.18.67
127
+ - **Package version:** 0.18.73
125
128
  - **Connector version:** 0.1.9
126
- - **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
129
+ - **Generated with Connector SDK commit SHA:** e4eb233f8dd57ad9bc825064625222a988db2cc6
130
+ - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/zendesk-support/CHANGELOG.md)
@@ -3748,4 +3748,3 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
3748
3748
  | `range_header` | `string` | No | Optional Range header for partial downloads (e.g., 'bytes=0-99') |
3749
3749
 
3750
3750
 
3751
-
@@ -50,6 +50,7 @@ from .models import (
50
50
  TicketFormsListResultMeta,
51
51
  ArticlesListResultMeta,
52
52
  ArticleAttachmentsListResultMeta,
53
+ ZendeskSupportCheckResult,
53
54
  ZendeskSupportExecuteResult,
54
55
  ZendeskSupportExecuteResultWithMeta,
55
56
  TicketsListResult,
@@ -227,6 +228,7 @@ __all__ = [
227
228
  "TicketFormsListResultMeta",
228
229
  "ArticlesListResultMeta",
229
230
  "ArticleAttachmentsListResultMeta",
231
+ "ZendeskSupportCheckResult",
230
232
  "ZendeskSupportExecuteResult",
231
233
  "ZendeskSupportExecuteResultWithMeta",
232
234
  "TicketsListResult",
@@ -496,6 +496,9 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
496
496
  # Extract untested flag
497
497
  untested = getattr(operation, "x_airbyte_untested", None) or False
498
498
 
499
+ # Extract preferred_for_check flag
500
+ preferred_for_check = getattr(operation, "x_airbyte_preferred_for_check", None) or False
501
+
499
502
  # Create endpoint definition
500
503
  endpoint = EndpointDefinition(
501
504
  method=method_name.upper(),
@@ -520,6 +523,7 @@ def convert_openapi_to_connector_model(spec: OpenAPIConnector) -> ConnectorModel
520
523
  graphql_body=graphql_body,
521
524
  file_field=file_field,
522
525
  untested=untested,
526
+ preferred_for_check=preferred_for_check,
523
527
  )
524
528
 
525
529
  # Add to entities map
@@ -164,6 +164,11 @@ class HostedExecutor:
164
164
  span.record_exception(e)
165
165
  raise
166
166
 
167
+ async def check(self) -> ExecutionResult:
168
+ """Perform a health check via the cloud API."""
169
+ config = ExecutionConfig(entity="*", action="check", params={})
170
+ return await self.execute(config)
171
+
167
172
  def _parse_execution_result(self, response: dict) -> ExecutionResult:
168
173
  """Parse API response into ExecutionResult.
169
174
 
@@ -70,6 +70,14 @@ class _OperationContext:
70
70
  self.validate_required_body_fields = executor._validate_required_body_fields
71
71
  self.extract_records = executor._extract_records
72
72
 
73
+ @property
74
+ def standard_handler(self) -> _StandardOperationHandler | None:
75
+ """Return the standard operation handler, or None if not registered."""
76
+ for h in self.executor._operation_handlers:
77
+ if isinstance(h, _StandardOperationHandler):
78
+ return h
79
+ return None
80
+
73
81
 
74
82
  class _OperationHandler(Protocol):
75
83
  """Protocol for operation handlers."""
@@ -544,6 +552,79 @@ class LocalExecutor:
544
552
  # These are "expected" execution errors - return them in ExecutionResult
545
553
  return ExecutionResult(success=False, data={}, error=str(e))
546
554
 
555
+ async def check(self) -> ExecutionResult:
556
+ """Perform a health check by running a lightweight list operation.
557
+
558
+ Finds the operation marked with preferred_for_check=True, or falls back
559
+ to the first list operation. Executes it with limit=1 to verify
560
+ connectivity and credentials.
561
+
562
+ Returns:
563
+ ExecutionResult with data containing status, error, and checked operation details.
564
+ """
565
+ check_entity = None
566
+ check_endpoint = None
567
+
568
+ # Look for preferred check operation
569
+ for (ent_name, op_action), endpoint in self._operation_index.items():
570
+ if getattr(endpoint, "preferred_for_check", False):
571
+ check_entity = ent_name
572
+ check_endpoint = endpoint
573
+ break
574
+
575
+ # Fallback to first list operation
576
+ if check_endpoint is None:
577
+ for (ent_name, op_action), endpoint in self._operation_index.items():
578
+ if op_action == Action.LIST:
579
+ check_entity = ent_name
580
+ check_endpoint = endpoint
581
+ break
582
+
583
+ if check_endpoint is None or check_entity is None:
584
+ return ExecutionResult(
585
+ success=True,
586
+ data={
587
+ "status": "unhealthy",
588
+ "error": "No list operation available for health check",
589
+ },
590
+ )
591
+
592
+ # Find the standard handler to execute the list operation
593
+ standard_handler = next(
594
+ (h for h in self._operation_handlers if isinstance(h, _StandardOperationHandler)),
595
+ None,
596
+ )
597
+
598
+ if standard_handler is None:
599
+ return ExecutionResult(
600
+ success=True,
601
+ data={
602
+ "status": "unhealthy",
603
+ "error": "No standard handler available",
604
+ },
605
+ )
606
+
607
+ try:
608
+ await standard_handler.execute_operation(check_entity, Action.LIST, {"limit": 1})
609
+ return ExecutionResult(
610
+ success=True,
611
+ data={
612
+ "status": "healthy",
613
+ "checked_entity": check_entity,
614
+ "checked_action": "list",
615
+ },
616
+ )
617
+ except Exception as e:
618
+ return ExecutionResult(
619
+ success=True,
620
+ data={
621
+ "status": "unhealthy",
622
+ "error": str(e),
623
+ "checked_entity": check_entity,
624
+ "checked_action": "list",
625
+ },
626
+ )
627
+
547
628
  async def _execute_operation(
548
629
  self,
549
630
  entity: str,
@@ -154,6 +154,18 @@ class ExecutorProtocol(Protocol):
154
154
  """
155
155
  ...
156
156
 
157
+ async def check(self) -> ExecutionResult:
158
+ """Perform a health check to verify connectivity and credentials.
159
+
160
+ Returns:
161
+ ExecutionResult with data containing:
162
+ - status: "healthy" or "unhealthy"
163
+ - error: Error message if unhealthy
164
+ - checked_entity: Entity used for the check
165
+ - checked_action: Action used for the check
166
+ """
167
+ ...
168
+
157
169
 
158
170
  # ============================================================================
159
171
  # Executor Exceptions
@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
380
380
  return entities
381
381
 
382
382
 
383
- def generate_tool_description(model: ConnectorModelProtocol) -> str:
383
+ def generate_tool_description(
384
+ model: ConnectorModelProtocol,
385
+ *,
386
+ enable_hosted_mode_features: bool = True,
387
+ ) -> str:
384
388
  """Generate AI tool description from connector metadata.
385
389
 
386
390
  Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
393
397
 
394
398
  Args:
395
399
  model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
400
+ enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
396
401
 
397
402
  Returns:
398
403
  Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
402
407
  # at the first empty line and only keeps the initial section.
403
408
 
404
409
  # Entity/action parameter details (including pagination params like limit, starting_after)
405
- search_field_paths = _collect_search_field_paths(model)
406
- lines.append("ENTITIES AND PARAMETERS:")
410
+ search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
411
+ # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
412
+ lines.append("ENTITIES (ACTIONS + PARAMS):")
407
413
  for entity in model.entities:
408
414
  lines.append(f" {entity.name}:")
409
415
  actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
427
433
  lines.append(" To paginate: pass starting_after=<last_id> while has_more is true")
428
434
 
429
435
  lines.append("GUIDELINES:")
430
- lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
431
- lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
436
+ if enable_hosted_mode_features:
437
+ lines.append(' - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
438
+ lines.append(" - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
432
439
  lines.append(" - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
433
440
  lines.append(" - If output is too large, refine the query with tighter filters/fields/limit.")
434
441
 
@@ -86,6 +86,16 @@ class Operation(BaseModel):
86
86
  "Validation will generate a warning instead of an error when cassettes are missing."
87
87
  ),
88
88
  )
89
+ x_airbyte_preferred_for_check: bool | None = Field(
90
+ None,
91
+ alias="x-airbyte-preferred-for-check",
92
+ description=(
93
+ "Mark this list operation as the preferred operation for health checks. "
94
+ "When the CHECK action is executed, this operation will be used instead of "
95
+ "falling back to the first available list operation. Choose a lightweight, "
96
+ "always-available endpoint (e.g., users, accounts)."
97
+ ),
98
+ )
89
99
 
90
100
  # Future extensions (commented out, defined for future use)
91
101
  # from .extensions import PaginationConfig
@@ -3,7 +3,7 @@
3
3
  import logging
4
4
  import platform
5
5
  import sys
6
- from datetime import datetime
6
+ from datetime import UTC, datetime
7
7
 
8
8
  from ..observability import ObservabilitySession
9
9
 
@@ -56,7 +56,7 @@ class SegmentTracker:
56
56
 
57
57
  try:
58
58
  event = ConnectorInitEvent(
59
- timestamp=datetime.utcnow(),
59
+ timestamp=datetime.now(UTC),
60
60
  session_id=self.session.session_id,
61
61
  user_id=self.session.user_id,
62
62
  execution_context=self.session.execution_context,
@@ -99,7 +99,7 @@ class SegmentTracker:
99
99
 
100
100
  try:
101
101
  event = OperationEvent(
102
- timestamp=datetime.utcnow(),
102
+ timestamp=datetime.now(UTC),
103
103
  session_id=self.session.session_id,
104
104
  user_id=self.session.user_id,
105
105
  execution_context=self.session.execution_context,
@@ -129,7 +129,7 @@ class SegmentTracker:
129
129
 
130
130
  try:
131
131
  event = SessionEndEvent(
132
- timestamp=datetime.utcnow(),
132
+ timestamp=datetime.now(UTC),
133
133
  session_id=self.session.session_id,
134
134
  user_id=self.session.user_id,
135
135
  execution_context=self.session.execution_context,
@@ -15,7 +15,16 @@ from .schema.security import AirbyteAuthConfig
15
15
 
16
16
 
17
17
  class Action(str, Enum):
18
- """Supported actions for Entity operations."""
18
+ """Supported actions for Entity operations.
19
+
20
+ Standard CRUD actions:
21
+ GET, CREATE, UPDATE, DELETE, LIST
22
+
23
+ Special actions:
24
+ API_SEARCH - Search via API endpoint
25
+ DOWNLOAD - Download file content
26
+ AUTHORIZE - OAuth authorization flow
27
+ """
19
28
 
20
29
  GET = "get"
21
30
  CREATE = "create"
@@ -223,6 +232,12 @@ class EndpointDefinition(BaseModel):
223
232
  description="Mark operation as untested to skip cassette validation (from x-airbyte-untested extension)",
224
233
  )
225
234
 
235
+ # Health check support (Airbyte extension)
236
+ preferred_for_check: bool = Field(
237
+ False,
238
+ description="Mark this list operation as preferred for health checks (from x-airbyte-preferred-for-check extension)",
239
+ )
240
+
226
241
 
227
242
  class EntityDefinition(BaseModel):
228
243
  """Definition of an API entity."""
@@ -810,11 +810,31 @@ def validate_connector_readiness(connector_dir: str | Path) -> Dict[str, Any]:
810
810
 
811
811
  success = operations_missing_cassettes == 0 and cassettes_invalid == 0 and total_operations > 0
812
812
 
813
+ # Check for preferred_for_check on at least one list operation
814
+ has_preferred_check = False
815
+ for entity in config.entities:
816
+ for action_val in entity.actions:
817
+ endpoint = entity.endpoints.get(action_val)
818
+ if endpoint and getattr(endpoint, "preferred_for_check", False):
819
+ has_preferred_check = True
820
+ break
821
+ if has_preferred_check:
822
+ break
823
+
824
+ readiness_warnings = []
825
+ if not has_preferred_check:
826
+ readiness_warnings.append(
827
+ "No operation has x-airbyte-preferred-for-check: true. "
828
+ "Add this extension to a lightweight list operation (e.g., users.list) "
829
+ "to enable reliable health checks."
830
+ )
831
+
813
832
  return {
814
833
  "success": success,
815
834
  "connector_name": config.name,
816
835
  "connector_path": str(connector_path),
817
836
  "validation_results": validation_results,
837
+ "readiness_warnings": readiness_warnings,
818
838
  "summary": {
819
839
  "total_operations": total_operations,
820
840
  "operations_with_cassettes": operations_with_cassettes,
@@ -88,6 +88,7 @@ if TYPE_CHECKING:
88
88
  from .models import ZendeskSupportOauth20AuthConfig, ZendeskSupportApiTokenAuthConfig
89
89
  # Import response models and envelope models at runtime
90
90
  from .models import (
91
+ ZendeskSupportCheckResult,
91
92
  ZendeskSupportExecuteResult,
92
93
  ZendeskSupportExecuteResultWithMeta,
93
94
  TicketsListResult,
@@ -809,6 +810,40 @@ class ZendeskSupportConnector:
809
810
  # No extractors - return raw response data
810
811
  return result.data
811
812
 
813
+ # ===== HEALTH CHECK METHOD =====
814
+
815
+ async def check(self) -> ZendeskSupportCheckResult:
816
+ """
817
+ Perform a health check to verify connectivity and credentials.
818
+
819
+ Executes a lightweight list operation (limit=1) to validate that
820
+ the connector can communicate with the API and credentials are valid.
821
+
822
+ Returns:
823
+ ZendeskSupportCheckResult with status ("healthy" or "unhealthy") and optional error message
824
+
825
+ Example:
826
+ result = await connector.check()
827
+ if result.status == "healthy":
828
+ print("Connection verified!")
829
+ else:
830
+ print(f"Check failed: {result.error}")
831
+ """
832
+ result = await self._executor.check()
833
+
834
+ if result.success and isinstance(result.data, dict):
835
+ return ZendeskSupportCheckResult(
836
+ status=result.data.get("status", "unhealthy"),
837
+ error=result.data.get("error"),
838
+ checked_entity=result.data.get("checked_entity"),
839
+ checked_action=result.data.get("checked_action"),
840
+ )
841
+ else:
842
+ return ZendeskSupportCheckResult(
843
+ status="unhealthy",
844
+ error=result.error or "Unknown error during health check",
845
+ )
846
+
812
847
  # ===== INTROSPECTION METHODS =====
813
848
 
814
849
  @classmethod
@@ -817,6 +852,7 @@ class ZendeskSupportConnector:
817
852
  func: _F | None = None,
818
853
  *,
819
854
  update_docstring: bool = True,
855
+ enable_hosted_mode_features: bool = True,
820
856
  max_output_chars: int | None = DEFAULT_MAX_OUTPUT_CHARS,
821
857
  ) -> _F | Callable[[_F], _F]:
822
858
  """
@@ -835,12 +871,16 @@ class ZendeskSupportConnector:
835
871
 
836
872
  Args:
837
873
  update_docstring: When True, append connector capabilities to __doc__.
874
+ enable_hosted_mode_features: When False, omit hosted-mode search sections from docstrings.
838
875
  max_output_chars: Max serialized output size before raising. Use None to disable.
839
876
  """
840
877
 
841
878
  def decorate(inner: _F) -> _F:
842
879
  if update_docstring:
843
- description = generate_tool_description(ZendeskSupportConnectorModel)
880
+ description = generate_tool_description(
881
+ ZendeskSupportConnectorModel,
882
+ enable_hosted_mode_features=enable_hosted_mode_features,
883
+ )
844
884
  original_doc = inner.__doc__ or ""
845
885
  if original_doc.strip():
846
886
  full_doc = f"{original_doc.strip()}\n{description}"
@@ -260,6 +260,7 @@ ZendeskSupportConnectorModel: ConnectorModel = ConnectorModel(
260
260
  'previous_page': '$.previous_page',
261
261
  'count': '$.count',
262
262
  },
263
+ preferred_for_check=True,
263
264
  ),
264
265
  Action.GET: EndpointDefinition(
265
266
  method='GET',
@@ -642,6 +642,25 @@ class ArticleAttachmentsListResultMeta(BaseModel):
642
642
  previous_page: Union[str | None, Any] = Field(default=None)
643
643
  count: Union[int, Any] = Field(default=None)
644
644
 
645
+ # ===== CHECK RESULT MODEL =====
646
+
647
+ class ZendeskSupportCheckResult(BaseModel):
648
+ """Result of a health check operation.
649
+
650
+ Returned by the check() method to indicate connectivity and credential status.
651
+ """
652
+ model_config = ConfigDict(extra="forbid")
653
+
654
+ status: str
655
+ """Health check status: 'healthy' or 'unhealthy'."""
656
+ error: str | None = None
657
+ """Error message if status is 'unhealthy', None otherwise."""
658
+ checked_entity: str | None = None
659
+ """Entity name used for the health check."""
660
+ checked_action: str | None = None
661
+ """Action name used for the health check."""
662
+
663
+
645
664
  # ===== RESPONSE ENVELOPE MODELS =====
646
665
 
647
666
  # Type variables for generic envelope models
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "airbyte-agent-zendesk-support"
3
- version = "0.18.67"
3
+ version = "0.18.73"
4
4
  description = "Airbyte Zendesk-Support Connector for AI platforms"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.13"