convexity-sdk 0.21.0.dev332__tar.gz → 0.21.0.dev336__tar.gz

{convexity_sdk-0.21.0.dev332 → convexity_sdk-0.21.0.dev336}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: convexity-sdk
-Version: 0.21.0.dev332
+Version: 0.21.0.dev336
 Summary: Convexity Python SDK - programmatic access to the Convexity platform
 Requires-Python: >=3.12
 Requires-Dist: convexity-api-client

{convexity_sdk-0.21.0.dev332 → convexity_sdk-0.21.0.dev336}/convexity_sdk/resources/crm.py

@@ -7,17 +7,26 @@ from typing import Any, TypeVar, cast
 from convexity_api_client import AuthenticatedClient, Client
 from convexity_api_client.api.v1 import crm_bulk_upsert_customers as _bulk_upsert_customers
 from convexity_api_client.api.v1 import crm_create_customer as _create_customer
+from convexity_api_client.api.v1 import crm_create_sales_rep as _create_sales_rep
 from convexity_api_client.api.v1 import crm_delete_customer as _delete_customer
+from convexity_api_client.api.v1 import crm_delete_sales_rep as _delete_sales_rep
 from convexity_api_client.api.v1 import crm_get_customer as _get_customer
+from convexity_api_client.api.v1 import crm_get_sales_rep as _get_sales_rep
 from convexity_api_client.api.v1 import crm_list_customers as _list_customers
+from convexity_api_client.api.v1 import crm_list_sales_reps as _list_sales_reps
 from convexity_api_client.api.v1 import crm_update_customer as _update_customer
+from convexity_api_client.api.v1 import crm_update_sales_rep as _update_sales_rep
 from convexity_api_client.models.bulk_upsert_customer_payload import BulkUpsertCustomerPayload
 from convexity_api_client.models.bulk_upsert_customers_request import BulkUpsertCustomersRequest
 from convexity_api_client.models.bulk_upsert_customers_response import BulkUpsertCustomersResponse
 from convexity_api_client.models.create_customer_request import CreateCustomerRequest
+from convexity_api_client.models.create_sales_rep_request import CreateSalesRepRequest
 from convexity_api_client.models.customer_response import CustomerResponse
 from convexity_api_client.models.list_customers_response import ListCustomersResponse
+from convexity_api_client.models.list_sales_reps_response import ListSalesRepsResponse
+from convexity_api_client.models.sales_rep_response import SalesRepResponse
 from convexity_api_client.models.update_customer_request import UpdateCustomerRequest
+from convexity_api_client.models.update_sales_rep_request import UpdateSalesRepRequest
 from convexity_api_client.types import UNSET, Unset
 
 ResponseT = TypeVar("ResponseT")
@@ -55,6 +64,7 @@ class CRM:
         default_shipping_address_entry_id: str | None = None,
         currency: str = "USD",
         payment_term_id: str | None = None,
+        sales_rep_id: str | None = None,
         credit_limit: float | None = None,
         ext_data: dict[str, Any] | None = None,
     ) -> CustomerResponse:
@@ -68,6 +78,7 @@ class CRM:
             default_shipping_address_entry_id=_optional(default_shipping_address_entry_id),
             currency=currency,
             payment_term_id=_optional(payment_term_id),
+            sales_rep_id=_optional(sales_rep_id),
             credit_limit=_optional(credit_limit),
             ext_data=cast(Any, _optional(ext_data)),
         )
@@ -126,6 +137,7 @@ class CRM:
         default_shipping_address_entry_id: str | None = None,
         currency: str | None = None,
         payment_term_id: str | None = None,
+        sales_rep_id: str | None | Unset = UNSET,
         credit_limit: float | None = None,
         is_active: bool | None = None,
         ext_data: dict[str, Any] | None = None,
@@ -139,6 +151,7 @@ class CRM:
             default_shipping_address_entry_id=_optional(default_shipping_address_entry_id),
             currency=_optional(currency),
             payment_term_id=_optional(payment_term_id),
