karrio-server-events 2025.5rc1__py3-none-any.whl

karrio/server/events/views/webhooks.py

@@ -0,0 +1,173 @@
+import logging
+
+from django.urls import path
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework import status, serializers
+from rest_framework.pagination import LimitOffsetPagination
+
+import karrio.server.openapi as openapi
+from karrio.server.core.views.api import GenericAPIView, APIView
+from karrio.server.serializers import PaginatedResult, PlainDictField
+from karrio.server.core.serializers import Operation, ErrorResponse
+from karrio.server.events.serializers.webhook import (
+    WebhookData,
+    Webhook,
+    WebhookSerializer,
+)
+from karrio.server.events.task_definitions.base.webhook import notify_subscribers
+from karrio.server.events.router import router
+from karrio.server.events import models
+
+
+logger = logging.getLogger(__name__)
+ENDPOINT_ID = "$$$$$$$"  # This endpoint id is used to make operation ids unique make sure not to duplicate
+Webhooks = PaginatedResult("WebhookList", Webhook)
+
+
+class WebhookTestRequest(serializers.Serializer):
+    payload = PlainDictField(required=True)
+
+
+class WebhookList(GenericAPIView):
+    pagination_class = LimitOffsetPagination
+    default_limit = 20
+    serializer_class = Webhooks
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}list",
+        extensions={"x-operationId": "listWebhooks"},
+        summary="List all webhooks",
+        responses={
+            200: Webhooks(),
+            404: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def get(self, request: Request):
+        """
+        Retrieve all webhooks.
+        """
+        webhooks = models.Webhook.access_by(request)
+        response = self.paginate_queryset(Webhook(webhooks, many=True).data)
+        return self.get_paginated_response(response)
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}create",
+        extensions={"x-operationId": "createWebhook"},
+        summary="Create a webhook",
+        request=WebhookData(),
+        responses={
+            201: Webhook(),
+            400: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def post(self, request: Request):
+        """Create a new webhook."""
+        webhook = (
+            WebhookSerializer.map(data=request.data, context=request).save().instance
+        )
+
+        return Response(Webhook(webhook).data, status=status.HTTP_201_CREATED)
+
+
+class WebhookDetails(APIView):
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}retrieve",
+        extensions={"x-operationId": "retrieveWebhook"},
+        summary="Retrieve a webhook",
+        responses={
+            201: Webhook(),
+            404: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def get(self, request: Request, pk: str):
+        """
+        Retrieve a webhook.
+        """
+        webhook = models.Webhook.access_by(request).get(pk=pk)
+        return Response(Webhook(webhook).data)
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}update",
+        extensions={"x-operationId": "updateWebhook"},
+        summary="Update a webhook",
+        request=WebhookData(),
+        responses={
+            200: Webhook(),
+            404: ErrorResponse(),
+            400: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def patch(self, request: Request, pk: str):
+        """
+        update a webhook.
+        """
+        webhook = models.Webhook.access_by(request).get(pk=pk)
+
+        WebhookSerializer.map(webhook, data=request.data).save()
+        return Response(Webhook(webhook).data)
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}remove",
+        extensions={"x-operationId": "removeWebhook"},
+        summary="Remove a webhook",
+        responses={
+            200: Operation(),
+            404: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def delete(self, request: Request, pk: str):
+        """
+        Remove a webhook.
+        """
+        webhook = models.Webhook.access_by(request).get(pk=pk)
+
+        webhook.delete(keep_parents=True)
+
+        return Response(Webhook(webhook).data)
+
+
+class WebhookTest(APIView):
+
+    @openapi.extend_schema(
+        tags=["Webhooks"],
+        operation_id=f"{ENDPOINT_ID}test",
+        extensions={"x-operationId": "testWebhook"},
+        summary="Test a webhook",
+        request=WebhookTestRequest(),
+        responses={
+            200: Operation(),
+            400: ErrorResponse(),
+            500: ErrorResponse(),
+        },
+    )
+    def post(self, request: Request, pk: str):
+        """
+        test a webhook.
+        """
+        webhook = models.Webhook.access_by(request).get(pk=pk)
+
+        notification, *_ = notify_subscribers([webhook], request.data)
+        _, response = notification
+        serializer = Operation(dict(operation="Test Webhook", success=response.ok))
+        return Response(serializer.data)
+
+
+router.urls.append(path("webhooks", WebhookList.as_view(), name="webhook-list"))
+router.urls.append(
+    path("webhooks/<str:pk>", WebhookDetails.as_view(), name="webhook-details")
+)
+router.urls.append(
+    path("webhooks/<str:pk>/test", WebhookTest.as_view(), name="webhook-test")
+)

karrio/server/graph/schemas/__init__.py

@@ -0,0 +1 @@
+__path__ = __import__('pkgutil').extend_path(__path__, __name__)  # type: ignore

karrio/server/graph/schemas/events/__init__.py

@@ -0,0 +1,47 @@
+import strawberry
+from strawberry.types import Info
+
+import karrio.server.graph.utils as utils
+import karrio.server.graph.schemas.base as base
+import karrio.server.graph.schemas.events.mutations as mutations
+import karrio.server.graph.schemas.events.inputs as inputs
+import karrio.server.graph.schemas.events.types as types
+import karrio.server.events.models as models
+
+extra_types: list = []
+
+
+@strawberry.type
+class Query:
+    webhook: types.WebhookType = strawberry.field(resolver=types.WebhookType.resolve)
+    webhooks: utils.Connection[types.WebhookType] = strawberry.field(
+        resolver=types.WebhookType.resolve_list
+    )
+
+    event: types.EventType = strawberry.field(resolver=types.EventType.resolve)
+    events: utils.Connection[types.EventType] = strawberry.field(
+        resolver=types.EventType.resolve_list
+    )
+
+
+@strawberry.type
+class Mutation:
+    @strawberry.mutation
+    def create_webhook(
+        self, info: Info, input: inputs.CreateWebhookMutationInput
+    ) -> mutations.CreateWebhookMutation:
+        return mutations.CreateWebhookMutation.mutate(info, **input.to_dict())
+
+    @strawberry.mutation
+    def update_webhook(
+        self, info: Info, input: inputs.UpdateWebhookMutationInput
+    ) -> mutations.UpdateWebhookMutation:
+        return mutations.UpdateWebhookMutation.mutate(info, **input.to_dict())
+
+    @strawberry.mutation
+    def delete_webhook(
+        self, info: Info, input: base.inputs.DeleteMutationInput
+    ) -> base.mutations.DeleteMutation:
+        return base.mutations.DeleteMutation.mutate(
+            info, model=models.Webhook, **input.to_dict()
+        )

karrio/server/graph/schemas/events/inputs.py

@@ -0,0 +1,43 @@
+import datetime
+import typing
+import strawberry
+
+import karrio.server.graph.utils as utils
+import karrio.server.events.serializers as serializers
+
+EventStatusEnum: typing.Any = strawberry.enum(serializers.EventTypes)
+
+
+@strawberry.input
+class CreateWebhookMutationInput(utils.BaseInput):
+    url: str
+    enabled_events: typing.List[EventStatusEnum]
+    description: typing.Optional[str] = strawberry.UNSET
+    disabled: typing.Optional[bool] = False
+
+
+@strawberry.input
+class WebhookFilter(utils.Paginated):
+    url: typing.Optional[str] = strawberry.UNSET
+    disabled: typing.Optional[bool] = strawberry.UNSET
+    test_mode: typing.Optional[bool] = strawberry.UNSET
+    events: typing.Optional[typing.List[EventStatusEnum]] = strawberry.UNSET
+    date_after: typing.Optional[datetime.datetime] = strawberry.UNSET
+    date_before: typing.Optional[datetime.datetime] = strawberry.UNSET
+
+
+@strawberry.input
+class UpdateWebhookMutationInput(utils.BaseInput):
+    id: str
+    url: typing.Optional[str] = strawberry.UNSET
+    enabled_events: typing.List[EventStatusEnum] = strawberry.UNSET
+    description: typing.Optional[str] = strawberry.UNSET
+    disabled: typing.Optional[bool] = strawberry.UNSET
+
+
+@strawberry.input
+class EventFilter(utils.Paginated):
+    entity_id: typing.Optional[str] = strawberry.UNSET
+    type: typing.Optional[typing.List[EventStatusEnum]] = strawberry.UNSET
+    date_after: typing.Optional[datetime.datetime] = strawberry.UNSET
+    date_before: typing.Optional[datetime.datetime] = strawberry.UNSET

karrio/server/graph/schemas/events/mutations.py

@@ -0,0 +1,56 @@
+import typing
+import strawberry
+from strawberry.types import Info
+
+import karrio.server.graph.utils as utils
+import karrio.server.graph.schemas.events.types as types
+import karrio.server.graph.schemas.events.inputs as inputs
+import karrio.server.events.serializers.webhook as serializers
+import karrio.server.events.models as models
+
+
+@strawberry.type
+class CreateWebhookMutation(utils.BaseMutation):
+    webhook: typing.Optional[types.WebhookType] = None
+
+    @staticmethod
+    @utils.authentication_required
+    @utils.authorization_required(["manage_webhooks"])
+    def mutate(
+        info: Info, **input: inputs.CreateWebhookMutationInput
+    ) -> "CreateWebhookMutation":
+        serializer = serializers.WebhookSerializer(
+            data=input,
+            context=info.context.request,
+        )
+        serializer.is_valid(raise_exception=True)
+
+        return CreateWebhookMutation(webhook=serializer.save())  # type:ignore
+
+
+@strawberry.type
+class UpdateWebhookMutation(utils.BaseMutation):
+    webhook: typing.Optional[types.WebhookType] = None
+
+    @staticmethod
+    @utils.authentication_required
+    @utils.authorization_required(["manage_webhooks"])
+    def mutate(
+        info: Info, **input: inputs.UpdateWebhookMutationInput
+    ) -> "UpdateWebhookMutation":
+        id = input.get("id")
+        webhook = models.Webhook.access_by(info.context.request).get(id=id)
+
+        serializer = serializers.WebhookSerializer(
+            webhook,
+            data=input,
+            partial=True,
+            context=info.context.request,
+        )
+        serializer.is_valid(raise_exception=True)
+        serializer.save()
+
+        # refetch the shipment to get the updated state with signals processed
+        update = models.Webhook.access_by(info.context.request).get(id=id)
+
+        return UpdateWebhookMutation(webhook=update)  # type:ignore

karrio/server/graph/schemas/events/types.py

@@ -0,0 +1,79 @@
+import typing
+import datetime
+import strawberry
+
+import karrio.lib as lib
+import karrio.server.graph.utils as utils
+import karrio.server.graph.schemas.base.types as base
+import karrio.server.graph.schemas.events.inputs as inputs
+import karrio.server.events.models as models
+import karrio.server.events.filters as filters
+
+
+@strawberry.type
+class WebhookType:
+    object_type: str
+    id: str
+    url: typing.Optional[str]
+    secret: typing.Optional[str]
+    disabled: typing.Optional[bool]
+    test_mode: typing.Optional[bool]
+    description: typing.Optional[str]
+    enabled_events: typing.List[inputs.EventStatusEnum]
+    last_event_at: typing.Optional[datetime.datetime]
+    created_at: typing.Optional[datetime.datetime]
+    updated_at: typing.Optional[datetime.datetime]
+    created_by: typing.Optional[base.UserType]
+
+    @staticmethod
+    @utils.authentication_required
+    def resolve(info, id: str) -> typing.Optional["WebhookType"]:
+        return models.Webhook.access_by(info.context.request).filter(id=id).first()
+
+    @staticmethod
+    @utils.authentication_required
+    def resolve_list(
+        info,
+        filter: typing.Optional[inputs.WebhookFilter] = strawberry.UNSET,
+    ) -> utils.Connection["WebhookType"]:
+        _filter = filter if filter is not strawberry.UNSET else inputs.WebhookFilter()
+        queryset = filters.WebhookFilter(
+            _filter.to_dict(), models.Webhook.access_by(info.context.request)
+        ).qs
+        return utils.paginated_connection(queryset, **_filter.pagination())
+
+
+@strawberry.type
+class EventType:
+    object_type: str
+    id: str
+    test_mode: typing.Optional[bool]
+    pending_webhooks: typing.Optional[int]
+    type: typing.Optional[inputs.EventStatusEnum]
+    created_at: typing.Optional[datetime.datetime]
+    updated_at: typing.Optional[datetime.datetime]
+    created_by: typing.Optional[base.UserType]
+
+    @strawberry.field
+    def data(self: models.Event) -> typing.Optional[utils.JSON]:
+        try:
+            return lib.to_dict(self.data)
+        except:
+            return self.data
+
+    @staticmethod
+    @utils.authentication_required
+    def resolve(info, id: str) -> typing.Optional["EventType"]:
+        return models.Event.access_by(info.context.request).filter(id=id).first()
+
+    @staticmethod
+    @utils.authentication_required
+    def resolve_list(
+        info,
+        filter: typing.Optional[inputs.EventFilter] = strawberry.UNSET,
+    ) -> utils.Connection["EventType"]:
+        _filter = filter if filter is not strawberry.UNSET else inputs.EventFilter()
+        queryset = filters.EventFilter(
+            _filter.to_dict(), models.Event.access_by(info.context.request)
+        ).qs
+        return utils.paginated_connection(queryset, **_filter.pagination())

karrio_server_events-2025.5rc1.dist-info/METADATA

@@ -0,0 +1,28 @@
+Metadata-Version: 2.4
+Name: karrio_server_events
+Version: 2025.5rc1
+Summary: Multi-carrier shipping API Events module
+Author-email: karrio <hello@karrio.io>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/karrioapi/karrio
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: karrio_server_core
+Requires-Dist: huey
+
+# karrio.server.events
+
+This package is a module of the [karrio](https://pypi.org/project/karrio.server) universal shipping API.
+
+## Requirements
+
+`Python 3.11+`
+
+## Installation
+
+```bash
+pip install karrio.server.events
+```
+
+Check the [karrio docs](https://docs.karrio.io) to get started.

karrio_server_events-2025.5rc1.dist-info/RECORD

@@ -0,0 +1,44 @@
+karrio/server/events/__init__.py,sha256=tvia3JfJUbr8axL76i0ic308Q0623SVKOyg0FXP3hBA,144
+karrio/server/events/admin.py,sha256=suMo4x8I3JBxAFBVIdE-5qnqZ6JAZV0FESABHOSc-vg,63
+karrio/server/events/apps.py,sha256=DIV8JdPB_3hD4DwhcQTevhph3PaceMkFSEGM1lOcdVY,301
+karrio/server/events/filters.py,sha256=vMeY42IsoFl482-yX1BI17sw-9x9euOnzTl-860W3sg,2230
+karrio/server/events/models.py,sha256=Ze4ITStRy_eb7qtujYbq7IISxvo7V2SKcmdCQ4fQO2I,2439
+karrio/server/events/router.py,sha256=IBUR7rfBkdEHQzWxYOPcVSM8NBp3fte9G6Q5BVTUNNw,95
+karrio/server/events/signals.py,sha256=gQ1FHwd-LXpg9OcV0inaqNBxSkqQVaztOgCOFNbo7I8,4549
+karrio/server/events/tasks.py,sha256=RVLJ2cNEQnT-3bUoitw9C_ST6g7tlLyzuJvu8omLOHc,712
+karrio/server/events/tests.py,sha256=mrbGGRNg5jwbTJtWWa7zSKdDyeB4vmgZCRc2nk6VY-g,60
+karrio/server/events/urls.py,sha256=oLTTzDWPhEFfK93EvzHTDRxqkw8Fr3iXneDXwFUkvcU,217
+karrio/server/events/migrations/0001_initial.py,sha256=c_HS1Pt89fnDgc839eh2VGBN4mvICBGWH5OUC5Xsz8k,2212
+karrio/server/events/migrations/0002_event.py,sha256=2f4SCoJcRXhPQRelH3EVRgpN77J0UmAW5yAtvvk42nc,1620
+karrio/server/events/migrations/0003_auto_20220303_1210.py,sha256=aOqf2v9w1DgfDKTWWkP94EDFhL7pg_LjeNEIl7-XdPw,813
+karrio/server/events/migrations/0004_custom_migration_2022_4.py,sha256=PjOvHs363wqVuYegVbDScEiw_iX9PHvg9fkviJaxcCI,1305
+karrio/server/events/migrations/0005_event_event_object_idx.py,sha256=UsDbq4z4n7wY4QyehzLy_9NP6GCejCqZAF9uizeh6Ng,513
+karrio/server/events/migrations/0006_webhook_events_alter_event_data.py,sha256=NJsoOUOEtarDO-7LCnrh8nxKmjyhe_mw-RhSIKDlYC0,2880
+karrio/server/events/migrations/0007_auto_20221130_0255.py,sha256=o5tkTj6vzrqpOyX6mXAYS3GOYlDRMkMY4tcPxzOzvOc,780
+karrio/server/events/migrations/0008_alter_event_type.py,sha256=DhUAI-yG_ugEv4f9oigdhn1lH_6A2nV8GyS-N63cmdQ,397
+karrio/server/events/migrations/0009_alter_webhook_enabled_events.py,sha256=0bhn3Ab_4cW2Zjptw7yfKJT1iTnsrBl_7goCCquNzcQ,1825
+karrio/server/events/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+karrio/server/events/serializers/__init__.py,sha256=S5KJONM1VFbB_Wyl__F2YbdSV7R_5RPNFos0ERkfDko,52
+karrio/server/events/serializers/base.py,sha256=Civqqod7X2u8wUfQpx7NejFpQfqQD8UWjztSOX4iWzg,2158
+karrio/server/events/serializers/event.py,sha256=dKYqldfSEjKMY7uB1rBFfEfSZ_dfEp8EPxbkBBSWzcc,289
+karrio/server/events/serializers/webhook.py,sha256=Ri5JS1SXpSsPUvQH989T_7Amu1p46y5TP54MEEhK8j8,889
+karrio/server/events/task_definitions/__init__.py,sha256=bpT73UG7mZL_JjEqMwbYx6q69jA8J5Jcoul1LcDokhA,81
+karrio/server/events/task_definitions/base/__init__.py,sha256=3vP52gFdCo9hctLRKnYvEi9iz1UK8GL_a47Nw44h3Nc,1834
+karrio/server/events/task_definitions/base/archiving.py,sha256=flbcxmD1pKlzCrYvekbwJ7Dvz4TaLdudAAsWH8JAjzI,2257
+karrio/server/events/task_definitions/base/tracking.py,sha256=UL7-z1nVp3Scz-Nm6xuJB8S6obfaiHd-IyBXXIcrwOo,8533
+karrio/server/events/task_definitions/base/webhook.py,sha256=NgXMJw_55pwZ5z4bu49VUekFNkUJ_cwvs01PNnLxhI4,3506
+karrio/server/events/tests/__init__.py,sha256=5szv9hDvu0R0jtm3XWktY19rCaE8bZ2LdjRm4oJ0pYA,220
+karrio/server/events/tests/test_events.py,sha256=Fxi1hv_lyuRJw5Y_ydywhq5P3akpxet4mFMFSiHU96c,4066
+karrio/server/events/tests/test_tracking_tasks.py,sha256=oOPdjhVax4SzTgBwKxySosgWOX6ZJ2Y-cYvXp3kj0lw,12114
+karrio/server/events/tests/test_webhooks.py,sha256=5Ts3RG_DQ5x0mnWRgTLOX-7FjSAEHXCvT913Sm7FLNM,3860
+karrio/server/events/views/__init__.py,sha256=Y4hfjd_YSOHj6L7oH41bssVW8rXI_l4vD_IthfNuJ2o,90
+karrio/server/events/views/webhooks.py,sha256=191DjXCoSTM_9AA-Kw-JxQ2TYQ6uYOQMrIDv11ZeTo0,5300
+karrio/server/graph/schemas/__init__.py,sha256=iOEMwnlORWezdO8-2vxBIPSR37D7JGjluZ8f55vzxls,81
+karrio/server/graph/schemas/events/__init__.py,sha256=Yg1rWew5DgSb_OnLy8n7qqwPLfVcZ1xm0_VzqP04rlE,1620
+karrio/server/graph/schemas/events/inputs.py,sha256=Mgy9qCUrbL-sMI5dNXsnbW8K5_PnGKM13brzZrc5OWk,1526
+karrio/server/graph/schemas/events/mutations.py,sha256=930g2D5TnAEgEjfEfLml1Q9OGCyxe2D592BhzSGDQAQ,1862
+karrio/server/graph/schemas/events/types.py,sha256=TPlrDwQV4LZXu-1t4gFl_eYayU39THmgYT3uv7VXnnw,2759
+karrio_server_events-2025.5rc1.dist-info/METADATA,sha256=jAONHcC5Qr-q3W4Qvxrm9f6J4KCeXuFU7kDeHsQcU8Y,704
+karrio_server_events-2025.5rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+karrio_server_events-2025.5rc1.dist-info/top_level.txt,sha256=D1D7x8R3cTfjF_15mfiO7wCQ5QMtuM4x8GaPr7z5i78,12
+karrio_server_events-2025.5rc1.dist-info/RECORD,,

karrio_server_events-2025.5rc1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

karrio_server_events-2025.5rc1.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+dist
+karrio