airbyte-agent-shopify 0.1.3__tar.gz → 0.1.13__tar.gz

airbyte_agent_shopify-0.1.13/AUTH.md

@@ -0,0 +1,95 @@
+# Shopify authentication and configuration
+
+This page documents the authentication and configuration options for the Shopify agent connector.
+
+## Authentication
+
+### Open source execution
+
+In open source mode, you provide API credentials directly to the connector.
+
+#### OAuth
+This authentication method isn't available for this connector.
+
+#### Token
+
+| Field Name | Type | Required | Description |
+|------------|------|----------|-------------|
+| `api_key` | `str` | Yes | Your Shopify Admin API access token |
+| `shop` | `str` | Yes | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |
+
+```python
+from airbyte_agent_shopify import ShopifyConnector
+from airbyte_agent_shopify.models import ShopifyAuthConfig
+
+connector = ShopifyConnector(
+    auth_config=ShopifyAuthConfig(
+        api_key="<Your Shopify Admin API access token>",
+        shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
+    )
+)
+```
+
+### Hosted execution
+
+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).
+
+#### OAuth
+This authentication method isn't available for this connector.
+
+#### Token
+
+Create a connector with Token credentials:
+
+```bash
+curl -X POST 'https://api.airbyte.ai/v1/integrations/connectors' \
+  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "external_user_id": "<EXTERNAL_USER_ID>",
+    "connector_type": "Shopify",
+    "credentials": {
+      "api_key": "<Your Shopify Admin API access token>",
+      "shop": "<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
+    }
+  }'
+```
+
+#### Execution
+
+After creating the connector, execute operations using either the Python SDK or API.
+
+**Python SDK**
+
+```python
+from airbyte_agent_shopify import ShopifyConnector
+
+connector = ShopifyConnector(
+    external_user_id="<your_external_user_id>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.tool_utils
+async def shopify_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+**API**
+
+```bash
+curl -X POST 'https://api.airbyte.ai/api/v1/connectors/sources/<connector_id>/execute' \
+  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'
+```
+
+
+## Configuration
+
+The Shopify connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the `config` parameter when initializing the connector.
+
+| Variable | Type | Required | Default | Description |
+|----------|------|----------|---------|-------------|
+| `shop` | `string` | Yes | my-store | Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com) |

airbyte_agent_shopify-0.1.13/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Shopify changelog
+
+## [0.1.13] - 2026-01-27
+- Updated connector definition (YAML version 0.1.2)
+- Source commit: c9b05509
+- SDK version: 0.1.0
+
+## [0.1.12] - 2026-01-27
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 4bded58d
+- SDK version: 0.1.0
+
+## [0.1.11] - 2026-01-26
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 74809153
+- SDK version: 0.1.0
+
+## [0.1.10] - 2026-01-26
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: b73c71e0
+- SDK version: 0.1.0
+
+## [0.1.9] - 2026-01-24
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 609c1d86
+- SDK version: 0.1.0
+
+## [0.1.8] - 2026-01-23
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 416466da
+- SDK version: 0.1.0
+
+## [0.1.7] - 2026-01-23
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: f17cdd8c
+- SDK version: 0.1.0
+
+## [0.1.6] - 2026-01-22
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 49e6dfe9
+- SDK version: 0.1.0
+
+## [0.1.5] - 2026-01-22
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: b27328e2
+- SDK version: 0.1.0
+
+## [0.1.4] - 2026-01-22
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 1da193dd
+- SDK version: 0.1.0
+
+## [0.1.3] - 2026-01-22
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: c713ec48
+- SDK version: 0.1.0
+
+## [0.1.2] - 2026-01-21
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: c7dab975
+- SDK version: 0.1.0
+
+## [0.1.1] - 2026-01-19
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 529cebb7
+- SDK version: 0.1.0
+
+## [0.1.0] - 2026-01-17
+- Updated connector definition (YAML version 0.1.1)
+- Source commit: 7c6c8361
+- SDK version: 0.1.0

{airbyte_agent_shopify-0.1.3 → airbyte_agent_shopify-0.1.13}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-shopify
-Version: 0.1.3
+Version: 0.1.13
 Summary: Airbyte Shopify Connector for AI platforms
 Project-URL: Homepage, https://github.com/airbytehq/airbyte-agent-connectors
 Project-URL: Documentation, https://docs.airbyte.com/ai-agents/
@@ -75,16 +75,48 @@ uv pip install airbyte-agent-shopify
 
 ## Usage
 
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
 ```python
