airbyte-agent-klaviyo 0.1.2__tar.gz → 0.1.4__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 (63) hide show
  1. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/CHANGELOG.md +10 -0
  2. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/PKG-INFO +3 -3
  3. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/README.md +2 -2
  4. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/__init__.py +8 -8
  5. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/cloud_utils/client.py +125 -0
  6. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/connector_model_loader.py +1 -0
  7. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/executor/hosted_executor.py +54 -25
  8. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/executor/local_executor.py +5 -12
  9. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/base.py +11 -0
  10. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/security.py +5 -0
  11. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/types.py +4 -0
  12. airbyte_agent_klaviyo-0.1.4/airbyte_agent_klaviyo/_vendored/connector_sdk/utils.py +127 -0
  13. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/validation.py +151 -2
  14. airbyte_agent_klaviyo-0.1.4/airbyte_agent_klaviyo/_vendored/connector_sdk/validation_replication.py +970 -0
  15. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/connector.py +118 -9
  16. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/pyproject.toml +1 -1
  17. airbyte_agent_klaviyo-0.1.2/airbyte_agent_klaviyo/_vendored/connector_sdk/utils.py +0 -60
  18. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/.gitignore +0 -0
  19. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/AUTH.md +0 -0
  20. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/REFERENCE.md +0 -0
  21. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/__init__.py +0 -0
  22. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/__init__.py +0 -0
  23. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/auth_strategies.py +0 -0
  24. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/auth_template.py +0 -0
  25. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/cloud_utils/__init__.py +0 -0
  26. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/constants.py +0 -0
  27. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/exceptions.py +0 -0
  28. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/executor/__init__.py +0 -0
  29. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/executor/models.py +0 -0
  30. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/extensions.py +0 -0
  31. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/__init__.py +0 -0
  32. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/adapters/__init__.py +0 -0
  33. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/adapters/httpx_adapter.py +0 -0
  34. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/config.py +0 -0
  35. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/exceptions.py +0 -0
  36. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/protocols.py +0 -0
  37. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http/response.py +0 -0
  38. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/http_client.py +0 -0
  39. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/introspection.py +0 -0
  40. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/logging/__init__.py +0 -0
  41. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/logging/logger.py +0 -0
  42. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/logging/types.py +0 -0
  43. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/observability/__init__.py +0 -0
  44. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/observability/config.py +0 -0
  45. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/observability/models.py +0 -0
  46. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/observability/redactor.py +0 -0
  47. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/observability/session.py +0 -0
  48. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/performance/__init__.py +0 -0
  49. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/performance/instrumentation.py +0 -0
  50. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/performance/metrics.py +0 -0
  51. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/__init__.py +0 -0
  52. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/components.py +0 -0
  53. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/connector.py +0 -0
  54. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/extensions.py +0 -0
  55. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/schema/operations.py +0 -0
  56. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/secrets.py +0 -0
  57. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/telemetry/__init__.py +0 -0
  58. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/telemetry/config.py +0 -0
  59. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/telemetry/events.py +0 -0
  60. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/_vendored/connector_sdk/telemetry/tracker.py +0 -0
  61. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/connector_model.py +0 -0
  62. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/models.py +24 -24
  63. {airbyte_agent_klaviyo-0.1.2 → airbyte_agent_klaviyo-0.1.4}/airbyte_agent_klaviyo/types.py +0 -0
@@ -1,5 +1,15 @@
1
1
  # Klaviyo changelog
2
2
 
3
+ ## [0.1.4] - 2026-02-02
4
+ - Updated connector definition (YAML version 1.0.0)
5
+ - Source commit: 9d9866b0
6
+ - SDK version: 0.1.0
7
+
8
+ ## [0.1.3] - 2026-01-30
9
+ - Updated connector definition (YAML version 1.0.0)
10
+ - Source commit: b184da3e
11
+ - SDK version: 0.1.0
12
+
3
13
  ## [0.1.2] - 2026-01-30
4
14
  - Updated connector definition (YAML version 1.0.0)
