airbyte-agent-zendesk-chat 0.1.11__py3-none-any.whl → 0.1.17__py3-none-any.whl

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.
@@ -15,9 +15,9 @@ from .models import (
15
15
  AgentTimeline,
16
16
  Ban,
17
17
  WebpathItem,
18
+ ChatEngagement,
18
19
  ChatHistoryItem,
19
20
  ChatConversion,
20
- ChatEngagement,
21
21
  Chat,
22
22
  Visitor,
23
23
  ChatSession,
@@ -110,9 +110,9 @@ __all__ = [
110
110
  "AgentTimeline",
111
111
  "Ban",
112
112
  "WebpathItem",
113
+ "ChatEngagement",
113
114
  "ChatHistoryItem",
114
115
  "ChatConversion",
115
- "ChatEngagement",
116
116
  "Chat",
117
117
  "Visitor",
118
118
  "ChatSession",
@@ -62,6 +62,53 @@ class TokenExtractValidationError(ConnectorModelLoaderError):
62
62
  pass
63
63
 
64
64
 
65
+ # Expected auth_mapping keys for each auth type.
66
+ # These are the auth parameters that each security scheme expects, NOT the user's credential field names.
67
+ EXPECTED_AUTH_MAPPING_KEYS: dict[AuthType, set[str]] = {
68
+ AuthType.BEARER: {"token"},
69
+ AuthType.BASIC: {"username", "password"},
70
+ AuthType.API_KEY: {"api_key"},
71
+ AuthType.OAUTH2: {"access_token", "refresh_token", "client_id", "client_secret"},
72
+ }
73
+
74
+
75
+ def _validate_auth_mapping_keys(
76
+ auth_type: AuthType,
77
+ auth_config: AirbyteAuthConfig | None,
78
+ scheme_name: str = "default",
79
+ ) -> None:
80
+ """Validate that auth_mapping keys match expected parameters for the auth type.
81
+
82
+ The auth_mapping keys must be the parameters expected by the security scheme
83
+ (e.g., "token" for bearer), not the user's credential field names.
84
+
85
+ Args:
86
+ auth_type: The authentication type
87
+ auth_config: The x-airbyte-auth-config containing auth_mapping
88
+ scheme_name: Name of the security scheme for error messages
89
+
90
+ Raises:
91
+ InvalidOpenAPIError: If auth_mapping keys don't match expected parameters
92
+ """
93
+ if auth_config is None or auth_config.auth_mapping is None:
94
+ return # No explicit auth_mapping, will use defaults
95
+
96
+ expected_keys = EXPECTED_AUTH_MAPPING_KEYS.get(auth_type)
97
+ if expected_keys is None:
98
+ return # Unknown auth type, skip validation
99
+
100
+ actual_keys = set(auth_config.auth_mapping.keys())
101
+ invalid_keys = actual_keys - expected_keys
102
+
103
+ if invalid_keys:
104
+ raise InvalidOpenAPIError(
105
+ f"Invalid auth_mapping keys for {auth_type.value} auth in scheme '{scheme_name}': {invalid_keys}. "
106
+ f"Expected keys for {auth_type.value}: {sorted(expected_keys)}. "
107
+ f"Note: auth_mapping keys must be the auth parameters (e.g., 'token' for bearer), "
108
+ f'not your credential field names. Use template syntax to map: token: "${{your_field}}"'
109
+ )
110
+
111
+
65
112
  def extract_path_params(path: str) -> list[str]:
66
113
  """Extract parameter names from path template.
67
114
 
@@ -711,7 +758,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
711
758
  description="Authentication bearer token",
712
759
  format=None,
713
760
  pattern=None,
714
- airbyte_secret=False,
715
761
  default=None,
716
762
  )
717
763
  },
@@ -731,7 +777,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
731
777
  description="Authentication username",
732
778
  format=None,
733
779
  pattern=None,
734
- airbyte_secret=False,
735
780
  default=None,
736
781
  ),
737
782
  "password": AuthConfigFieldSpec(
@@ -740,7 +785,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
740
785
  description="Authentication password",
741
786
  format=None,
742
787
  pattern=None,
743
- airbyte_secret=False,
744
788
  default=None,
745
789
  ),
746
790
  },
@@ -760,7 +804,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
760
804
  description="API authentication key",
761
805
  format=None,
762
806
  pattern=None,
763
- airbyte_secret=False,
764
807
  default=None,
765
808
  )
766
809
  },
@@ -785,7 +828,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
785
828
  description="OAuth2 access token",
786
829
  format=None,
787
830
  pattern=None,
788
- airbyte_secret=False,
789
831
  default=None,
790
832
  ),
791
833
  "refresh_token": AuthConfigFieldSpec(
@@ -794,7 +836,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
794
836
  description="OAuth2 refresh token (optional)",
795
837
  format=None,
796
838
  pattern=None,
797
- airbyte_secret=False,
798
839
  default=None,
799
840
  ),
800
841
  "client_id": AuthConfigFieldSpec(
@@ -803,7 +844,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
803
844
  description="OAuth2 client ID (optional)",
804
845
  format=None,
805
846
  pattern=None,
806
- airbyte_secret=False,
807
847
  default=None,
808
848
  ),
809
849
  "client_secret": AuthConfigFieldSpec(
@@ -812,7 +852,6 @@ def _generate_default_auth_config(auth_type: AuthType) -> AirbyteAuthConfig:
812
852
  description="OAuth2 client secret (optional)",
813
853
  format=None,
814
854
  pattern=None,
815
- airbyte_secret=False,
816
855
  default=None,
817
856
  ),
818
857
  },
@@ -924,6 +963,9 @@ def _parse_single_security_scheme(scheme: Any) -> AuthConfig:
924
963
  oauth2_config = _parse_oauth2_config(scheme)
925
964
  # Use explicit x-airbyte-auth-config if present, otherwise generate default
926
965
  auth_config_obj = scheme.x_airbyte_auth_config or _generate_default_auth_config(AuthType.OAUTH2)
966
+ # Validate auth_mapping keys if explicitly provided
967
+ if scheme.x_airbyte_auth_config:
968
+ _validate_auth_mapping_keys(AuthType.OAUTH2, scheme.x_airbyte_auth_config)
927
969
  return AuthConfig(
928
970
  type=AuthType.OAUTH2,
929
971
  config=oauth2_config,
@@ -934,6 +976,10 @@ def _parse_single_security_scheme(scheme: Any) -> AuthConfig:
934
976
  # Use explicit x-airbyte-auth-config if present, otherwise generate default
935
977
  auth_config_obj = scheme.x_airbyte_auth_config or _generate_default_auth_config(auth_type)
936
978
 
979
+ # Validate auth_mapping keys if explicitly provided
980
+ if scheme.x_airbyte_auth_config:
981
+ _validate_auth_mapping_keys(auth_type, scheme.x_airbyte_auth_config)
982
+
937
983
  return AuthConfig(
938
984
  type=auth_type,
939
985
  config=auth_config,
@@ -490,7 +490,7 @@ class HTTPClient:
490
490
 
491
491
  if not response_text.strip():
492
492
  response_data = {}
493
- elif "application/json" in content_type or not content_type:
493
+ elif "application/json" in content_type or "+json" in content_type or not content_type:
494
494
  response_data = await response.json()
495
495
  else:
496
496
  error_msg = f"Expected JSON response for {method.upper()} {url}, got content-type: {content_type}"
@@ -55,7 +55,6 @@ class AuthConfigFieldSpec(BaseModel):
55
55
  description: str | None = None
56
56
  format: str | None = None # e.g., "email", "uri"
57
57
  pattern: str | None = None # Regex validation
58
- airbyte_secret: bool = Field(False, alias="airbyte_secret")
59
58
  default: Any | None = None
60
59
 
61
60
 
@@ -136,7 +136,7 @@ class ZendeskChatConnector:
136
136
  """
137
137
 
138
138
  connector_name = "zendesk-chat"
139
- connector_version = "0.1.4"
139
+ connector_version = "0.1.5"
140
140
  vendored_sdk_version = "0.1.0" # Version of vendored connector-sdk
141
141
 
142
142
  # Map of (entity, action) -> needs_envelope for envelope wrapping decision
@@ -26,7 +26,7 @@ from uuid import (
26
26
  ZendeskChatConnectorModel: ConnectorModel = ConnectorModel(
27
27
  id=UUID('40d24d0f-b8f9-4fe0-9e6c-b06c0f3f45e4'),
28
28
  name='zendesk-chat',
29
- version='0.1.4',
29
+ version='0.1.5',
30
30
  base_url='https://{subdomain}.zendesk.com/api/v2/chat',
31
31
  auth=AuthConfig(
32
32
  type=AuthType.BEARER,
@@ -40,7 +40,6 @@ ZendeskChatConnectorModel: ConnectorModel = ConnectorModel(
40
40
  'access_token': AuthConfigFieldSpec(
41
41
  title='Access Token',
42
42
  description='Your Zendesk Chat OAuth 2.0 access token',
43
- airbyte_secret=True,
44
43
  ),
45
44
  },
46
45
  auth_mapping={'token': '${access_token}'},
@@ -139,6 +139,27 @@ class WebpathItem(BaseModel):
139
139
  from_: Union[str | None, Any] = Field(default=None, alias="from")
140
140
  timestamp: Union[str | None, Any] = Field(default=None)
141
141
 
142
+ class ChatEngagement(BaseModel):
143
+ """ChatEngagement type definition"""
144
+ model_config = ConfigDict(extra="allow", populate_by_name=True)
145
+
146
+ id: Union[str | None, Any] = Field(default=None)
147
+ agent_id: Union[str | None, Any] = Field(default=None)
148
+ agent_name: Union[str | None, Any] = Field(default=None)
149
+ agent_full_name: Union[str | None, Any] = Field(default=None)
150
+ department_id: Union[int | None, Any] = Field(default=None)
151
+ timestamp: Union[str | None, Any] = Field(default=None)
152
+ duration: Union[float | None, Any] = Field(default=None)
153
+ accepted: Union[bool | None, Any] = Field(default=None)
154
+ assigned: Union[bool | None, Any] = Field(default=None)
155
+ started_by: Union[str | None, Any] = Field(default=None)
156
+ rating: Union[str | None, Any] = Field(default=None)
157
+ comment: Union[str | None, Any] = Field(default=None)
158
+ count: Union[Any, Any] = Field(default=None)
159
+ response_time: Union[Any, Any] = Field(default=None)
160
+ skills_requested: Union[list[int] | None, Any] = Field(default=None)
161
+ skills_fulfilled: Union[bool | None, Any] = Field(default=None)
162
+
142
163
  class ChatHistoryItem(BaseModel):
143
164
  """ChatHistoryItem type definition"""
144
165
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -168,27 +189,6 @@ class ChatConversion(BaseModel):
168
189
  timestamp: Union[str | None, Any] = Field(default=None)
169
190
  attribution: Union[Any, Any] = Field(default=None)
170
191
 
171
- class ChatEngagement(BaseModel):
172
- """ChatEngagement type definition"""
173
- model_config = ConfigDict(extra="allow", populate_by_name=True)
174
-
175
- id: Union[str | None, Any] = Field(default=None)
176
- agent_id: Union[str | None, Any] = Field(default=None)
177
- agent_name: Union[str | None, Any] = Field(default=None)
178
- agent_full_name: Union[str | None, Any] = Field(default=None)
179
- department_id: Union[int | None, Any] = Field(default=None)
180
- timestamp: Union[str | None, Any] = Field(default=None)
181
- duration: Union[float | None, Any] = Field(default=None)
182
- accepted: Union[bool | None, Any] = Field(default=None)
183
- assigned: Union[bool | None, Any] = Field(default=None)
184
- started_by: Union[str | None, Any] = Field(default=None)
185
- rating: Union[str | None, Any] = Field(default=None)
186
- comment: Union[str | None, Any] = Field(default=None)
187
- count: Union[Any, Any] = Field(default=None)
188
- response_time: Union[Any, Any] = Field(default=None)
189
- skills_requested: Union[list[int] | None, Any] = Field(default=None)
190
- skills_fulfilled: Union[bool | None, Any] = Field(default=None)
191
-
192
192
  class Chat(BaseModel):
193
193
  """Chat conversation transcript"""
194
194
  model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-zendesk-chat
3
- Version: 0.1.11
3
+ Version: 0.1.17
4
4
  Summary: Airbyte Zendesk-Chat 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/
@@ -119,7 +119,7 @@ This example assumes you've already authenticated your connector with Airbyte. S
119
119
  from airbyte_agent_zendesk-chat import ZendeskChatConnector
120
120
 
121
121
  connector = ZendeskChatConnector(
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
  )
@@ -162,6 +162,6 @@ For the service's official API docs, see the [Zendesk-Chat API reference](https:
162
162
 
163
163
  ## Version information
164
164
 
165
- - **Package version:** 0.1.11
166
- - **Connector version:** 0.1.4
167
- - **Generated with Connector SDK commit SHA:** 609c1d86c76b36ff699b57123a5a8c2050d958c3
165
+ - **Package version:** 0.1.17
166
+ - **Connector version:** 0.1.5
167
+ - **Generated with Connector SDK commit SHA:** 0f5e1914fa0d7d52de7bc0018afab712184a0847
@@ -1,17 +1,17 @@
1
- airbyte_agent_zendesk_chat/__init__.py,sha256=ca45IFjyP9cCDoJcdAKiVWLQKviM2sTzGOla63CPO_s,4292
2
- airbyte_agent_zendesk_chat/connector.py,sha256=R_JDuiJ0kpk4_xNfgUPg1LNHlrcpYLx56Vkq8z8HesI,45365
3
- airbyte_agent_zendesk_chat/connector_model.py,sha256=phL6Mh98faJyMEC9KshDl8vtJrV6cWctRvgBOoKB4Sg,122093
4
- airbyte_agent_zendesk_chat/models.py,sha256=zCgNKE7xJ5OWch2fMprtInihzsk6k-rzu0myoHV2rng,23905
1
+ airbyte_agent_zendesk_chat/__init__.py,sha256=58FoaYF-1xPmAAb8YxLdKZ3ZczA9WnZZRBLfvaPDRAw,4292
2
+ airbyte_agent_zendesk_chat/connector.py,sha256=3ggEauUPKiLBZ4Glzx9VTQU0UYnGoPEjpathUWzwfL0,45365
3
+ airbyte_agent_zendesk_chat/connector_model.py,sha256=-dBvC7ciacOr7_AuxI-We1UeXOoF0N_TBM16-6jihXU,122052
4
+ airbyte_agent_zendesk_chat/models.py,sha256=gLTJanLPEu46ftb6BoRjIqVIpPWDpVXhQoj4x7X1DfM,23905
5
5
  airbyte_agent_zendesk_chat/types.py,sha256=C5laH7V__abYm0F1Jck49Az6SCJQdnXLgtahxponDgM,28925
6
6
  airbyte_agent_zendesk_chat/_vendored/__init__.py,sha256=ILl7AHXMui__swyrjxrh9yRa4dLiwBvV6axPWFWty80,38
7
7
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/__init__.py,sha256=T5o7roU6NSpH-lCAGZ338sE5dlh4ZU6i6IkeG1zpems,1949
8
8
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/auth_strategies.py,sha256=5Sb9moUp623o67Q2wMa8iZldJH08y4gQdoutoO_75Iw,42088
9
9
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/auth_template.py,sha256=nju4jqlFC_KI82ILNumNIyiUtRJcy7J94INIZ0QraI4,4454
10
- airbyte_agent_zendesk_chat/_vendored/connector_sdk/connector_model_loader.py,sha256=nCu6oym6LoKrS94NTivU1vyQE_qnU-rhx8ExpuOX_LU,39544
10
+ airbyte_agent_zendesk_chat/_vendored/connector_sdk/connector_model_loader.py,sha256=AW9bsdggzuc3ydy2bYYF33L6LxLKLQer9Wm47IOuQw0,41492
11
11
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/constants.py,sha256=AtzOvhDMWbRJgpsQNWl5tkogHD6mWgEY668PgRmgtOY,2737
12
12
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/exceptions.py,sha256=ss5MGv9eVPmsbLcLWetuu3sDmvturwfo6Pw3M37Oq5k,481
13
13
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/extensions.py,sha256=XWRRoJOOrwUHSKbuQt5DU7CCu8ePzhd_HuP7c_uD77w,21376
14
- airbyte_agent_zendesk_chat/_vendored/connector_sdk/http_client.py,sha256=yucwu3OvJh5wLQa1mk-gTKjtqjKKucMw5ltmlE7mk1c,28000
14
+ airbyte_agent_zendesk_chat/_vendored/connector_sdk/http_client.py,sha256=09Fclbq4wrg38EM2Yh2kHiykQVXqdAGby024elcEz8E,28027
15
15
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/introspection.py,sha256=kRVI4TDQDLdcCnTBUML8ycAtdqAQufVh-027sMkb4i8,19165
16
16
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/secrets.py,sha256=J9ezMu4xNnLW11xY5RCre6DHP7YMKZCqwGJfk7ufHAM,6855
17
17
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/types.py,sha256=in8gHsn5nsScujOfHZmkOgNmqmJKiPyNNjg59m5fGWc,8807
@@ -47,11 +47,11 @@ airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/components.py,sha256=n
47
47
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/connector.py,sha256=mSZk1wr2YSdRj9tTRsPAuIlCzd_xZLw-Bzl1sMwE0rE,3731
48
48
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/extensions.py,sha256=5hgpFHK7fzpzegCkJk882DeIP79bCx_qairKJhvPMZ8,9590
49
49
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/operations.py,sha256=RpzGtAI4yvAtMHAfMUMcUwgHv_qJojnKlNb75_agUF8,5729
50
- airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/security.py,sha256=6ljzf_JHs4amnQX9AhePcEsT8P3ZnTSC4xeg7-cvsNQ,9100
50
+ airbyte_agent_zendesk_chat/_vendored/connector_sdk/schema/security.py,sha256=1CVCavrPdHHyk7B6JtUD75yRS_hWLCemZF1zwGbdqxg,9036
51
51
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/telemetry/__init__.py,sha256=RaLgkBU4dfxn1LC5Y0Q9rr2PJbrwjxvPgBLmq8_WafE,211
52
52
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
53
53
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
54
54
  airbyte_agent_zendesk_chat/_vendored/connector_sdk/telemetry/tracker.py,sha256=Ftrk0_ddfM7dZG8hF9xBuPwhbc9D6JZ7Q9qs5o3LEyA,5579
55
- airbyte_agent_zendesk_chat-0.1.11.dist-info/METADATA,sha256=S4acOSQYD6WwXfYnRoQG4jN4eZmQE15QryY4DiefAp8,6606
56
- airbyte_agent_zendesk_chat-0.1.11.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
57
- airbyte_agent_zendesk_chat-0.1.11.dist-info/RECORD,,
55
+ airbyte_agent_zendesk_chat-0.1.17.dist-info/METADATA,sha256=QZEUxZ8Ks_l1UwPw8i7mFlLzVCRxZG1POV8zR_bmo38,6610
56
+ airbyte_agent_zendesk_chat-0.1.17.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
57
+ airbyte_agent_zendesk_chat-0.1.17.dist-info/RECORD,,