+            sales_rep_id=sales_rep_id,
             credit_limit=_optional(credit_limit),
             is_active=_optional(is_active),
             ext_data=cast(Any, _optional(ext_data)),
@@ -150,3 +163,84 @@ class CRM:
         """Delete a CRM customer/account."""
         result = _delete_customer.sync(customer_id, client=self._client, project_id=project_id)
         return _expect_response(result, CustomerResponse, "deleting customer")
+
+    def create_sales_rep(
+        self,
+        *,
+        project_id: str,
+        code: str,
+        name: str | None = None,
+        email: str | None = None,
+        user_id: str | None = None,
+        default_commission_rate: float | str | None = None,
+        ext_data: dict[str, Any] | None = None,
+    ) -> SalesRepResponse:
+        """Create a sales rep, optionally linked to an organization member."""
+        body = CreateSalesRepRequest(
+            code=code,
+            name=_optional(name),
+            email=_optional(email),
+            user_id=_optional(user_id),
+            default_commission_rate=_optional(default_commission_rate),
+            ext_data=cast(Any, _optional(ext_data)),
+        )
+        result = _create_sales_rep.sync(client=self._client, body=body, project_id=project_id)
+        return _expect_response(result, SalesRepResponse, "creating sales rep")
+
+    def list_sales_reps(
+        self,
+        *,
+        project_id: str,
+        search: str | None = None,
+        is_active: bool | None = None,
+        limit: int = 50,
+        offset: int = 0,
+    ) -> ListSalesRepsResponse:
+        """List sales reps for a project."""
+        result = _list_sales_reps.sync(
+            client=self._client,
+            search=_optional(search),
+            is_active=_optional(is_active),
+            limit=limit,
+            offset=offset,
+            project_id=project_id,
+        )
+        if isinstance(result, ListSalesRepsResponse):
+            return result
+        return ListSalesRepsResponse(sales_reps=[], total=0)
+
+    def get_sales_rep(self, sales_rep_id: str, *, project_id: str) -> SalesRepResponse | None:
+        """Get a sales rep by ID."""
+        result = _get_sales_rep.sync(sales_rep_id, client=self._client, project_id=project_id)
+        return result if isinstance(result, SalesRepResponse) else None
+
+    def update_sales_rep(
+        self,
+        sales_rep_id: str,
+        *,
+        project_id: str,
+        code: str | None | Unset = UNSET,
+        name: str | None | Unset = UNSET,
+        email: str | None | Unset = UNSET,
+        user_id: str | None | Unset = UNSET,
+        default_commission_rate: float | str | None | Unset = UNSET,
+        is_active: bool | None | Unset = UNSET,
+        ext_data: dict[str, Any] | None | Unset = UNSET,
+    ) -> SalesRepResponse:
+        """Update a sales rep; pass ``None`` to clear nullable fields."""
+        body = UpdateSalesRepRequest(
+            code=code,
+            name=name,
+            email=email,
+            user_id=user_id,
+            default_commission_rate=default_commission_rate,
+            is_active=is_active,
+            ext_data=cast(Any, ext_data),
+        )
+        result = _update_sales_rep.sync(sales_rep_id, client=self._client, body=body, project_id=project_id)
+        return _expect_response(result, SalesRepResponse, "updating sales rep")
+
+    def delete_sales_rep(self, sales_rep_id: str, *, project_id: str) -> SalesRepResponse:
+        """Delete an unused sales rep, or deactivate one with customer/order history."""
+        result = _delete_sales_rep.sync(sales_rep_id, client=self._client, project_id=project_id)
+        return _expect_response(result, SalesRepResponse, "deleting sales rep")

{convexity_sdk-0.21.0.dev332 → convexity_sdk-0.21.0.dev336}/convexity_sdk/resources/sales.py

@@ -303,6 +303,8 @@ class Sales:
         so_number: str,
         lines: list[CreateSalesOrderLineRequest | dict[str, Any]] | None = None,
         customer_id: str | None = None,
