amigo_sdk 0.7.0__tar.gz → 0.9.0__tar.gz

amigo_sdk-0.9.0/.github/workflows/auto-release.yml

@@ -0,0 +1,181 @@
+name: Auto Release (Backend API changes)
+
+on:
+  repository_dispatch:
+    types: [openapi-updated]
+
+permissions:
+  contents: write
+
+jobs:
+  detect:
+    name: Detect OpenAPI change
+    runs-on: ubuntu-latest
+    outputs:
+      changed: ${{ steps.diff.outputs.changed }}
+      spec_url: ${{ steps.spec.outputs.spec_url }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Ensure jq
+        run: sudo apt-get update && sudo apt-get install -y jq
+
+      - name: Resolve spec URL
+        id: spec
+        run: |
+          SPEC_URL="${{ github.event.client_payload.spec_url }}"
+          if [ -z "$SPEC_URL" ]; then
+            SPEC_URL="https://api.amigo.ai/v1/openapi.json"
+          fi
+          echo "spec_url=$SPEC_URL" >> $GITHUB_OUTPUT
+
+      - name: Fetch current production spec
+        run: curl -fSL -o openapi-new.json "${{ steps.spec.outputs.spec_url }}"
+
+      - name: Check baseline presence
+        id: baseline
+        run: |
+          mkdir -p specs
+          if [ ! -f specs/openapi-baseline.json ]; then
+            echo "missing=true" >> $GITHUB_OUTPUT
+          else
+            echo "missing=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Prepare baseline
+        run: |
+          mkdir -p specs
+          if [ ! -f specs/openapi-baseline.json ]; then
+            cp openapi-new.json specs/openapi-baseline.json
+          fi
+
+      - name: Diagnostics (spec and baseline)
+        run: |
+          echo "Resolved spec_url: ${{ steps.spec.outputs.spec_url }}"
+          echo "Baseline missing: ${{ steps.baseline.outputs.missing }}"
+          echo "jq version: $(jq --version)"
+          jq -S '
+            def sort_deep:
+              if type == "array" then
+                map(sort_deep) | sort_by(tostring)
+              elif type == "object" then
+                with_entries(.value |= sort_deep)
+              else . end;
+            (del(.info) | del(.servers)) | sort_deep
+          ' specs/openapi-baseline.json > baseline.norm.json || true
+          jq -S '
+            def sort_deep:
+              if type == "array" then
+                map(sort_deep) | sort_by(tostring)
+              elif type == "object" then
+                with_entries(.value |= sort_deep)
+              else . end;
+            (del(.info) | del(.servers)) | sort_deep
+          ' openapi-new.json > new.norm.json
+          if [ -f baseline.norm.json ]; then
+            echo "BASELINE_NORM_SHA=$(sha256sum baseline.norm.json | awk '{print $1}')"
+          else
+            echo "BASELINE_NORM_SHA=(none)"
+          fi
+          echo "NEW_NORM_SHA=$(sha256sum new.norm.json | awk '{print $1}')"
+          if [ -f baseline.norm.json ]; then
+            if diff -q baseline.norm.json new.norm.json >/dev/null 2>&1; then
+              echo "Quick diff: identical"
+            else
+              echo "Quick diff: differs"
+            fi
+          fi
+
+          # Section-level hashes and key diffs
+          echo "\n== Section-level hashes =="
+          if [ -f specs/openapi-baseline.json ]; then
+            BASELINE_PATHS_SHA=$(jq -cS '(.paths // {})' specs/openapi-baseline.json | sha256sum | awk '{print $1}')
+            BASELINE_SCHEMAS_SHA=$(jq -cS '(.components.schemas // {})' specs/openapi-baseline.json | sha256sum | awk '{print $1}')
+            BASELINE_PATHS_COUNT=$(jq -r '(.paths // {}) | keys | length' specs/openapi-baseline.json)
+            BASELINE_SCHEMAS_COUNT=$(jq -r '(.components.schemas // {}) | keys | length' specs/openapi-baseline.json)
+          else
+            BASELINE_PATHS_SHA=(none)
+            BASELINE_SCHEMAS_SHA=(none)
+            BASELINE_PATHS_COUNT=0
+            BASELINE_SCHEMAS_COUNT=0
+          fi
+          NEW_PATHS_SHA=$(jq -cS '(.paths // {})' openapi-new.json | sha256sum | awk '{print $1}')
+          NEW_SCHEMAS_SHA=$(jq -cS '(.components.schemas // {})' openapi-new.json | sha256sum | awk '{print $1}')
+          NEW_PATHS_COUNT=$(jq -r '(.paths // {}) | keys | length' openapi-new.json)
+          NEW_SCHEMAS_COUNT=$(jq -r '(.components.schemas // {}) | keys | length' openapi-new.json)
+          echo "BASELINE paths: count=$BASELINE_PATHS_COUNT sha=$BASELINE_PATHS_SHA"
+          echo "NEW      paths: count=$NEW_PATHS_COUNT sha=$NEW_PATHS_SHA"
+          echo "BASELINE schemas: count=$BASELINE_SCHEMAS_COUNT sha=$BASELINE_SCHEMAS_SHA"
+          echo "NEW      schemas: count=$NEW_SCHEMAS_COUNT sha=$NEW_SCHEMAS_SHA"
+
+          echo "\n== Key diffs (paths) =="
+          if [ -f specs/openapi-baseline.json ]; then
+            jq -r '(.paths // {}) | keys | sort[]' specs/openapi-baseline.json > baseline.paths.txt || true
+          else
+            : > baseline.paths.txt
+          fi
+          jq -r '(.paths // {}) | keys | sort[]' openapi-new.json > new.paths.txt
+          echo "Removed paths (in baseline, not in new):"; comm -23 baseline.paths.txt new.paths.txt || true
+          echo "Added paths (in new, not in baseline):"; comm -13 baseline.paths.txt new.paths.txt || true
+
+          echo "\n== Key diffs (components.schemas) =="
+          if [ -f specs/openapi-baseline.json ]; then
+            jq -r '(.components.schemas // {}) | keys | sort[]' specs/openapi-baseline.json > baseline.schemas.txt || true
+          else
+            : > baseline.schemas.txt
+          fi
+          jq -r '(.components.schemas // {}) | keys | sort[]' openapi-new.json > new.schemas.txt
+          echo "Removed schemas (in baseline, not in new):"; comm -23 baseline.schemas.txt new.schemas.txt || true
+          echo "Added schemas (in new, not in baseline):"; comm -13 baseline.schemas.txt new.schemas.txt || true
+
+      - name: Compare normalized specs
+        id: diff
+        run: |
+          if [ "${{ steps.baseline.outputs.missing }}" = "true" ]; then
+            echo "changed=true" >> $GITHUB_OUTPUT
+            exit 0
+          fi
+          jq -S '
+            def sort_deep:
+              if type == "array" then
+                map(sort_deep) | sort_by(tostring)
+              elif type == "object" then
+                with_entries(.value |= sort_deep)
+              else . end;
+            (del(.info) | del(.servers)) | sort_deep
+          ' specs/openapi-baseline.json > baseline.norm.json
+          jq -S '
+            def sort_deep:
+              if type == "array" then
+                map(sort_deep) | sort_by(tostring)
+              elif type == "object" then
+                with_entries(.value |= sort_deep)
+              else . end;
+            (del(.info) | del(.servers)) | sort_deep
+          ' openapi-new.json > new.norm.json
+          if diff -q baseline.norm.json new.norm.json >/dev/null 2>&1; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Upload normalized specs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: normalized-specs
+          path: |
+            baseline.norm.json
+            new.norm.json
+          retention-days: 7
+
+  release-on-dispatch:
+    name: Trigger SDK release (minor)
+    needs: detect
+    if: needs.detect.outputs.changed == 'true'
+    uses: ./.github/workflows/release.yml
+    with:
+      version_type: minor
+      dry_run: ${{ github.event.client_payload.dry_run == true }}
+      spec_url: ${{ needs.detect.outputs.spec_url }}
+    secrets: inherit

{amigo_sdk-0.7.0 → amigo_sdk-0.9.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amigo_sdk
-Version: 0.7.0
+Version: 0.9.0
 Summary: Amigo AI Python SDK
 Author: Amigo AI
 License-File: LICENSE
@@ -46,34 +46,23 @@ amigo_sdk
 
 This SDK auto-generates its types from the latest [Amigo OpenAPI schema](https://api.amigo.ai/v1/openapi.json). As a result, only the latest published SDK version is guaranteed to match the current API. If you pin to an older version, it may not include the newest endpoints or fields.
 
-## Quick Start
+## Quick Start (sync)
 
 ```python
-import asyncio
 from amigo_sdk import AmigoClient
 from amigo_sdk.generated.model import GetConversationsParametersQuery
 
-# Initialize the client
-client = AmigoClient(
+# Initialize and use the client synchronously
+with AmigoClient(
     api_key="your-api-key",
     api_key_id="your-api-key-id",
     user_id="user-id",
-    org_id="your-organization-id",
-)
-
-# List recent conversations
-async def example():
-    try:
-        async with client:
-            conversations = await client.conversation.get_conversations(
-                GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
-            )
-            print("Conversations:", conversations)
-    except Exception as error:
-        print(error)
-
-# Run the example
-asyncio.run(example())
+    organization_id="your-organization-id",
+) as client:
+    conversations = client.conversation.get_conversations(
+        GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
+    )
+    print("Conversations:", conversations)
 ```
 
 ## Examples
@@ -84,13 +73,13 @@ For more SDK usage examples see checkout the [examples/](examples/README.md) fol
 
 The SDK requires the following configuration parameters:
 
-| Parameter    | Type | Required | Description                                                    |
-| ------------ | ---- | -------- | -------------------------------------------------------------- |
-| `api_key`    | str  | ✅       | API key from Amigo dashboard                                   |
-| `api_key_id` | str  | ✅       | API key ID from Amigo dashboard                                |
-| `user_id`    | str  | ✅       | User ID on whose behalf the request is made                    |
-| `org_id`     | str  | ✅       | Your organization ID                                           |
-| `base_url`   | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
+| Parameter         | Type | Required | Description                                                    |
+| ----------------- | ---- | -------- | -------------------------------------------------------------- |
+| `api_key`         | str  | ✅       | API key from Amigo dashboard                                   |
+| `api_key_id`      | str  | ✅       | API key ID from Amigo dashboard                                |
+| `user_id`         | str  | ✅       | User ID on whose behalf the request is made                    |
+| `organization_id` | str  | ✅       | Your organization ID                                           |
+| `base_url`        | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
 
 ### Environment Variables
 
@@ -100,7 +89,7 @@ You can also configure the SDK using environment variables:
 export AMIGO_API_KEY="your-api-key"
 export AMIGO_API_KEY_ID="your-api-key-id"
 export AMIGO_USER_ID="user-id"
-export AMIGO_ORG_ID="your-organization-id"
+export AMIGO_ORGANIZATION_ID="your-organization-id"
 export AMIGO_BASE_URL="https://api.amigo.ai"  # optional
 ```
 
@@ -110,7 +99,8 @@ Then initialize the client without parameters:
 from amigo_sdk import AmigoClient
 
 # Automatically loads from environment variables
-client = AmigoClient()
+with AmigoClient() as client:
+    ...
 ```
 
 ### Using .env Files
@@ -153,25 +143,23 @@ from amigo_sdk.errors import (
     AuthenticationError,
     NotFoundError,
     BadRequestError,
-    ValidationError
+    ValidationError,
 )
 
-async def example_with_error_handling():
-    client = AmigoClient()
-
-    try:
-        async with client:
-            result = await client.organizations.get_organization("org-id")
-    except AuthenticationError as error:
-        print("Authentication failed:", error)
-    except NotFoundError as error:
-        print("Resource not found:", error)
-    except BadRequestError as error:
-        print("Bad request:", error)
-    except ValidationError as error:
-        print("Validation error:", error)
-    except Exception as error:
-        print("Unexpected error:", error)
+try:
+    with AmigoClient() as client:
+        org = client.organization.get()
+        print("Organization:", org)
+except AuthenticationError as error:
+    print("Authentication failed:", error)
+except NotFoundError as error:
+    print("Resource not found:", error)
+except BadRequestError as error:
+    print("Bad request:", error)
+except ValidationError as error:
+    print("Validation error:", error)
+except Exception as error:
+    print("Unexpected error:", error)
 ```
 
 ## Development

{amigo_sdk-0.7.0 → amigo_sdk-0.9.0}/README.md

@@ -24,34 +24,23 @@ amigo_sdk
 
 This SDK auto-generates its types from the latest [Amigo OpenAPI schema](https://api.amigo.ai/v1/openapi.json). As a result, only the latest published SDK version is guaranteed to match the current API. If you pin to an older version, it may not include the newest endpoints or fields.
 
-## Quick Start
+## Quick Start (sync)
 
 ```python
-import asyncio
 from amigo_sdk import AmigoClient
 from amigo_sdk.generated.model import GetConversationsParametersQuery
 
-# Initialize the client
-client = AmigoClient(
+# Initialize and use the client synchronously
+with AmigoClient(
     api_key="your-api-key",
     api_key_id="your-api-key-id",
     user_id="user-id",
-    org_id="your-organization-id",
-)
-
-# List recent conversations
-async def example():
-    try:
-        async with client:
-            conversations = await client.conversation.get_conversations(
-                GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
-            )
-            print("Conversations:", conversations)
-    except Exception as error:
-        print(error)
-
-# Run the example
-asyncio.run(example())
+    organization_id="your-organization-id",
+) as client:
+    conversations = client.conversation.get_conversations(
+        GetConversationsParametersQuery(limit=10, sort_by=["-created_at"])
+    )
+    print("Conversations:", conversations)
 ```
 
 ## Examples
@@ -62,13 +51,13 @@ For more SDK usage examples see checkout the [examples/](examples/README.md) fol
 
 The SDK requires the following configuration parameters:
 
-| Parameter    | Type | Required | Description                                                    |
-| ------------ | ---- | -------- | -------------------------------------------------------------- |
-| `api_key`    | str  | ✅       | API key from Amigo dashboard                                   |
-| `api_key_id` | str  | ✅       | API key ID from Amigo dashboard                                |
-| `user_id`    | str  | ✅       | User ID on whose behalf the request is made                    |
-| `org_id`     | str  | ✅       | Your organization ID                                           |
-| `base_url`   | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
+| Parameter         | Type | Required | Description                                                    |
+| ----------------- | ---- | -------- | -------------------------------------------------------------- |
+| `api_key`         | str  | ✅       | API key from Amigo dashboard                                   |
+| `api_key_id`      | str  | ✅       | API key ID from Amigo dashboard                                |
+| `user_id`         | str  | ✅       | User ID on whose behalf the request is made                    |
+| `organization_id` | str  | ✅       | Your organization ID                                           |
+| `base_url`        | str  | ❌       | Base URL of the Amigo API (defaults to `https://api.amigo.ai`) |
 
 ### Environment Variables
 
@@ -78,7 +67,7 @@ You can also configure the SDK using environment variables:
 export AMIGO_API_KEY="your-api-key"
 export AMIGO_API_KEY_ID="your-api-key-id"
 export AMIGO_USER_ID="user-id"
-export AMIGO_ORG_ID="your-organization-id"
+export AMIGO_ORGANIZATION_ID="your-organization-id"
 export AMIGO_BASE_URL="https://api.amigo.ai"  # optional
 ```
 
@@ -88,7 +77,8 @@ Then initialize the client without parameters:
 from amigo_sdk import AmigoClient
 
 # Automatically loads from environment variables
-client = AmigoClient()
+with AmigoClient() as client:
+    ...
 ```
 
 ### Using .env Files
@@ -131,25 +121,23 @@ from amigo_sdk.errors import (
     AuthenticationError,
     NotFoundError,
     BadRequestError,
-    ValidationError
+    ValidationError,
 )
 
-async def example_with_error_handling():
-    client = AmigoClient()
-
-    try:
-        async with client:
-            result = await client.organizations.get_organization("org-id")
-    except AuthenticationError as error:
-        print("Authentication failed:", error)
-    except NotFoundError as error:
-        print("Resource not found:", error)
-    except BadRequestError as error:
-        print("Bad request:", error)
-    except ValidationError as error:
-        print("Validation error:", error)
-    except Exception as error:
-        print("Unexpected error:", error)
+try:
+    with AmigoClient() as client:
+        org = client.organization.get()
+        print("Organization:", org)
+except AuthenticationError as error:
+    print("Authentication failed:", error)
+except NotFoundError as error:
+    print("Resource not found:", error)
+except BadRequestError as error:
+    print("Bad request:", error)
+except ValidationError as error:
+    print("Validation error:", error)
+except Exception as error:
+    print("Unexpected error:", error)
 ```
 
 ## Development