airbyte-agent-shopify 0.1.16__tar.gz → 0.1.18__tar.gz

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/AUTH.md

@@ -13,11 +13,15 @@ This authentication method isn't available for this connector.
 
 #### Token
 
+`credentials` fields you need:
+
 | 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) |
 
+Example request:
+
 ```python
 from airbyte_agent_shopify import ShopifyConnector
 from airbyte_agent_shopify.models import ShopifyAuthConfig
@@ -38,16 +42,27 @@ In hosted mode, you first create a connector via the Airbyte API (providing your
 This authentication method isn't available for this connector.
 
 #### Token
+Create a connector with Token credentials.
+
+
+`credentials` fields you need:
+
+| 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) |
+
+Example request:
 
-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' \
+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",
+    "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)>"

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Shopify changelog
 
+## [0.1.18] - 2026-01-28
+- Updated connector definition (YAML version 0.1.2)
+- Source commit: 97007bbd
+- SDK version: 0.1.0
+
+## [0.1.17] - 2026-01-28
+- Updated connector definition (YAML version 0.1.2)
+- Source commit: f6c6fca2
+- SDK version: 0.1.0
+
 ## [0.1.16] - 2026-01-28
 - Updated connector definition (YAML version 0.1.2)
 - Source commit: 71f48c10

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-shopify
-Version: 0.1.16
+Version: 0.1.18
 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/
@@ -119,10 +119,11 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
     return await connector.execute(entity, action, params or {})
 ```
 
-
 ## Full documentation
 
-This connector supports the following entities and actions.
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
 
 | Entity | Actions |
 |--------|---------|
@@ -160,14 +161,16 @@ 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).
+### Authentication and configuration
+
+For all authentication and configuration 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).
+### Shopify API docs
 
-For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
+See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
 
 ## Version information
 
-- **Package version:** 0.1.16
+- **Package version:** 0.1.18
 - **Connector version:** 0.1.2
-- **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
+- **Generated with Connector SDK commit SHA:** 97007bbdad3a6ac982ee2c0cdd667acdb5c12d3c

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/README.md

