airbyte-agent-shopify 0.1.24__py3-none-any.whl → 0.1.25__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.
@@ -161,24 +161,80 @@ 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
+
164
210
  async def create_source(
165
211
  self,
166
212
  name: str,
167
213
  connector_definition_id: str,
168
214
  external_user_id: str,
169
- credentials: dict[str, Any],
215
+ credentials: dict[str, Any] | None = None,
170
216
  replication_config: dict[str, Any] | None = None,
217
+ server_side_oauth_secret_id: str | None = None,
218
+ source_template_id: str | None = None,
171
219
  ) -> str:
172
- """Create a new source on Airbyte Agent Platform.
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
173
225
 
174
226
  Args:
175
227
  name: Source name
176
228
  connector_definition_id: UUID of the connector definition
177
229
  external_user_id: User identifier
178
- credentials: Connector auth config dict
230
+ credentials: Connector auth config dict. Required unless using OAuth.
179
231
  replication_config: Optional replication settings (e.g., start_date for
180
232
  connectors with x-airbyte-replication-config). Required for REPLICATION
181
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.
182
238
 
183
239
  Returns:
184
240
  The created source ID (UUID string)
@@ -187,19 +243,21 @@ class AirbyteCloudClient:
187
243
  httpx.HTTPStatusError: If creation fails
188
244
 
189
245
  Example:
246
+ # With direct credentials:
190
247
  source_id = await client.create_source(
191
- name="My Gong Source",
192
- connector_definition_id="32382e40-3b49-4b99-9c5c-4076501914e7",
248
+ name="My Intercom Source",
249
+ connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
193
250
  external_user_id="my-workspace",
194
- credentials={"access_key": "...", "access_key_secret": "..."}
251
+ credentials={"access_token": "..."},
252
+ replication_config={"start_date": "2024-01-01T00:00:00Z"}
195
253
  )
196
254
 
197
- # For REPLICATION mode sources (e.g., Intercom):
255
+ # With server-side OAuth:
198
256
  source_id = await client.create_source(
199
257
  name="My Intercom Source",
200
258
  connector_definition_id="d8313939-3782-41b0-be29-b3ca20d8dd3a",
201
259
  external_user_id="my-workspace",
202
- credentials={"access_token": "..."},
260
+ server_side_oauth_secret_id="airbyte_oauth_..._secret_...",
203
261
  replication_config={"start_date": "2024-01-01T00:00:00Z"}
204
262
  )
205
263
  """
@@ -211,11 +269,16 @@ class AirbyteCloudClient:
211
269
  "name": name,
212
270
  "definition_id": connector_definition_id,
213
271
  "external_user_id": external_user_id,
214
- "credentials": credentials,
215
272
  }
216
273
 
274
+ if credentials is not None:
275
+ request_body["credentials"] = credentials
217
276
  if replication_config is not None:
218
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
219
282
 
220
283
  response = await self._http_client.post(url, json=request_body, headers=headers)
221
284
  response.raise_for_status()
@@ -1088,6 +1088,7 @@ class ShopifyConnector:
1088
1088
  auth_config: "ShopifyAuthConfig",
1089
1089
  name: str | None = None,
1090
1090
  replication_config: dict[str, Any] | None = None,
1091
+ source_template_id: str | None = None,
1091
1092
  ) -> "ShopifyConnector":
1092
1093
  """
1093
1094
  Create a new hosted connector on Airbyte Cloud.
@@ -1104,6 +1105,8 @@ class ShopifyConnector:
1104
1105
  name: Optional source name (defaults to connector name + external_user_id)
1105
1106
  replication_config: Optional replication settings dict.
1106
1107
  Required for connectors with x-airbyte-replication-config (REPLICATION mode sources).
1108
+ source_template_id: Source template ID. Required when organization has
1109
+ multiple source templates for this connector type.
1107
1110
 
1108
1111
  Returns:
1109
1112
  A ShopifyConnector instance configured in hosted mode
@@ -1120,6 +1123,7 @@ class ShopifyConnector:
1120
1123
  # Use the connector
1121
1124
  result = await connector.execute("entity", "list", {})
1122
1125
  """
1126
+
1123
1127
  from ._vendored.connector_sdk.cloud_utils import AirbyteCloudClient
1124
1128
 
1125
1129
  client = AirbyteCloudClient(
@@ -1128,8 +1132,8 @@ class ShopifyConnector:
1128
1132
  )
1129
1133
 
1130
1134
  try:
1131
- # Build credentials from auth_config
1132
- credentials = auth_config.model_dump(exclude_none=True)
1135
+ # Build credentials from auth_config (if provided)
1136
+ credentials = auth_config.model_dump(exclude_none=True) if auth_config else None
1133
1137
  replication_config_dict = replication_config.model_dump(exclude_none=True) if replication_config else None
1134
1138
 
1135
1139
  # Create source on Airbyte Cloud
@@ -1140,6 +1144,7 @@ class ShopifyConnector:
1140
1144
  external_user_id=external_user_id,
1141
1145
  credentials=credentials,
1142
1146
  replication_config=replication_config_dict,
1147
+ source_template_id=source_template_id,
1143
1148
  )
1144
1149
  finally:
