airbyte-agent-shopify 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

airbyte_agent_shopify/__init__.py

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

airbyte_agent_shopify/models.py

@@ -119,55 +119,6 @@ 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)
@@ -225,6 +176,55 @@ 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,22 +329,6 @@ 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)
@@ -376,6 +360,22 @@ 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)

{airbyte_agent_shopify-0.1.3.dist-info → airbyte_agent_shopify-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: airbyte-agent-shopify
-Version: 0.1.3
+Version: 0.1.4
 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,18 +75,49 @@ 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.describe
+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/hosted-execution).
+
+```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 {})
+```
 
 ## Full documentation
 
@@ -128,12 +159,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
+- **Package version:** 0.1.4
 - **Connector version:** 0.1.1
-- **Generated with Connector SDK commit SHA:** c713ec4833c2b52dc89926ec68caa343423884cd
+- **Generated with Connector SDK commit SHA:** 1da193dd2b3d4b2e2147ba74bd9a4062a62c4186

{airbyte_agent_shopify-0.1.3.dist-info → airbyte_agent_shopify-0.1.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
-airbyte_agent_shopify/__init__.py,sha256=pTsmlkXDY1gSoK-1vljXuQrbOa4ABrxUth6aau_HAoY,9661
+airbyte_agent_shopify/__init__.py,sha256=uFn4x1bUldfWTPBITTIGYrjD5bRufgEVvKVviDOUd_0,9661
 airbyte_agent_shopify/connector.py,sha256=Cax_d6uRrhn8h6H6uyPSe2crZCGDv-9UzNRF3vwbxgI,91544
 airbyte_agent_shopify/connector_model.py,sha256=xZDsz1CqmSkPTrlvK7hheWLs2RCDsIFD4JiZTu5ll-s,691051
-airbyte_agent_shopify/models.py,sha256=tJdBFrs6UpuDaecihwOmhhNUhtw0VaqWh3m-HKvf6X0,60917
+airbyte_agent_shopify/models.py,sha256=hBMmLBLBlmqU8TdcJGpm3fQyyDVP3BEpDJ5C2cInBso,60917
 airbyte_agent_shopify/types.py,sha256=AwQ4PR2wZmHNuryriCFdRxf9q48J1mnPwspUB1b-L_o,10221
 airbyte_agent_shopify/_vendored/__init__.py,sha256=ILl7AHXMui__swyrjxrh9yRa4dLiwBvV6axPWFWty80,38
 airbyte_agent_shopify/_vendored/connector_sdk/__init__.py,sha256=T5o7roU6NSpH-lCAGZ338sE5dlh4ZU6i6IkeG1zpems,1949
@@ -52,6 +52,6 @@ airbyte_agent_shopify/_vendored/connector_sdk/telemetry/__init__.py,sha256=RaLgk
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/config.py,sha256=tLmQwAFD0kP1WyBGWBS3ysaudN9H3e-3EopKZi6cGKg,885
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/events.py,sha256=8Y1NbXiwISX-V_wRofY7PqcwEXD0dLMnntKkY6XFU2s,1328
 airbyte_agent_shopify/_vendored/connector_sdk/telemetry/tracker.py,sha256=Ftrk0_ddfM7dZG8hF9xBuPwhbc9D6JZ7Q9qs5o3LEyA,5579
-airbyte_agent_shopify-0.1.3.dist-info/METADATA,sha256=JdjLExh9Wsjl2GyPKwiuWGdKcMDIzcppegsXekR98_8,6381
-airbyte_agent_shopify-0.1.3.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-airbyte_agent_shopify-0.1.3.dist-info/RECORD,,
+airbyte_agent_shopify-0.1.4.dist-info/METADATA,sha256=IzYycCz2Bhrto-iqyGAN3INajX_PjZVY8KHS7VEPTJw,7820
+airbyte_agent_shopify-0.1.4.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+airbyte_agent_shopify-0.1.4.dist-info/RECORD,,