@@ -86,10 +86,11 @@ async def shopify_execute(entity: str, action: str, params: dict | None = None):
     return await connector.execute(entity, action, params or {})
 ```
 
-
 ## Full documentation
 
-This connector supports the following entities and actions.
+### Entities and actions
+
+This connector supports the following entities and actions. For more details, see this connector's [full reference documentation](REFERENCE.md).
 
 | Entity | Actions |
 |--------|---------|
@@ -127,14 +128,16 @@ 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).
+### Authentication and configuration
+
+For all authentication and configuration 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).
+### Shopify API docs
 
-For the service's official API docs, see the [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
+See the official [Shopify API reference](https://shopify.dev/docs/api/admin-rest).
 
 ## Version information
 
-- **Package version:** 0.1.16
+- **Package version:** 0.1.18
 - **Connector version:** 0.1.2
-- **Generated with Connector SDK commit SHA:** 71f48c102ce98c9298e5102761e740f0d97eb71b
+- **Generated with Connector SDK commit SHA:** 97007bbdad3a6ac982ee2c0cdd667acdb5c12d3c

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/REFERENCE.md

@@ -4292,4 +4292,3 @@ curl --location 'https://api.airbyte.ai/api/v1/connectors/sources/{your_source_i
 
 </details>
 
-

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/airbyte_agent_shopify/__init__.py

@@ -14,9 +14,9 @@ from .models import (
     MarketingConsent,
     OrderAddress,
     LineItem,
-    Fulfillment,
     Transaction,
     Refund,
+    Fulfillment,
     Order,
     OrderList,
     ProductVariant,
@@ -187,9 +187,9 @@ __all__ = [
     "MarketingConsent",
     "OrderAddress",
     "LineItem",
-    "Fulfillment",
     "Transaction",
     "Refund",
+    "Fulfillment",
     "Order",
     "OrderList",
     "ProductVariant",

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/airbyte_agent_shopify/_vendored/connector_sdk/introspection.py

@@ -380,7 +380,11 @@ def describe_entities(model: ConnectorModelProtocol) -> list[dict[str, Any]]:
     return entities
 
 
-def generate_tool_description(model: ConnectorModelProtocol) -> str:
+def generate_tool_description(
+    model: ConnectorModelProtocol,
+    *,
+    enable_hosted_mode_features: bool = True,
+) -> str:
     """Generate AI tool description from connector metadata.
 
     Produces a detailed description that includes:
@@ -393,6 +397,7 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
 
     Args:
         model: Object conforming to ConnectorModelProtocol (e.g., ConnectorModel)
+        enable_hosted_mode_features: When False, omit hosted-mode search guidance from the docstring.
 
     Returns:
         Formatted description string suitable for AI tool documentation
@@ -402,8 +407,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     # at the first empty line and only keeps the initial section.
 
     # Entity/action parameter details (including pagination params like limit, starting_after)
-    search_field_paths = _collect_search_field_paths(model)
-    lines.append("ENTITIES AND PARAMETERS:")
+    search_field_paths = _collect_search_field_paths(model) if enable_hosted_mode_features else {}
+    # Avoid a "PARAMETERS:" header because some docstring parsers treat it as a params section marker.
+    lines.append("ENTITIES (ACTIONS + PARAMS):")
     for entity in model.entities:
         lines.append(f"  {entity.name}:")
         actions = getattr(entity, "actions", []) or []
@@ -427,8 +433,9 @@ def generate_tool_description(model: ConnectorModelProtocol) -> str:
     lines.append("  To paginate: pass starting_after=<last_id> while has_more is true")
 
     lines.append("GUIDELINES:")
-    lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
-    lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
+    if enable_hosted_mode_features:
+        lines.append('  - Prefer cached search over direct API calls when using execute(): action="search" whenever possible.')
+        lines.append("  - Direct API actions (list/get/download) are slower and should be used only if search cannot answer the query.")
     lines.append("  - Keep results small: use params.fields, params.query.filter, small params.limit, and cursor pagination.")
     lines.append("  - If output is too large, refine the query with tighter filters/fields/limit.")
 

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/airbyte_agent_shopify/connector.py

@@ -908,6 +908,7 @@ class ShopifyConnector:
         func: _F | None = None,
         *,
         update_docstring: bool = True,
+        enable_hosted_mode_features: bool = True,
         max_output_chars: int | None = DEFAULT_MAX_OUTPUT_CHARS,
     ) -> _F | Callable[[_F], _F]:
         """
@@ -926,12 +927,16 @@ class ShopifyConnector:
 
         Args:
             update_docstring: When True, append connector capabilities to __doc__.
+            enable_hosted_mode_features: When False, omit hosted-mode search sections from docstrings.
             max_output_chars: Max serialized output size before raising. Use None to disable.
         """
 
         def decorate(inner: _F) -> _F:
             if update_docstring:
-                description = generate_tool_description(ShopifyConnectorModel)
+                description = generate_tool_description(
+                    ShopifyConnectorModel,
+                    enable_hosted_mode_features=enable_hosted_mode_features,
+                )
                 original_doc = inner.__doc__ or ""
                 if original_doc.strip():
                     full_doc = f"{original_doc.strip()}\n{description}"

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/pyproject.toml

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

{airbyte_agent_shopify-0.1.16 → airbyte_agent_shopify-0.1.18}/airbyte_agent_shopify/models.py

@@ -153,29 +153,6 @@ class LineItem(BaseModel):
     duties: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
     discount_allocations: Union[list[dict[str, Any]] | None, Any] = Field(default=None)
 
-class Fulfillment(BaseModel):
-    """A fulfillment"""
-    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)
-    status: Union[str | None, Any] = Field(default=None)
-    created_at: Union[str | None, Any] = Field(default=None)
-    service: Union[str | None, Any] = Field(default=None)
-    updated_at: Union[str | None, Any] = Field(default=None)
-    tracking_company: Union[str | None, Any] = Field(default=None)
-    shipment_status: Union[str | None, Any] = Field(default=None)
-    location_id: Union[int | None, Any] = Field(default=None)
-    origin_address: Union[dict[str, Any] | None, Any] = Field(default=None)
-    line_items: Union[list[LineItem] | None, Any] = Field(default=None)
-    tracking_number: Union[str | None, Any] = Field(default=None)
-    tracking_numbers: Union[list[str] | None, Any] = Field(default=None)
-    tracking_url: Union[str | None, Any] = Field(default=None)
-    tracking_urls: Union[list[str] | None, Any] = Field(default=None)
-    receipt: Union[dict[str, Any] | None, Any] = Field(default=None)
-    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)
@@ -225,6 +202,29 @@ class Refund(BaseModel):
     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 Fulfillment(BaseModel):
+    """A fulfillment"""
+    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)
+    status: Union[str | None, Any] = Field(default=None)
+    created_at: Union[str | None, Any] = Field(default=None)
+    service: Union[str | None, Any] = Field(default=None)
+    updated_at: Union[str | None, Any] = Field(default=None)
+    tracking_company: Union[str | None, Any] = Field(default=None)
+    shipment_status: Union[str | None, Any] = Field(default=None)
+    location_id: Union[int | None, Any] = Field(default=None)
+    origin_address: Union[dict[str, Any] | None, Any] = Field(default=None)
+    line_items: Union[list[LineItem] | None, Any] = Field(default=None)
+    tracking_number: Union[str | None, Any] = Field(default=None)
+    tracking_numbers: Union[list[str] | None, Any] = Field(default=None)
+    tracking_url: Union[str | None, Any] = Field(default=None)
+    tracking_urls: Union[list[str] | None, Any] = Field(default=None)
+    receipt: Union[dict[str, Any] | None, Any] = Field(default=None)
+    name: Union[str | None, Any] = Field(default=None)
+    admin_graphql_api_id: Union[str | None, Any] = Field(default=None)
+
 class Order(BaseModel):
     """A Shopify order"""
     model_config = ConfigDict(extra="allow", populate_by_name=True)