1145
1150
  await client.close()
@@ -1153,6 +1158,7 @@ class ShopifyConnector:
1153
1158
 
1154
1159
 
1155
1160
 
1161
+
1156
1162
  class CustomersQuery:
1157
1163
  """
1158
1164
  Query class for Customers entity operations.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: airbyte-agent-shopify
3
- Version: 0.1.24
3
+ Version: 0.1.25
4
4
  Summary: Airbyte Shopify 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/
@@ -171,7 +171,7 @@ See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest
171
171
 
172
172
  ## Version information
173
173
 
174
- - **Package version:** 0.1.24
174
+ - **Package version:** 0.1.25
175
175
  - **Connector version:** 0.1.3
176
- - **Generated with Connector SDK commit SHA:** b184da3e22ef8521d2eeebf3c96a0fe8da2424f5
176
+ - **Generated with Connector SDK commit SHA:** 9d9866b0aae8c3494d04d34e193b9bd860bfc1c6
177
177
  - **Changelog:** [View changelog](https://github.com/airbytehq/airbyte-agent-connectors/blob/main/connectors/shopify/CHANGELOG.md)
@@ -1,5 +1,5 @@
1
1
  airbyte_agent_shopify/__init__.py,sha256=VzEfKBOuvkw1Kxz_VgySeuOUzh9cC936EkU9O7xI-aU,9711
2
- airbyte_agent_shopify/connector.py,sha256=6G3HzGH2YqnSTFnrxFDx1Hqy7YhjW8iH8XaD74_YG04,99334
2
+ airbyte_agent_shopify/connector.py,sha256=tfPJuuqBBkvjMJaid7UuYD1JkIIGmBUqQzAZ902q2ws,99627
3
3
  airbyte_agent_shopify/connector_model.py,sha256=OOKD-zmjbVv-MX-r3c-QF3alQqn6vKTDjRjAF6y0ddQ,691056
4
4
  airbyte_agent_shopify/models.py,sha256=hpXPTZ25RVc6a-nMbkLcGVq3zOeDx6oc8tQMUdfJnHg,61514
5
5
  airbyte_agent_shopify/types.py,sha256=AwQ4PR2wZmHNuryriCFdRxf9q48J1mnPwspUB1b-L_o,10221
@@ -19,7 +19,7 @@ airbyte_agent_shopify/_vendored/connector_sdk/utils.py,sha256=UYwYuSLhsDD-4C0dBs
19
19
  airbyte_agent_shopify/_vendored/connector_sdk/validation.py,sha256=w5WGnmILkdBslpXhAXhKhE-c8ANBc_OZQxr_fUeAgtc,39666
20
20
  airbyte_agent_shopify/_vendored/connector_sdk/validation_replication.py,sha256=v7F5YWd5m4diIF7_4m4nOkC9crg97vqRUUkt9ka9HZ4,36043
21
21
  airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/__init__.py,sha256=4799Hv9f2zxDVj1aLyQ8JpTEuFTp_oOZMRz-NZCdBJg,134
22
- airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/client.py,sha256=-_ibaHVa7KBBw8SnMuxpWz6XkrSgNTFdMgDfTChtywg,9505
22
+ airbyte_agent_shopify/_vendored/connector_sdk/cloud_utils/client.py,sha256=e0VLNCmesGGfo2uD0GiICgXsXTeTkh0GYiVgx_e4VEc,12296
23
23
  airbyte_agent_shopify/_vendored/connector_sdk/executor/__init__.py,sha256=EmG9YQNAjSuYCVB4D5VoLm4qpD1KfeiiOf7bpALj8p8,702
24
24
  airbyte_agent_shopify/_vendored/connector_sdk/executor/hosted_executor.py,sha256=tv0njAdy-gdHBg4izgcxhEWYbrNiBifEYEca9AWzaL0,8693
25
25
  airbyte_agent_shopify/_vendored/connector_sdk/executor/local_executor.py,sha256=RtdTXFzfoJz5Coz9nwQi81Df1402BRgO1Mgd3ZzTkfw,76581
@@ -53,6 +53,6 @@ airbyte_agent_shopify/_vendored/connector_sdk/telemetry/__init__.py,sha256=RaLgk
53
53
  airbyte_agent_shopify/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
54
54
  airbyte_agent_shopify/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
55
55
  airbyte_agent_shopify/_vendored/connector_sdk/telemetry/tracker.py,sha256=SginFQbHqVUVYG82NnNzG34O-tAQ_wZYjGDcuo0q4Kk,5584
56
- airbyte_agent_shopify-0.1.24.dist-info/METADATA,sha256=XVJq7Cm7W45sKaztRhMolJ4fvU_S4T0eWPU6NHtwRWY,7999
57
- airbyte_agent_shopify-0.1.24.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
58
- airbyte_agent_shopify-0.1.24.dist-info/RECORD,,
56
+ airbyte_agent_shopify-0.1.25.dist-info/METADATA,sha256=6KxU325F2jIH1mvCsWioEeNBHQB5GzGK4DLeTsDAEAU,7999
57
+ airbyte_agent_shopify-0.1.25.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
58
+ airbyte_agent_shopify-0.1.25.dist-info/RECORD,,