-from airbyte_agent_shopify import ShopifyConnector, ShopifyAuthConfig
+from airbyte_agent_shopify import ShopifyConnector
+from airbyte_agent_shopify.models import ShopifyAuthConfig
 
 connector = ShopifyConnector(
-  auth_config=ShopifyAuthConfig(
-    api_key="...",
-    shop="..."
-  )
+    auth_config=ShopifyAuthConfig(
+        api_key="<Your Shopify Admin API access token>",
+        shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
+    )
 )
-result = await connector.customers.list()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.tool_utils
+async def shopify_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+```python
+from airbyte_agent_shopify import ShopifyConnector
+
+connector = ShopifyConnector(
+    external_user_id="<your_external_user_id>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.tool_utils
+async def shopify_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
 
@@ -128,12 +160,14 @@ This connector supports the following entities and actions.
 | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
 
 
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
 For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
 
 For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
 
 ## Version information
 
-- **Package version:** 0.1.3
-- **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** c713ec4833c2b52dc89926ec68caa343423884cd
+- **Package version:** 0.1.13
+- **Connector version:** 0.1.2
+- **Generated with Connector SDK commit SHA:** c9b05509eb899e313055660f378d9c1f1e9129c7

{airbyte_agent_shopify-0.1.3 → airbyte_agent_shopify-0.1.13}/README.md

@@ -42,16 +42,48 @@ uv pip install airbyte-agent-shopify
 
 ## Usage
 
+Connectors can run in open source or hosted mode.
+
+### Open source
+
+In open source mode, you provide API credentials directly to the connector.
+
 ```python
-from airbyte_agent_shopify import ShopifyConnector, ShopifyAuthConfig
+from airbyte_agent_shopify import ShopifyConnector
+from airbyte_agent_shopify.models import ShopifyAuthConfig
 
 connector = ShopifyConnector(
-  auth_config=ShopifyAuthConfig(
-    api_key="...",
-    shop="..."
-  )
+    auth_config=ShopifyAuthConfig(
+        api_key="<Your Shopify Admin API access token>",
+        shop="<Your Shopify store name (e.g., 'my-store' from my-store.myshopify.com)>"
+    )
 )
-result = await connector.customers.list()
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.tool_utils
+async def shopify_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
+```
+
+### Hosted
+
+In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead. 
+
+This example assumes you've already authenticated your connector with Airbyte. See [Authentication](AUTH.md) to learn more about authenticating. If you need a step-by-step guide, see the [hosted execution tutorial](https://docs.airbyte.com/ai-agents/quickstarts/tutorial-hosted).
+
+```python
+from airbyte_agent_shopify import ShopifyConnector
+
+connector = ShopifyConnector(
+    external_user_id="<your_external_user_id>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.tool_utils
+async def shopify_execute(entity: str, action: str, params: dict | None = None):
+    return await connector.execute(entity, action, params or {})
 ```
 
 
@@ -95,12 +127,14 @@ This connector supports the following entities and actions.
 | Fulfillment Orders | [List](./REFERENCE.md#fulfillment-orders-list), [Get](./REFERENCE.md#fulfillment-orders-get) |
 
 
+For all authentication options, see the connector's [authentication documentation](AUTH.md).
+
 For detailed documentation on available actions and parameters, see this connector's [full reference documentation](./REFERENCE.md).
 
 For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
 
 ## Version information
 
-- **Package version:** 0.1.3
-- **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** c713ec4833c2b52dc89926ec68caa343423884cd
+- **Package version:** 0.1.13
+- **Connector version:** 0.1.2
+- **Generated with Connector SDK commit SHA:** c9b05509eb899e313055660f378d9c1f1e9129c7