5
15
  - Source commit: 5b20f488
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-klaviyo
3
- Version: 0.1.2
3
+ Version: 0.1.4
4
4
  Summary: Airbyte Klaviyo 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/
@@ -146,7 +146,7 @@ See the official [Klaviyo API reference](https://developers.klaviyo.com/en/refer
146
146
 
147
147
  ## Version information
148
148
 
149
- - **Package version:** 0.1.2
149
+ - **Package version:** 0.1.4
150
150
  - **Connector version:** 1.0.0
151
- - **Generated with Connector SDK commit SHA:** 5b20f488dec0e8f29410823753106603c23a4b65
151
+ - **Generated with Connector SDK commit SHA:** 9d9866b0aae8c3494d04d34e193b9bd860bfc1c6
152
152
  - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/klaviyo/CHANGELOG.md)
@@ -113,7 +113,7 @@ See the official [Klaviyo API reference](https://developers.klaviyo.com/en/refer
113
113
 
114
114
  ## Version information
115
115
 
116
- - **Package version:** 0.1.2
116
+ - **Package version:** 0.1.4
117
117
  - **Connector version:** 1.0.0
118
- - **Generated with Connector SDK commit SHA:** 5b20f488dec0e8f29410823753106603c23a4b65
118
+ - **Generated with Connector SDK commit SHA:** 9d9866b0aae8c3494d04d34e193b9bd860bfc1c6
119
119
  - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/klaviyo/CHANGELOG.md)
