airbyte-agent-shopify 0.1.4__tar.gz → 0.1.6__tar.gz

airbyte_agent_shopify-0.1.6/AUTH.md

@@ -0,0 +1,96 @@
+# 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 is not 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 is not available for this connector.
+
+#### Token
+
+Create a connector with Token credentials:
+
+```bash
+curl -X POST 'https://api.airbyte.ai/v1/integrations/sources' \
+  -H 'Authorization: Bearer <SCOPED_TOKEN>' \
+  -H 'Content-Type: application/json' \
+  -d '{
+    "workspace_id": "<WORKSPACE_ID>",
+    "source_template_id": "<SOURCE_TEMPLATE_ID>",
+    "name": "My Shopify Connector",
+    "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-scoped-token>",
+    airbyte_client_id="<your-client-id>",
+    airbyte_client_secret="<your-client-secret>"
+)
+
+@agent.tool_plain # assumes you're using Pydantic AI
+@ShopifyConnector.describe
+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.4 → airbyte_agent_shopify-0.1.6}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Shopify changelog
 
+## [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

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-shopify
-Version: 0.1.4
+Version: 0.1.6
 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/
@@ -102,7 +102,7 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
 
 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/hosted-execution).
+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
@@ -167,6 +167,6 @@ For the service's official API docs, see the [Shopify API reference](https://sho
 
 ## Version information
 
-- **Package version:** 0.1.4
+- **Package version:** 0.1.6
 - **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** 1da193dd2b3d4b2e2147ba74bd9a4062a62c4186
+- **Generated with Connector SDK commit SHA:** 49e6dfe93fc406c8d2ed525372608fa2766ebece

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/README.md

@@ -69,7 +69,7 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
 
 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/hosted-execution).
+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
@@ -134,6 +134,6 @@ For the service's official API docs, see the [Shopify API reference](https://sho
 
 ## Version information
 
-- **Package version:** 0.1.4
+- **Package version:** 0.1.6
 - **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** 1da193dd2b3d4b2e2147ba74bd9a4062a62c4186
+- **Generated with Connector SDK commit SHA:** 49e6dfe93fc406c8d2ed525372608fa2766ebece

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/airbyte_agent_shopify/__init__.py

@@ -13,14 +13,14 @@ from .models import (
     CustomerAddressList,
     MarketingConsent,
     OrderAddress,
-    LineItem,
-    Fulfillment,
     Transaction,
     Refund,
+    LineItem,
+    Fulfillment,
     Order,
     OrderList,
-    ProductVariant,
     ProductImage,
+    ProductVariant,
     Product,
     ProductList,
     ProductVariantList,
@@ -186,14 +186,14 @@ __all__ = [
     "CustomerAddressList",
     "MarketingConsent",
     "OrderAddress",
-    "LineItem",
-    "Fulfillment",
     "Transaction",
     "Refund",
+    "LineItem",
+    "Fulfillment",
     "Order",
     "OrderList",
-    "ProductVariant",
     "ProductImage",
+    "ProductVariant",
     "Product",
     "ProductList",
     "ProductVariantList",

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/airbyte_agent_shopify/_vendored/connector_sdk/auth_strategies.py

@@ -634,9 +634,7 @@ class OAuth2AuthStrategy(AuthStrategy):
             Headers dict with additional headers added
         """
         # Build template context with extracted secret values
-        template_context = {
-            key: extract_secret_value(value) for key, value in secrets.items()
-        }
+        template_context = {key: extract_secret_value(value) for key, value in secrets.items()}
 
         for header_name, value_template in additional_headers.items():
             # Use Jinja2 templating for variable substitution

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/airbyte_agent_shopify/_vendored/connector_sdk/executor/local_executor.py

@@ -694,9 +694,7 @@ class LocalExecutor:
         """
         return {key: value for key, value in params.items() if key in allowed_fields and value is not None}
 
-    def _extract_header_params(
-        self, endpoint: EndpointDefinition, params: dict[str, Any], body: dict[str, Any] | None = None
-    ) -> dict[str, str]:
+    def _extract_header_params(self, endpoint: EndpointDefinition, params: dict[str, Any], body: dict[str, Any] | None = None) -> dict[str, str]:
         """Extract header parameters from params and schema defaults.
 
         Also adds Content-Type header when there's a request body (unless already specified

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "airbyte-agent-shopify"
-version = "0.1.4"
+version = "0.1.6"
 description = "Airbyte Shopify Connector for AI platforms"
 readme = "README.md"
 requires-python = ">=3.13"

{airbyte_agent_shopify-0.1.4 → airbyte_agent_shopify-0.1.6}/airbyte_agent_shopify/models.py

@@ -119,6 +119,55 @@ class OrderAddress(BaseModel):
     latitude: Union[float | None, Any] = Field(default=None)
     longitude: Union[float | None, Any] = Field(default=None)
 
+class Transaction(BaseModel):
+    """An order transaction"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[int, Any] = Field(default=None)
+    order_id: Union[int | None, Any] = Field(default=None)
+    kind: Union[str | None, Any] = Field(default=None)
+    gateway: Union[str | None, Any] = Field(default=None)
+    status: Union[str | None, Any] = Field(default=None)
+    message: Union[str | None, Any] = Field(default=None)
+    created_at: Union[str | None, Any] = Field(default=None)
+    test: Union[bool | None, Any] = Field(default=None)
+    authorization: Union[str | None, Any] = Field(default=None)
+    location_id: Union[int | None, Any] = Field(default=None)
+    user_id: Union[int | None, Any] = Field(default=None)
+    parent_id: Union[int | None, Any] = Field(default=None)
+    processed_at: Union[str | None, Any] = Field(default=None)
+    device_id: Union[int | None, Any] = Field(default=None)
+    error_code: Union[str | None, Any] = Field(default=None)
+    source_name: Union[str | None, Any] = Field(default=None)
+    receipt: Union[dict[str, Any] | None, Any] = Field(default=None)
+    currency_exchange_adjustment: Union[dict[str, Any] | None, Any] = Field(default=None)
+    amount: Union[str | None, Any] = Field(default=None)
+    currency: Union[str | None, Any] = Field(default=None)
+    payment_id: Union[str | None, Any] = Field(default=None)
+    total_unsettled_set: Union[dict[str, Any] | None, Any] = Field(default=None)
+    manual_payment_gateway: Union[bool | None, Any] = Field(default=None)
+    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
+
+class Refund(BaseModel):
+    """An order refund"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[int, Any] = Field(default=None)
+    order_id: Union[int | None, Any] = Field(default=None)
+    created_at: Union[str | None, Any] = Field(default=None)
+    note: Union[str | None, Any] = Field(default=None)
+    user_id: Union[int | None, Any] = Field(default=None)
+    processed_at: Union[str | None, Any] = Field(default=None)
+    restock: Union[bool | None, Any] = Field(default=None)
+    duties: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
+    total_duties_set: Union[dict[str, Any] | None, Any] = Field(default=None)
+    return_: Union[dict[str, Any] | None, Any] = Field(default=None, alias="return")
+    refund_line_items: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
+    transactions: Union[list[Transaction] | None, Any] = Field(default=None)
+    order_adjustments: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
+    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
+    refund_shipping_lines: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
+
 class LineItem(BaseModel):
     """LineItem type definition"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -176,55 +225,6 @@ class Fulfillment(BaseModel):
     name: Union[str | None, Any] = Field(default=None)
     admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
 
-class Transaction(BaseModel):
-    """An order transaction"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[int, Any] = Field(default=None)
-    order_id: Union[int | None, Any] = Field(default=None)
-    kind: Union[str | None, Any] = Field(default=None)
-    gateway: Union[str | None, Any] = Field(default=None)
-    status: Union[str | None, Any] = Field(default=None)
-    message: Union[str | None, Any] = Field(default=None)
-    created_at: Union[str | None, Any] = Field(default=None)
-    test: Union[bool | None, Any] = Field(default=None)
-    authorization: Union[str | None, Any] = Field(default=None)
-    location_id: Union[int | None, Any] = Field(default=None)
-    user_id: Union[int | None, Any] = Field(default=None)
-    parent_id: Union[int | None, Any] = Field(default=None)
-    processed_at: Union[str | None, Any] = Field(default=None)
-    device_id: Union[int | None, Any] = Field(default=None)
-    error_code: Union[str | None, Any] = Field(default=None)
-    source_name: Union[str | None, Any] = Field(default=None)
-    receipt: Union[dict[str, Any] | None, Any] = Field(default=None)
-    currency_exchange_adjustment: Union[dict[str, Any] | None, Any] = Field(default=None)
-    amount: Union[str | None, Any] = Field(default=None)
-    currency: Union[str | None, Any] = Field(default=None)
-    payment_id: Union[str | None, Any] = Field(default=None)
-    total_unsettled_set: Union[dict[str, Any] | None, Any] = Field(default=None)
-    manual_payment_gateway: Union[bool | None, Any] = Field(default=None)
-    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
-
-class Refund(BaseModel):
-    """An order refund"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[int, Any] = Field(default=None)
-    order_id: Union[int | None, Any] = Field(default=None)
-    created_at: Union[str | None, Any] = Field(default=None)
-    note: Union[str | None, Any] = Field(default=None)
-    user_id: Union[int | None, Any] = Field(default=None)
-    processed_at: Union[str | None, Any] = Field(default=None)
-    restock: Union[bool | None, Any] = Field(default=None)
-    duties: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
-    total_duties_set: Union[dict[str, Any] | None, Any] = Field(default=None)
-    return_: Union[dict[str, Any] | None, Any] = Field(default=None, alias="return")
-    refund_line_items: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
-    transactions: Union[list[Transaction] | None, Any] = Field(default=None)
-    order_adjustments: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
-    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
-    refund_shipping_lines: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
-
 class Order(BaseModel):
     """A Shopify order"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -329,6 +329,22 @@ class OrderList(BaseModel):
 
     orders: Union[list[Order], Any] = Field(default=None)
 
+class ProductImage(BaseModel):
+    """A product image"""
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    id: Union[int, Any] = Field(default=None)
+    product_id: Union[int | None, Any] = Field(default=None)
+    position: Union[int | None, Any] = Field(default=None)
+    created_at: Union[str | None, Any] = Field(default=None)
+    updated_at: Union[str | None, Any] = Field(default=None)
+    alt: Union[str | None, Any] = Field(default=None)
+    width: Union[int | None, Any] = Field(default=None)
+    height: Union[int | None, Any] = Field(default=None)
+    src: Union[str | None, Any] = Field(default=None)
+    variant_ids: Union[list[int] | None, Any] = Field(default=None)
+    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
+
 class ProductVariant(BaseModel):
     """A product variant"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)
@@ -360,22 +376,6 @@ class ProductVariant(BaseModel):
     requires_shipping: Union[bool | None, Any] = Field(default=None)
     admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
 
-class ProductImage(BaseModel):
-    """A product image"""
-    model_config = ConfigDict(extra="allow", populate_by_name=True)
-
-    id: Union[int, Any] = Field(default=None)
-    product_id: Union[int | None, Any] = Field(default=None)
-    position: Union[int | None, Any] = Field(default=None)
-    created_at: Union[str | None, Any] = Field(default=None)
-    updated_at: Union[str | None, Any] = Field(default=None)
-    alt: Union[str | None, Any] = Field(default=None)
-    width: Union[int | None, Any] = Field(default=None)
-    height: Union[int | None, Any] = Field(default=None)
-    src: Union[str | None, Any] = Field(default=None)
-    variant_ids: Union[list[int] | None, Any] = Field(default=None)
-    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
-
 class Product(BaseModel):
     """A Shopify product"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)