fix(client): align P3 OpenAPI schemas with Katana official API (#267)

Align priority 3 resource schemas with Katana's official API spec:

Materials:
- Add custom_field_collection_id to CreateMaterialRequest

Sales Order Shipping Fee:
- Add tax_rate_id to updateSalesOrderShippingFee PATCH endpoint

Webhook Logs Export:
- Replace start_date/end_date with created_at_min/created_at_max
- Replace status_filter array with status_code integer
- Add event enum filter with all supported webhook event types
- Add delivered boolean filter
- Remove format field (no longer supported)

Closes #261, #262, #263

Co-authored-by: Doug Borg <dougborg@apple.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>

Author: 3 people

docs/katana-openapi.yaml

@@ -3532,6 +3532,12 @@ components:
           description: Material configuration options for creating variants
           items:
             $ref: "#/components/schemas/MaterialConfig"
+        custom_field_collection_id:
+          type:
+            - integer
+            - "null"
+          maximum: 2147483647
+          description: ID of the custom field collection to associate with this material
         variants:
           type: array
           minItems: 1
@@ -6539,40 +6545,89 @@ components:
       properties:
         webhook_id:
           type: integer
-          description: |-
-            Filter logs to specific webhook subscription (optional - if not provided, exports all webhook logs)
-        start_date:
+          description: Filter logs to specific webhook subscription (optional - if not provided, exports all webhook logs)
+        event:
           type: string
-          format: date-time
-          description: Start date for log export range (ISO 8601 format)
-        end_date:
+          description: Filter logs by event type
+          enum:
+            - sales_order.created
+            - sales_order.packed
+            - sales_order.delivered
+            - sales_order.updated
+            - sales_order.deleted
+            - sales_order.availability_updated
+            - purchase_order.created
+            - purchase_order.updated
+            - purchase_order.deleted
+            - purchase_order.partially_received
+            - purchase_order.received
+            - purchase_order_row.created
+            - purchase_order_row.received
+            - purchase_order_row.updated
+            - purchase_order_row.deleted
+            - outsourced_purchase_order.created
+            - outsourced_purchase_order.updated
+            - outsourced_purchase_order.deleted
+            - outsourced_purchase_order.received
+            - outsourced_purchase_order_row.created
+            - outsourced_purchase_order_row.updated
+            - outsourced_purchase_order_row.deleted
+            - outsourced_purchase_order_row.received
+            - outsourced_purchase_order_recipe_row.created
+            - outsourced_purchase_order_recipe_row.updated
+            - outsourced_purchase_order_recipe_row.deleted
+            - manufacturing_order.created
+            - manufacturing_order.updated
+            - manufacturing_order.deleted
+            - manufacturing_order.in_progress
+            - manufacturing_order.blocked
+            - manufacturing_order.done
+            - manufacturing_order_recipe_row.created
+            - manufacturing_order_recipe_row.updated
+            - manufacturing_order_recipe_row.deleted
+            - manufacturing_order_recipe_row.ingredients_in_stock
+            - manufacturing_order_operation_row.created
+            - manufacturing_order_operation_row.updated
+            - manufacturing_order_operation_row.deleted
+            - manufacturing_order_operation_row.in_progress
+            - manufacturing_order_operation_row.paused
+            - manufacturing_order_operation_row.blocked
+            - manufacturing_order_operation_row.completed
+            - current_inventory.product_updated
+            - current_inventory.material_updated
+            - current_inventory.product_out_of_stock
+            - current_inventory.material_out_of_stock
+            - product.created
+            - product.updated
+            - product.deleted
+            - material.created
+            - material.updated
+            - material.deleted
+            - variant.created
+            - variant.updated
+            - variant.deleted
+            - product_recipe_row.created
+            - product_recipe_row.deleted
+            - product_recipe_row.updated
+        status_code:
+          type: integer
+          description: Filter logs by HTTP status code
+        delivered:
+          type: boolean
+          description: Filter logs by delivery status (true for successful deliveries)
+        created_at_min:
           type: string
-          format: date-time
-          description: End date for log export range (ISO 8601 format)
-        status_filter:
-          type: array
-          description: Filter logs by delivery status (success, failure, retry)
-          items:
-            type: string
-            enum:
-              - success
-              - failure
-              - retry
-        format:
+          description: Minimum creation date for log export range (ISO 8601 format)
+        created_at_max:
           type: string
-          enum:
-            - csv
-            - json
-          default: csv
-          description: Export file format preference
+          description: Maximum creation date for log export range (ISO 8601 format)
       example:
         webhook_id: 1
-        start_date: "2024-01-10T00:00:00Z"
-        end_date: "2024-01-15T23:59:59Z"
-        status_filter:
-          - failure
-          - retry
-        format: csv
+        event: sales_order.created
+        status_code: 200
+        delivered: true
+        created_at_min: "2024-01-10T00:00:00Z"
+        created_at_max: "2024-01-15T23:59:59Z"
     WebhookLogsExport:
       type: object
       description: Webhook log export result containing downloadable data for debugging and monitoring webhook delivery
@@ -20043,14 +20098,15 @@ paths:
               type: object
               additionalProperties: false
               properties:
-                amount:
-                  type: number
-                  format: float
-                  description: Shipping fee amount
-                  minimum: 0
                 description:
                   type: string
                   description: Shipping fee description
+                amount:
+                  type: integer
+                  description: Shipping fee amount
+                tax_rate_id:
+                  type: integer
+                  description: ID of the tax rate to apply to the shipping fee
       responses:
         "200":
           description: Sales order shipping fee updated successfully

katana_public_api_client/api/webhook_logs/export_webhook_logs.py

@@ -89,9 +89,9 @@ def sync_detailed(
 
     Args:
         body (WebhookLogsExportRequest): Request parameters for exporting webhook delivery logs
-            for analysis and debugging Example: {'webhook_id': 1, 'start_date':
-            '2024-01-10T00:00:00Z', 'end_date': '2024-01-15T23:59:59Z', 'status_filter': ['failure',
-            'retry'], 'format': 'csv'}.
+            for analysis and debugging Example: {'webhook_id': 1, 'event': 'sales_order.created',
+            'status_code': 200, 'delivered': True, 'created_at_min': '2024-01-10T00:00:00Z',
+            'created_at_max': '2024-01-15T23:59:59Z'}.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -126,9 +126,9 @@ def sync(
 
     Args:
         body (WebhookLogsExportRequest): Request parameters for exporting webhook delivery logs
-            for analysis and debugging Example: {'webhook_id': 1, 'start_date':
-            '2024-01-10T00:00:00Z', 'end_date': '2024-01-15T23:59:59Z', 'status_filter': ['failure',
-            'retry'], 'format': 'csv'}.
+            for analysis and debugging Example: {'webhook_id': 1, 'event': 'sales_order.created',
+            'status_code': 200, 'delivered': True, 'created_at_min': '2024-01-10T00:00:00Z',
+            'created_at_max': '2024-01-15T23:59:59Z'}.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -158,9 +158,9 @@ async def asyncio_detailed(
 
     Args:
         body (WebhookLogsExportRequest): Request parameters for exporting webhook delivery logs
-            for analysis and debugging Example: {'webhook_id': 1, 'start_date':
-            '2024-01-10T00:00:00Z', 'end_date': '2024-01-15T23:59:59Z', 'status_filter': ['failure',
-            'retry'], 'format': 'csv'}.
+            for analysis and debugging Example: {'webhook_id': 1, 'event': 'sales_order.created',
+            'status_code': 200, 'delivered': True, 'created_at_min': '2024-01-10T00:00:00Z',
+            'created_at_max': '2024-01-15T23:59:59Z'}.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
@@ -193,9 +193,9 @@ async def asyncio(
 
     Args:
         body (WebhookLogsExportRequest): Request parameters for exporting webhook delivery logs
-            for analysis and debugging Example: {'webhook_id': 1, 'start_date':
-            '2024-01-10T00:00:00Z', 'end_date': '2024-01-15T23:59:59Z', 'status_filter': ['failure',
-            'retry'], 'format': 'csv'}.
+            for analysis and debugging Example: {'webhook_id': 1, 'event': 'sales_order.created',
+            'status_code': 200, 'delivered': True, 'created_at_min': '2024-01-10T00:00:00Z',
+            'created_at_max': '2024-01-15T23:59:59Z'}.
 
     Raises:
         errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

katana_public_api_client/models/__init__.py

@@ -535,10 +535,7 @@
 from .webhook_list_response import WebhookListResponse
 from .webhook_logs_export import WebhookLogsExport
 from .webhook_logs_export_request import WebhookLogsExportRequest
-from .webhook_logs_export_request_format import WebhookLogsExportRequestFormat
-from .webhook_logs_export_request_status_filter_item import (
-    WebhookLogsExportRequestStatusFilterItem,
-)
+from .webhook_logs_export_request_event import WebhookLogsExportRequestEvent
 
 __all__ = (
     "AdditionalCost",
@@ -906,6 +903,5 @@
     "WebhookListResponse",
     "WebhookLogsExport",
     "WebhookLogsExportRequest",
-    "WebhookLogsExportRequestFormat",
-    "WebhookLogsExportRequestStatusFilterItem",
+    "WebhookLogsExportRequestEvent",
 )

katana_public_api_client/models/create_material_request.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from collections.abc import Mapping
-from typing import TYPE_CHECKING, Any, TypeVar
+from typing import TYPE_CHECKING, Any, TypeVar, cast
 
 from attrs import define as _attrs_define
 
@@ -40,6 +40,7 @@ class CreateMaterialRequest:
     purchase_uom: str | Unset = UNSET
     purchase_uom_conversion_rate: float | Unset = UNSET
     configs: list[MaterialConfig] | Unset = UNSET
+    custom_field_collection_id: int | None | Unset = UNSET
 
     def to_dict(self) -> dict[str, Any]:
         name = self.name
@@ -72,6 +73,12 @@ def to_dict(self) -> dict[str, Any]:
                 configs_item = configs_item_data.to_dict()
                 configs.append(configs_item)
 
+        custom_field_collection_id: int | None | Unset
+        if isinstance(self.custom_field_collection_id, Unset):
+            custom_field_collection_id = UNSET
+        else:
+            custom_field_collection_id = self.custom_field_collection_id
+
         field_dict: dict[str, Any] = {}
 
         field_dict.update(
@@ -98,6 +105,8 @@ def to_dict(self) -> dict[str, Any]:
             field_dict["purchase_uom_conversion_rate"] = purchase_uom_conversion_rate
         if configs is not UNSET:
             field_dict["configs"] = configs
+        if custom_field_collection_id is not UNSET:
+            field_dict["custom_field_collection_id"] = custom_field_collection_id
 
         return field_dict
 
@@ -141,6 +150,17 @@ def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
 
                 configs.append(configs_item)
 
+        def _parse_custom_field_collection_id(data: object) -> int | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(int | None | Unset, data)
+
+        custom_field_collection_id = _parse_custom_field_collection_id(
+            d.pop("custom_field_collection_id", UNSET)
+        )
+
         create_material_request = cls(
             name=name,
             variants=variants,
@@ -153,6 +173,7 @@ def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
             purchase_uom=purchase_uom,
             purchase_uom_conversion_rate=purchase_uom_conversion_rate,
             configs=configs,
+            custom_field_collection_id=custom_field_collection_id,
         )
 
         return create_material_request

katana_public_api_client/models/update_sales_order_shipping_fee_body.py

@@ -12,34 +12,42 @@
 
 @_attrs_define
 class UpdateSalesOrderShippingFeeBody:
-    amount: float | Unset = UNSET
     description: str | Unset = UNSET
+    amount: int | Unset = UNSET
+    tax_rate_id: int | Unset = UNSET
 
     def to_dict(self) -> dict[str, Any]:
+        description = self.description
+
         amount = self.amount
 
-        description = self.description
+        tax_rate_id = self.tax_rate_id
 
         field_dict: dict[str, Any] = {}
 
         field_dict.update({})
-        if amount is not UNSET:
-            field_dict["amount"] = amount
         if description is not UNSET:
             field_dict["description"] = description
+        if amount is not UNSET:
+            field_dict["amount"] = amount
+        if tax_rate_id is not UNSET:
+            field_dict["tax_rate_id"] = tax_rate_id
 
         return field_dict
 
     @classmethod
     def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
         d = dict(src_dict)
+        description = d.pop("description", UNSET)
+
         amount = d.pop("amount", UNSET)
 
-        description = d.pop("description", UNSET)
+        tax_rate_id = d.pop("tax_rate_id", UNSET)
 
         update_sales_order_shipping_fee_body = cls(
-            amount=amount,
             description=description,
+            amount=amount,
+            tax_rate_id=tax_rate_id,
         )
 
         return update_sales_order_shipping_fee_body