@@ -13,8 +13,8 @@ from .models import (
13
13
  Profile,
14
14
  ProfilesListLinks,
15
15
  ProfilesList,
16
- ListLinks,
17
16
  ListAttributes,
17
+ ListLinks,
18
18
  List,
19
19
  ListsListLinks,
20
20
  ListsList,
@@ -28,14 +28,14 @@ from .models import (
28
28
  EventRelationshipsMetricData,
29
29
  EventRelationshipsMetric,
30
30
  EventRelationships,
31
- EventAttributes,
32
31
  EventLinks,
32
+ EventAttributes,
33
33
  Event,
34
34
  EventsListLinks,
35
35
  EventsList,
36
- MetricLinks,
37
36
  MetricAttributesIntegration,
38
37
  MetricAttributes,
38
+ MetricLinks,
39
39
  Metric,
40
40
  MetricsListLinks,
41
41
  MetricsList,
@@ -44,8 +44,8 @@ from .models import (
44
44
  Flow,
45
45
  FlowsListLinks,
46
46
  FlowsList,
47
- TemplateLinks,
48
47
  TemplateAttributes,
48
+ TemplateLinks,
49
49
  Template,
50
50
  TemplatesListLinks,
51
51
  TemplatesList,
@@ -124,8 +124,8 @@ __all__ = [
124
124
  "Profile",
125
125
  "ProfilesListLinks",
126
126
  "ProfilesList",
127
- "ListLinks",
128
127
  "ListAttributes",
128
+ "ListLinks",
129
129
  "List",
130
130
  "ListsListLinks",
131
131
  "ListsList",
@@ -139,14 +139,14 @@ __all__ = [
139
139
  "EventRelationshipsMetricData",
140
140
  "EventRelationshipsMetric",
141
141
  "EventRelationships",
142
- "EventAttributes",
143
142
  "EventLinks",
143
+ "EventAttributes",
144
144
  "Event",
145
145
  "EventsListLinks",
146
146
  "EventsList",
147
- "MetricLinks",
148
147
  "MetricAttributesIntegration",
149
148
  "MetricAttributes",
149
+ "MetricLinks",
150
150
  "Metric",
151
151
  "MetricsListLinks",
152
152
  "MetricsList",
@@ -155,8 +155,8 @@ __all__ = [
155
155
  "Flow",
156
156
  "FlowsListLinks",
157
157
  "FlowsList",
158
- "TemplateLinks",
159
158
  "TemplateAttributes",
159
+ "TemplateLinks",
160
160
  "Template",
161
161
  "TemplatesListLinks",
162
162
  "TemplatesList",
@@ -161,6 +161,131 @@ class AirbyteCloudClient:
161
161
  connector_id = connectors[0]["id"]
162
162
  return connector_id
163
163
 
164
+ async def initiate_oauth(
165
+ self,
166
+ definition_id: str,
167
+ external_user_id: str,
168
+ redirect_url: str,
169
+ ) -> str:
170
+ """Initiate a server-side OAuth flow.
171
+
172
+ Starts the OAuth flow for a connector. Returns a consent URL where the
173
+ end user should be redirected to grant access. After completing consent,
174
+ they'll be redirected to your redirect_url with a `server_side_oauth_secret_id`
175
+ query parameter that can be used with `create_source()`.
176
+
177
+ Args:
178
+ definition_id: Connector definition UUID
179
+ external_user_id: Workspace identifier
180
+ redirect_url: URL where users will be redirected after OAuth consent
181
+
182
+ Returns:
183
+ The OAuth consent URL
184
+
185
+ Raises:
186
+ httpx.HTTPStatusError: If the request fails
187
+
188
+ Example:
189
+ consent_url = await client.initiate_oauth(
190
+ definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
191
+ external_user_id="my-workspace",
192
+ redirect_url="https://myapp.com/oauth/callback",
193
+ )
194
+ # Redirect user to: consent_url
195
+ # After consent: https://myapp.com/oauth/callback?server_side_oauth_secret_id=...
196
+ """
197
+ token = await self.get_bearer_token()
198
+ url = f"{self.API_BASE_URL}/api/v1/integrations/connectors/oauth/initiate"
199
+ headers = {"Authorization": f"Bearer {token}"}
200
+ request_body = {
201
+ "external_user_id": external_user_id,
202
+ "definition_id": definition_id,
203
+ "redirect_url": redirect_url,
204
+ }
205
+
206
+ response = await self._http_client.post(url, json=request_body, headers=headers)
207
+ response.raise_for_status()
208
+ return response.json()["consent_url"]
209
+
210
+ async def create_source(
211
+ self,
212
+ name: str,
213
+ connector_definition_id: str,
214
+ external_user_id: str,
215
+ credentials: dict[str, Any] | None = None,
216
+ replication_config: dict[str, Any] | None = None,
217
+ server_side_oauth_secret_id: str | None = None,
218
+ source_template_id: str | None = None,
219
+ ) -> str:
220
+ """Create a new source on Airbyte Cloud.
221
+
222
+ Supports two authentication modes:
223
+ 1. Direct credentials: Provide `credentials` dict
224
+ 2. Server-side OAuth: Provide `server_side_oauth_secret_id` from OAuth flow
225
+
226
+ Args:
227
+ name: Source name
228
+ connector_definition_id: UUID of the connector definition
229
+ external_user_id: User identifier
230
+ credentials: Connector auth config dict. Required unless using OAuth.
231
+ replication_config: Optional replication settings (e.g., start_date for
232
+ connectors with x-airbyte-replication-config). Required for REPLICATION
233
+ mode sources like Intercom.
234
+ server_side_oauth_secret_id: OAuth secret ID from initiate_oauth redirect.
235
+ When provided, credentials are not required.
236
+ source_template_id: Source template ID. Required when organization has
237
+ multiple source templates for this connector type.
238
+
239
+ Returns:
240
+ The created source ID (UUID string)
241
+
242
+ Raises:
243
+ httpx.HTTPStatusError: If creation fails
244
+
245
+ Example:
246
+ # With direct credentials:
247
+ source_id = await client.create_source(
248
+ name="My Intercom Source",
249
+ connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
250
+ external_user_id="my-workspace",
251
+ credentials={"access_token": "..."},
252
+ replication_config={"start_date": "2024-01-01T00:00:00Z"}
253
+ )
254
+
255
+ # With server-side OAuth:
256
+ source_id = await client.create_source(
257
+ name="My Intercom Source",
258
+ connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
259
+ external_user_id="my-workspace",
260
+ server_side_oauth_secret_id="airbyte_oauth_..._secret_...",
261
+ replication_config={"start_date": "2024-01-01T00:00:00Z"}
262
+ )
263
+ """
264
+ token = await self.get_bearer_token()
265
+ url = f"{self.API_BASE_URL}/v1/integrations/connectors"
266
+ headers = {"Authorization": f"Bearer {token}"}
267
+
268
+ request_body: dict[str, Any] = {
269
+ "name": name,
270
+ "definition_id": connector_definition_id,
271
+ "external_user_id": external_user_id,
272
+ }
273
+
274
+ if credentials is not None:
275
+ request_body["credentials"] = credentials
276
+ if replication_config is not None:
277
+ request_body["replication_config"] = replication_config
278
+ if server_side_oauth_secret_id is not None:
279
+ request_body["server_side_oauth_secret_id"] = server_side_oauth_secret_id
280
+ if source_template_id is not None:
281
+ request_body["source_template_id"] = source_template_id
282
+
283
+ response = await self._http_client.post(url, json=request_body, headers=headers)
284
+ response.raise_for_status()
285
+
286
+ data = response.json()
287
+ return data["id"]
288
+
164
289
  async def execute_connector(
165
290
  self,
166
291
  connector_id: str,
@@ -1014,6 +1014,7 @@ def _parse_security_scheme_to_option(scheme_name: str, scheme: Any) -> AuthOptio
1014
1014
  type=single_auth.type,
1015
1015
  config=single_auth.config,
1016
1016
  user_config_spec=single_auth.user_config_spec,
1017
+ untested=getattr(scheme, "x_airbyte_untested", False),
1017
1018
  )
1018
1019
 
1019
1020
 
@@ -19,19 +19,26 @@ class HostedExecutor:
19
19
  instead of directly calling external services. The cloud API handles all
20
20
  connector logic, secrets management, and execution.
21
21
 
22
- The executor takes an external_user_id and uses the AirbyteCloudClient to:
22
+ The executor uses the AirbyteCloudClient to:
23
23
  1. Authenticate with the Airbyte Platform (bearer token with caching)
24
- 2. Look up the user's connector
24
+ 2. Look up the user's connector (if connector_id not provided)
25
25
  3. Execute the connector operation via the cloud API
26
26
 
27
27
  Implements ExecutorProtocol.
28
28
 
29
29
  Example:
30
- # Create executor with user ID, credentials, and connector definition ID
30
+ # Create executor with explicit connector_id (no lookup needed)
31
+ executor = HostedExecutor(
32
+ airbyte_client_id="client_abc123",
33
+ airbyte_client_secret="secret_xyz789",
34
+ connector_id="existing-source-uuid",
35
+ )
36
+
37
+ # Or create executor with user ID for lookup
31
38
  executor = HostedExecutor(
32
- external_user_id="user-123",
33
39
  airbyte_client_id="client_abc123",
34
40
  airbyte_client_secret="secret_xyz789",
41
+ external_user_id="user-123",
35
42
  connector_definition_id="abc123-def456-ghi789",
36
43
  )
37
44
 
@@ -51,28 +58,48 @@ class HostedExecutor:
51
58
 
52
59
  def __init__(
53
60
  self,
54
- external_user_id: str,
55
61
  airbyte_client_id: str,
56
62
  airbyte_client_secret: str,
57
- connector_definition_id: str,
63
+ connector_id: str | None = None,
64
+ external_user_id: str | None = None,
65
+ connector_definition_id: str | None = None,
58
66
  ):
59
67
  """Initialize hosted executor.
60
68
 
69
+ Either provide connector_id directly OR (external_user_id + connector_definition_id)
70
+ for lookup.
71
+
61
72
  Args:
62
- external_user_id: User identifier in the Airbyte system
63
73
  airbyte_client_id: Airbyte client ID for authentication
64
74
  airbyte_client_secret: Airbyte client secret for authentication
65
- connector_definition_id: Connector definition ID used to look up
66
- the user's connector.
75
+ connector_id: Direct connector/source ID (skips lookup if provided)
76
+ external_user_id: User identifier in the Airbyte system (for lookup)
77
+ connector_definition_id: Connector definition ID (for lookup)
78
+
79
+ Raises:
80
+ ValueError: If neither connector_id nor (external_user_id + connector_definition_id) provided
67
81
 
68
82
  Example:
83
+ # With explicit connector_id (no lookup)
84
+ executor = HostedExecutor(
85
+ airbyte_client_id="client_abc123",
86
+ airbyte_client_secret="secret_xyz789",
87
+ connector_id="existing-source-uuid",
88
+ )
89
+
90
+ # With lookup by user + definition
69
91
  executor = HostedExecutor(
70
- external_user_id="user-123",
71
92
  airbyte_client_id="client_abc123",
72
93
  airbyte_client_secret="secret_xyz789",
94
+ external_user_id="user-123",
73
95
  connector_definition_id="abc123-def456-ghi789",
74
96
  )
75
97
  """
98
+ # Validate: either connector_id OR (external_user_id + connector_definition_id) required
99
+ if not connector_id and not (external_user_id and connector_definition_id):
100
+ raise ValueError("Either connector_id OR (external_user_id + connector_definition_id) must be provided")
101
+
102
+ self._connector_id = connector_id
76
103
  self._external_user_id = external_user_id
77
104
  self._connector_definition_id = connector_definition_id
78
105
 
@@ -86,10 +113,9 @@ class HostedExecutor:
86
113
  """Execute connector via cloud API (ExecutorProtocol implementation).
87
114
 
88
115
  Flow:
89
- 1. Get connector definition id from executor config
90
- 2. Look up the user's connector ID
91
- 3. Execute the connector operation via the cloud API
92
- 4. Parse the response into ExecutionResult
116
+ 1. Use provided connector_id or look up from external_user_id + definition_id
117
+ 2. Execute the connector operation via the cloud API
118
+ 3. Parse the response into ExecutionResult
93
119
 
94
120
  Args:
95
121
  config: Execution configuration (entity, action, params)
@@ -98,7 +124,7 @@ class HostedExecutor:
98
124
  ExecutionResult with success/failure status
99
125
 
100
126
  Raises:
101
- ValueError: If no connector or multiple connectors found for user
127
+ ValueError: If no connector or multiple connectors found for user (when doing lookup)
102
128
  httpx.HTTPStatusError: If API returns 4xx/5xx status code
103
129
  httpx.RequestError: If network request fails
104
130
 
@@ -114,23 +140,26 @@ class HostedExecutor:
114
140
 
115
141
  with tracer.start_as_current_span("airbyte.hosted_executor.execute") as span:
116
142
  # Add span attributes for observability
117
- span.set_attribute("connector.definition_id", self._connector_definition_id)
143
+ if self._connector_definition_id:
144
+ span.set_attribute("connector.definition_id", self._connector_definition_id)
118
145
  span.set_attribute("connector.entity", config.entity)
119
146
  span.set_attribute("connector.action", config.action)
120
- span.set_attribute("user.external_id", self._external_user_id)
147
+ if self._external_user_id:
148
+ span.set_attribute("user.external_id", self._external_user_id)
121
149
  if config.params:
122
150
  # Only add non-sensitive param keys
123
151
  span.set_attribute("connector.param_keys", list(config.params.keys()))
124
152
 
125
153
  try:
126
- # Step 1: Get connector definition id
127
- connector_definition_id = self._connector_definition_id
128
-
129
- # Step 2: Get the connector ID for this user
130
- connector_id = await self._cloud_client.get_connector_id(
131
- external_user_id=self._external_user_id,
132
- connector_definition_id=connector_definition_id,
133
- )
154
+ # Use provided connector_id or look it up
155
+ if self._connector_id:
156
+ connector_id = self._connector_id
157
+ else:
158
+ # Look up connector by external_user_id + definition_id
159
+ connector_id = await self._cloud_client.get_connector_id(
160
+ external_user_id=self._external_user_id, # type: ignore[arg-type]
161
+ connector_definition_id=self._connector_definition_id, # type: ignore[arg-type]
162
+ )
134
163
 
135
164
  span.set_attribute("connector.connector_id", connector_id)
136
165
 
@@ -36,6 +36,7 @@ from ..types import (
36
36
  EndpointDefinition,
37
37
  EntityDefinition,
38
38
  )
39
+ from ..utils import find_matching_auth_options
39
40
 
40
41
  from .models import (
41
42
  ActionNotSupportedError,
@@ -356,8 +357,8 @@ class LocalExecutor:
356
357
  ) -> tuple[AuthOption, dict[str, SecretStr]]:
357
358
  """Infer authentication scheme from provided credentials.
358
359
 
359
- Matches user credentials against each auth option's required fields
360
- to determine which scheme to use.
360
+ Uses shared utility find_matching_auth_options to match credentials
361
+ against each auth option's required fields.
361
362
 
362
363
  Args:
363
364
  user_credentials: User-provided credentials
@@ -375,16 +376,8 @@ class LocalExecutor:
375
376
  # Get the credential keys provided by the user
376
377
  provided_keys = set(user_credentials.keys())
377
378
 
378
- # Find all options where all required fields are present
379
- matching_options: list[AuthOption] = []
380
- for option in options:
381
- if option.user_config_spec and option.user_config_spec.required:
382
- required_fields = set(option.user_config_spec.required)
383
- if required_fields.issubset(provided_keys):
384
- matching_options.append(option)
385
- elif not option.user_config_spec or not option.user_config_spec.required:
386
- # Option has no required fields - it matches any credentials
387
- matching_options.append(option)
379
+ # Use shared utility to find matching options
380
+ matching_options = find_matching_auth_options(provided_keys, options)
388
381
 
389
382
  # Handle matching results
390
383
  if len(matching_options) == 0:
@@ -126,6 +126,17 @@ class Info(BaseModel):
126
126
  x_airbyte_example_questions: ExampleQuestions | None = Field(None, alias="x-airbyte-example-questions")
127
127
  x_airbyte_cache: CacheConfig | None = Field(None, alias="x-airbyte-cache")
128
128
  x_airbyte_replication_config: ReplicationConfig | None = Field(None, alias="x-airbyte-replication-config")
129
+ x_airbyte_skip_suggested_streams: list[str] = Field(
130
+ default_factory=list,
131
+ alias="x-airbyte-skip-suggested-streams",
132
+ description="List of Airbyte suggested streams to skip when validating cache entity coverage",
133
+ )
134
+ x_airbyte_skip_auth_methods: list[str] = Field(
135
+ default_factory=list,
136
+ alias="x-airbyte-skip-auth-methods",
137
+ description="List of Airbyte auth methods to skip when validating auth compatibility. "
138
+ "Use the SelectiveAuthenticator option key (e.g., 'Private App Credentials', 'oauth2.0')",
139
+ )
129
140
 
130
141
 
131
142
  class ServerVariable(BaseModel):
@@ -199,6 +199,11 @@ class SecurityScheme(BaseModel):
199
199
  alias="x-airbyte-token-extract",
200
200
  description="List of fields to extract from OAuth2 token responses and use as server variables",
201
201
  )
202
+ x_airbyte_untested: bool = Field(
203
+ False,
204
+ alias="x-airbyte-untested",
205
+ description="Mark this auth scheme as untested to skip cassette coverage validation",
206
+ )
202
207
 
203
208
  @field_validator("x_airbyte_token_extract", mode="after")
204
209
  @classmethod
@@ -90,6 +90,10 @@ class AuthOption(BaseModel):
90
90
  None,
91
91
  description="User-facing credential specification from x-airbyte-auth-config",
92
92
  )
93
+ untested: bool = Field(
94
+ False,
95
+ description="Mark this auth scheme as untested to skip cassette coverage validation",
96
+ )
93
97
 
94
98
 
95
99
  class AuthConfig(BaseModel):
@@ -0,0 +1,127 @@
1
+ """Utility functions for working with connectors."""
2
+
3
+ from __future__ import annotations
4
+
5
+ from collections.abc import AsyncIterator
6
+ from pathlib import Path
7
+ from typing import TYPE_CHECKING
8
+
9
+ if TYPE_CHECKING:
10
+ from .types import AuthOption
11
+
12
+
13
+ async def save_download(
14
+ download_iterator: AsyncIterator[bytes],
15
+ path: str | Path,
16
+ *,
17
+ overwrite: bool = False,
18
+ ) -> Path:
19
+ """Save a download iterator to a file.
20
+
21
+ Args:
22
+ download_iterator: AsyncIterator[bytes] from a download operation
23
+ path: File path where content should be saved
24
+ overwrite: Whether to overwrite existing file (default: False)
25
+
26
+ Returns:
27
+ Absolute Path to the saved file
28
+
29
+ Raises:
30
+ FileExistsError: If file exists and overwrite=False
31
+ OSError: If file cannot be written
32
+
33
+ Example:
34
+ >>> from .utils import save_download
35
+ >>>
36
+ >>> # Download and save a file
37
+ >>> result = await connector.download_article_attachment(id="123")
38
+ >>> file_path = await save_download(result, "./downloads/attachment.pdf")
39
+ >>> print(f"Downloaded to {file_path}")
40
+ Downloaded to /absolute/path/to/downloads/attachment.pdf
41
+ >>>
42
+ >>> # Overwrite existing file
43
+ >>> file_path = await save_download(result, "./downloads/attachment.pdf", overwrite=True)
44
+ """
45
+ # Convert to Path object
46
+ file_path = Path(path).expanduser().resolve()
47
+
48
+ # Check if file exists
49
+ if file_path.exists() and not overwrite:
50
+ raise FileExistsError(f"File already exists: {file_path}. Use overwrite=True to replace it.")
51
+
52
+ # Create parent directories if needed
53
+ file_path.parent.mkdir(parents=True, exist_ok=True)
54
+
55
+ # Stream content to file
56
+ try:
57
+ with open(file_path, "wb") as f:
58
+ async for chunk in download_iterator:
59
+ f.write(chunk)
60
+ except Exception as e:
61
+ # Clean up partial file on error
62
+ if file_path.exists():
63
+ file_path.unlink()
64
+ raise OSError(f"Failed to write file {file_path}: {e}") from e
65
+
66
+ return file_path
67
+
68
+
69
+ def find_matching_auth_options(
70
+ provided_keys: set[str],
71
+ auth_options: list[AuthOption],
72
+ ) -> list[AuthOption]:
73
+ """Find auth options that match the provided credential keys.
74
+
75
+ This is the single source of truth for auth scheme inference logic,
76
+ used by both the executor (at runtime) and validation (for cassettes).
77
+
78
+ Matching logic:
79
+ - An option matches if all its required fields are present in provided_keys
80
+ - Options with no required fields match any credentials
81
+
82
+ Args:
83
+ provided_keys: Set of credential/auth_config keys
84
+ auth_options: List of AuthOption from the connector model
85
+
86
+ Returns:
87
+ List of AuthOption that match the provided keys
88
+ """
89
+ matching_options: list[AuthOption] = []
90
+
91
+ for option in auth_options:
92
+ if option.user_config_spec and option.user_config_spec.required:
93
+ required_fields = set(option.user_config_spec.required)
94
+ if required_fields.issubset(provided_keys):
95
+ matching_options.append(option)
96
+ elif not option.user_config_spec or not option.user_config_spec.required:
97
+ # Option has no required fields - it matches any credentials
98
+ matching_options.append(option)
99
+
100
+ return matching_options
101
+
102
+
103
+ def infer_auth_scheme_name(
104
+ provided_keys: set[str],
105
+ auth_options: list[AuthOption],
106
+ ) -> str | None:
107
+ """Infer the auth scheme name from provided credential keys.
108
+
109
+ Uses find_matching_auth_options to find matches, then returns
110
+ the scheme name only if exactly one option matches.
111
+
112
+ Args:
113
+ provided_keys: Set of credential/auth_config keys
114
+ auth_options: List of AuthOption from the connector model
115
+
116
+ Returns:
117
+ The scheme_name if exactly one match, None otherwise
118
+ """
119
+ if not provided_keys or not auth_options:
120
+ return None
121
+
122
+ matching = find_matching_auth_options(provided_keys, auth_options)
123
+
124
+ if len(matching) == 1:
125
+ return matching[0].scheme_name
126
+
127
+ return None