+        sales_rep_id: str | None = None,
+        commission_rate_snapshot: float | str | None | Unset = UNSET,
         channel_id: str | None = None,
         external_id: str | None = None,
         requested_ship_date: datetime | None = None,
@@ -315,6 +317,8 @@ class Sales:
         body = CreateSalesOrderRequest(
             so_number=so_number,
             customer_id=_optional(customer_id),
+            sales_rep_id=_optional(sales_rep_id),
+            commission_rate_snapshot=commission_rate_snapshot,
             channel_id=_optional(channel_id),
             external_id=_optional(external_id),
             requested_ship_date=_optional(requested_ship_date),
@@ -344,6 +348,7 @@ class Sales:
         project_id: str,
         lifecycle_status: CanonicalStatus | str | None = None,
         customer_id: str | None = None,
+        sales_rep_id: str | None = None,
         channel_id: str | None = None,
         limit: int = 50,
         offset: int = 0,
@@ -353,6 +358,7 @@ class Sales:
             client=self._client,
             lifecycle_status=cast(Any, _optional(_order_status(lifecycle_status))),
             customer_id=_optional(customer_id),
+            sales_rep_id=_optional(sales_rep_id),
             channel_id=_optional(channel_id),
             limit=limit,
             offset=offset,

{convexity_sdk-0.21.0.dev332 → convexity_sdk-0.21.0.dev336}/convexity_sdk/resources/warehouses.py

@@ -9,17 +9,38 @@ from __future__ import annotations
 from typing import Any, TypeVar, cast
 
 from convexity_api_client import AuthenticatedClient, Client
+from convexity_api_client.api.v1 import (
+    inventory_assign_item_warehouse_location as _assign_item_warehouse_location,
+)
 from convexity_api_client.api.v1 import inventory_create_warehouse as _create_warehouse
 from convexity_api_client.api.v1 import (
     inventory_create_warehouse_location as _create_warehouse_location,
 )
 from convexity_api_client.api.v1 import inventory_get_warehouse as _get_warehouse
 from convexity_api_client.api.v1 import inventory_get_warehouse_location as _get_warehouse_location
+from convexity_api_client.api.v1 import (
+    inventory_list_item_warehouse_locations as _list_item_warehouse_locations,
+)
+from convexity_api_client.api.v1 import (
+    inventory_list_warehouse_location_items as _list_warehouse_location_items,
+)
 from convexity_api_client.api.v1 import inventory_list_warehouse_locations as _list_warehouse_locations
 from convexity_api_client.api.v1 import inventory_list_warehouses as _list_warehouses
 from convexity_api_client.api.v1 import inventory_update_warehouse as _update_warehouse
+from convexity_api_client.models.assign_inventory_item_location_request import (
+    AssignInventoryItemLocationRequest,
+)
 from convexity_api_client.models.create_warehouse_location_request import CreateWarehouseLocationRequest
 from convexity_api_client.models.create_warehouse_request import CreateWarehouseRequest
+from convexity_api_client.models.inventory_item_location_assignment_response import (
+    InventoryItemLocationAssignmentResponse,
+)
+from convexity_api_client.models.list_item_warehouse_locations_response import (
+    ListItemWarehouseLocationsResponse,
+)
+from convexity_api_client.models.list_warehouse_location_items_response import (
+    ListWarehouseLocationItemsResponse,
+)
 from convexity_api_client.models.list_warehouse_locations_response import ListWarehouseLocationsResponse
 from convexity_api_client.models.list_warehouses_response import ListWarehousesResponse
 from convexity_api_client.models.location_type import LocationType
@@ -121,6 +142,47 @@ class Warehouses:
         result = _update_warehouse.sync(warehouse_id, client=self._client, body=body, project_id=project_id)
         return _expect_response(result, WarehouseResponse, "updating warehouse")
 
+    def list_item_locations(
+        self,
+        item_id: str,
+        *,
+        project_id: str,
+        limit: int = 100,
+        offset: int = 0,
+    ) -> ListItemWarehouseLocationsResponse:
+        """List locations where an item is assigned or currently stocked."""
+        result = _list_item_warehouse_locations.sync(
+            item_id,
+            client=self._client,
+            project_id=project_id,
+            limit=limit,
+            offset=offset,
+        )
+        if isinstance(result, ListItemWarehouseLocationsResponse):
+            return result
+        return ListItemWarehouseLocationsResponse(items=[], total=0)
+
+    def assign_item_location(
+        self,
+        item_id: str,
+        warehouse_location_id: str,
+        *,
+        project_id: str,
+        ext_data: dict[str, Any] | None = None,
+    ) -> InventoryItemLocationAssignmentResponse:
+        """Assign an item to a location, reactivating an existing assignment."""
+        body = AssignInventoryItemLocationRequest(
+            warehouse_location_id=warehouse_location_id,
+            ext_data=cast(Any, _optional(ext_data)),
+        )
+        result = _assign_item_warehouse_location.sync(
+            item_id,
+            client=self._client,
+            body=body,
+            project_id=project_id,
+        )
+        return _expect_response(result, InventoryItemLocationAssignmentResponse, "assigning item to location")
+
     # -- WarehouseLocation ----------------------------------------------------
 
     def create_location(
@@ -197,3 +259,25 @@ class Warehouses:
         if isinstance(result, ListWarehouseLocationsResponse):
             return result
         return ListWarehouseLocationsResponse(items=[], total=0)
+
+    def list_location_items(
+        self,
+        warehouse_id: str,
+        location_id: str,
+        *,
+        project_id: str,
+        limit: int = 100,
+        offset: int = 0,
+    ) -> ListWarehouseLocationItemsResponse:
+        """List items assigned to or currently stocked at a location."""
+        result = _list_warehouse_location_items.sync(
+            warehouse_id,
+            location_id,
+            client=self._client,
+            project_id=project_id,
+            limit=limit,
+            offset=offset,
+        )
+        if isinstance(result, ListWarehouseLocationItemsResponse):
+            return result
+        return ListWarehouseLocationItemsResponse(items=[], total=0)

convexity_sdk-0.21.0.dev336/samples/crm/004_manage_sales_reps.py

@@ -0,0 +1,55 @@
+"""Create a sales rep, assign a customer, and snapshot commission on an order."""
+
+from __future__ import annotations
+
+import uuid
+
+from convexity_sdk import ConvexityClient
+
+ORG_SLUG = "convexity-sdk-samples"
+PROJECT_SLUG = "griffin-it"
+
+
+def find_project_id(client: ConvexityClient) -> str:
+    organization = client.organizations.get_by_slug(ORG_SLUG)
+    if organization is None:
+        raise RuntimeError(f"Organization '{ORG_SLUG}' not found. Run ../create_org_and_project.py first.")
+    project = client.projects.get_by_slug(organization.id, PROJECT_SLUG)
+    if project is None:
+        raise RuntimeError(f"Project '{PROJECT_SLUG}' not found. Run ../create_org_and_project.py first.")
+    return project.id
+
+
+def main() -> None:
+    client = ConvexityClient()
+    project_id = find_project_id(client)
+    suffix = uuid.uuid4().hex[:8].upper()
+
+    sales_rep = client.crm.create_sales_rep(
+        project_id=project_id,
+        code=f"SDK-REP-{suffix}",
+        name="SDK Sample Rep",
+        email=f"rep-{suffix.lower()}@example.com",
+        default_commission_rate="0.075",
+    )
+    customer = client.crm.create_customer(
+        project_id=project_id,
+        code=f"SDK-CUST-{suffix}",
+        name="SDK Sales Rep Customer",
+        sales_rep_id=sales_rep.id,
+    )
+    order = client.sales.create_order(
+        project_id=project_id,
+        so_number=f"SDK-SO-{suffix}",
+        customer_id=customer.id,
+        lines=[],
+    )
+
+    print(f"Sales rep: {sales_rep.code} ({sales_rep.id})")
+    print(f"Customer default rep: {customer.sales_rep_id}")
+    print(f"Order rep: {order.sales_rep_id}")
+    print(f"Commission snapshot: {order.commission_rate_snapshot}")
+
+
+if __name__ == "__main__":
+    main()

convexity_sdk-0.21.0.dev336/samples/inventory/009_list_location_items.py

@@ -0,0 +1,38 @@
+"""List the assigned and stocked items visible in a warehouse location.
+
+Set ``CONVEXITY_PROJECT_ID``, ``CONVEXITY_WAREHOUSE_ID``, and
+``CONVEXITY_LOCATION_ID`` before running this sample.
+"""
+
+from __future__ import annotations
+
+import os
+
+from convexity_sdk import ConvexityClient
+
+
+def require_env(name: str) -> str:
+    value = os.getenv(name)
+    if value:
+        return value
+    raise RuntimeError(f"Set {name} before running this sample")
+
+
+def main() -> None:
+    client = ConvexityClient()
+    contents = client.warehouses.list_location_items(
+        require_env("CONVEXITY_WAREHOUSE_ID"),
+        require_env("CONVEXITY_LOCATION_ID"),
+        project_id=require_env("CONVEXITY_PROJECT_ID"),
+    )
+    print(f"{contents.total} item(s) assigned to or stocked at this location")
+    for item in contents.items:
+        assignment_state = "assigned" if item.is_assigned else "stocked"
+        print(
+            f"{item.sku}: {item.name} — {assignment_state}, "
+            f"on hand {item.on_hand_qty}, available {item.available_qty}"
+        )
+
+
+if __name__ == "__main__":
+    main()

convexity_sdk-0.21.0.dev336/samples/inventory/010_list_item_warehouse_locations.py

@@ -0,0 +1,38 @@
+"""List warehouses and locations where an item is assigned or stocked.
+
+Set ``CONVEXITY_PROJECT_ID`` and ``CONVEXITY_INVENTORY_ITEM_ID`` before
+running this sample.
+"""
+
+from __future__ import annotations
+
+import os
+
+from convexity_sdk import ConvexityClient
+
+
+def require_env(name: str) -> str:
+    value = os.getenv(name)
+    if value:
+        return value
+    raise RuntimeError(f"Set {name} before running this sample")
+
+
+def main() -> None:
+    client = ConvexityClient()
+    locations = client.warehouses.list_item_locations(
+        require_env("CONVEXITY_INVENTORY_ITEM_ID"),
+        project_id=require_env("CONVEXITY_PROJECT_ID"),
+    )
+    print(f"{locations.total} warehouse location(s)")
+    for location in locations.items:
+        state = "assigned" if location.is_assigned else "stocked"
+        print(
+            f"{location.warehouse_code} / {location.location_name}: "
+            f"{state}, on hand {location.on_hand_qty}, "
+            f"available {location.available_qty}"
+        )
+
+
+if __name__ == "__main__":
+    main()

convexity_sdk-0.21.0.dev336/samples/inventory/011_assign_item_location.py

@@ -0,0 +1,20 @@
+"""Assign an inventory item to a warehouse location.
+
+Set CONVEXITY_PROJECT_ID, CONVEXITY_ITEM_ID, and
+CONVEXITY_WAREHOUSE_LOCATION_ID before running this sample.
+"""
+
+from __future__ import annotations
+
+import os
+
+from convexity_sdk import ConvexityClient
+
+client = ConvexityClient()
+assignment = client.warehouses.assign_item_location(
+    os.environ["CONVEXITY_ITEM_ID"],
+    os.environ["CONVEXITY_WAREHOUSE_LOCATION_ID"],
+    project_id=os.environ["CONVEXITY_PROJECT_ID"],
+)
+
+print(f"Assigned {assignment.inventory_item_id} to {assignment.warehouse_location_id}")